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

This class describes a demagnetized operator on macro cells network. More...

#include <SM_MacroCellsContinuousDemagnetizedOperator.h>

Inheritance diagram for SM_MacroCellsContinuousDemagnetizedOperator:
Inheritance graph
[legend]
Collaboration diagram for SM_MacroCellsContinuousDemagnetizedOperator:
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...
 
virtual tMemSize getContentsMemorySize () const
 return the memory size of the included associations More...
 
virtual CORE_UniquePointer< SM_SliceOperatorNewInstance () const override
 create a New instance of this More...
 
virtual tString toString () const final
 return string representaton of the operator
 
- Public Member Functions inherited from SM_MacroCellsDemagnetizedOperator
void setMacroCellsNetwork (CORE_UniquePointer< SM_MacroCellsNetwork > network)
 set the macro cell network
 
SM_MacroCellsNetworkgetMacroCellsNetwork ()
 get the macro cell network
 
const SM_MacroCellsNetworkgetMacroCellsNetwork () const
 get the macro cell network
 
void setMacroCellsMagnetizationField (CORE_UniquePointer< SM_MacroCellsMagnetizationField > f)
 set the macro cell Magnetization field
 
SM_MacroCellsMagnetizationFieldgetMacroCellsMagnetizationField ()
 get the macro cells Magnetization field
 
const SM_MacroCellsMagnetizationFieldgetMacroCellsMagnetizationField () const
 get the macro cells Magnetization field
 
void setMacroCellsDemagnetizedField (CORE_UniquePointer< SM_MacroCellsDemagnetizedField > f)
 set the macro cell demagnetized field
 
SM_MacroCellsDemagnetizedFieldgetMacroCellsDemagnetizedField ()
 get the macro cells demagnetized field
 
const SM_MacroCellsDemagnetizedFieldgetMacroCellsDemagnetizedField () const
 get the macro cells demagnetized field
 
virtual void discretize (const SM_Network &network, const SM_Material &material) override
 discretize the operator on the netowek More...
 
virtual void updateState (const tIndex &timeIndex, const SM_Network &network, const SM_Material &material, const SM_RealField &S) override
 uodate the state of the operator at time index More...
 
virtual void computeMagneticFieldSlice (const tIndex &timeIndex, const SM_Network &network, const SM_Material &material, const tIndex &startIndex, const tIndex &endIndex, const tReal *S, const tBoolean &alpha, const tIndex &nH, tReal *H) const final
 compute the anisotropy magnetic field by virtual method More...
 
virtual tReal computeSpinEnergy (const tIndex &i, const tIndex &timeIndex, const SM_Network &network, const SM_Material &material, const SM_RealField &S) const override
 compute the spin energy by virtual method More...
 
virtual tReal computeEnergySlice (const tIndex &stepIndex, const SM_Network &network, const SM_Material &material, const tIndex &startIndex, const tIndex &endIndex, const tReal *S) const override
 compute the energy by virtual method More...
 
- Public Member Functions inherited from SM_SliceOperator
const tString & getName () const
 return the operator name More...
 
virtual void copy (const SM_SliceOperator &op)
 copy More...
 
virtual void adimensionize (const tReal &cH)
 adimensionize operator with characteric field value in J 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...
 
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< SelfClassNew (const CORE_OptionsList &arguments)
 build a new instance of the operator More...
 
static CORE_UniquePointer< SelfClassNew ()
 build a new instance of the operator 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...
 
- Static Public Member Functions inherited from SM_LinearSliceOperator
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...
 

Protected Member Functions

 SM_MacroCellsContinuousDemagnetizedOperator (const CORE_OptionsList &arguments)
 create a network class
 
virtual ~SM_MacroCellsContinuousDemagnetizedOperator (void)
 destroy
 
- Protected Member Functions inherited from SM_MacroCellsDemagnetizedOperator
 SM_MacroCellsDemagnetizedOperator (const CORE_OptionsList &arguments)
 create a network class
 
virtual ~SM_MacroCellsDemagnetizedOperator (void)
 destroy
 
- Protected Member Functions inherited from SM_SliceOperator
 SM_SliceOperator (void)
 create a network class
 
virtual ~SM_SliceOperator (void)
 destroy
 
void setName (const tString &name)
 set the name More...
 
- Protected Member Functions inherited from CORE_Object
 CORE_Object ()
 build an instance of the object
 
virtual ~CORE_Object ()
 destroy the instance of object std

 
- Protected Member Functions inherited from SM_LinearSliceOperator
 SM_LinearSliceOperator (void)
 create a network class
 
virtual ~SM_LinearSliceOperator (void)
 destroy
 

Detailed Description

This class describes a demagnetized operator on macro cells network.

The Demagnetized field is considered as an external field. So the energy is computed as a Zeeman operator:

Member Function Documentation

◆ getContentsMemorySize()

virtual tMemSize SM_MacroCellsContinuousDemagnetizedOperator::getContentsMemorySize ( ) const
inlinevirtual

return the memory size of the included associations

Returns
the memory size of the storage in bytes 1 Kb = 1024 bytes 1 Mb = 1024 Kb 1 Gb = 1024 Mb 1 Tb = 1024 Gb 1 Hb = 1024 Tb

Reimplemented from SM_MacroCellsDemagnetizedOperator.

◆ getMemorySize()

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

◆ New() [1/2]

static CORE_UniquePointer<SelfClass> SM_MacroCellsContinuousDemagnetizedOperator::New ( )
inlinestatic

build a new instance of the operator

Returns
an unique pointer of the operator

◆ New() [2/2]

static CORE_UniquePointer<SelfClass> SM_MacroCellsContinuousDemagnetizedOperator::New ( const CORE_OptionsList arguments)
inlinestatic

build a new instance of the operator

Returns
an unique pointer of the operator

◆ NewInstance()

virtual CORE_UniquePointer<SM_SliceOperator> SM_MacroCellsContinuousDemagnetizedOperator::NewInstance ( ) const
inlineoverridevirtual

create a New instance of this

Returns
an unique pointer to the instance

Implements SM_SliceOperator.


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