This class describes an noise rate function of the form \( \varepsilon(t)=\varepsilon_0 \). More...
#include <SM_ConstantNoiseRateFunction.h>
Inheritance diagram for SM_ConstantNoiseRateFunction:
Collaboration diagram for SM_ConstantNoiseRateFunction:
Public Member Functions | |
| SM_ConstantNoiseRateFunction (void) | |
| create | |
| virtual | ~SM_ConstantNoiseRateFunction (void) |
| destroy | |
| virtual tMemSize | getMemorySize () const |
| return the memory size of the class and the memory size of all its attributes/associations More... | |
| virtual tString | getName () const override |
| the the name of the system | |
| tReal | computeSCFunction (const tReal &t) const |
| compute the noise rate function More... | |
 Public Member Functions inherited from SM_NoiseRateFunction< SM_ConstantNoiseRateFunction > | |
| tReal | computeSCFunction (const tReal &t) const |
| compute the noise rate function by static polymorphism More... | |
| virtual tReal | computeFunction (const tReal &t) const final |
| compute the noise rate function More... | |
| Public Member Functions inherited from SM_NoiseRateFunctionInterface | |
| 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... | |
| 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... | |
Static Public Member Functions | |
| static CORE_UniquePointer< SM_ConstantNoiseRateFunction > | New () |
| build a new instance of a SM_NoiseRateFunction 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 SM_NoiseRateFunction< SM_ConstantNoiseRateFunction > | |
| SM_NoiseRateFunction (void) | |
| create | |
| virtual | ~SM_NoiseRateFunction (void) |
| destroy | |
| Protected Member Functions inherited from SM_NoiseRateFunctionInterface | |
| 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 | |
Detailed Description
This class describes an noise rate function of the form \( \varepsilon(t)=\varepsilon_0 \).
- Version
- 1.0
Member Function Documentation
◆ computeSCFunction()
|
inline |
compute the noise rate function
- Parameters
-
[in] t : time value
- Returns
- value of the noise
◆ getMemorySize()
|
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
- the added size of the base classes which contains:
Reimplemented from SM_NoiseRateFunction< SM_ConstantNoiseRateFunction >.
◆ New()
|
inlinestatic |
build a new instance of a SM_NoiseRateFunction
- Returns
- an unique pointer of SM_NoiseRateFunction
The documentation for this class was generated from the following file:
- /home/despreau/Developpement/CPP/devcpp20/include/stochmagnet/landauLifschitz/noiseRateFunctions/SM_ConstantNoiseRateFunction.h
