C++ mpi module for stochmagnet_main Package
Public Member Functions | Static Public Member Functions | List of all members
SM_StochasticOutputLoader Class Reference

this class loads classes of the package More...

#include <SM_StochasticOutputLoader.h>

Inheritance diagram for SM_StochasticOutputLoader:
Inheritance graph
[legend]
Collaboration diagram for SM_StochasticOutputLoader:
Collaboration graph
[legend]

Public Member Functions

 SM_StochasticOutputLoader ()
 build a SM_StochasticOutputLoader
 
virtual ~SM_StochasticOutputLoader (void)
 destroy a SM_StochasticOutputLoader
 
virtual tMemSize getMemorySize () const override
 return the memory size of the class and the memory size of all its attributes/associations More...
 
- Public Member Functions inherited from SM_Loader
 SM_Loader ()
 build a SM_Loader
 
virtual ~SM_Loader (void)
 destroy a SM_Loader
 
- Public Member Functions inherited from CORE_Object
template<class T >
std::shared_ptr< T > getSharedPointer ()
 return the shared pointer for this More...
 
template<class T >
std::shared_ptr< const T > getConstSharedPointer () const
 return a const shared pointer for this More...
 
virtual tMemSize getContentsMemorySize () const
 return nthe memory size of the included associations More...
 
template<class T >
tBoolean isInstanceOf () const
 test if the clas T is an instance of this class More...
 
tString getClassName () const
 return the name of the class More...
 
tString getPointerString () const
 retrun the pointer of the class as a string More...
 
tString getIdentityString () const
 retrun the string identification of the class More...
 
virtual tString toString () const
 return the string representation of the object node More...
 

Static Public Member Functions

static tBoolean LoadStochasticOutputFromOptions (SM_StochasticTrajectory &stochasticOutput, const CORE_OptionsList &options)
 load the stochastic output from options More...
 
static tBoolean LoadStochasticOutputFromOptions (SM_StochasticEnergy &stochasticOutput, const CORE_OptionsList &options)
 load the stochastic output from options More...
 
static tBoolean LoadStochasticOutputFromOptions (SM_StochasticDecreasingNoise &stochasticOutput, const CORE_OptionsList &options)
 load the stochastic output from options More...
 
static tBoolean LoadStochasticOutputFromOptions (SM_StochasticXDMF &stochasticOutput, const CORE_OptionsList &options)
 load the stochastic output from options More...
 
static tBoolean LoadStochasticOutputFromOptions (SM_StochasticCurieTemperature &stochasticOutput, const CORE_OptionsList &options)
 load the stochastic output from options More...
 
static tBoolean LoadStochasticOutputFromOptions (SM_StochasticJs &stochasticOutput, const CORE_OptionsList &options)
 load the stochastic output from options More...
 
static tBoolean LoadStochasticOutputFromOptions (SM_StochasticBoltzmann &stochasticOutput, const CORE_OptionsList &options)
 load the stochastic output from options More...
 
static tBoolean LoadStochasticOutputFromOptions (SM_StochasticHysteresis &stochasticOutput, const CORE_OptionsList &options)
 load the stochastic output from options More...
 
static tBoolean LoadStochasticOutputFromOptions (SM_StochasticOutputList &stochasticOutput, const CORE_OptionsList &options)
 load the stochastic output from options More...
 
static tBoolean LoadStochasticOutputFromOptions (SM_StochasticOutputList &stochasticDataList, const std::vector< tString > &SOutputList, const CORE_OptionsList &options)
 load the stochastic output from options More...
 
- Static Public Member Functions inherited from SM_Loader
static tBoolean LoadBeamFromOptions (SM_Beam &beam, const CORE_OptionsList &options)
 load the beam from options More...
 
static tBoolean LoadSystemFromOptions (SM_System &system, const CORE_OptionsList &options)
 load the system from options More...
 
static tBoolean LoadNetworkFromOptions (SM_Network &network, const SM_CrystalStructure &cStructure, const CORE_OptionsList &options)
 load the network from options More...
 
static tBoolean LoadMaterialFromOptions (SM_Material &material, const CORE_OptionsList &options)
 load the material form options More...
 
static tBoolean LoadCrystalStructureFromOptions (SM_CrystalStructure &cStructure, const CORE_OptionsList &options)
 load crystal structure from options More...
 
static tBoolean LoadSystemOperatorsFromOptions (SM_System &system, const CORE_OptionsList &options)
 load the operators of the system More...
 
static tBoolean LoadSystemInitialMagneticMomentDirectionsFromOptions (SM_System &system, const CORE_OptionsList &options)
 load the dierction of initial magnetic moments of the system More...
 
static tBoolean LoadSystemNoiseFromOptions (SM_System &system, const CORE_OptionsList &options)
 load the noise of the system More...
 
static tBoolean LoadStochasticOutputFromOptions (SM_StochasticOutputComponent &outputSData, const CORE_OptionsList &options)
 load the stochastic outputs for the runer More...
 
- Static Public Member Functions inherited from CORE_Object
static tBoolean EnableMemoryStack (const tBoolean &isMemoryChecked)
 enable the memory stack More...
 
static void EnableMemoryStack ()
 enable the memory stack
 
static void DisableMemoryStack ()
 disable the memory stack
 
static tBoolean IsMemoryStackEnabled ()
 return trur if the memory stack is enabled
 
static tString MemoryStackToString ()
 get the memory stack in string More...
 
static tIndex GetRegisteredClassesNumber ()
 get the memory stack in string More...
 

Additional Inherited Members

- Protected Member Functions inherited from CORE_Object
 CORE_Object ()
 build an instance of the object
 
virtual ~CORE_Object ()
 destroy the instance of object std

 

Detailed Description

this class loads classes of the package

Member Function Documentation

◆ getMemorySize()

virtual tMemSize SM_StochasticOutputLoader::getMemorySize ( ) const
inlineoverridevirtual

return the memory size of the class and the memory size of all its attributes/associations

Returns
the memory size of the class and the memory size of its attributes/associations in bytes The mamory size is :
  • the added size of the base classes which contains:
    • the primary attributes size depends on the order: (first delare the smallest attributes size
    • all virtual functions costs <pointer-size> (4 32xor 8 64x) bytes by virtual function
    • virtual inherihtance will increase of (4 or 8) bytes
  • we add the size of the contains values of the attributes : for example the size of a string is the length of the string 1 octet = 1 byte 1 Ko = 1024 bytes 1 Mo = 1024 Ko 1 Go = 1024 Mo

Reimplemented from SM_Loader.

◆ LoadStochasticOutputFromOptions() [1/10]

tBoolean SM_StochasticOutputLoader::LoadStochasticOutputFromOptions ( SM_StochasticBoltzmann stochasticOutput,
const CORE_OptionsList options 
)
static

load the stochastic output from options

Parameters
[in,out]stochasticOutput: stochastic output
[in]optionsoptions of the stochastic output to load

◆ LoadStochasticOutputFromOptions() [2/10]

tBoolean SM_StochasticOutputLoader::LoadStochasticOutputFromOptions ( SM_StochasticCurieTemperature stochasticOutput,
const CORE_OptionsList options 
)
static

load the stochastic output from options

Parameters
[in,out]stochasticOutput: stochastic output
[in]optionsoptions of the stochastic output to load

◆ LoadStochasticOutputFromOptions() [3/10]

tBoolean SM_StochasticOutputLoader::LoadStochasticOutputFromOptions ( SM_StochasticDecreasingNoise stochasticOutput,
const CORE_OptionsList options 
)
static

load the stochastic output from options

Parameters
[in,out]stochasticOutput: stochastic output
[in]optionsoptions of the stochastic output to load

◆ LoadStochasticOutputFromOptions() [4/10]

tBoolean SM_StochasticOutputLoader::LoadStochasticOutputFromOptions ( SM_StochasticEnergy stochasticOutput,
const CORE_OptionsList options 
)
static

load the stochastic output from options

Parameters
[in,out]stochasticOutput: stochastic output
[in]optionsoptions of the stochastic output to load

◆ LoadStochasticOutputFromOptions() [5/10]

tBoolean SM_StochasticOutputLoader::LoadStochasticOutputFromOptions ( SM_StochasticHysteresis stochasticOutput,
const CORE_OptionsList options 
)
static

load the stochastic output from options

Parameters
[in,out]stochasticOutput: stochastic output
[in]optionsoptions of the stochastic output to load

◆ LoadStochasticOutputFromOptions() [6/10]

tBoolean SM_StochasticOutputLoader::LoadStochasticOutputFromOptions ( SM_StochasticJs stochasticOutput,
const CORE_OptionsList options 
)
static

load the stochastic output from options

Parameters
[in,out]stochasticOutput: stochastic output
[in]optionsoptions of the stochastic output to load

◆ LoadStochasticOutputFromOptions() [7/10]

tBoolean SM_StochasticOutputLoader::LoadStochasticOutputFromOptions ( SM_StochasticOutputList stochasticDataList,
const std::vector< tString > &  SOutputList,
const CORE_OptionsList options 
)
static

load the stochastic output from options

Parameters
[in,out]stochasticDataListstochastic output
[in]SOutputList: output list to generate
[in]optionsoptions of the stochastic output to load

◆ LoadStochasticOutputFromOptions() [8/10]

tBoolean SM_StochasticOutputLoader::LoadStochasticOutputFromOptions ( SM_StochasticOutputList stochasticOutput,
const CORE_OptionsList options 
)
static

load the stochastic output from options

Parameters
[in,out]stochasticOutput: stochastic output
[in]optionsoptions of the stochastic output to load

◆ LoadStochasticOutputFromOptions() [9/10]

tBoolean SM_StochasticOutputLoader::LoadStochasticOutputFromOptions ( SM_StochasticTrajectory stochasticOutput,
const CORE_OptionsList options 
)
static

load the stochastic output from options

Parameters
[in,out]stochasticOutput: stochastic output
[in]optionsoptions of the stochastic output to load

◆ LoadStochasticOutputFromOptions() [10/10]

tBoolean SM_StochasticOutputLoader::LoadStochasticOutputFromOptions ( SM_StochasticXDMF stochasticOutput,
const CORE_OptionsList options 
)
static

load the stochastic output from options

Parameters
[in,out]stochasticOutput: stochastic output
[in]optionsoptions of the stochastic output to load

The documentation for this class was generated from the following files: