This class describes a noise rate function. More...

#include <SM_NoiseRateFunctionInterface.h>

Inheritance diagram for SM_NoiseRateFunctionInterface:

[legend]

Collaboration diagram for SM_NoiseRateFunctionInterface:

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

void	adimensionize (const tReal &cField)
	adimensionize

void	setNoiseRate (const tReal &eps)
	set the noise rate More...

const tReal &	getNoiseRate () const
	get the noise rate More...

void	setNoisePower (const tReal &eps)
	set the noise power More...

const tReal &	getNoisePower () const
	get the noise power More...

virtual tString	getName () const =0
	the the name of the system

virtual tReal	computeFunction (const tReal &t) const =0
	compute the noise rate function More...

void	computeFunction (const tReal &t, tReal &epsilon) const
	compute the noise rate function More...

virtual tString	toString () const final
	return the string reprsentation or the class 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...

Protected Member Functions
	SM_NoiseRateFunctionInterface (void)
	create

virtual	~SM_NoiseRateFunctionInterface (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 describes a noise rate function.

Author: Stephane Despreaux

Version: 1.0

Member Function Documentation

◆ computeFunction() [1/2]

virtual tReal SM_NoiseRateFunctionInterface::computeFunction ( const tReal & t ) const

pure virtual

compute the noise rate function

Parameters

[in] t : time value

Returns: getNoiseRate()

Implemented in SM_NoiseRateFunction< DerivedClass >, SM_NoiseRateFunction< SM_ConstantNoiseRateFunction >, and SM_NoiseRateFunction< SM_InverseNoiseRateFunction >.

◆ computeFunction() [2/2]

void SM_NoiseRateFunctionInterface::computeFunction	(	const tReal &	t,
		tReal &	epsilon
	)		const

inline

compute the noise rate function

Parameters

[in]	t	: time value
[out]	epsilon	: value of the function

◆ getMemorySize()

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

Reimplemented in SM_InverseNoiseRateFunction, SM_ConstantNoiseRateFunction, SM_NoiseRateFunction< DerivedClass >, SM_NoiseRateFunction< SM_ConstantNoiseRateFunction >, and SM_NoiseRateFunction< SM_InverseNoiseRateFunction >.

◆ getNoisePower()

const tReal& SM_NoiseRateFunctionInterface::getNoisePower ( ) const

inline

get the noise power

Returns: the noise power

◆ getNoiseRate()

const tReal& SM_NoiseRateFunctionInterface::getNoiseRate ( ) const

inline

get the noise rate

Returns: the noise rate

◆ setNoisePower()

void SM_NoiseRateFunctionInterface::setNoisePower ( const tReal & eps )

inline

set the noise power

Parameters

[in] eps noise power

◆ setNoiseRate()

void SM_NoiseRateFunctionInterface::setNoiseRate ( const tReal & eps )

inline

set the noise rate

Parameters

[in] eps noise rate

◆ toString()

virtual tString SM_NoiseRateFunctionInterface::toString ( ) const

inlinefinalvirtual

return the string reprsentation or the class

Returns: the stringrepresentation 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_NoiseRateFunctionInterface.h

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ computeFunction() [1/2]

◆ computeFunction() [2/2]

◆ getMemorySize()

◆ getNoisePower()

◆ getNoiseRate()

◆ setNoisePower()

◆ setNoiseRate()

◆ toString()