This class is a Beam Runner class for Stoch Microm package. More...

#include <SMOMPI_BeamRunner.h>

Inheritance diagram for SMOMPI_BeamRunner:

Collaboration diagram for SMOMPI_BeamRunner:

Public Member Functions
	SMOMPI_BeamRunner (void)
	create

virtual	~SMOMPI_BeamRunner (void)
	destroy

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

template<class BEAM , class STOCHASTIC_OUTPUT >
	requires (functions_type::isBaseOf< SM_StochasticJs, STOCHASTIC_OUTPUT >) static inline tBoolean RunBeam(const tBoolean &isTemplatedRun
	run the beam simulations with stochastic output More...

template<class BEAM , class STOCHASTIC_OUTPUT >
	requires (!(functions_type::isBaseOf< SM_StochasticJs, STOCHASTIC_OUTPUT >)) static tBoolean RunBeam(const tBoolean &isTemplatedRun
	run the beam simulations with stochastic output More...

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
template<class STOCHASTIC_OUTPUT >
static tBoolean	Run (const CORE_Run &runner, STOCHASTIC_OUTPUT &stochasticOutput, const CORE_OptionsList &options)
	compute the stochastic output from options More...

template<class BEAM_CYCLE , class STOCHASTIC_OUTPUT >
static tBoolean	Run (const CORE_Run &runner, SM_BeamCycle< BEAM_CYCLE > &cycleManager, STOCHASTIC_OUTPUT &stochasticOutput, const CORE_OptionsList &options)
	compute cycles of beam running for the stochastic output from options 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...

Public Attributes
BEAM &	beam

BEAM STOCHASTIC_OUTPUT &	stochasticOutput

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 is a Beam Runner class for Stoch Microm package.

Running a beam:

reads the options :
- CORE_Run::ReadOutputOptions() : load the IO options
creates a beam thanks to the the classes factory with the options of the program
loads the beam options depending on the beam type and adimensionize the system
- SM_LandauLifschitzLoader::LoadLandauLifschitzBeamFromOptions()
- SM_MonteCarloLoader::LoadMonteCarloBeamFromOptions
initializes the seed of stochastic functions SM_MultiStochasticFunctionsInterface::randomSeed()
initializes the stochastic outputs SM_StochasticOutputLoader::LoadStochasticOutputFromOptions()
discretizes the beam SM_Beam::discretize()
saves the network in a .net file SM_Network::saveToFile()
runs a beam either
- with virtual abstract methods SM_Beam::run() or
- with virtual templated methods SM_Beam::runWithSCStochasticFunctions()
saves the directions of magnetic moment depending on options

Author
Stephane Despreaux

Version
2.0

Member Function Documentation

◆ getMemorySize()

virtual tMemSize SMOMPI_BeamRunner::getMemorySize ( ) const

inlinevirtual

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

◆ requires() [1/2]

template<class BEAM , class STOCHASTIC_OUTPUT >

SMOMPI_BeamRunner::requires ( ! functions_type::isBaseOf< SM_StochasticJs, STOCHASTIC_OUTPUT > ) const &

run the beam simulations with stochastic output

Parameters

[in]	isTemplatedRun	true to run the casted templated version, false to run the virtual method version
[in,out]	beam	the beam to run
[in,out]	stochasticOutput	: the stochastic output data to compute

Returns: true if the running has succeeded

◆ requires() [2/2]

template<class BEAM , class STOCHASTIC_OUTPUT >

SMOMPI_BeamRunner::requires ( functions_type::isBaseOf< SM_StochasticJs, STOCHASTIC_OUTPUT > ) const &

run the beam simulations with stochastic output

Parameters

[in]	isTemplatedRun	true to run the casted templated version, false to run the virtual method version
[in,out]	beam	the beam to run
[in,out]	stochasticOutput	: the stochastic output data to compute

Returns: true if the running has succeeded

◆ Run() [1/2]

template<class BEAM_CYCLE , class STOCHASTIC_OUTPUT >

tBoolean SMOMPI_BeamRunner::Run	(	const CORE_Run &	runner,
		SM_BeamCycle< BEAM_CYCLE > &	cycleManager,
		STOCHASTIC_OUTPUT &	stochasticOutput,
		const CORE_OptionsList &	options
	)

static

compute cycles of beam running for the stochastic output from options

Parameters

[in]	runner	runner which launch the program
[in,out]	cycleManager	: manager of the cycle to run the beam
[in,out]	stochasticOutput	: the stochastic output data to compute
[in]	options	: options of the stochastic output to compute

Returns: true if the running has succeeded

◆ Run() [2/2]

template<class STOCHASTIC_OUTPUT >

tBoolean SMOMPI_BeamRunner::Run	(	const CORE_Run &	runner,
		STOCHASTIC_OUTPUT &	stochasticOutput,
		const CORE_OptionsList &	options
	)

static

compute the stochastic output from options

Parameters

[in]	runner	runner which launch the program
[in,out]	stochasticOutput	: the stochastic output data to compute
[in]	options	: options of the stochastic output to compute

Returns: true if the running has succeeded

Member Data Documentation

◆ stochasticOutput

BEAM STOCHASTIC_OUTPUT & SMOMPI_BeamRunner::stochasticOutput

Initial value:

{

return beam.stochasticJRun(stochasticOutput,stochasticOutput.getJFunction())

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

/home/despreau/Developpement/CPP/devcpp20/include/stochmagnet/main/mpi/SMOMPI_BeamRunner.h
/home/despreau/Developpement/CPP/devcpp20/include/stochmagnet/main/mpi/SMOMPI_BeamRunner.hpp

Public Member Functions

Static Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ getMemorySize()

◆ requires() [1/2]

◆ requires() [2/2]

◆ Run() [1/2]

◆ Run() [2/2]

Member Data Documentation

◆ stochasticOutput