This class is describes a grid of FCC structure. More...

#include <SM_FCCStructure.h>

Inheritance diagram for SM_FCCStructure:

[legend]

Collaboration diagram for SM_FCCStructure:

[legend]

Public Member Functions
virtual CORE_UniquePointer< SM_CrystalStructure >	newInstance () const final
	create new instance of the crystal structure More...

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

Public Member Functions inherited from SM_CrystalStructure
virtual void	copy (const SM_CrystalStructure &s)
	copy the structure More...

const tString &	getName () const
	get the name of the structure (in constructor)

const tUCInt &	getCoordinationNumber () const
	get the coodination number More...

const tUCInt &	getAtomsNumber () const
	get the atoms number More...

void	setUnitCellSize (const tReal &a)
	set unit cell size More...

void	setUnitCellSize (const std::array< tReal, SM_Constants::DIM > &as)
	set unit cell size More...

void	setUnitCellSize (const std::vector< tReal > &as)
	set unit cell size More...

void	setUnitCellSize (std::initializer_list< tReal > &&as)
	set unit cell size More...

const std::array< tReal, SM_Constants::DIM > &	getUnitCellSize () const
	get unit cell size More...

const tReal &	getUnitVolume () const
	get unit volume More...

tReal	getAtomVolume () const
	get atom volume in angstrom^3

const tReal &	getAtomVolumeWeight () const
	get atom volume weight with no unit

void	setAtomVolumeWeight (const tReal &weight)
	set atom volume weight in angstrom More...

virtual tString	toString () const override
	turn the class into a string representation 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...

Static Public Member Functions
static CORE_UniquePointer< SM_FCCStructure >	New ()
	build a new instance of a FCC structure 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_FCCStructure (void)
	create an instance class

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

Protected Member Functions inherited from SM_CrystalStructure
	SM_CrystalStructure (void)
	create a network class

virtual	~SM_CrystalStructure (void)
	destroy

void	setName (const tString &name)
	set the name of the structure (in constructor)

void	setCoordinationNumber (const tUCInt &n)
	set the coordination number More...

void	setAtomsNumber (const tUCInt &n)
	set the atoms number per unit cell 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

Detailed Description

This class is describes a grid of FCC structure.

The atom volume in angstrom has o be multiplied by the unit cell volume

parameter	adimensionized value
name	FCC
coordination number	12
atoms number per cell	4
atom volume	0.25

Author: Stephane Despreaux

Version: 3.0

Member Function Documentation

◆ getContentsMemorySize()

virtual tMemSize SM_FCCStructure::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_CrystalStructure.

◆ getMemorySize()

virtual tMemSize SM_FCCStructure::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_CrystalStructure.

◆ New()

static CORE_UniquePointer<SM_FCCStructure> SM_FCCStructure::New ( )

inlinestatic

build a new instance of a FCC structure

Returns: an unique pointer of a FCC structure

◆ newInstance()

virtual CORE_UniquePointer<SM_CrystalStructure> SM_FCCStructure::newInstance ( ) const

inlinefinalvirtual

create new instance of the crystal structure

Returns: an unique pointer to a new instance of this class

Implements SM_CrystalStructure.

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

/home/despreau/Developpement/CPP/devcpp20/include/stochmagnet/crystalStructures/SM_FCCStructure.h

Public Member Functions