This class describes an OpenMP/MPI implementation of operator This package defined the following abstract methods: More...

#include <SMOMPI_Operator.h>

Inheritance diagram for SMOMPI_Operator:

[legend]

Collaboration diagram for SMOMPI_Operator:

[legend]

Public Member Functions
virtual CORE_UniquePointer< SM_Operator >	NewInstance () const
	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...

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 final
	compute the magnetic field by virtual method More...

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

Public Member Functions inherited from SM_Operator
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 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 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< SMOMPI_Operator >	New (CORE_UniquePointer< SM_SliceOperator > sliceOperator)
	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...

Protected Member Functions
	SMOMPI_Operator (void)
	create a network class

virtual	~SMOMPI_Operator (void)
	destroy

Protected Member Functions inherited from SM_Operator
	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

Detailed Description

This class describes an OpenMP/MPI implementation of operator This package defined the following abstract methods:

SM_Operator::computeMagneticField()
SM_Operator::computeSpinEnergy()
SM_Operator::computeEnergy()

Author
Stephane Despreaux

Version
2.0

Member Function Documentation

◆ computeEnergy() [1/2]

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

finalvirtual

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 when the operator is considred as linear

Implements SM_Operator.

◆ computeEnergy() [2/2]

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

finalvirtual

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

Implements SM_Operator.

◆ computeMagneticField()

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

finalvirtual

compute the magnetic field by virtual method

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
[in]	alpha	: sum operator
[in,out]	H	magnetic field of size nParticles x dim

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

Implements SM_Operator.

◆ getContentsMemorySize()

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

◆ getMemorySize()

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

◆ New()

static CORE_UniquePointer<SMOMPI_Operator> SMOMPI_Operator::New ( CORE_UniquePointer< SM_SliceOperator > sliceOperator )

inlinestatic

build a new instance of the operator

Returns: an unique pointer of the operator

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

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Member Function Documentation

◆ computeEnergy() [1/2]

◆ computeEnergy() [2/2]

◆ computeMagneticField()

◆ getContentsMemorySize()

◆ getMemorySize()

◆ New()