This class is a simulation of a beam of trajectories form a laudau-Lifschitz system. More...

#include <SM_LandauLifschitzBeam.h>

Inheritance diagram for SM_LandauLifschitzBeam:

[legend]

Collaboration diagram for SM_LandauLifschitzBeam:

[legend]

Public Member Functions
virtual tMemSize	getMemorySize () const override
	return the memory size of the class and the memory size of all its attributes/associations More...

virtual tMemSize	getContentsMemorySize () const override
	return the memory size of the included associations More...

SM_LandauLifschitzSystem &	getLLSystem ()
	get the landau lifschitz system

const SM_LandauLifschitzSystem &	getLLSystem () const
	get the landau lifschitz system

template<class StochOutputImplement >
tBoolean	run (SM_StochasticOutput< StochOutputImplement > &outputSData)
	run the simulations More...

template<class StochOutputImplement >
tBoolean	stochasticJRun (SM_StochasticOutput< StochOutputImplement > &outputSData, const std::function< void(const tReal &, const tReal &, const tReal &, tReal &)> &F)
	run the simulations More...

Public Member Functions inherited from SM_Beam
void	setBeamSize (const tIndex &n)
	set the beam size More...

void	setBeamSize (const tIndex &s0, const tIndex &s1)
	set the beam size More...

const tIndex &	getBeamSize () const
	get the beam size More...

const tIndex &	getBeamSize (tIndex &s0, tIndex &s1) const
	get the beam size More...

void	setPreconditioningStepsNumber (const tIndex &n)
	set the number of steps of preconditioning More...

const tIndex &	getPreconditioningStepsNumber () const
	get the number of steps for precoditioning More...

void	setStepsNumber (const tIndex &n)
	set the number of steps for loop More...

const tIndex &	getStepsNumber () const
	get the number of steps for stochastic computation More...

void	resetStochasticFunctions ()
	reset the stochastic functions

void	setStochasticFunctions (CORE_UniquePointer< SM_MultiStochasticFunctionsInterface > &f)
	set the stochastic functions More...

tBoolean	hasStochasticFunctions () const
	return true if the beam has a stochastic function

const SM_MultiStochasticFunctionsInterface &	getStochasticFunctions () const
	get the stochastic functions More...

SM_MultiStochasticFunctionsInterface &	getStochasticFunctions ()
	get the stochastic functions More...

void	setSystem (CORE_UniquePointer< SM_System > system)
	set the system More...

const SM_System &	getSystem () const
	get the system More...

SM_System &	getSystem ()
	get the system More...

tBoolean	hasSystem () const
	return true if the system of the beam is not null More...

void	normalize (const tBoolean &isAdimensionized)
	adimensionize the beam data

void	discretize ()
	discretize its system and its stochastic function

template<class System , class StochOutputImplement >
tBoolean	run (SM_StochasticOutput< StochOutputImplement > &outputSData)
	run the simulations More...

virtual tString	toString () const override
	turn the class into a string representation More...

Public Member Functions inherited from SM_Object
	SM_Object (void)
	create

virtual	~SM_Object (void)
	destroy

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...

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...

Protected Member Functions
	SM_LandauLifschitzBeam (void)
	create

virtual	~SM_LandauLifschitzBeam (void)
	destroy

Protected Member Functions inherited from SM_Beam
	SM_Beam (void)
	create

virtual	~SM_Beam (void)
	destroy

Protected Member Functions inherited from CORE_Object
	CORE_Object ()
	build an instance of the object

virtual	~CORE_Object ()
	destroy the instance of object std

Additional Inherited Members
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...

Detailed Description

This class is a simulation of a beam of trajectories form a laudau-Lifschitz system.

The simulation of a beam follows the algorithm:

image html beamAlgorithm.png

Author: Stephane Despreaux

Version: 2.0

Member Function Documentation

◆ getContentsMemorySize()

virtual tMemSize SM_LandauLifschitzBeam::getContentsMemorySize ( ) const

inlineoverridevirtual

return the memory size of the included associations

Returns: the memory size of the storage in bytes 1 Kb = 1024 bytes 1 Mb = 1024 Kb 1 Gb = 1024 Mb 1 Tb = 1024 Gb 1 Hb = 1024 Tb

Reimplemented from SM_Beam.

Reimplemented in SMOMPI_LandauLifschitzBeam.

◆ getMemorySize()

virtual tMemSize SM_LandauLifschitzBeam::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_Beam.

Reimplemented in SMOMPI_LandauLifschitzBeam.

◆ run()

template<class StochOutputImplement >

tBoolean SM_LandauLifschitzBeam::run ( SM_StochasticOutput< StochOutputImplement > & outputSData )

inline

run the simulations

Parameters

[in,out] outputSData : data to save at each time & simulation

Returns: true if the running has succeeded

◆ stochasticJRun()

template<class StochOutputImplement >

tBoolean SM_LandauLifschitzBeam::stochasticJRun	(	SM_StochasticOutput< StochOutputImplement > &	outputSData,
		const std::function< void(const tReal &, const tReal &, const tReal &, tReal &)> &	F
	)

run the simulations

Parameters

[in,out]	outputSData	: data to save at each time & simulation
[in]	F	: function J depending on F, epsilon et normal law

Returns: true if the running has succeeded

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

/home/despreau/Developpement/CPP/devcpp20/include/stochmagnet/landauLifschitz/SM_LandauLifschitzBeam.h
/home/despreau/Developpement/CPP/devcpp20/include/stochmagnet/landauLifschitz/SM_LandauLifschitzBeam.hpp

Public Member Functions