This class is dedicated to build a network. More...

#include <SM_NetworkBuilder.h>

Inheritance diagram for SM_NetworkBuilder:

[legend]

Collaboration diagram for SM_NetworkBuilder:

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 void	buildNetwork (const SM_CrystalStructure &cStructure, const std::array< tBoolean, SM_Constants::DIM > &isPeriodic, const std::array< tReal, SM_Constants::DIM > &X0, const std::array< tInteger, SM_Constants::DIM > &Ns, const std::valarray< tMask > &mask, SM_Network &network)=0
	build the network from a grid paver and a mask on crystal structure on grid More...

virtual tBoolean	buildDomainNetwork (const SM_CrystalStructure &cStructure, const std::array< tBoolean, SM_Constants::DIM > &isPeriodic, const tString &domainExpression, SM_Network &network)=0
	build the network from domain expression More...

void	buildPaverNetwork (const SM_CrystalStructure &cStructure, const std::array< tBoolean, SM_Constants::DIM > &isPeriodic, const std::array< tInteger, SM_Constants::DIM > &Ns, SM_Network &network)
	build the network from a grid paver More...

void	buildPaverNetwork (const SM_CrystalStructure &cStructure, const std::array< tReal, SM_Constants::DIM > &X0, const std::array< tInteger, SM_Constants::DIM > &Ns, SM_Network &network)
	build the network from a grid paver More...

void	buildPaverNetwork (const SM_CrystalStructure &cStructure, const std::array< tInteger, SM_Constants::DIM > &Ns, SM_Network &network)
	build the network from a grid paver More...

void	buildPaverNetwork (const SM_CrystalStructure &cStructure, const std::array< tBoolean, SM_Constants::DIM > &isPeriodic, const std::array< tReal, SM_Constants::DIM > &X0, const std::array< tInteger, SM_Constants::DIM > &Ns, SM_Network &network)
	build the network from a grid paver 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_NetworkBuilder (void)
	create a network class

virtual	~SM_NetworkBuilder (void)
	destroy

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 dedicated to build a network.

The following methods build the netwok

buildNetwork() : build a network in a paver grid of size Ns with min point X0 anad a boolean mask indicating if the cell of the grid is in domain
buildDomainNetwork() : build a network with domain algebric expression see Math Expression Parser Package

Author: Stephane Despreaux

Version: 3.0

Member Function Documentation

◆ buildDomainNetwork()

virtual tBoolean SM_NetworkBuilder::buildDomainNetwork	(	const SM_CrystalStructure &	cStructure,
		const std::array< tBoolean, SM_Constants::DIM > &	isPeriodic,
		const tString &	domainExpression,
		SM_Network &	network
	)

pure virtual

build the network from domain expression

Parameters

[in]	cStructure	type of unit cell to build
[in]	isPeriodic	: periodic in direction
[in]	domainExpression	: the domain expression to parse
[out]	network	: build network

Implemented in SM_CrystalStructuresGridBuilder.

◆ buildNetwork()

virtual void SM_NetworkBuilder::buildNetwork	(	const SM_CrystalStructure &	cStructure,
		const std::array< tBoolean, SM_Constants::DIM > &	isPeriodic,
		const std::array< tReal, SM_Constants::DIM > &	X0,
		const std::array< tInteger, SM_Constants::DIM > &	Ns,
		const std::valarray< tMask > &	mask,
		SM_Network &	network
	)

pure virtual

build the network from a grid paver and a mask on crystal structure on grid

Parameters

[in]	cStructure	: crystal structure
[in]	isPeriodic	: periodic in direction
[in]	X0	: minimum point of the domain
[in]	Ns	network number of cells per direction
[in]	mask	: indicator of the inside cell flag
[out]	network	: build network

Implemented in SMOMPI_CrystalStructuresGridBuilder.

◆ buildPaverNetwork() [1/4]

void SM_NetworkBuilder::buildPaverNetwork	(	const SM_CrystalStructure &	cStructure,
		const std::array< tBoolean, SM_Constants::DIM > &	isPeriodic,
		const std::array< tInteger, SM_Constants::DIM > &	Ns,
		SM_Network &	network
	)

inline

build the network from a grid paver

Parameters

[in]	cStructure	type of unit cell to build
[in]	isPeriodic	: periodic in direction
[in]	Ns	network number of cells per direction
[out]	network	: build network

◆ buildPaverNetwork() [2/4]

void SM_NetworkBuilder::buildPaverNetwork	(	const SM_CrystalStructure &	cStructure,
		const std::array< tBoolean, SM_Constants::DIM > &	isPeriodic,
		const std::array< tReal, SM_Constants::DIM > &	X0,
		const std::array< tInteger, SM_Constants::DIM > &	Ns,
		SM_Network &	network
	)

inline

build the network from a grid paver

Parameters

[in]	cStructure	type of unit cell to build
[in]	isPeriodic	: periodicity of the network to build
[in]	X0	min point of the domain
[in]	Ns	network number of cells per direction
[out]	network	built network

◆ buildPaverNetwork() [3/4]

void SM_NetworkBuilder::buildPaverNetwork	(	const SM_CrystalStructure &	cStructure,
		const std::array< tInteger, SM_Constants::DIM > &	Ns,
		SM_Network &	network
	)

inline

build the network from a grid paver

Parameters

[in]	cStructure	type of unit cell to build
[in]	Ns	network number of cells per direction
[out]	network	: build network

◆ buildPaverNetwork() [4/4]

void SM_NetworkBuilder::buildPaverNetwork	(	const SM_CrystalStructure &	cStructure,
		const std::array< tReal, SM_Constants::DIM > &	X0,
		const std::array< tInteger, SM_Constants::DIM > &	Ns,
		SM_Network &	network
	)

inline

build the network from a grid paver

Parameters

[in]	cStructure	type of unit cell to build
[in]	X0	: min point of the grid
[in]	Ns	network number of cells per direction
[out]	network	: build network

◆ getContentsMemorySize()

virtual tMemSize SM_NetworkBuilder::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 SM_NetworkGridBuilder, SM_CrystalStructuresGridBuilder, and SMOMPI_CrystalStructuresGridBuilder.

◆ getMemorySize()

virtual tMemSize SM_NetworkBuilder::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 SM_NetworkGridBuilder, SM_CrystalStructuresGridBuilder, and SMOMPI_CrystalStructuresGridBuilder.

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

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

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ buildDomainNetwork()

◆ buildNetwork()

◆ buildPaverNetwork() [1/4]

◆ buildPaverNetwork() [2/4]

◆ buildPaverNetwork() [3/4]

◆ buildPaverNetwork() [4/4]

◆ getContentsMemorySize()

◆ getMemorySize()