C++ main module for stochmagnet Package  1.0
Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
SM_DemagnetizedOperator Class Reference

This class is describes a demagnetized operator. More...

#include <SM_DemagnetizedOperator.h>

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

Public Member Functions

virtual CORE_UniquePointer< SM_Operator > NewInstance () const override
 create a New instance of this @retrun an unique pointer to the instance More...
 
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 void discretize (const SM_System &system)
 discretize the operator : do nothing by default More...
 
void updateMagnetizedCells (const SM_RealField &Mu)
 update the boolean array to indicates if mu at particule is magnetized More...
 
virtual void computeMagneticField (const tIndex &t, const SM_Network &network, const tReal *mu, tReal *B) const override
 compute the magnetic field at time step t by virtual method More...
 
virtual void computeMagneticFieldAndEnergy (const tIndex &t, const SM_Network &network, const tReal *mu, tReal *B, tReal &E) const override
 compute the magnetic field at time step t by virtual method More...
 
void computeTemplatedMagneticField (const tIndex &t, const SM_Network &network, const tReal *mu, tReal *B) const
 compute the magnetic field More...
 
void computeTemplatedMagneticFieldAndEnergy (const tIndex &t, const SM_Network &network, const tReal *mu, tReal *B, tReal &E) const
 compute the magnetic field and energy More...
 
virtual tReal computeEnergy (const tIndex &t, const SM_Network &network, const tReal *mu) const override
 compute the energy at time step index t More...
 
tReal computeTemplatedEnergy (const tIndex &t, const SM_Network &network, const tReal *mu) const
 compute the energy at time step index t More...
 
void computeTemplatedMagneticFieldAndEnergy (const tIndex &t, const SM_Network &network, const tReal *mu, tReal *H, tReal &E)
 compute the magnetic field and energy at time t More...
 
const tString & getName () const
 return the operator name More...
 
virtual void copy (const SM_Operator &op)
 copy More...
 
void computeMagneticField (const tIndex &t, const SM_Network &network, const SM_RealField &Mu, SM_RealField &B) const
 compute the magnetic field at time t by virtual method More...
 
tReal computeEnergy (const tIndex &t, const SM_Network &network, const SM_RealField &mu) const
 compute the energy at time t by virtual method More...
 
virtual tReal computeEnergy (const SM_Network &network, const tReal *mu, const tReal *H) const
 compute the energy More...
 
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...
 
virtual tString toString () const
 return the string representation of the object node More...
 

Static Public Member Functions

static CORE_UniquePointer< SM_DemagnetizedOperator > New ()
 build a new instance of the operator More...
 
static tBoolean EnableMemoryStack (const tBoolean &isMemoryChecked)
 enable the memory stack More...
 
static void EnableMemoryStack ()
 enable the memory stack More...
 
static void DisableMemoryStack ()
 disable the memory stack More...
 
static tBoolean IsMemoryStackEnabled ()
 return trur if the memory stack is enabled More...
 
static tString MemoryStackToString ()
 get the memory stack in string More...
 
static tIndex GetRegisteredClassesNumber ()
 get the memory stack in string More...
 

Protected Member Functions

 SM_DemagnetizedOperator (void)
 create a network class More...
 
virtual ~SM_DemagnetizedOperator (void)
 destroy More...
 
void setName (const tString &name)
 set the name More...
 

Private Member Functions

template<class T >
std::shared_ptr< T > setThis (std::unique_ptr< T, CORE_Object::Delete > &up)
 set the shared pointer from an unique pointer More...
 

Private Attributes

CORE_BooleanArray mAreMagnetizedCells
 
tString mName
 
std::weak_ptr< CORE_Object > mThis
 

Detailed Description

This class is describes a demagnetized operator.

The demagnetized energy is \( E= \frac{1}{\lambda^3} \displaystyle \sum_{i,j=0,i\neq j}^{i,j=P-1} \left ( \frac{<\mu_i,\mu_j>}{r_{ij}^3} - 3 \frac{<r_{ij},\mu_i><r_{ij},\mu_j>}{r_{ij}^5} \right ) \) with \( r_{ij}=P_j-P_i \)

In order to have \(\displaystyle \forall i \in [0,P[, \frac{dE}{d\mu_i}(P)=-H(P) \),

the corresponding magnetic excitation field is: \( H(P_i)= - \frac{2}{\lambda^3} \displaystyle \sum_{j=0,j \neq i}^{P-1} \left ( \frac{\mu_j}{r_{ij}^3} - 3 \frac{r_{ij} <r_{ij},\mu_j>}{r_{ij}^5} \right ) \)

As H is linear with respect of \( \mu_i\), the energy can also be computed as \( \displaystyle E=- \frac{1}{2} \sum_{i=0}^{P-1} <H(P_i),\mu(P_i)> \)

Author
Stephane Despreaux
Version
2.0

Constructor & Destructor Documentation

◆ SM_DemagnetizedOperator()

SM_DemagnetizedOperator::SM_DemagnetizedOperator ( void  )
inlineprotected

create a network class

References SM_Operator::setName().

Referenced by New().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ ~SM_DemagnetizedOperator()

virtual SM_DemagnetizedOperator::~SM_DemagnetizedOperator ( void  )
inlineprotectedvirtual

destroy

Member Function Documentation

◆ computeEnergy() [1/3]

virtual tReal SM_Operator::computeEnergy ( const SM_Network &  network,
const tReal *  mu,
const tReal *  H 
) const
inlinevirtualinherited

compute the energy

Parameters
[in]network: network
[in]mumagnetic moments of size nParticles x dim
[in]Hmagnetic field of size nParticles x dim
Returns
the energy of the operator \( E=-\frac{1}{2}.<H,Mu> \)

Reimplemented in SM_ZeemanOperator.

References SM_Network::getDimension(), SM_Network::getParticlesNumber(), tIndex, and tReal.

Here is the call graph for this function:

◆ computeEnergy() [2/3]

tReal SM_Operator::computeEnergy ( const tIndex &  t,
const SM_Network &  network,
const SM_RealField &  mu 
) const
inlineinherited

compute the energy at time t by virtual method

Parameters
[in]t: time step index
[in]network: network
[in]mumagnetic moments of size nParticles x dim
Returns
the energy of the operator

Referenced by SM_Test::testDerivative().

Here is the caller graph for this function:

◆ computeEnergy() [3/3]

virtual tReal SM_DemagnetizedOperator::computeEnergy ( const tIndex &  t,
const SM_Network &  network,
const tReal *  mu 
) const
inlineoverridevirtual

compute the energy at time step index t

Parameters
[in]t: time step index
[in]network: network of the field
[in]mumagnetic moments of size nParticles x dim
Returns
the energy of the operator

Implements SM_Operator.

◆ computeMagneticField() [1/2]

void SM_Operator::computeMagneticField ( const tIndex &  t,
const SM_Network &  network,
const SM_RealField &  Mu,
SM_RealField &  B 
) const
inlineinherited

compute the magnetic field at time t by virtual method

Parameters
[in]t: time step index
[in]network: network
[in]Mumagnetic moments of size nParticles x dim
[out]Bmagnetic field of size nParticles x dim defined by B=H(mu)

References SM_Operator::computeMagneticField(), CORE_Field< T, K, D, S, I >::getElementsNumber(), CORE_Field< T, K, D, S, I >::setElementsNumber(), and tIndex.

Here is the call graph for this function:

◆ computeMagneticField() [2/2]

virtual void SM_DemagnetizedOperator::computeMagneticField ( const tIndex &  t,
const SM_Network &  network,
const tReal *  mu,
tReal *  B 
) const
inlineoverridevirtual

compute the magnetic field at time step t by virtual method

Parameters
[in]t: time step index
[in]network: network of the field
[in]mumagnetic moments of size nParticles x dim
[in,out]Bmagnetic field of size nParticles x dim

\( B(P_i) += - \frac{1}{\lambda^3} \displasytyle \sum_{j=0,j \neq i}^{P-1} \left ( \frac{\mu_i}{r_{ij}^3} - 3 \frac{r_{ij} <r_{ij},\mu_j>}{r_{ij}^5} \right ) \)

Implements SM_Operator.

◆ computeMagneticFieldAndEnergy()

virtual void SM_DemagnetizedOperator::computeMagneticFieldAndEnergy ( const tIndex &  t,
const SM_Network &  network,
const tReal *  mu,
tReal *  B,
tReal &  E 
) const
inlineoverridevirtual

compute the magnetic field at time step t by virtual method

Parameters
[in]t: time step index
[in]network: network of the field
[in]mumagnetic moments of size nParticles x dim
[in,out]Bmagnetic field of size nParticles x dim
[out]EEnergy of the operator

Implements SM_Operator.

◆ computeTemplatedEnergy()

tReal SM_DemagnetizedOperator::computeTemplatedEnergy ( const tIndex &  t,
const SM_Network &  network,
const tReal *  mu 
) const
inline

compute the energy at time step index t

Parameters
[in]t: time step index
[in]network: network of the field
[in]mumagnetic moments of size nParticles x dim
Returns
the Demagnetized energy E : \( E= \frac{1}{\lambda^3} \displasytyle \sum_{i,j=0,i\neq j}^{i,j=P-1} \left ( \frac{<\mu_i,\mu_j>}{r_{ij}^3} - 3 \frac{<r_{ij},\mu_i><r_{ij},Mu_j>}{r_{ij}^5} \right ) \)

References SM_Network::getDimension(), SM_Network::getLambda(), SM_Network::getParticlesCoordinates(), SM_Network::getParticlesNumber(), CORE_Field< T, K, D, S, I >::getValues(), tIndex, and tReal.

Here is the call graph for this function:

◆ computeTemplatedMagneticField()

void SM_DemagnetizedOperator::computeTemplatedMagneticField ( const tIndex &  t,
const SM_Network &  network,
const tReal *  mu,
tReal *  B 
) const
inline

compute the magnetic field

Parameters
[in]t: time step index
[in]network: network of the field
[in]mumagnetic moments of size nParticles x dim
[in,out]Bmagnetic field of size nParticles x dim return : \( B(P_i) += - \frac{1}{\lambda^3} \displasytyle \sum_{j=0,j \neq i}^{P-1} \left ( \frac{\mu_i}{r_{ij}^3} - 3 \frac{r_{ij} <r_{ij},\mu_j>}{r_{ij}^5} \right ) \)

References tReal.

Referenced by SM_TemplatedSystem< SystemImpl >::computeTemplatedMagneticField().

Here is the caller graph for this function:

◆ computeTemplatedMagneticFieldAndEnergy() [1/2]

void SM_DemagnetizedOperator::computeTemplatedMagneticFieldAndEnergy ( const tIndex &  t,
const SM_Network &  network,
const tReal *  mu,
tReal *  B,
tReal &  E 
) const
inline

compute the magnetic field and energy

Parameters
[in]t: time step index
[in]network: network of the field
[in]mumagnetic moments of size nParticles x dim
[in,out]Bmagnetic field of size nParticles x dim
[out]Eenergy of the operator return : \( B(P_i) += - \frac{1}{\lambda^3} \displasytyle \sum_{j=0,j \neq i}^{P-1} \left ( \frac{\mu_i}{r_{ij}^3} - 3 \frac{r_{ij} <r_{ij},\mu_j>}{r_{ij}^5} \right ) \)

References SM_Network::getDimension(), SM_Network::getLambda(), SM_Network::getParticlesCoordinates(), SM_Network::getParticlesNumber(), CORE_Field< T, K, D, S, I >::getValues(), tIndex, and tReal.

Referenced by SM_TemplatedSystem< SystemImpl >::computeTemplatedMagneticFieldAndEnergies().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ computeTemplatedMagneticFieldAndEnergy() [2/2]

void SM_TemplatedOperator< SM_DemagnetizedOperator >::computeTemplatedMagneticFieldAndEnergy ( const tIndex &  t,
const SM_Network &  network,
const tReal *  mu,
tReal *  H,
tReal &  E 
)
inlineinherited

compute the magnetic field and energy at time t

Parameters
[in]tindex of time step for computation
[in]network: network of the field
[in]mumagnetic moments of size nParticles x dim
[in,out]Hmagnetic field of size nParticles x dim
[out]Eenergy of the operator

◆ copy()

virtual void SM_Operator::copy ( const SM_Operator &  op)
inlinevirtualinherited

copy

Parameters
[in]op: operator to copy

Reimplemented in SM_ZeemanOperator.

References SM_Operator::getName(), and SM_Operator::mName.

Referenced by SM_ZeemanOperator::copy().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ DisableMemoryStack()

static void CORE_Object::DisableMemoryStack ( )
inlinestaticinherited

disable the memory stack

Referenced by CORE_Object::EnableMemoryStack().

Here is the caller graph for this function:

◆ discretize()

void SM_DemagnetizedOperator::discretize ( const SM_System &  system)
virtual

discretize the operator : do nothing by default

Parameters
[in]system: system of the operator

Reimplemented from SM_Operator.

References SM_Operator::discretize(), SM_System::getInitialMagneticMoment(), and updateMagnetizedCells().

Here is the call graph for this function:

◆ EnableMemoryStack() [1/2]

static void CORE_Object::EnableMemoryStack ( )
inlinestaticinherited

enable the memory stack

Referenced by CORE_Object::EnableMemoryStack(), and CORE_Run::SetDebugOptions().

Here is the caller graph for this function:

◆ EnableMemoryStack() [2/2]

static tBoolean CORE_Object::EnableMemoryStack ( const tBoolean &  isMemoryChecked)
inlinestaticinherited

enable the memory stack

Parameters
[in]isMemoryChecked: true to verify memory allocation of CORE_Object classes
Returns
true if the memroy is checked

References CORE_Object::DisableMemoryStack(), CORE_Object::EnableMemoryStack(), and CORE_Object::IsMemoryStackEnabled().

Here is the call graph for this function:

◆ getClassName()

tString CORE_Object::getClassName ( ) const
inlineinherited

return the name of the class

Returns
the string name of the class

Referenced by CORE_Object::getIdentityString(), and CORE_Test::testTypes().

Here is the caller graph for this function:

◆ getConstSharedPointer()

template<class T >
std::shared_ptr<const T> CORE_Object::getConstSharedPointer ( ) const
inlineinherited

return a const shared pointer for this

Returns
the shared pointer as a type T

References CORE_Object::mThis.

◆ getContentsMemorySize()

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

References SM_Operator::getContentsMemorySize(), CORE_PtrArray< T, I >::getSize(), mAreMagnetizedCells, tBoolean, and tMemSize.

Referenced by getMemorySize().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ getIdentityString()

tString CORE_Object::getIdentityString ( ) const
inlineinherited

retrun the string identification of the class

Returns
the string identity of the class

References CORE_Object::getClassName(), and core_functions::pointerToString().

Referenced by CORE_Test::testArray(), CORE_Test::testField(), CORE_Test::testTypes(), CORE_Object::toString(), CORE_ClassFactory::toString(), and CORE_Field< T, K, D, S, I >::toString().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ getMemorySize()

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

References getContentsMemorySize().

Here is the call graph for this function:

◆ getName()

const tString& SM_Operator::getName ( ) const
inlineinherited

return the operator name

Returns
the name of the operator

References SM_Operator::mName.

Referenced by SM_Operator::copy(), and SM_TemplatedSystem< SystemImpl >::getOperatorNames().

Here is the caller graph for this function:

◆ getPointerString()

tString CORE_Object::getPointerString ( ) const
inlineinherited

retrun the pointer of the class as a string

Returns
the pointer of the calss as a string

References core_functions::pointerToString().

Here is the call graph for this function:

◆ GetRegisteredClassesNumber()

static tIndex CORE_Object::GetRegisteredClassesNumber ( )
inlinestaticinherited

get the memory stack in string

Returns
the string representation of the memory stack

◆ getSharedPointer()

template<class T >
std::shared_ptr<T> CORE_Object::getSharedPointer ( )
inlineinherited

return the shared pointer for this

Returns
the shared pointer as a type T

References CORE_Object::mThis.

◆ isInstanceOf()

template<class T >
tBoolean CORE_Object::isInstanceOf ( ) const
inlineinherited

test if the clas T is an instance of this class

Returns
true if the object is an instance of T

Referenced by SM_Beam::templatedSimulate().

Here is the caller graph for this function:

◆ IsMemoryStackEnabled()

static tBoolean CORE_Object::IsMemoryStackEnabled ( )
inlinestaticinherited

return trur if the memory stack is enabled

Referenced by CORE_Object::EnableMemoryStack(), and main().

Here is the caller graph for this function:

◆ MemoryStackToString()

static tString CORE_Object::MemoryStackToString ( )
inlinestaticinherited

get the memory stack in string

Returns
the string representation of the memory stack

Referenced by main().

Here is the caller graph for this function:

◆ New()

static CORE_UniquePointer<SM_DemagnetizedOperator> SM_DemagnetizedOperator::New ( )
inlinestatic

build a new instance of the operator

Returns
an unique pointer of the operator

References SM_DemagnetizedOperator().

Referenced by SM_Run::createMagneticDipolarMap(), NewInstance(), and SM_ClassFactory::NewInstance().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ NewInstance()

virtual CORE_UniquePointer<SM_Operator> SM_DemagnetizedOperator::NewInstance ( ) const
inlineoverridevirtual

create a New instance of this @retrun an unique pointer to the instance

Implements SM_Operator.

References New().

Here is the call graph for this function:

◆ setName()

void SM_Operator::setName ( const tString &  name)
inlineprotectedinherited

set the name

Parameters
[in]namename of the operator

References SM_Operator::mName.

Referenced by SM_DemagnetizedOperator(), SM_HeissenbergOperator::SM_HeissenbergOperator(), and SM_ZeemanOperator::SM_ZeemanOperator().

Here is the caller graph for this function:

◆ setThis()

template<class T >
std::shared_ptr<T> CORE_Object::setThis ( std::unique_ptr< T, CORE_Object::Delete > &  up)
inlineprivateinherited

set the shared pointer from an unique pointer

Parameters
[in,out]upunique pointer of the class at input, points to null pointer at output
Returns
the shared pointer of the class

Method only calledby the friend class CORE_ClassFactory::NewSharedInstance()

References CORE_Object::mThis.

◆ toString()

virtual tString CORE_Object::toString ( ) const
inlinevirtualinherited

return the string representation of the object node

Returns
the string representation of the object node

Reimplemented in SM_TimeStepper, SM_System, SM_StochasticFunction, SM_Network, SM_LandauLifschitzFunction, SM_Beam, CORE_Field< T, K, D, S, I >, CORE_Field< T, K, D, CORE_StdPtrArray< T >, CORE_StdPtrField< T, K, D > >, CORE_Field< T, K, D, CORE_StdValArray< T >, CORE_StdValField< T, K, D > >, CORE_Collection< T, I >, CORE_ClassFactory, and SM_NoiseRateFunction.

References CORE_Object::getIdentityString().

Referenced by SM_Run::run(), CORE_Collection< T, I >::toString(), SM_Beam::toString(), SM_Network::toString(), SM_StochasticFunction::toString(), SM_System::toString(), and SM_TimeStepper::toString().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ updateMagnetizedCells()

void SM_DemagnetizedOperator::updateMagnetizedCells ( const SM_RealField &  Mu)
inline

update the boolean array to indicates if mu at particule is magnetized

Parameters
[in]mu: initial mu

References CORE_PtrArray< T, I >::begin(), CORE_Field< T, K, D, S, I >::cbegin(), CORE_PtrArray< T, I >::end(), CORE_Field< T, K, D, S, I >::getDimension(), CORE_Field< T, K, D, S, I >::getElementsNumber(), mAreMagnetizedCells, CORE_PtrArray< T, I >::setSize(), and tReal.

Referenced by discretize().

Here is the call graph for this function:
Here is the caller graph for this function:

Member Data Documentation

◆ mAreMagnetizedCells

CORE_BooleanArray SM_DemagnetizedOperator::mAreMagnetizedCells
private

Referenced by getContentsMemorySize(), and updateMagnetizedCells().

◆ mName

tString SM_Operator::mName
privateinherited

Referenced by SM_Operator::copy(), SM_Operator::getContentsMemorySize(), SM_Operator::getName(), SM_Operator::setName(), and SM_Operator::SM_Operator().

◆ mThis

std::weak_ptr<CORE_Object> CORE_Object::mThis
privateinherited

Referenced by CORE_Object::getConstSharedPointer(), CORE_Object::getSharedPointer(), and CORE_Object::setThis().

The documentation for this class was generated from the following files:
Generated on Wed Mar 8 2023 09:58:11 for C++ main module for stochmagnet Package by doxygen 1.9.1