this class loads classes of the package More...

#include <SM_LandauLifschitzLoader.h>

Inheritance diagram for SM_LandauLifschitzLoader:

Collaboration diagram for SM_LandauLifschitzLoader:

Public Member Functions
	SM_LandauLifschitzLoader ()
	build a SM_LandauLifschitzLoader

virtual	~SM_LandauLifschitzLoader (void)
	destroy a SM_LandauLifschitzLoader

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	LoadLandauLifschitzBeamFromOptions (SM_LandauLifschitzBeam &beam, const CORE_OptionsList &options)
	load the beam from options More...

static tBoolean	LoadLandauLifschitzSystemFromOptions (SM_LandauLifschitzSystem &system, const CORE_OptionsList &options)
	load the landau lifschitz system from options More...

static tBoolean	LoadSystemNoiseRateFunctionFromOptions (SM_LandauLifschitzSystem &system, const CORE_OptionsList &options)
	load the noise data of the system from options More...

static tBoolean	LoadSystemRelaxationFromOptions (SM_LandauLifschitzSystem &system, const CORE_OptionsList &options)
	load the relaxation parameters of the system from options More...

static tBoolean	LoadLandauLifschitzFunctionFromOptions (SM_LandauLifschitzFunction &llF, const CORE_OptionsList &options)
	load the landau lifschitz functions from options More...

static tBoolean	LoadTimeStepperFromOptions (SM_TimeStepper &stepper, const CORE_OptionsList &options)
	load the noise data of the system 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_LandauLifschitzLoader::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.

◆ LoadLandauLifschitzBeamFromOptions()

tBoolean SM_LandauLifschitzLoader::LoadLandauLifschitzBeamFromOptions	(	SM_LandauLifschitzBeam &	beam,
		const CORE_OptionsList &	options
	)

static

load the beam from options

Parameters

[in,out]	beam	: ll beam to load
[in]	options	options of the builder It creates the landau-lifschitz system of the beam with option "ll-system" it loads its system

◆ LoadLandauLifschitzFunctionFromOptions()

tBoolean SM_LandauLifschitzLoader::LoadLandauLifschitzFunctionFromOptions	(	SM_LandauLifschitzFunction &	llF,
		const CORE_OptionsList &	options
	)

static

load the landau lifschitz functions from options

Parameters

[in,out]	llF	: ll function to load
[in]	options	options of the builder It loads landau lifschitz type with option "ll-type" landau lifschitz damping parameter with option "ll-lambda"

◆ LoadLandauLifschitzSystemFromOptions()

tBoolean SM_LandauLifschitzLoader::LoadLandauLifschitzSystemFromOptions	(	SM_LandauLifschitzSystem &	system,
		const CORE_OptionsList &	options
	)

static

load the landau lifschitz system from options

Parameters

[in,out]	system	: system to load
[in]	options	options of the builder -It creates: its landau lifschitz function with option "ll-type" its time stepper with option "time-stepper" its noise rate function with option "noise" -It loads its relaxation parameters its LL function its time stepper -It initializes the direction of magnetic moment with option "-S0" the adimensionizing of the parameters with options "adimensionnized" the noise options

◆ LoadSystemNoiseRateFunctionFromOptions()

tBoolean SM_LandauLifschitzLoader::LoadSystemNoiseRateFunctionFromOptions	(	SM_LandauLifschitzSystem &	system,
		const CORE_OptionsList &	options
	)

static

load the noise data of the system from options

Parameters

[in,out]	system	: system to load
[in]	options	options of the builder It creates the noise rate function with option 'noise'

◆ LoadSystemRelaxationFromOptions()

tBoolean SM_LandauLifschitzLoader::LoadSystemRelaxationFromOptions	(	SM_LandauLifschitzSystem &	system,
		const CORE_OptionsList &	options
	)

static

load the relaxation parameters of the system from options

Parameters

[in,out]	system	: ll system to load
[in]	options	options of the builder It loads relaxation tolearance "relaxation-tolerance" if relaxation is used to stop the running with the option "use-relaxation"

◆ LoadTimeStepperFromOptions()

tBoolean SM_LandauLifschitzLoader::LoadTimeStepperFromOptions	(	SM_TimeStepper &	stepper,
		const CORE_OptionsList &	options
	)

static

load the noise data of the system from options

Parameters

[in,out]	stepper	: stepper to load
[in]	options	options of the builder It loads time step with option "time-step"

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

/home/despreau/Developpement/CPP/devcpp20/include/stochmagnet/landauLifschitz/SM_LandauLifschitzLoader.h
/home/despreau/Developpement/CPP/devcpp20/src/stochmagnet/landauLifschitz/SM_LandauLifschitzLoader.cpp

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ getMemorySize()

◆ LoadLandauLifschitzBeamFromOptions()

◆ LoadLandauLifschitzFunctionFromOptions()

◆ LoadLandauLifschitzSystemFromOptions()

◆ LoadSystemNoiseRateFunctionFromOptions()

◆ LoadSystemRelaxationFromOptions()

◆ LoadTimeStepperFromOptions()