C++ mpi module for stochmagnet_main Package
SM_LandauLifschitzOptions.h
1 #ifndef SM_LandauLifschitzOptions_H
2 #define SM_LandauLifschitzOptions_H
3 
4 //supez class header
5 #include "SM_Options.h"
6 
14 class SM_LandauLifschitzOptions : public virtual SM_Options {
15 
16  //attributes
17 private :
18 
19 
20 
21 protected:
22  // CONSTRUCTORS
26  }//end constructor method
27 
28  // DESTRUCTORS
32  }//end destructor method
33 
34 
35 
36 public :
37  //MEMORY
38 
52  virtual tMemSize getMemorySize() const override{
53  return sizeof(*this)+getContentsMemorySize();
54  }//end getMemorySize Method
55 
56 
57  //shared pointer methods
58  //======================
59 
63  static inline CORE_UniquePointer<SM_LandauLifschitzOptions> New() {
64  return CORE_UniquePointer<SM_LandauLifschitzOptions>(new SM_LandauLifschitzOptions(),
66  }//end New method
67 
68 
69  // MAIN Method
70 
71 public:
72 
73 public:
77  virtual void initManOptions(CORE_OptionsList& options) const override {
78 
80  tString tab="\n\t\t\t";
81 
82 
83 
84 
85  //L
86  options.setManOption("LL","LL-system","stochastic model in {ito,stratonovich,stratonovich-n,heun}");
87  options.setManOption("LL","LL-lambda","microscopic damping parameter");
88  options.setManOption("LL","LL-type","Landau Lischitz type in ('LL','NLL'} NLL: the first argument is supposed to be normalized ");
89  options.setManOption("LL","noise","stochastic noise type in {'',constant,inverse}");
90  options.setManOption("LL","time-step","initial time step in s ");
91  options.setManOption("LL","time-stepper","kind of the stepper in {constant}");
92 
93  options.setManOption("LL","use-relaxation","true to use relaxation for deterministic system");
94  options.setManOption("LL","relaxation-tolerance","relaxation tolerance when relaxation is used");
95 
96 
97  }//end initManOptions method
98 
102  virtual void initOptions(CORE_OptionsList& options) const override {
103  SM_Options::initOptions(options);
104 
105 
106 
107 
108  //Landau lisfchitz system default options
109  options.setOptionValue("LL-system","stratonovich-n");
110  options.setOptionValue("LL-lambda",0.5);
111  options.setOptionValue("LL-type","ll");
112  options.setOptionValue("noise","constant");
113  options.setOptionValue("time-step",1.e-15);
114  options.setOptionValue("time-stepper","constant");
115  options.setOptionValue("use-relaxation","false");
116  options.setOptionValue("relaxation-tolerance",1.e-8);
117 
118 
119  }//end initOptions method
120 
121 
122 
123 };//end class method
124 
125 
126 #endif
class Free introduced for deleting a smart pointer
Definition: CORE_Object.h:113
virtual tMemSize getContentsMemorySize() const
return nthe memory size of the included associations
Definition: CORE_Object.h:278
This class is an list of options.
Definition: CORE_OptionsList.h:36
void setOptionValue(const tString &optName, const tBoolean &value)
set option
Definition: CORE_OptionsList.h:194
void setManOption(const tString &category, const tString &optName, const tString &man)
set man option
Definition: CORE_OptionsList.h:187
This class is the options of the package.
Definition: SM_LandauLifschitzOptions.h:14
static CORE_UniquePointer< SM_LandauLifschitzOptions > New()
return a new unique pointer of this
Definition: SM_LandauLifschitzOptions.h:63
virtual void initManOptions(CORE_OptionsList &options) const override
init the man of the options
Definition: SM_LandauLifschitzOptions.h:77
virtual void initOptions(CORE_OptionsList &options) const override
default initialization of the options
Definition: SM_LandauLifschitzOptions.h:102
virtual tMemSize getMemorySize() const override
return the memory size of the class and the memory size of all its attributes/associations
Definition: SM_LandauLifschitzOptions.h:52
virtual ~SM_LandauLifschitzOptions(void)
destroy class instance
Definition: SM_LandauLifschitzOptions.h:31
SM_LandauLifschitzOptions(void)
create class instance
Definition: SM_LandauLifschitzOptions.h:25
This class is the options of the package.
Definition: SM_Options.h:14
virtual void initManOptions(CORE_OptionsList &options) const override
init the man of the options
Definition: SM_Options.h:79
virtual void initOptions(CORE_OptionsList &options) const override
default initialization of the options
Definition: SM_Options.h:205