C++ mpi module for stochmagnet_main Package
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
SM_LinearSliceOperator Class Reference

This class is describes a linear operator interface in a slice of particles of a network. More...

#include <SM_LinearSliceOperator.h>

Inheritance diagram for SM_LinearSliceOperator:
Inheritance graph
[legend]
Collaboration diagram for SM_LinearSliceOperator:
Collaboration graph
[legend]

Public Member Functions

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 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...
 
virtual tString toString () const
 return the string representation of the object node More...
 

Static Public Member Functions

static tReal ComputeEnergy (const SM_Network &network, const SM_Material &material, const tIndex &startIndex, const tIndex &endIndex, const tReal *S, const tInteger &nH, const tReal *H)
 compute the energy by virtual method 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...
 

Protected Member Functions

 SM_LinearSliceOperator (void)
 create a network class
 
virtual ~SM_LinearSliceOperator (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 is describes a linear operator interface in a slice of particles of a network.

It computes the enrgy of the netwok wihci is valid only for linear operator: \( E=-\frac{1}{2}.\mu_s (H \cdot S )\)

Author
Stephane Despreaux
Version
2.0

Member Function Documentation

◆ ComputeEnergy()

static tReal SM_LinearSliceOperator::ComputeEnergy ( const SM_Network network,
const SM_Material material,
const tIndex &  startIndex,
const tIndex &  endIndex,
const tReal *  S,
const tInteger &  nH,
const tReal *  H 
)
inlinestatic

compute the energy by virtual method

Parameters
[in]network: network
[in]material: material of the network
[in]startIndex: start index of the particle to compute the energy
[in]endIndex: end index of the particle to compute the energy
[in]Sunit direction of magnetic spin moment of size nParticles x dim
[in]nH: number of elements of H
[in]H: magnetic field
Returns
the energy of the operator

It computes \( E==-\frac{1}{2}.\mu_s (H \cdot S )\)

◆ getMemorySize()

virtual tMemSize SM_LinearSliceOperator::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_HeisenbergOperator, SM_DMIOperator, SM_MacroCellsContinuousDemagnetizedOperator, SM_DipolarOperator, SMOMPI_DipolarOperator, SM_UniaxialAnisotropyOperator, and SM_PlanarAnisotropyOperator.


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