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

#include <SM_MacroCellsDemagnetizedOperator.h>

Inheritance diagram for SM_MacroCellsDemagnetizedOperator:

[legend]

Collaboration diagram for SM_MacroCellsDemagnetizedOperator:

[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...

void	setMacroCellsNetwork (CORE_UniquePointer< SM_MacroCellsNetwork > network)
	set the macro cell network

SM_MacroCellsNetwork &	getMacroCellsNetwork ()
	get the macro cell network

const SM_MacroCellsNetwork &	getMacroCellsNetwork () const
	get the macro cell network

void	setMacroCellsMagnetizationField (CORE_UniquePointer< SM_MacroCellsMagnetizationField > f)
	set the macro cell Magnetization field

SM_MacroCellsMagnetizationField &	getMacroCellsMagnetizationField ()
	get the macro cells Magnetization field

const SM_MacroCellsMagnetizationField &	getMacroCellsMagnetizationField () const
	get the macro cells Magnetization field

void	setMacroCellsDemagnetizedField (CORE_UniquePointer< SM_MacroCellsDemagnetizedField > f)
	set the macro cell demagnetized field

SM_MacroCellsDemagnetizedField &	getMacroCellsDemagnetizedField ()
	get the macro cells demagnetized field

const SM_MacroCellsDemagnetizedField &	getMacroCellsDemagnetizedField () 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...

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

Public Member Functions inherited from SM_SliceOperator
virtual CORE_UniquePointer< SM_SliceOperator >	NewInstance () const =0
	create a New instance of this More...

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...

Protected Member Functions
	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

Additional Inherited Members
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...

Detailed Description

This class is describes a demagnetized operator.

To improve the simulation accuracy and time computing of the dipolar field done by EMM_DipolarOperator, an other approach consists in discretizing the network in macro cells with a fixed cell size with is prefered to be a multiple of the unit cell size.

The position of each macro cell \(p_{mc}\) is defined from the magnetic center of mass of the particles of the macro cell: \( p_{mc}=\frac{\sum_{p_j \in \omega_{mc}} \tilde \mu^j_s . p_j}{\sum_{p_j \in \omega_{mc}} \tilde \mu^j} \) where \(\omega_{mc} \) is the domain of the macro cell at index \(mc\).

The magnetization of the macro cell is the sum of the atomic moments of the particles in the macro cell: \( M_{mc}=\sum_{p_j \in \omega_{mc}} \tilde \mu^j_s . S_j \)

The demagnetized field within each macro cell p is

\( H^p_{dem}=\frac{\mu_0}{4.\pi} \left ( \sum_{q\neq p} \frac{3 <M^q,u_{pq}>_3.u_{pq} - M^q}{r^3_{pq}} \right) - \frac{\mu_0}{3.V_p} M^p \)

where \(r_{pq}\) if the vector direction from macro cell \(p\) to macro cell \(q\) and the unit vector \(u_{pq}=\frac{r_{pq}}{|r_{pq}|}\) and \(V_p\) is the effective volume of the macro cell defined by:

\( V_p = n^a_p . \frac{a^3}{N_a} \)

when \(n^a_p\) is the number of particles inside the macro cell, \(a\) is the unit cell size and \(N_a\) the number of atoms in the unit cell size. The last term of the equation represents the demagnetized field generated by the particles in the macro cell to themselves.

The dipolar field of each particle is the demagnetized field defined of the macro cell to which it belongs.

Author: Stephane Despreaux

Version: 2.0

Member Function Documentation

◆ computeEnergySlice()

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

overridevirtual

compute the energy by virtual method

Parameters

[in]	stepIndex	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 SM_Constants::DIM

Returns: the energy of the operator

It returns \( E=\frac{1}{2} \sum_p E_i \)

Implements SM_SliceOperator.

Reimplemented in SM_MacroCellsExternalDemagnetizedOperator.

◆ computeMagneticFieldSlice()

void SM_MacroCellsDemagnetizedOperator::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

finalvirtual

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 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
[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 \( H=alpha.H+H_{op} \)

\( H_{op}= K. \nabla_{S_i} Phi(S_i,U) \)

iterator on H at particle at end of coordinate of iH

Implements SM_SliceOperator.

◆ computeSpinEnergy()

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

overridevirtual

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.

Reimplemented in SM_MacroCellsExternalDemagnetizedOperator.

◆ discretize()

void SM_MacroCellsDemagnetizedOperator::discretize	(	const SM_Network &	network,
		const SM_Material &	material
	)

overridevirtual

discretize the operator on the netowek

Parameters

[in]	network	:operator on which the operatr is applied
[in]	material	: material of the particles of network It does : compute the macro cells discretize the magnetization field discretize the demagnetized field

Reimplemented from SM_SliceOperator.

Reimplemented in SM_MacroCellsExternalDemagnetizedOperator.

◆ getContentsMemorySize()

virtual tMemSize SM_MacroCellsDemagnetizedOperator::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_SliceOperator.

Reimplemented in SM_MacroCellsExternalDemagnetizedOperator, and SM_MacroCellsContinuousDemagnetizedOperator.

◆ getMemorySize()

virtual tMemSize SM_MacroCellsDemagnetizedOperator::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_SliceOperator.

Reimplemented in SM_MacroCellsExternalDemagnetizedOperator, and SM_MacroCellsContinuousDemagnetizedOperator.

◆ updateState()

void SM_MacroCellsDemagnetizedOperator::updateState	(	const tIndex &	timeIndex,
		const SM_Network &	network,
		const SM_Material &	material,
		const SM_RealField &	S
	)

overridevirtual

uodate the state of the operator at time index

Parameters

[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

Reimplemented from SM_SliceOperator.

Reimplemented in SM_MacroCellsExternalDemagnetizedOperator.

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

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

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ computeEnergySlice()

◆ computeMagneticFieldSlice()

◆ computeSpinEnergy()

◆ discretize()

◆ getContentsMemorySize()

◆ getMemorySize()

◆ updateState()