This class is describes a Magnetization field. More...

#include <SM_MacroCellsMagnetizationField.h>

Inheritance diagram for SM_MacroCellsMagnetizationField:

[legend]

Collaboration diagram for SM_MacroCellsMagnetizationField:

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

virtual CORE_UniquePointer< SM_MacroCellsMagnetizationField >	newInstance () const =0
	create a New instance of this More...

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 void	computeField (const SM_Material &material, const SM_MacroCellsNetwork &network, const SM_RealField &S, SM_RealField &M)
	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...

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

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

Author: Stephane Despreaux

Version: 2.0

Member Function Documentation

◆ computeField() [1/2]

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

virtual

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

\( M_c= \sum_{i \in c} \mu_s S_i\)

Reimplemented in SMOMPI_OneMasterMacroCellsMagnetizationField, SMOMPI_NoMasterMacroCellsMagnetizationField, and SMOMPI_AllMasterMacroCellsMagnetizationField.

◆ computeField() [2/2]

void SM_MacroCellsMagnetizationField::computeField	(	const tIndex &	stepIndex,
		const SM_Material &	material,
		const SM_MacroCellsNetwork &	network,
		const SM_RealField &	S
	)

inline

compute the magnetization field from S

Parameters

[in]	stepIndex	: index of the step
[in]	material	: material of the network
[in]	network	: network of particles
[in]	S	: spin directions

◆ computeFieldSlice() [1/2]

void SM_MacroCellsMagnetizationField::computeFieldSlice	(	const tReal &	mu_s,
		const tIndex &	n,
		const tInteger *	iMacroCellsList,
		const tReal *	iS,
		tReal *	vM
	)		const

protected

computes the magnetization field M[0,nMCCells[ from S defined on network

Parameters

[in]	mu_s	: atomic spin moment
[in]	n	: numbe rof particles to computs
[in]	iMacroCellsList	: iterator on macro cell list of [start,end[ particles
[in]	iS	: iterator on S values at any particle in [start,end[
[in]	vM	: M values for macro cells in [0,nMacroCells[

◆ computeFieldSlice() [2/2]

void SM_MacroCellsMagnetizationField::computeFieldSlice	(	const tReal &	mu_s,
		const tInteger &	n,
		const tInteger *	iParticlesMCList,
		const tInteger *	iParticlesMCListOffset,
		const tReal *	iS,
		tReal *	vM
	)		const

protected

computes the magnetization field M[0,nMCCells[ from S defined on network

Parameters

[in]	mu_s	: atomic spin moment
[in]	n	number of elements of the slice
[in]	iParticlesMCList	iterator on list of particles in macro cell start
[in]	iParticlesMCListOffset	iterator on offset list of particles in macro cell start
[in]	iS	: iterator on S values for all particle
[in]	vM	: M values for macro cells in [start,end[

◆ discretize()

virtual void SM_MacroCellsMagnetizationField::discretize	(	const SM_Material &	material,
		const SM_MacroCellsNetwork &	network
	)

inlinevirtual

discretize the field It does :

set the number of elements of the magnetization field

Reimplemented in SMOMPI_OneMasterMacroCellsMagnetizationField.

◆ getContentsMemorySize()

virtual tMemSize SM_MacroCellsMagnetizationField::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 CORE_Object.

Reimplemented in SMOMPI_OneMasterMacroCellsMagnetizationField, SMOMPI_NoMasterMacroCellsMagnetizationField, and SMOMPI_AllMasterMacroCellsMagnetizationField.

◆ getField()

const SM_RealField& SM_MacroCellsMagnetizationField::getField ( ) const

inline

get magnetization field on macro cells

Returns: the magnetization field on macro cells

◆ getMemorySize()

virtual tMemSize SM_MacroCellsMagnetizationField::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_OneMasterMacroCellsMagnetizationField, SMOMPI_NoMasterMacroCellsMagnetizationField, and SMOMPI_AllMasterMacroCellsMagnetizationField.

◆ newInstance()

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

pure virtual

create a New instance of this

Returns: an unique pointer to the instance

Implemented in SMOMPI_OneMasterMacroCellsMagnetizationField, SMOMPI_NoMasterMacroCellsMagnetizationField, and SMOMPI_AllMasterMacroCellsMagnetizationField.

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

/home/despreau/Developpement/CPP/devcpp20/include/stochmagnet/operators/fields/SM_MacroCellsMagnetizationField.h
/home/despreau/Developpement/CPP/devcpp20/src/stochmagnet/operators/fields/SM_MacroCellsMagnetizationField.cpp

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ computeField() [1/2]

◆ computeField() [2/2]

◆ computeFieldSlice() [1/2]

◆ computeFieldSlice() [2/2]

◆ discretize()

◆ getContentsMemorySize()

◆ getField()

◆ getMemorySize()

◆ newInstance()