This class describes an MPI implementation of the magnetization field based on no master core. More...

#include <SMOMPI_NoMasterMacroCellsMagnetizationField.h>

Inheritance diagram for SMOMPI_NoMasterMacroCellsMagnetizationField:

[legend]

Collaboration diagram for SMOMPI_NoMasterMacroCellsMagnetizationField:

[legend]

Public Member Functions
virtual CORE_UniquePointer< SM_MacroCellsMagnetizationField >	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	computeField (const SM_Material &material, const SM_MacroCellsNetwork &network, const SM_RealField &S, SM_RealField &M) final
	compute the magnetization field from S More...

Public Member Functions inherited from SM_MacroCellsMagnetizationField
virtual void	discretize (const SM_Material &material, const SM_MacroCellsNetwork &network)
	discretize the field It does : More...

const SM_RealField &	getField () const
	get magnetization field on macro cells More...

SM_RealField &	getField ()
	get the magnetization field for writing

const tIndex &	getStepIndex () const
	return the step of the last magnetization field computed

void	computeField (const tIndex &stepIndex, const SM_Material &material, const SM_MacroCellsNetwork &network, const SM_RealField &S)
	compute the magnetization field from S 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 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_NoMasterMacroCellsMagnetizationField (void)
	create a network class

virtual	~SMOMPI_NoMasterMacroCellsMagnetizationField (void)
	destroy

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

virtual	~SM_MacroCellsMagnetizationField (void)
	destroy

void	setStepIndex (const tIndex &index)
	set the step of the last magnetization field computed

void	computeFieldSlice (const tReal &mu_s, const tIndex &n, const tInteger iMacroCellsList, const tReal iS, tReal *vM) const
	computes the magnetization field M[0,nMCCells[ from S defined on network More...

void	computeFieldSlice (const tReal &mu_s, const tInteger &n, const tInteger iParticlesMCList, const tInteger iParticlesMCListOffset, const tReal iS, tReal vM) const
	computes the magnetization field M[0,nMCCells[ from S defined on network 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 MPI implementation of the magnetization field based on no master core.

Author: Stephane Despreaux

Version: 2.0

Member Function Documentation

◆ computeField()

virtual void SMOMPI_NoMasterMacroCellsMagnetizationField::computeField	(	const SM_Material &	material,
		const SM_MacroCellsNetwork &	network,
		const SM_RealField &	S,
		SM_RealField &	M
	)

inlinefinalvirtual

compute the magnetization field from S

Parameters

[in]	material	: material of the network
[in]	network	: maco cells network data
[in]	S	: spin directions
[out]	M	: magnetization field It computes for all macro cells of the network : \( M_c= \sum_{i \in c} \mu_s S_i\)

Reimplemented from SM_MacroCellsMagnetizationField.

◆ getContentsMemorySize()

virtual tMemSize SMOMPI_NoMasterMacroCellsMagnetizationField::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_MacroCellsMagnetizationField.

◆ getMemorySize()

virtual tMemSize SMOMPI_NoMasterMacroCellsMagnetizationField::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_MacroCellsMagnetizationField.

◆ New()

static CORE_UniquePointer<SelfClass> SMOMPI_NoMasterMacroCellsMagnetizationField::New ( )

inlinestatic

build a new instance of the operator

Returns: an unique pointer of the operator

◆ newInstance()

virtual CORE_UniquePointer<SM_MacroCellsMagnetizationField> SMOMPI_NoMasterMacroCellsMagnetizationField::newInstance ( ) const

inlineoverridevirtual

create a New instance of this

Returns: an unique pointer to the instance

Implements SM_MacroCellsMagnetizationField.

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

/home/despreau/Developpement/CPP/devcpp20/include/stochmagnet/operators/fields/mpi/SMOMPI_NoMasterMacroCellsMagnetizationField.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Member Function Documentation

◆ computeField()

◆ getContentsMemorySize()

◆ getMemorySize()

◆ New()

◆ newInstance()