This class build a grid of structure. More...

#include <SM_DomainGridBuilder.h>

Inheritance diagram for SM_DomainGridBuilder:

[legend]

Collaboration diagram for SM_DomainGridBuilder:

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

tBoolean	buildMask (const std::array< tReal, SM_Constants::DIM > &Hs, const tString &domainExpression, std::array< tInteger, SM_Constants::DIM > &Ns, std::array< tReal, SM_Constants::DIM > &bbMinPoint, std::valarray< tMask > &mask)
	build mask 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...

virtual tString	toString () const
	return the string representation of the object node More...

Protected Member Functions
	SM_DomainGridBuilder (void)
	create a network class

virtual	~SM_DomainGridBuilder (void)
	destroy

virtual void	buildMask (const std::array< tInteger, SM_Constants::DIM > &Ns, const std::array< tReal, SM_Constants::DIM > &Hs, const std::array< tReal, SM_Constants::DIM > &X0, const EXPR_RootNode &geo, std::valarray< tMask > &mask) const =0
	build the mask for the bounding box with the geo function More...

void	buildMaskSlice (const tIndex &startIndex, const tIndex &endIndex, const std::array< tInteger, SM_Constants::DIM > &Ns, const std::array< tReal, SM_Constants::DIM > &Hs, const std::array< tReal, SM_Constants::DIM > &X0, const EXPR_RootNode &geo, std::valarray< tMask > &mask) const
	build the mask for the bounding box with the geo function 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 build a grid of structure.

Author: Stephane Despreaux

Version: 3.0

Member Function Documentation

◆ buildMask() [1/2]

virtual void SM_DomainGridBuilder::buildMask	(	const std::array< tInteger, SM_Constants::DIM > &	Ns,
		const std::array< tReal, SM_Constants::DIM > &	Hs,
		const std::array< tReal, SM_Constants::DIM > &	X0,
		const EXPR_RootNode &	geo,
		std::valarray< tMask > &	mask
	)		const

protectedpure virtual

build the mask for the bounding box with the geo function

Parameters

[in]	Ns	network number of cells per direction
[in]	Hs	cell size per direction in angstrom
[in]	X0	min point of the bounding box
[in]	geo	geometry function to indicates if a point belongs to the domain
[out]	mask	: indicator of the inside cell flag

The implementation on the method depend on serial/openMP/mpi implementations

Implemented in SMOMPI_DomainGridBuilder.

◆ buildMask() [2/2]

tBoolean SM_DomainGridBuilder::buildMask	(	const std::array< tReal, SM_Constants::DIM > &	Hs,
		const tString &	domainExpression,
		std::array< tInteger, SM_Constants::DIM > &	Ns,
		std::array< tReal, SM_Constants::DIM > &	bbMinPoint,
		std::valarray< tMask > &	mask
	)

build mask

Parameters

[in]	Hs	: cell size per direction in angstrom
[in]	domainExpression	: algebric expression of the domain
[out]	Ns	:number of elements per direction
[out]	bbMinPoint	: min point of the domain
[out]	mask	: indicator of the inside cell flag

◆ buildMaskSlice()

void SM_DomainGridBuilder::buildMaskSlice	(	const tIndex &	startIndex,
		const tIndex &	endIndex,
		const std::array< tInteger, SM_Constants::DIM > &	Ns,
		const std::array< tReal, SM_Constants::DIM > &	Hs,
		const std::array< tReal, SM_Constants::DIM > &	X0,
		const EXPR_RootNode &	geo,
		std::valarray< tMask > &	mask
	)		const

protected

build the mask for the bounding box with the geo function

Parameters

[in]	startIndex	: start cell of the slice
[in]	endIndex	: end cell of the slice
[in]	Ns	network number of cells per direction
[in]	Hs	cell size per direction in angstrom
[in]	X0	min point of the bounding box
[in]	geo	geometry function to indicates if apoint belongs to the domain
[out]	mask	: indicator of the inside cell flag

◆ getContentsMemorySize()

virtual tMemSize SM_DomainGridBuilder::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_DomainGridBuilder.

◆ getMemorySize()

virtual tMemSize SM_DomainGridBuilder::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_DomainGridBuilder.

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

/home/despreau/Developpement/CPP/devcpp20/include/stochmagnet/network/SM_DomainGridBuilder.h
/home/despreau/Developpement/CPP/devcpp20/src/stochmagnet/network/SM_DomainGridBuilder.cpp

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ buildMask() [1/2]

◆ buildMask() [2/2]

◆ buildMaskSlice()

◆ getContentsMemorySize()

◆ getMemorySize()