C++ main module for stochmagnet Package  1.0
Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
SM_StratonovichSystem Class Reference

This class is a simulation of one trajectory class for Stoch Microm package based on Stratonovich system. More...

#include <SM_StratonovichSystem.h>

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

Public Member Functions

 SM_StratonovichSystem (void)
 create a class More...
 
virtual ~SM_StratonovichSystem (void)
 destroy the class More...
 
virtual tMemSize getMemorySize () const
 return the memory size of the class and the memory size of all its attributes/associations More...
 
const tReal & getK () const
 return the stratonovich constant More...
 
virtual void discretize () override
 discretize the system It computes the Stratonovich constant depending on the parameters of the Landau Lifschitz function More...
 
tBoolean computeTemplatedMuAtNextTimeStep (const tReal &dt, const tReal &epsilon_t, const tIndex &nParticles, const tDimension &dim, const tReal *mu_t, tReal *mu_tpdt) const
 compute mu at time step More...
 
virtual void getOperatorNames (std::vector< tString > &names) const override
 get the operator names More...
 
tBoolean makeTemplatedRelaxation (const SM_TemplatedStochasticFunction< StochImpl > &randomFunction, tReal *mu, tReal *Es)
 compute the relaxation process by calling only templated methods More...
 
tBoolean makeTemplatedRelaxation (const SM_TemplatedStochasticFunction< StochImpl > &randomFunction, const SM_TemplatedNoiseRateFunction< NoiseImpl > &noiseRateFunction, tReal *mu, tReal *Es)
 compute the relaxation process by calling only templated methods More...
 
virtual tMemSize getContentsMemorySize () const
 return the memory size of the included associations More...
 
const SM_Network & getNetwork () const
 get the network More...
 
SM_Network & getNetwork ()
 get the network More...
 
const SM_TimeStepper & getTimeStepper () const
 get the time stepper More...
 
SM_TimeStepper & getTimeStepper ()
 get the time stepper More...
 
void setInitialMagneticMoment (const std::valarray< tReal > &mu0)
 set the initial Magnetic Moment by moving More...
 
void setInitialMagneticMoment (const SM_RealField &mu0)
 set the initial Magnetic Moment by moving More...
 
void setInitialMagneticMoment (const tIndex &N, const std::array< tReal, 3 > &mu0)
 set the initial Magnetic Moment by copy More...
 
const SM_RealField & getInitialMagneticMoment () const
 set the initial Magnetic Moment More...
 
void setNoiseRateFunction (CORE_UniquePointer< SM_NoiseRateFunction > &f)
 gst the noise rate function More...
 
SM_NoiseRateFunction & getNoiseRateFunction ()
 get the noise rate function More...
 
const SM_NoiseRateFunction & getNoiseRateFunction () const
 get the noise rate function More...
 
const SM_LandauLifschitzFunction & getLandauLifschitzFunction () const
 get the Landau Lifschitz function return the Landau lifschitz function for reading More...
 
SM_LandauLifschitzFunction & getLandauLifschitzFunction ()
 get the Landau Lifschitz function More...
 
void addOperator (CORE_UniquePointer< SM_Operator > op)
 add operator More...
 
const SM_Operator * getOperator (const tString &name) const
 get the operator with name More...
 
void copyOperators (const SM_System &system)
 copy the operator More...
 
const std::map< tString, CORE_UniquePointer< SM_Operator > > & getOperators () const
 get the operators More...
 
tIndex getOperatorsNumber () const
 get the operator with name More...
 
tBoolean makeRelaxation (const SM_StochasticFunction *randomFunction, tReal *mu, tReal *Es)
 compute the relaxation process by calling only virtual methods More...
 
virtual tString toString () const override
 turn the class into a string representation More...
 
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...
 

Static Public Member Functions

static CORE_UniquePointer< SM_StratonovichSystem > New ()
 build a new instance of a system More...
 
static tBoolean EnableMemoryStack (const tBoolean &isMemoryChecked)
 enable the memory stack More...
 
static void EnableMemoryStack ()
 enable the memory stack More...
 
static void DisableMemoryStack ()
 disable the memory stack More...
 
static tBoolean IsMemoryStackEnabled ()
 return trur if the memory stack is enabled More...
 
static tString MemoryStackToString ()
 get the memory stack in string More...
 
static tIndex GetRegisteredClassesNumber ()
 get the memory stack in string More...
 

Protected Member Functions

void computeTemplatedMagneticField (const tIndex &t, const SM_Network &network, const tReal *mu, tReal *B) const
 compute the magnetic field at time step index t by calling the templated method SM_TemplatedOperator::computeTemplatedMagneticField() More...
 
void computeTemplatedMagneticFieldAndEnergies (const tIndex &t, const SM_Network &network, const tReal *mu, tReal *B, tReal *Es) const
 compute the magnetic field at time t by calling the templated method SM_TemplatedOperator::computeTemplatedMagneticField() More...
 
virtual tBoolean computeMuAtNextTimeStep (const tReal &dt, const tReal &epsilon_t, const tIndex &nParticles, const tDimension &dim, const tReal *mu_t, tReal *mu_tpdt) const
 compute mu at time step More...
 
SM_RealField & getMagneticField ()
 get the magnetic field More...
 
void computeMagneticField (const tIndex &t, const SM_Network &network, const tReal *mu, tReal *B) const
 compute the magnetic field at time step index t by calling the virtual method SM_Operator::computeMagneticField() More...
 
void computeMagneticFieldAndEnergies (const tIndex &t, const SM_Network &network, const tReal *mu, tReal *B, tReal *Es) const
 compute the magnetic field by calling the virtual method SM_Operator::computeMagneticField() More...
 

Private Member Functions

template<class T >
std::shared_ptr< T > setThis (std::unique_ptr< T, CORE_Object::Delete > &up)
 set the shared pointer from an unique pointer More...
 

Private Attributes

tReal mK
 
const SM_ZeemanOperator * mZeemanOperator
 
const SM_DemagnetizedOperator * mDemagnetizedOperator
 
const SM_HeissenbergOperator * mHeissenbergOperator
 
SM_LandauLifschitzFunction mLLFunction
 
SM_Network mNetwork
 
SM_TimeStepper mTimeStepper
 
std::map< tString, CORE_UniquePointer< SM_Operator > > mOperators
 
SM_RealField mB
 
SM_RealField mMu0
 
CORE_UniquePointer< SM_NoiseRateFunction > mNoiseRateFunction
 
std::weak_ptr< CORE_Object > mThis
 

Detailed Description

This class is a simulation of one trajectory class for Stoch Microm package based on Stratonovich system.

Author
Stephane Despreaux
Version
2.0

Constructor & Destructor Documentation

◆ SM_StratonovichSystem()

SM_StratonovichSystem::SM_StratonovichSystem ( void  )
inline

create a class

Referenced by New().

Here is the caller graph for this function:

◆ ~SM_StratonovichSystem()

virtual SM_StratonovichSystem::~SM_StratonovichSystem ( void  )
inlinevirtual

destroy the class

Member Function Documentation

◆ addOperator()

void SM_System::addOperator ( CORE_UniquePointer< SM_Operator >  op)
inlineinherited

add operator

Parameters
[in,out]op: operator to add. op points to null at the output

References SM_System::mOperators.

Referenced by SM_Test::grid3DParticlesTestCase(), SM_Test::linedParticlesTestCase(), SM_Run::loadOperatorsFromOptions(), and SM_Test::testOperators().

Here is the caller graph for this function:

◆ computeMagneticField()

void SM_System::computeMagneticField ( const tIndex &  t,
const SM_Network &  network,
const tReal *  mu,
tReal *  B 
) const
inlineprotectedinherited

compute the magnetic field at time step index t by calling the virtual method SM_Operator::computeMagneticField()

Parameters
[in]tindex of the time step
[in]network: network of the field
[in]mumagnetic moments of size nParticles x dim
[out]Bmagnetic field of size nParticles x dim

References SM_Network::getDimension(), SM_Network::getParticlesNumber(), SM_System::mOperators, tIndex, and tReal.

Here is the call graph for this function:

◆ computeMagneticFieldAndEnergies()

void SM_System::computeMagneticFieldAndEnergies ( const tIndex &  t,
const SM_Network &  network,
const tReal *  mu,
tReal *  B,
tReal *  Es 
) const
inlineprotectedinherited

compute the magnetic field by calling the virtual method SM_Operator::computeMagneticField()

Parameters
[in]tindex of the time step
[in]network: network of the field
[in]mumagnetic moments of size nParticles x dim
[out]Bmagnetic field of size nParticles x dim
[out]EsEnergies of size nOpertaors+1

References SM_Network::getDimension(), SM_Network::getParticlesNumber(), SM_System::mOperators, tIndex, and tReal.

Referenced by SM_System::makeRelaxation().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ computeMuAtNextTimeStep()

virtual tBoolean SM_TemplatedSystem< SM_StratonovichSystem >::computeMuAtNextTimeStep ( const tReal &  dt,
const tReal &  epsilon_t,
const tIndex &  nParticles,
const tDimension &  dim,
const tReal *  mu_t,
tReal *  mu_tpdt 
) const
inlineprotectedvirtualinherited

compute mu at time step

Parameters
[in]dttime step
[in]epsilon_t: epsilon at time t
[in]nParticlesnumber of particles
[in]dimdimension of space
[in]mu_t: mu at time t
[in,out]mu_tpdtmu at time t+dt

\( \mu_{t+dt}=\mu_{t+dt}+(1-K.\varepsilon_t^2.dt).\mu_t \)

Returns
false if there is a point \( P_i \) where at the coordinate k , \( |\mu_k(P_i)| \) is too much greater than 1 (10 for instance)

Implements SM_System.

◆ computeTemplatedMagneticField()

void SM_TemplatedSystem< SM_StratonovichSystem >::computeTemplatedMagneticField ( const tIndex &  t,
const SM_Network &  network,
const tReal *  mu,
tReal *  B 
) const
inlineprotectedinherited

compute the magnetic field at time step index t by calling the templated method SM_TemplatedOperator::computeTemplatedMagneticField()

Parameters
[in]t: index of the time step
[in]network: network of the field
[in]mumagnetic moments of size nParticles x dim
[out]Bmagnetic field of size nParticles x dim

◆ computeTemplatedMagneticFieldAndEnergies()

void SM_TemplatedSystem< SM_StratonovichSystem >::computeTemplatedMagneticFieldAndEnergies ( const tIndex &  t,
const SM_Network &  network,
const tReal *  mu,
tReal *  B,
tReal *  Es 
) const
inlineprotectedinherited

compute the magnetic field at time t by calling the templated method SM_TemplatedOperator::computeTemplatedMagneticField()

Parameters
[in]t: index of the time step
[in]network: network of the field
[in]mumagnetic moments of size nParticles x dim
[out]Bmagnetic field of size nParticles x dim
[out]EsEnergies of operator of size nOperators+1

◆ computeTemplatedMuAtNextTimeStep()

tBoolean SM_StratonovichSystem::computeTemplatedMuAtNextTimeStep ( const tReal &  dt,
const tReal &  epsilon_t,
const tIndex &  nParticles,
const tDimension &  dim,
const tReal *  mu_t,
tReal *  mu_tpdt 
) const
inline

compute mu at time step

Parameters
[in]dttime step
[in]epsilon_t: epsilon at time t
[in]nParticlesnumber of particles
[in]dimdimension of space
[in]mu_t: mu at time t
[in,out]mu_tpdtmu at time t+dt

\( \mu_{t+dt}=\mu_{t+dt}+(1-K.\varepsilon_t^2.dt).\mu_t \)

References mK, tBoolean, tIndex, and tReal.

◆ copyOperators()

void SM_System::copyOperators ( const SM_System &  system)
inlineinherited

copy the operator

Parameters
[in]system: the operators of the system are copied.

References SM_System::getOperators().

Here is the call graph for this function:

◆ DisableMemoryStack()

static void CORE_Object::DisableMemoryStack ( )
inlinestaticinherited

disable the memory stack

Referenced by CORE_Object::EnableMemoryStack().

Here is the caller graph for this function:

◆ discretize()

virtual void SM_StratonovichSystem::discretize ( )
inlineoverridevirtual

discretize the system It computes the Stratonovich constant depending on the parameters of the Landau Lifschitz function

Reimplemented from SM_TemplatedSystem< SM_StratonovichSystem >.

References SM_TemplatedSystem< SystemImpl >::discretize(), SM_LandauLifschitzFunction::getAlpha(), SM_LandauLifschitzFunction::getBeta(), SM_System::getLandauLifschitzFunction(), mK, and tReal.

Here is the call graph for this function:

◆ EnableMemoryStack() [1/2]

static void CORE_Object::EnableMemoryStack ( )
inlinestaticinherited

enable the memory stack

Referenced by CORE_Object::EnableMemoryStack(), and CORE_Run::SetDebugOptions().

Here is the caller graph for this function:

◆ EnableMemoryStack() [2/2]

static tBoolean CORE_Object::EnableMemoryStack ( const tBoolean &  isMemoryChecked)
inlinestaticinherited

enable the memory stack

Parameters
[in]isMemoryChecked: true to verify memory allocation of CORE_Object classes
Returns
true if the memroy is checked

References CORE_Object::DisableMemoryStack(), CORE_Object::EnableMemoryStack(), and CORE_Object::IsMemoryStackEnabled().

Here is the call graph for this function:

◆ getClassName()

tString CORE_Object::getClassName ( ) const
inlineinherited

return the name of the class

Returns
the string name of the class

Referenced by CORE_Object::getIdentityString(), and CORE_Test::testTypes().

Here is the caller graph for this function:

◆ getConstSharedPointer()

template<class T >
std::shared_ptr<const T> CORE_Object::getConstSharedPointer ( ) const
inlineinherited

return a const shared pointer for this

Returns
the shared pointer as a type T

References CORE_Object::mThis.

◆ getContentsMemorySize()

virtual tMemSize SM_System::getContentsMemorySize ( ) const
inlinevirtualinherited

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

References CORE_Object::getContentsMemorySize(), SM_Network::getContentsMemorySize(), CORE_Field< T, K, D, S, I >::getContentsMemorySize(), SM_System::mB, SM_System::mLLFunction, SM_System::mMu0, SM_System::mNetwork, SM_System::mNoiseRateFunction, SM_System::mOperators, and tMemSize.

Referenced by SM_ItoSystem::getMemorySize(), SM_StratonovichNormalizedSystem::getMemorySize(), getMemorySize(), SM_System::getMemorySize(), and SM_TemplatedSystem< SystemImpl >::getMemorySize().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ getIdentityString()

tString CORE_Object::getIdentityString ( ) const
inlineinherited

retrun the string identification of the class

Returns
the string identity of the class

References CORE_Object::getClassName(), and core_functions::pointerToString().

Referenced by CORE_Test::testArray(), CORE_Test::testField(), CORE_Test::testTypes(), CORE_Object::toString(), CORE_ClassFactory::toString(), and CORE_Field< T, K, D, S, I >::toString().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ getInitialMagneticMoment()

const SM_RealField& SM_System::getInitialMagneticMoment ( ) const
inlineinherited

set the initial Magnetic Moment

Returns
the initial magnetic moment

References SM_System::mMu0.

Referenced by SM_Beam::discretize(), SM_DemagnetizedOperator::discretize(), and SM_System::makeRelaxation().

Here is the caller graph for this function:

◆ getK()

const tReal& SM_StratonovichSystem::getK ( ) const
inline

return the stratonovich constant

Returns
the stratonivhc constant : \( \alpha^2.(1+\beta^2) \) where \((\alpha,\beta) \) is the coefficent of the landau lifschitz function see SM_LandauLifschitzFunction

References mK.

◆ getLandauLifschitzFunction() [1/2]

SM_LandauLifschitzFunction& SM_System::getLandauLifschitzFunction ( )
inlineinherited

get the Landau Lifschitz function

Returns
the Landau lifschitz function for writing

References SM_System::mLLFunction.

◆ getLandauLifschitzFunction() [2/2]

const SM_LandauLifschitzFunction& SM_System::getLandauLifschitzFunction ( ) const
inlineinherited

get the Landau Lifschitz function return the Landau lifschitz function for reading

References SM_System::mLLFunction.

Referenced by SM_Beam::discretize(), SM_StratonovichNormalizedSystem::discretize(), discretize(), SM_Test::grid3DParticlesTestCase(), SM_Test::linedParticlesTestCase(), SM_Run::loadBeamFromOptions(), SM_System::makeRelaxation(), and SM_Test::testOperators().

Here is the caller graph for this function:

◆ getMagneticField()

SM_RealField& SM_System::getMagneticField ( )
inlineprotectedinherited

get the magnetic field

References SM_System::mB.

◆ getMemorySize()

virtual tMemSize SM_StratonovichSystem::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 SM_TemplatedSystem< SM_StratonovichSystem >.

References SM_System::getContentsMemorySize().

Here is the call graph for this function:

◆ getNetwork() [1/2]

SM_Network& SM_System::getNetwork ( )
inlineinherited

get the network

Returns
the network for writing

References SM_System::mNetwork.

◆ getNetwork() [2/2]

const SM_Network& SM_System::getNetwork ( ) const
inlineinherited

get the network

Returns
the network for reading

References SM_System::mNetwork.

Referenced by SM_Beam::computeL2Convergence(), SM_Beam::discretize(), SM_System::discretize(), SM_PermanentZeemanOperator::discretize(), SM_ZeemanOperator::discretize(), SM_Output::generateOutput(), SM_Test::grid3DParticlesTestCase(), SM_Test::linedParticlesTestCase(), SM_Run::loadMagneticMomentFromOptions(), SM_System::makeRelaxation(), SM_VTK::save(), SM_Test::testEnergyOperatorsDerivatives(), and SM_Test::validate().

Here is the caller graph for this function:

◆ getNoiseRateFunction() [1/2]

SM_NoiseRateFunction& SM_System::getNoiseRateFunction ( )
inlineinherited

get the noise rate function

Returns
the noise rate function

References SM_System::mNoiseRateFunction.

Referenced by SM_Beam::computeL2Convergence(), SM_System::makeRelaxation(), SM_Output::saveStochasticIndicators(), and SM_Beam::templatedSimulate().

Here is the caller graph for this function:

◆ getNoiseRateFunction() [2/2]

const SM_NoiseRateFunction& SM_System::getNoiseRateFunction ( ) const
inlineinherited

get the noise rate function

Returns
the noise rate function

References SM_System::mNoiseRateFunction.

◆ getOperator()

const SM_Operator* SM_System::getOperator ( const tString &  name) const
inlineinherited

get the operator with name

Parameters
[in]name: name of the operator

References SM_System::mOperators.

Referenced by SM_Beam::computeL2Convergence(), SM_TemplatedSystem< SystemImpl >::discretize(), and SM_Test::testEnergyOperatorsDerivatives().

Here is the caller graph for this function:

◆ getOperatorNames()

virtual void SM_TemplatedSystem< SM_StratonovichSystem >::getOperatorNames ( std::vector< tString > &  names) const
inlineoverridevirtualinherited

get the operator names

Parameters
[out]names: names of the operator

Reimplemented from SM_System.

◆ getOperators()

const std::map<tString,CORE_UniquePointer<SM_Operator> >& SM_System::getOperators ( ) const
inlineinherited

get the operators

Returns
the operators map : name->operator

References SM_System::mOperators.

Referenced by SM_System::copyOperators().

Here is the caller graph for this function:

◆ getOperatorsNumber()

tIndex SM_System::getOperatorsNumber ( ) const
inlineinherited

get the operator with name

Parameters
[in]name: name of the operator

References SM_System::mOperators.

Referenced by SM_Beam::discretize(), SM_System::makeRelaxation(), and SM_Output::saveStochasticIndicators().

Here is the caller graph for this function:

◆ getPointerString()

tString CORE_Object::getPointerString ( ) const
inlineinherited

retrun the pointer of the class as a string

Returns
the pointer of the calss as a string

References core_functions::pointerToString().

Here is the call graph for this function:

◆ GetRegisteredClassesNumber()

static tIndex CORE_Object::GetRegisteredClassesNumber ( )
inlinestaticinherited

get the memory stack in string

Returns
the string representation of the memory stack

◆ getSharedPointer()

template<class T >
std::shared_ptr<T> CORE_Object::getSharedPointer ( )
inlineinherited

return the shared pointer for this

Returns
the shared pointer as a type T

References CORE_Object::mThis.

◆ getTimeStepper() [1/2]

SM_TimeStepper& SM_System::getTimeStepper ( )
inlineinherited

get the time stepper

Returns
the time stepper for writing

References SM_System::mTimeStepper.

◆ getTimeStepper() [2/2]

const SM_TimeStepper& SM_System::getTimeStepper ( ) const
inlineinherited

get the time stepper

Returns
the time stepper for reading

References SM_System::mTimeStepper.

Referenced by SM_Beam::computeL2Convergence(), SM_Beam::discretize(), SM_ZeemanOperator::discretize(), SM_Output::generateOutput(), SM_Test::grid3DParticlesTestCase(), SM_Test::linedParticlesTestCase(), SM_Run::loadBeamFromOptions(), SM_System::makeRelaxation(), SM_VTK::save(), SM_Output::saveStochasticIndicators(), SM_Test::testOperators(), and SM_Test::validate().

Here is the caller graph for this function:

◆ isInstanceOf()

template<class T >
tBoolean CORE_Object::isInstanceOf ( ) const
inlineinherited

test if the clas T is an instance of this class

Returns
true if the object is an instance of T

Referenced by SM_Beam::templatedSimulate().

Here is the caller graph for this function:

◆ IsMemoryStackEnabled()

static tBoolean CORE_Object::IsMemoryStackEnabled ( )
inlinestaticinherited

return trur if the memory stack is enabled

Referenced by CORE_Object::EnableMemoryStack(), and main().

Here is the caller graph for this function:

◆ makeRelaxation()

tBoolean SM_System::makeRelaxation ( const SM_StochasticFunction *  randomFunction,
tReal *  mu,
tReal *  Es 
)
inherited

compute the relaxation process by calling only virtual methods

Parameters
[in]randomFunctionrandom function for the stochastic simulation
[out]mumu at all time of size nParticules x dim x nTimeSteps
[out]Esenergies of the system for each operatr & total operator

References ASSERT_IN, SM_LandauLifschitzFunction::computeFunction(), SM_NoiseRateFunction::computeFunction(), SM_System::computeMagneticFieldAndEnergies(), SM_System::computeMuAtNextTimeStep(), CORE_Field< T, K, D, S, I >::getDimension(), SM_Network::getDimension(), CORE_Field< T, K, D, S, I >::getElementsNumber(), SM_System::getInitialMagneticMoment(), SM_System::getLandauLifschitzFunction(), SM_TimeStepper::getMaximumTimeStepsNumber(), SM_System::getNetwork(), SM_System::getNoiseRateFunction(), SM_System::getOperatorsNumber(), SM_Network::getParticlesNumber(), SM_TimeStepper::getTimeStep(), SM_System::getTimeStepper(), SM_System::mB, SM_System::mMu0, SM_StochasticFunction::random(), tBoolean, tIndex, and tReal.

Here is the call graph for this function:

◆ makeTemplatedRelaxation() [1/2]

tBoolean SM_TemplatedSystem< SM_StratonovichSystem >::makeTemplatedRelaxation ( const SM_TemplatedStochasticFunction< StochImpl > &  randomFunction,
const SM_TemplatedNoiseRateFunction< NoiseImpl > &  noiseRateFunction,
tReal *  mu,
tReal *  Es 
)
inherited

compute the relaxation process by calling only templated methods

Parameters
[in]randomFunction: the stochastic random function
[in]noiseRateFunction: the noise rate function
[out]mumu at all time
[out]Esenergy of alloperator at all time

◆ makeTemplatedRelaxation() [2/2]

tBoolean SM_TemplatedSystem< SM_StratonovichSystem >::makeTemplatedRelaxation ( const SM_TemplatedStochasticFunction< StochImpl > &  randomFunction,
tReal *  mu,
tReal *  Es 
)
inlineinherited

compute the relaxation process by calling only templated methods

Parameters
[in]randomFunction: the stochastic random function
[out]mumu at all time
[out]Esenergy of alloperator at all time

◆ MemoryStackToString()

static tString CORE_Object::MemoryStackToString ( )
inlinestaticinherited

get the memory stack in string

Returns
the string representation of the memory stack

Referenced by main().

Here is the caller graph for this function:

◆ New()

static CORE_UniquePointer<SM_StratonovichSystem> SM_StratonovichSystem::New ( )
inlinestatic

build a new instance of a system

Returns
an unique pointer of system

References SM_StratonovichSystem().

Referenced by SM_ClassFactory::NewInstance().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ setInitialMagneticMoment() [1/3]

void SM_System::setInitialMagneticMoment ( const SM_RealField &  mu0)
inlineinherited

set the initial Magnetic Moment by moving

Parameters
[in]mu0constant value of Mu at time 0 by moving

References SM_System::mMu0, and CORE_StdPtrField< T, K, D >::normalize().

Here is the call graph for this function:

◆ setInitialMagneticMoment() [2/3]

void SM_System::setInitialMagneticMoment ( const std::valarray< tReal > &  mu0)
inlineinherited

set the initial Magnetic Moment by moving

Parameters
[in]mu0constant value of Mu at time 0 by moving

References SM_System::mMu0, and CORE_StdPtrField< T, K, D >::normalize().

Referenced by SM_Test::grid3DParticlesTestCase(), SM_Test::linedParticlesTestCase(), SM_Run::loadMagneticMomentFromOptions(), and SM_Test::testEnergyOperatorsDerivatives().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ setInitialMagneticMoment() [3/3]

void SM_System::setInitialMagneticMoment ( const tIndex &  N,
const std::array< tReal, 3 > &  mu0 
)
inlineinherited

set the initial Magnetic Moment by copy

Parameters
[in]N: number of particles
[in]mu0constant value of Mu

References CORE_StdPtrField< T, K, D >::initialize(), SM_System::mMu0, and CORE_Field< T, K, D, S, I >::setElementsNumber().

Here is the call graph for this function:

◆ setNoiseRateFunction()

void SM_System::setNoiseRateFunction ( CORE_UniquePointer< SM_NoiseRateFunction > &  f)
inlineinherited

gst the noise rate function

Parameters
[in]f: the noise rate function

References SM_System::mNoiseRateFunction.

Referenced by SM_Test::grid3DParticlesTestCase(), SM_Test::linedParticlesTestCase(), SM_Run::loadBeamFromOptions(), and SM_Test::testOperators().

Here is the caller graph for this function:

◆ setThis()

template<class T >
std::shared_ptr<T> CORE_Object::setThis ( std::unique_ptr< T, CORE_Object::Delete > &  up)
inlineprivateinherited

set the shared pointer from an unique pointer

Parameters
[in,out]upunique pointer of the class at input, points to null pointer at output
Returns
the shared pointer of the class

Method only calledby the friend class CORE_ClassFactory::NewSharedInstance()

References CORE_Object::mThis.

◆ toString()

tString SM_System::toString ( ) const
overridevirtualinherited

turn the class into a string representation

Returns
a string representation of the class

Reimplemented from CORE_Object.

References SM_Network::getDimension(), CORE_Field< T, K, D, S, I >::getElementsNumber(), SM_System::mLLFunction, SM_System::mMu0, SM_System::mNetwork, SM_System::mNoiseRateFunction, SM_System::mTimeStepper, tIndex, tNaturalInteger, CORE_Object::toString(), SM_LandauLifschitzFunction::toString(), SM_Network::toString(), SM_TimeStepper::toString(), tReal, and tUInt.

Here is the call graph for this function:

Member Data Documentation

◆ mB

SM_RealField SM_System::mB
privateinherited

Referenced by SM_System::discretize(), SM_System::getContentsMemorySize(), SM_System::getMagneticField(), and SM_System::makeRelaxation().

◆ mDemagnetizedOperator

const SM_DemagnetizedOperator* SM_TemplatedSystem< SM_StratonovichSystem >::mDemagnetizedOperator
privateinherited

◆ mHeissenbergOperator

const SM_HeissenbergOperator* SM_TemplatedSystem< SM_StratonovichSystem >::mHeissenbergOperator
privateinherited

◆ mK

tReal SM_StratonovichSystem::mK
private

Referenced by computeTemplatedMuAtNextTimeStep(), discretize(), and getK().

◆ mLLFunction

SM_LandauLifschitzFunction SM_System::mLLFunction
privateinherited

Referenced by SM_System::getContentsMemorySize(), SM_System::getLandauLifschitzFunction(), SM_System::SM_System(), and SM_System::toString().

◆ mMu0

SM_RealField SM_System::mMu0
privateinherited

Referenced by SM_System::getContentsMemorySize(), SM_System::getInitialMagneticMoment(), SM_System::makeRelaxation(), SM_System::setInitialMagneticMoment(), SM_System::SM_System(), and SM_System::toString().

◆ mNetwork

SM_Network SM_System::mNetwork
privateinherited

Referenced by SM_System::getContentsMemorySize(), SM_System::getNetwork(), and SM_System::toString().

◆ mNoiseRateFunction

CORE_UniquePointer<SM_NoiseRateFunction> SM_System::mNoiseRateFunction
privateinherited

Referenced by SM_System::getContentsMemorySize(), SM_System::getNoiseRateFunction(), SM_System::setNoiseRateFunction(), and SM_System::toString().

◆ mOperators

std::map<tString,CORE_UniquePointer<SM_Operator> > SM_System::mOperators
privateinherited

Referenced by SM_System::addOperator(), SM_System::computeMagneticField(), SM_System::computeMagneticFieldAndEnergies(), SM_System::discretize(), SM_System::getContentsMemorySize(), SM_System::getOperator(), SM_System::getOperatorNames(), SM_System::getOperators(), and SM_System::getOperatorsNumber().

◆ mThis

std::weak_ptr<CORE_Object> CORE_Object::mThis
privateinherited

Referenced by CORE_Object::getConstSharedPointer(), CORE_Object::getSharedPointer(), and CORE_Object::setThis().

◆ mTimeStepper

SM_TimeStepper SM_System::mTimeStepper
privateinherited

Referenced by SM_System::getTimeStepper(), and SM_System::toString().

◆ mZeemanOperator

const SM_ZeemanOperator* SM_TemplatedSystem< SM_StratonovichSystem >::mZeemanOperator
privateinherited
The documentation for this class was generated from the following file:
Generated on Wed Mar 8 2023 09:58:12 for C++ main module for stochmagnet Package by doxygen 1.9.1