SM_TimeStepper Class Reference

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
virtual	~SM_TimeStepper (void)
	destroy
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...
virtual void	adimensionize (const tReal &cT)
	adimensionize operator with characteric field value in J More...
void	setTimeStep (const tReal &dt)
	set the time step More...
const tReal &	getTimeStep () const
	return the time step 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...
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 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 is describes a time stepper.

Author

Stephane Despreaux

Version

2.0

Member Function Documentation

adimensionize()

virtual void SM_TimeStepper::adimensionize ( const tReal &  cT )

inlinevirtual

adimensionize operator with characteric field value in J

Parameters

[in]

cT

: charateristic time value in s \( \frac{a^3}{\gamma \mu_0 \mu_s}} \)

copy()

void SM_TimeStepper::copy ( const SM_TimeStepper &  T )

inline

copy the time stepper

Parameters

[in]

T

: the time stepper to copy

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.

getTimeStep()

const tReal& SM_TimeStepper::getTimeStep ( ) const

inline

return the time step

Returns

the time step

New()

static CORE_UniquePointer<SM_TimeStepper> SM_TimeStepper::New ( )

inlinestatic

build a new instance of a TimeStepper

Returns

an unique pointer of TimeStepper

setTimeStep()

void SM_TimeStepper::setTimeStep ( const tReal &  dt )

inline

set the time step

Parameters

[in]

dt

: the time step

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.

---

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

• /home/despreau/Developpement/CPP/devcpp20/include/stochmagnet/landauLifschitz/core/SM_TimeStepper.h