This class is describes a SMOMPI implementation of dipolar operator. More...

#include <SMOMPI_DipolarOperator.h>

Inheritance diagram for SMOMPI_DipolarOperator:

[legend]

Collaboration diagram for SMOMPI_DipolarOperator:

[legend]

Public Member Functions
virtual CORE_UniquePointer< SM_SliceOperator >	NewInstance () const override
	create a New instance of this 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	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...

void	computeMagneticFieldAtNetwork (const SM_Material &material, const SM_Network &networkP, const tReal S_P, const SM_Network &networkX, const tBoolean &alpha, const tInteger &nH, tReal H) const
	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 final
	compute the spin energy by virtual method More...

virtual tReal	computeEnergySlice (const tIndex &timeIndex, const SM_Network &network, const SM_Material &material, const tIndex &startIndex, const tIndex &endIndex, const tReal *S) const final
	compute the energy at time t by virtual method for all particles in [startIndex,endIndex[ More...

Public Member Functions inherited from SM_DipolarOperator
virtual void	discretize (const SM_Network &network, const SM_Material &material) override
	discretize the operator on the netowek More...

void	computeDipolarFieldAtPoints (const SM_Material &material, const tInteger &nP, const tReal P, const tReal S, const tInteger &nX, const tReal X, const tBoolean &alpha, tReal H) const
	compute the magnetic field by virtual method More...

void	computeDipolarFieldAtSeparatedPoints (const SM_Material &material, const tInteger &nP, const tReal P, const tReal S, const tInteger &nX, const tReal X, const tBoolean &alpha, tReal H) const
	compute the dipolar field at separated X points 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...

virtual void	updateState (const tIndex &timeIndex, const SM_Network &network, const SM_Material &material, const SM_RealField &S)
	update the stae of the operator at time index More...

virtual tString	toString () const override
	return string representaton of the operator

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< SelfClass >	New ()
	build a new instance of the operator More...

Static Public Member Functions inherited from SM_DipolarOperator
static void	ComputeSpinDipolarEnergy (const tReal &mu_s, const tReal &Edip, const tInteger &nParticles, const tReal X, const tReal S, const tReal Xi, const tReal Si, tReal &E)
	compute the dipolar spin energy More...

static void	ComputeSeparatedSpinDipolarEnergy (const tReal &mu_s, const tReal &Edip, const tInteger &nParticles, const tReal X, const tReal S, const tReal Xi, const tReal Si, tReal &E)
	compute the dipolar spin energy for a separated domain \( \Omega_j\) 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
	SMOMPI_DipolarOperator (void)
	create a network class

virtual	~SMOMPI_DipolarOperator (void)
	destroy

Protected Member Functions inherited from SM_DipolarOperator
	SM_DipolarOperator (void)
	create a network class

virtual	~SM_DipolarOperator (void)
	destroy

const tReal &	getLambdaH () const
	get lambda H More...

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 is describes a SMOMPI implementation of dipolar operator.

Author: Stephane Despreaux

Version: 2.0

Member Function Documentation

◆ computeEnergySlice()

tReal SMOMPI_DipolarOperator::computeEnergySlice	(	const tIndex &	timeIndex,
		const SM_Network &	network,
		const SM_Material &	material,
		const tIndex &	startIndex,
		const tIndex &	endIndex,
		const tReal *	S
	)		const

finalvirtual

compute the energy at time t by virtual method for all particles in [startIndex,endIndex[

Parameters

[in]	timeIndex	: index of time
[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]	S	unit direction of magnetic spin moment of size nParticles x dim

Returns: the energy of the operator It returns \( E=\frac{1/2} \sum_i E_i \)

Implements SM_SliceOperator.

◆ computeMagneticFieldAtNetwork()

void SMOMPI_DipolarOperator::computeMagneticFieldAtNetwork	(	const SM_Material &	material,
		const SM_Network &	networkP,
		const tReal *	S_P,
		const SM_Network &	networkX,
		const tBoolean &	alpha,
		const tInteger &	nH,
		tReal *	H
	)		const

compute the anisotropy magnetic field by virtual method

Parameters

[in]	material	: material of the network
[in]	networkP	: network whic defines the points P
[in]	S_P	unit directions of magnetic spin moment of size networkP.getParticlesNumber() x dim defined on P
[in]	networkX	: network whic defines the points X
[in]	alpha	sum operator 0 or 1
[in]	nH	number of elements of H
[in,out]	H	total magnetic field of size nH x dim

Computes \( \forall X_i \in X H(X_i)=\alpha.H_i+ \frac{H_{dip}}{4.\pi} \displaystyle \sum_{j=0}^{j=P-1} \frac{1}{r_{ij}^3} \left (3 U_{ij} <U_{ij},Sj> - S_j \right )\) with \( r_{ij}=|X_i-P_j|, U=(X_i-P_j)/r_{ij} \)

◆ computeMagneticFieldSlice()

virtual void SMOMPI_DipolarOperator::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

inlinefinalvirtual

compute the anisotropy magnetic field by virtual method

Parameters

[in]	timeIndex	: time step index
[in]	network	: network
[in]	material	: material of the network
[in]	startIndex	: start index of the particle to compute the magnetic field
[in]	endIndex	: end index of the particle to compute the magnetic field
[in]	S	unit direction of magnetic spin moment of size nParticles x dim
[in]	alpha	sum operator 0 or 1
[in]	nH	number of elements of H
[in,out]	H	total magnetic field of size nH x dim

Computes \( \forall i \in [s,e[, H_i=\alpha.H_i+ \frac{H_{dip}}{4.\pi} \displaystyle \sum_{j=0}^{j=N-1} \frac{1}{r_{ij}^3} \left (3 U_{ij} <U_{ij},Sj> - S_j \right )\) with \( r_{ij}=|X_i-P_j|, U=(X_i-P_j)/r_{ij} \)

Implements SM_SliceOperator.

◆ computeSpinEnergy()

tReal SMOMPI_DipolarOperator::computeSpinEnergy	(	const tIndex &	i,
		const tIndex &	timeIndex,
		const SM_Network &	network,
		const SM_Material &	material,
		const SM_RealField &	S
	)		const

finalvirtual

compute the spin energy by virtual method

Parameters

[in]	i	: index of the particles
[in]	timeIndex	: time step index
[in]	network	: network
[in]	material	: material of the network
[in]	S	unit direction of magnetic spin moment of size nParticles x dim

Returns: the energy of the operator \( E_i= H_{dip}.\frac{M_s}{4.\pi} \displaystyle \sum_{j=0}^{j=P-1} \frac{1}{r_{ij}^3} \left ( <S_i,S_j> -3<U,Si><U,Sj> \right )\) with \(r_{ij}=|P_j-P_i|\) and \( U=\frac{1}{r_ij} (P_j-P_i)\)

Implements SM_SliceOperator.

◆ getContentsMemorySize()

virtual tMemSize SMOMPI_DipolarOperator::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_DipolarOperator.

◆ getMemorySize()

virtual tMemSize SMOMPI_DipolarOperator::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_DipolarOperator.

◆ New()

static CORE_UniquePointer<SelfClass> SMOMPI_DipolarOperator::New ( )

inlinestatic

build a new instance of the operator

Returns: an unique pointer of the operator

◆ NewInstance()

virtual CORE_UniquePointer<SM_SliceOperator> SMOMPI_DipolarOperator::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 files:

/home/despreau/Developpement/CPP/devcpp20/include/stochmagnet/operators/dipolar/mpi/SMOMPI_DipolarOperator.h
/home/despreau/Developpement/CPP/devcpp20/src/stochmagnet/operators/dipolar/mpi/SMOMPI_DipolarOperator.cpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Member Function Documentation

◆ computeEnergySlice()

◆ computeMagneticFieldAtNetwork()

◆ computeMagneticFieldSlice()

◆ computeSpinEnergy()

◆ getContentsMemorySize()

◆ getMemorySize()

◆ New()

◆ NewInstance()