This class generate a grid of fcc structures. More...

#include <SM_FCCStructuresBuilder.h>

Inheritance diagram for SM_FCCStructuresBuilder:

[legend]

Collaboration diagram for SM_FCCStructuresBuilder:

[legend]

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 override
	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 override
	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 override
	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 override
	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 CORE_UniquePointer< SM_FCCStructuresBuilder >	New ()
	build a new instance of a FCC structure More...

Static Public Member Functions inherited from SM_CrystalStructuresBuilder
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_FCCStructuresBuilder (void)
	create an instance class

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

Protected Member Functions inherited from SM_CrystalStructuresBuilder
	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 generate a grid of fcc structures.

Author: Stephane Despreaux

Version: 3.0

Member Function Documentation

◆ buildNetworkGridSet()

void SM_FCCStructuresBuilder::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

overridevirtual

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

Implements SM_CrystalStructuresBuilder.

◆ buildNetworkSliceSet()

void SM_FCCStructuresBuilder::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

overridevirtual

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

Implements SM_CrystalStructuresBuilder.

◆ getContentsMemorySize()

virtual tMemSize SM_FCCStructuresBuilder::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_CrystalStructuresBuilder.

◆ getMemorySize()

virtual tMemSize SM_FCCStructuresBuilder::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_CrystalStructuresBuilder.

◆ getNetworkGridMaxSize()

tIndex SM_FCCStructuresBuilder::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

overridevirtual

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	: number of grids to build the network
[in]	gridIndex	: index of the grid

Implements SM_CrystalStructuresBuilder.

◆ getNetworkSliceMaxSizeOffset()

void SM_FCCStructuresBuilder::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

overridevirtual

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

Implements SM_CrystalStructuresBuilder.

◆ New()

static CORE_UniquePointer<SM_FCCStructuresBuilder> SM_FCCStructuresBuilder::New ( )

inlinestatic

build a new instance of a FCC structure

Returns: an unique pointer of a FCC structure

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

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Member Function Documentation

◆ buildNetworkGridSet()

◆ buildNetworkSliceSet()

◆ getContentsMemorySize()

◆ getMemorySize()

◆ getNetworkGridMaxSize()

◆ getNetworkSliceMaxSizeOffset()

◆ New()