This class is a UtilityRunner class for Stoch Magnet package. More...
#include <SMOMPI_UtilityRunner.h>
Inheritance diagram for SMOMPI_UtilityRunner:
Collaboration diagram for SMOMPI_UtilityRunner:
Public Member Functions | |
| SMOMPI_UtilityRunner (void) | |
| create | |
| virtual | ~SMOMPI_UtilityRunner (void) |
| destroy | |
| virtual tMemSize | getMemorySize () const |
| return the memory size of the class and the memory size of all its attributes/associations More... | |
 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... | |
| virtual tString | toString () const |
| return the string representation of the object node More... | |
Static Public Member Functions | |
| static tBoolean | GenerateMagneticMomentsDirections (const CORE_OptionsList &options) |
| generate dierctions of all magnetic moments into a file More... | |
| static tBoolean | GenerateDipolarMap (const CORE_OptionsList &options) |
| generate dipolar field map into vtk files 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 a UtilityRunner class for Stoch Magnet package.
- Version
- 2.0
Member Function Documentation
◆ GenerateDipolarMap()
|
static |
generate dipolar field map into vtk files
- Parameters
-
[in] options options of the program
If the option dipolar-map-type is
- center spin : computes the dipolar field from a magnetic moment spin (0,1,0) at center of domain
- map spin :
◆ GenerateMagneticMomentsDirections()
|
static |
generate dierctions of all magnetic moments into a file
- Parameters
-
[in] options options of the program
◆ 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 CORE_Object.
The documentation for this class was generated from the following file:
- /home/despreau/Developpement/CPP/devcpp20/include/stochmagnet/main/mpi/SMOMPI_UtilityRunner.h
