This class is describes a time stepper. More...

#include <SM_TimeStepper.h>

Inheritance diagram for SM_TimeStepper:

Collaboration diagram for SM_TimeStepper:

Public Member Functions
	SM_TimeStepper (void)
	create a network class More...

virtual	~SM_TimeStepper (void)
	destroy More...

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

void	copy (const SM_TimeStepper &T)
	copy the time stepper More...

void	setTimeStep (const tReal &dt)
	set the time step More...

const tReal &	getTimeStep () const
	return the time step More...

void	setTargetTime (const tReal &t)
	set the target time More...

const tReal &	getTargetTime () const
	return the target time More...

void	setMaximumTimeStepsNumber (const tIndex &nSteps)
	set the maximum time steps number More...

const tIndex &	getMaximumTimeStepsNumber () const
	return the time steps number 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...

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

Static Public Member Functions
static CORE_UniquePointer< SM_TimeStepper >	New ()
	build a new instance of a TimeStepper 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...

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	mTimeStep

tReal	mTargetTime

tIndex	mMaximumTimeStepsNumber

std::weak_ptr< CORE_Object >	mThis

Detailed Description

This class is describes a time stepper.

Author: Stephane Despreaux

Version: 2.0

Constructor & Destructor Documentation

◆ SM_TimeStepper()

SM_TimeStepper::SM_TimeStepper ( void )

inline

create a network class

References mMaximumTimeStepsNumber, mTargetTime, and mTimeStep.

Referenced by New().

Here is the caller graph for this function:

◆ ~SM_TimeStepper()

virtual SM_TimeStepper::~SM_TimeStepper ( void )

inlinevirtual

destroy

Member Function Documentation

◆ copy()

void SM_TimeStepper::copy ( const SM_TimeStepper & T )

inline

copy the time stepper

Parameters

[in] T : the time stepper to copy

References getTargetTime(), getTimeStep(), mMaximumTimeStepsNumber, mTargetTime, and mTimeStep.

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:

◆ 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 CORE_Object::getContentsMemorySize ( ) const

inlinevirtualinherited

return nthe 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 in CORE_VectorList< T, I >, CORE_VectorList< tString, CORE_StringsList >, CORE_ValArray< T, I >, CORE_ValArray< T, CORE_StdValArray< T > >, CORE_Run, CORE_PtrArray< T, I >, CORE_PtrArray< T, CORE_StdPtrArray< T > >, CORE_Field< T, K, D, S, I >, CORE_Field< T, K, D, CORE_StdPtrArray< T >, CORE_StdPtrField< T, K, D > >, CORE_Field< T, K, D, CORE_StdValArray< T >, CORE_StdValField< T, K, D > >, CORE_ClassFactory, SMS_STDUniformFunction, SMS_STDNormalFunction, SMS_BoostUniformFunction, SMS_BoostNormalFunction, SM_ZeemanOperator, SM_XDMF, SM_VTK, SM_System, SM_Output, SM_Operator, SM_Network, SM_DemagnetizedOperator, SM_Beam, CORE_StringsList, and CORE_Out.

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:

◆ getMaximumTimeStepsNumber()

const tIndex& SM_TimeStepper::getMaximumTimeStepsNumber ( ) const

inline

return the time steps number

Returns: the time step

References mMaximumTimeStepsNumber.

Referenced by SM_Beam::computeL2Convergence(), SM_Beam::discretize(), SM_ZeemanOperator::discretize(), SM_Output::generateOutput(), SM_System::makeRelaxation(), SM_TemplatedSystem< SystemImpl >::makeTemplatedRelaxation(), SM_VTK::save(), SM_Output::saveStochasticIndicators(), and SM_Test::validate().

Here is the caller graph for this function:

◆ getMemorySize()

virtual tMemSize SM_TimeStepper::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_Object.

References CORE_Object::getContentsMemorySize().

Here is the call 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.

◆ getTargetTime()

const tReal& SM_TimeStepper::getTargetTime ( ) const

inline

return the target time

Returns: the target time

References mTargetTime.

Referenced by copy().

Here is the caller graph for this function:

◆ getTimeStep()

const tReal& SM_TimeStepper::getTimeStep ( ) const

inline

return the time step

Returns: the time step

References mTimeStep.

Referenced by SM_Beam::computeL2Convergence(), copy(), SM_Output::generateOutput(), SM_System::makeRelaxation(), SM_TemplatedSystem< SystemImpl >::makeTemplatedRelaxation(), SM_Output::saveStochasticIndicators(), 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:

◆ 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_TimeStepper> SM_TimeStepper::New ( )

inlinestatic

build a new instance of a TimeStepper

Returns: an unique pointer of TimeStepper

References SM_TimeStepper().

Referenced by SM_ClassFactory::NewInstance().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setMaximumTimeStepsNumber()

void SM_TimeStepper::setMaximumTimeStepsNumber ( const tIndex & nSteps )

inline

set the maximum time steps number

Parameters

[in] nSteps maximum time step number

References mMaximumTimeStepsNumber, mTargetTime, and mTimeStep.

◆ setTargetTime()

void SM_TimeStepper::setTargetTime ( const tReal & t )

inline

set the target time

Parameters

[in] t : the target time of the relaxation

References mMaximumTimeStepsNumber, mTargetTime, mTimeStep, and tInteger.

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] up unique 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.

◆ setTimeStep()

void SM_TimeStepper::setTimeStep ( const tReal & dt )

inline

set the time step

Parameters

[in] dt : the time step

References ASSERT_IN, mMaximumTimeStepsNumber, mTargetTime, mTimeStep, and tInteger.

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

Here is the caller graph for this function:

◆ toString()

virtual tString SM_TimeStepper::toString ( ) const

inlineoverridevirtual

turn the class into a string representation

Returns: a string representation of the class

Reimplemented from CORE_Object.

References mMaximumTimeStepsNumber, mTargetTime, mTimeStep, and CORE_Object::toString().

Referenced by SM_System::toString().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ mMaximumTimeStepsNumber

tIndex SM_TimeStepper::mMaximumTimeStepsNumber

private

Referenced by copy(), getMaximumTimeStepsNumber(), setMaximumTimeStepsNumber(), setTargetTime(), setTimeStep(), SM_TimeStepper(), and toString().

◆ mTargetTime

tReal SM_TimeStepper::mTargetTime

private

Referenced by copy(), getTargetTime(), setMaximumTimeStepsNumber(), setTargetTime(), setTimeStep(), SM_TimeStepper(), and toString().

◆ mThis

std::weak_ptr<CORE_Object> CORE_Object::mThis

privateinherited

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

◆ mTimeStep

tReal SM_TimeStepper::mTimeStep

private

Referenced by copy(), getTimeStep(), setMaximumTimeStepsNumber(), setTargetTime(), setTimeStep(), SM_TimeStepper(), and toString().

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

SM_TimeStepper.h

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ SM_TimeStepper()

◆ ~SM_TimeStepper()

Member Function Documentation

◆ copy()

◆ DisableMemoryStack()

◆ EnableMemoryStack() [1/2]

◆ EnableMemoryStack() [2/2]

◆ getClassName()

◆ getConstSharedPointer()

◆ getContentsMemorySize()

◆ getIdentityString()

◆ getMaximumTimeStepsNumber()

◆ getMemorySize()

◆ getPointerString()

◆ GetRegisteredClassesNumber()

◆ getSharedPointer()

◆ getTargetTime()

◆ getTimeStep()

◆ isInstanceOf()

◆ IsMemoryStackEnabled()

◆ MemoryStackToString()

◆ New()

◆ setMaximumTimeStepsNumber()

◆ setTargetTime()

◆ setThis()

◆ setTimeStep()

◆ toString()

Member Data Documentation

◆ mMaximumTimeStepsNumber

◆ mTargetTime

◆ mThis

◆ mTimeStep