This class is describes an operator. More...

#include <SM_Operator.h>

Inheritance diagram for SM_Operator:

[legend]

Collaboration diagram for SM_Operator:

Public Member Functions
virtual CORE_UniquePointer< SM_Operator >	NewInstance () const =0
	create a new instance of this

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 nthe memory size of the included associations More...

SM_SliceOperator &	getSliceOperator ()
	get the slice operator for writing More...

const SM_SliceOperator &	getSliceOperator () const
	get the slice operator for reading More...

virtual void	copy (const SM_Operator &op)
	copy More...

tString	getName () const
	get the name of the operator More...

tBoolean	isLinear () const

void	adimensionize (const tReal &cH)
	adimensionize operator with characteric field value in J More...

void	discretize (const SM_Network &network, const SM_Material &material)
	discretize the operator on the network More...

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 void	computeMagneticField (const tIndex &timeIndex, const SM_Network &network, const SM_Material &material, const SM_RealField &S, const tBoolean &alpha, SM_RealField &H) const =0
	compute the 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
	compute the spin energy by virtual method More...

tReal	computeEnergy (const SM_Network &network, const SM_Material &material, const SM_RealField &S) const
	compute the energy by virtual method More...

virtual tReal	computeEnergy (const tIndex &timeIndex, const SM_Network &network, const SM_Material &material, const SM_RealField &S) const =0
	compute the energy by virtual method More...

virtual tReal	computeEnergy (const SM_Network &network, const SM_Material &material, const SM_RealField &S, const SM_RealField &H) const =0
	compute the energy as linear by virtual method 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...

Protected Member Functions
	SM_Operator (void)
	create a network class

virtual	~SM_Operator (void)
	destroy

void	setSliceOperator (CORE_UniquePointer< SM_SliceOperator > sliceOperator)
	set the slice operator 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 an operator.

Each operator must set its name.

Each operator has to compute its magnetic field and energy

The operator class is linked to a slice operator SM_SliceOperation which implements the operator on a slice of particles.

It calls the same methods within the SM_SliceOperator.

adimenisonize(h) : adimensionizes the operator with the charactericti values of the field h
discretize(SM_Network,SM_Material) : discretizes the operator with the network and material data
updateState(step�ndex,SM_Network,SM_Material,S) : updates the operator with the direction of the magnetic moment of spins
computeMagneticField(stepIndex,SM_Network,SM_Material,S,H) computes the magnetic field H from S and the data of the network and the material for stepIndex
computeSpinEnergy(i,stepIndex,SM_Network,SM_Material,S) computes the energy of the spin i from S and the data of the network and the material for stepIndex
computeEnergy(,stepIndex,SM_Network,SM_Material,S) compute sthe enrgy of the network

Author
Stephane Despreaux

Version
2.0

Member Function Documentation

◆ adimensionize()

void SM_Operator::adimensionize ( const tReal & cH )

inline

adimensionize operator with characteric field value in J

Parameters

[in] cH : charateristic field value in J \( \mu_0 . \mu_s . a^{-3}\)

◆ computeEnergy() [1/3]

tReal SM_Operator::computeEnergy	(	const SM_Network &	network,
		const SM_Material &	material,
		const SM_RealField &	S
	)		const

inline

compute the energy by virtual method

Parameters

[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

◆ computeEnergy() [2/3]

virtual tReal SM_Operator::computeEnergy	(	const SM_Network &	network,
		const SM_Material &	material,
		const SM_RealField &	S,
		const SM_RealField &	H
	)		const

pure virtual

compute the energy as linear by virtual method

Parameters

[in]	network	: network
[in]	material	: material of the network
[in]	S	unit direction of magnetic spin moment of size nParticles x dim
[in]	H	magnetic field

Returns: E if the operator is linear, E unchnaged if not

Implemented in SMOMPI_Operator.

◆ computeEnergy() [3/3]

virtual tReal SM_Operator::computeEnergy	(	const tIndex &	timeIndex,
		const SM_Network &	network,
		const SM_Material &	material,
		const SM_RealField &	S
	)		const

pure virtual

compute the energy by virtual method

Parameters

[in]	timeIndex	: index of time
[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

Implemented in SMOMPI_Operator.

◆ computeMagneticField()

virtual void SM_Operator::computeMagneticField	(	const tIndex &	timeIndex,
		const SM_Network &	network,
		const SM_Material &	material,
		const SM_RealField &	S,
		const tBoolean &	alpha,
		SM_RealField &	H
	)		const

pure virtual

compute the magnetic field by virtual method

Parameters

[in]	timeIndex	: time step index
[in]	network	: network
[in]	material	material of the particles of the network
[in]	S	unit direction of magnetic spin moment of size nParticles x dim
[in]	alpha	: sum operator
[in,out]	H	magnetic field of size nParticles x dim

Computes \( H=alpha.H+H_{op} \)

Implemented in SMOMPI_Operator.

◆ computeSpinEnergy()

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

inlinevirtual

compute the spin energy by virtual method

Parameters

[in]	i	: index of the particle
[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

◆ copy()

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

inlinevirtual

copy

Parameters

[in] op : operator to copy

◆ discretize()

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

inline

discretize the operator on the network

Parameters

[in]	network	: network on which the operator is applied
[in]	material	: material of the network

◆ getContentsMemorySize()

virtual tMemSize SM_Operator::getContentsMemorySize ( ) const

inlinevirtual

return nthe 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 CORE_Object.

Reimplemented in SMOMPI_Operator.

◆ getMemorySize()

virtual tMemSize SM_Operator::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 SMOMPI_Operator.

◆ getName()

tString SM_Operator::getName ( ) const

inline

get the name of the operator

Returns: the name of the operator

◆ getSliceOperator() [1/2]

SM_SliceOperator& SM_Operator::getSliceOperator ( )

inline

get the slice operator for writing

Returns: the slice operator for writing

◆ getSliceOperator() [2/2]

const SM_SliceOperator& SM_Operator::getSliceOperator ( ) const

inline

get the slice operator for reading

Returns: the slice operator for reading

◆ isLinear()

tBoolean SM_Operator::isLinear ( ) const

inline

Returns: true if the operator is linear

◆ setSliceOperator()

void SM_Operator::setSliceOperator ( CORE_UniquePointer< SM_SliceOperator > sliceOperator )

inlineprotected

set the slice operator

Parameters

[in] sliceOperator : operator to copy

◆ updateState()

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

inline

update the stae 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

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

/home/despreau/Developpement/CPP/devcpp20/include/stochmagnet/core/SM_Operator.h

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ adimensionize()

◆ computeEnergy() [1/3]

◆ computeEnergy() [2/3]

◆ computeEnergy() [3/3]

◆ computeMagneticField()

◆ computeSpinEnergy()

◆ copy()

◆ discretize()

◆ getContentsMemorySize()

◆ getMemorySize()

◆ getName()

◆ getSliceOperator() [1/2]

◆ getSliceOperator() [2/2]

◆ isLinear()

◆ setSliceOperator()

◆ updateState()