C++ main module for stochmagnet Package  1.0
SM_Run.h
Go to the documentation of this file.
1 #ifndef SM_Run_H
2 #define SM_Run_H
3 
4 //inherits header
5 #include "CORE_Run.h"
6 
7 class SM_Beam;
8 class SM_Network;
9 class SM_System;
10 
18 class SM_Run : public CORE_Run {
19 
20  //attributes
21 private :
22 
23 
24 
25 public:
26  // CONSTRUCTORS
29  SM_Run(void);
30 
31  // DESTRUCTORS
34  virtual ~SM_Run(void);
35 
36 
37 
38 public :
39  // CREATE class
40 
41 
42  //SET & GET methods
43 
44 
45 
46 
47  //MEMORY
48 
62  virtual tMemSize getMemorySize() const {
63  return sizeof(*this)+getContentsMemorySize();
64  }
65 
66 
67  // MAIN Method
68 
69 public:
70 
71 public:
75  virtual void initManOptions(std::map<tString,std::map<tString,tString> >& options) const override;
76 
80  virtual void initOptions(std::map<tString,tString>& options) const override;
81 
85  virtual void createClassFactories(const std::map<tString,tString>& options) const override;
86 
87 public:
93  virtual tBoolean makeTests(const std::map<tString,tString>& options) const override;
94 
95 
101  virtual tBoolean makeRun(const tString& command,const std::map<tString,tString>& options) const override;
102 
103 private:
104 
108  tBoolean run(const std::map<tString,tString>& options) const;
109 
110 
111  //loader
116  CORE_UniquePointer<SM_Beam> loadBeamFromOptions(const std::map<tString,tString>& options) const;
122  tBoolean loadNetworkFromOptions(SM_Network& network,const std::map<tString,tString>& options) const;
123 
129  tBoolean loadMagneticMomentFromOptions(SM_System& system,const std::map<tString,tString>& options) const;
135  tBoolean loadOperatorsFromOptions(SM_System& system,const std::map<tString,tString>& options) const;
136 
137  //output generator
144  const std::map<tString,tString>& options) const;
145 
150  tBoolean createMagneticDipolarMap(const tString& fileName) const ;
151 };
152 
153 
154 #endif
This class is an outpput results generator for stoch magnet program.
Definition: CORE_Run.h:36
virtual tMemSize getContentsMemorySize() const override
return the memory size in byte
Definition: CORE_Run.h:90
This class is a simulation of a beam of trajectories class for Stoch Microm package.
Definition: SM_Beam.h:46
This class is describes a a network.
Definition: SM_Network.h:18
Definition: SM_Run.h:18
virtual void createClassFactories(const std::map< tString, tString > &options) const override
create the class factories from options
Definition: SM_Run.cpp:131
tBoolean loadOperatorsFromOptions(SM_System &system, const std::map< tString, tString > &options) const
load the operators
Definition: SM_Run.cpp:503
virtual void initManOptions(std::map< tString, std::map< tString, tString > > &options) const override
init the man of the options
Definition: SM_Run.cpp:43
virtual tMemSize getMemorySize() const
return the memory size of the class and the memory size of all its attributes/associations
Definition: SM_Run.h:62
virtual tBoolean makeTests(const std::map< tString, tString > &options) const override
mak ethe tests of the prograp
Definition: SM_Run.cpp:139
tBoolean createMagneticDipolarMap(const tString &fileName) const
create a dipolar magnetic map
Definition: SM_Run.cpp:580
SM_Run(void)
create
Definition: SM_Run.cpp:29
tBoolean run(const std::map< tString, tString > &options) const
run the progra with the options
Definition: SM_Run.cpp:178
virtual ~SM_Run(void)
destroy
Definition: SM_Run.cpp:34
tBoolean generateOutput(SM_Beam &beam, const std::map< tString, tString > &options) const
save the file for animations
Definition: SM_Run.cpp:548
tBoolean loadNetworkFromOptions(SM_Network &network, const std::map< tString, tString > &options) const
load the network
Definition: SM_Run.cpp:379
tBoolean loadMagneticMomentFromOptions(SM_System &system, const std::map< tString, tString > &options) const
load the magnetic moment
Definition: SM_Run.cpp:431
CORE_UniquePointer< SM_Beam > loadBeamFromOptions(const std::map< tString, tString > &options) const
load the beam
Definition: SM_Run.cpp:254
virtual void initOptions(std::map< tString, tString > &options) const override
default initialization of the options
Definition: SM_Run.cpp:85
virtual tBoolean makeRun(const tString &command, const std::map< tString, tString > &options) const override
make Run command
Definition: SM_Run.cpp:147
This class is a simulation of one trajectory class for Stoch Microm package.
Definition: SM_System.h:51
typename std::unique_ptr< T, CORE_Object::Delete > CORE_UniquePointer
Definition: sp.h:8
#define tString
Definition: types.h:147
#define tMemSize
Definition: types.h:166
#define tBoolean
Definition: types.h:151