This class is an interface class for method for building a grid of crystal structure. More...

#include <SM_CrystalStructuresBuilder.h>

Inheritance diagram for SM_CrystalStructuresBuilder:

[legend]

Collaboration diagram for SM_CrystalStructuresBuilder:

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	getNetworkSliceMaxSizeOffset (const SM_CrystalStructure &cStructure, const std::array< tInteger, SM_Constants::DIM > &Ns, const std::array< tBoolean, SM_Constants::DIM > &periodicity, std::valarray< tIndex > &sliceParticlesNumberOffset) const =0
	get the max size of the network More...

virtual void	buildNetworkSliceSet (const tInteger &slicesNumber, const tInteger &sliceIndex, const std::array< tReal, SM_Constants::DIM > &X0, const std::array< tInteger, SM_Constants::DIM > &Ns, const std::array< tReal, SM_Constants::DIM > &Hs, const std::array< tBoolean, SM_Constants::DIM > &periodicity, const std::valarray< tMask > &mask, tIndex &nParticles, tIndex particles, tReal X, tIndex neighborsNumberPerParticle, tIndex &nNeighboringParticles, tIndex neighboringParticlesList) const =0
	build a network based on a decomposed in slice sets More...

virtual tIndex	getNetworkGridMaxSize (const SM_CrystalStructure &cStructure, const std::array< tInteger, SM_Constants::DIM > &Ns, const std::array< tBoolean, SM_Constants::DIM > &isPeriodic, const std::array< tInteger, SM_Constants::DIM > &gridSize, const std::array< tInteger, SM_Constants::DIM > &gridIndex) const =0
	get the max size of the network More...

virtual void	buildNetworkGridSet (const std::array< tInteger, SM_Constants::DIM > &gridsNumber, const std::array< tInteger, SM_Constants::DIM > &gridIndex, const std::array< tReal, SM_Constants::DIM > &X0, const std::array< tInteger, SM_Constants::DIM > &Ns, const std::array< tReal, SM_Constants::DIM > &Hs, const std::array< tBoolean, SM_Constants::DIM > &periodicity, const std::valarray< tMask > &mask, tIndex &nParticles, tIndex particles, tReal X, tIndex neighborsNumberPerParticle, tIndex &nNeighboringParticles, tIndex neighboringParticlesList) const =0
	build a network based on a nD paver grid decomposed in grid sets 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...

Static Public Member Functions
static void	RegisterParticle (const tIndex &indexParticle, const std::array< tReal, SM_Constants::DIM > &P, const std::map< tIndex, tIndex > &neighboringParticlesOrderedList, tIndex &nParticles, tIndex &iParticles, tReal &iX, tIndex &iNeighborsNumberPerParticle, tIndex &nNeighboringParticles, tIndex &iNeighboringParticlesList)
	register particles in network list data 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
	SM_CrystalStructuresBuilder (void)
	create an instance class

virtual	~SM_CrystalStructuresBuilder (void)
	destroy the instance of the class

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 is an interface class for method for building a grid of crystal structure.

Author: Stephane Despreaux

Version: 3.0

Member Function Documentation

◆ buildNetworkGridSet()

virtual void SM_CrystalStructuresBuilder::buildNetworkGridSet	(	const std::array< tInteger, SM_Constants::DIM > &	gridsNumber,
		const std::array< tInteger, SM_Constants::DIM > &	gridIndex,
		const std::array< tReal, SM_Constants::DIM > &	X0,
		const std::array< tInteger, SM_Constants::DIM > &	Ns,
		const std::array< tReal, SM_Constants::DIM > &	Hs,
		const std::array< tBoolean, SM_Constants::DIM > &	periodicity,
		const std::valarray< tMask > &	mask,
		tIndex &	nParticles,
		tIndex *	particles,
		tReal *	X,
		tIndex *	neighborsNumberPerParticle,
		tIndex &	nNeighboringParticles,
		tIndex *	neighboringParticlesList
	)		const

pure virtual

build a network based on a nD paver grid decomposed in grid sets

Parameters

[in]	gridsNumber	: number of grid sets per coordinate
[in]	gridIndex	: index of the grid set to build in [0,gridsNumber[ per coordinate
[in]	X0	: min point of the paver grid
[in]	Ns	: number of cells per direction of th paver grid
[in]	Hs	: cell size per direction in angstrom
[in]	periodicity	: periodicity of the paver per dierction
[in]	mask	: indicates if the cel lis in geometry (0: to be out of the geometry)
[out]	nParticles	number of particles of the set
[out]	particles	: index of particles of the pack of size >= nParticles
[out]	X	: SM_Constants::DIM coordinates of the particles of the pack of size >= nParticles x SM_Constants::DIM
[out]	neighborsNumberPerParticle	: number of neighboring particles of the particles
[out]	nNeighboringParticles	: number of neghboring particles
[out]	neighboringParticlesList	: list of neighboring particles of size >= nNeighboringParticles

Implemented in SM_FCCStructuresBuilder, SM_BCCStructuresBuilder, and SM_BCC2StructuresBuilder.

◆ buildNetworkSliceSet()

virtual void SM_CrystalStructuresBuilder::buildNetworkSliceSet	(	const tInteger &	slicesNumber,
		const tInteger &	sliceIndex,
		const std::array< tReal, SM_Constants::DIM > &	X0,
		const std::array< tInteger, SM_Constants::DIM > &	Ns,
		const std::array< tReal, SM_Constants::DIM > &	Hs,
		const std::array< tBoolean, SM_Constants::DIM > &	periodicity,
		const std::valarray< tMask > &	mask,
		tIndex &	nParticles,
		tIndex *	particles,
		tReal *	X,
		tIndex *	neighborsNumberPerParticle,
		tIndex &	nNeighboringParticles,
		tIndex *	neighboringParticlesList
	)		const

pure virtual

build a network based on a decomposed in slice sets

Parameters

[in]	slicesNumber	: number of slice sets
[in]	sliceIndex	: index of the slice set to build in [0,slicesNumber[
[in]	X0	: min point of the paver grid
[in]	Ns	: number of cells per direction of th paver grid
[in]	Hs	: cell size per direction in angstrom
[in]	periodicity	: periodicity of the paver per dierction
[in]	mask	: indicates if the cel lis in geometry (0: to be out of the geometry)
[out]	nParticles	number of particles of the set
[out]	particles	: index of particles of the pack of size >= nParticles
[out]	X	: SM_Constants::DIM coordinates of the particles of the pack of size >= nParticles x SM_Constants::DIM
[out]	neighborsNumberPerParticle	: number of neighboring particles of the particles
[out]	nNeighboringParticles	: number of neghboring particles
[out]	neighboringParticlesList	: list of neighboring particles of size >= nNeighboringParticles

Implemented in SM_FCCStructuresBuilder, SM_BCCStructuresBuilder, and SM_BCC2StructuresBuilder.

◆ getContentsMemorySize()

virtual tMemSize SM_CrystalStructuresBuilder::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_FCCStructuresBuilder, SM_BCCStructuresBuilder, and SM_BCC2StructuresBuilder.

◆ getMemorySize()

virtual tMemSize SM_CrystalStructuresBuilder::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_FCCStructuresBuilder, SM_BCCStructuresBuilder, and SM_BCC2StructuresBuilder.

◆ getNetworkGridMaxSize()

virtual tIndex SM_CrystalStructuresBuilder::getNetworkGridMaxSize	(	const SM_CrystalStructure &	cStructure,
		const std::array< tInteger, SM_Constants::DIM > &	Ns,
		const std::array< tBoolean, SM_Constants::DIM > &	isPeriodic,
		const std::array< tInteger, SM_Constants::DIM > &	gridSize,
		const std::array< tInteger, SM_Constants::DIM > &	gridIndex
	)		const

pure virtual

get the max size of the network

Parameters

[in]	cStructure	crystal structure
[in]	Ns	number of cells of the paver grid per direction
[in]	isPeriodic	: periodicity of the paver per direction
[in]	gridSize	: size of the grid of structures
[in]	gridIndex	: index of the grid to build the crystal structures

Implemented in SM_FCCStructuresBuilder, SM_BCCStructuresBuilder, and SM_BCC2StructuresBuilder.

◆ getNetworkSliceMaxSizeOffset()

virtual void SM_CrystalStructuresBuilder::getNetworkSliceMaxSizeOffset	(	const SM_CrystalStructure &	cStructure,
		const std::array< tInteger, SM_Constants::DIM > &	Ns,
		const std::array< tBoolean, SM_Constants::DIM > &	periodicity,
		std::valarray< tIndex > &	sliceParticlesNumberOffset
	)		const

pure virtual

get the max size of the network

Parameters

[in]	cStructure	crystal structure
[in]	Ns	number of cells of the paver grid per direction
[in]	periodicity	: periodicity of the paver per direction
[out]	sliceParticlesNumberOffset	index of first particle within a global list sliceParticlesNumberOffset[i+1]-sliceParticlesNumberOffset[i+1] is the maw number of particles of the slice

Implemented in SM_FCCStructuresBuilder, SM_BCCStructuresBuilder, and SM_BCC2StructuresBuilder.

◆ RegisterParticle()

static void SM_CrystalStructuresBuilder::RegisterParticle	(	const tIndex &	indexParticle,
		const std::array< tReal, SM_Constants::DIM > &	P,
		const std::map< tIndex, tIndex > &	neighboringParticlesOrderedList,
		tIndex &	nParticles,
		tIndex *&	iParticles,
		tReal *&	iX,
		tIndex *&	iNeighborsNumberPerParticle,
		tIndex &	nNeighboringParticles,
		tIndex *&	iNeighboringParticlesList
	)

inlinestatic

register particles in network list data

Parameters

[in]	indexParticle	id of the particle
[in]	P	coordinate of the particle
[in]	neighboringParticlesOrderedList	: neighboring particles orderd list of the particle at P
[in,out]	nParticles	iterator on cumulative number of particles
[in,out]	iParticles	iterator on index of particles
[in,out]	iX	: iterator on coordinates of particles
[in,out]	iNeighborsNumberPerParticle	: iterator on number of neighboring particles for each particle
[in,out]	nNeighboringParticles	: cumulative number of neighboring particles
[in,out]	iNeighboringParticlesList	iterator on list of neighoring particles odred per particle

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

/home/despreau/Developpement/CPP/devcpp20/include/stochmagnet/network/SM_CrystalStructuresBuilder.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Member Function Documentation

◆ buildNetworkGridSet()

◆ buildNetworkSliceSet()

◆ getContentsMemorySize()

◆ getMemorySize()

◆ getNetworkGridMaxSize()

◆ getNetworkSliceMaxSizeOffset()

◆ RegisterParticle()