SM_Material Class Reference

This class describes a materials defined by state attributes: More...

#include <SM_Material.h>

Inheritance diagram for SM_Material:

Collaboration diagram for SM_Material:

Public Member Functions
	SM_Material (void)
	create a materialclass
virtual	~SM_Material (void)
	destroy
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...
void	setCrystalStructure (CORE_UniquePointer< SM_CrystalStructure > cStructure)
	set the crystal structure More...
const SM_CrystalStructure &	getCrystalStructure () const
	get the crystal structure More...
SM_CrystalStructure &	getCrystalStructure ()
	get the crystal structure More...
tBoolean	hasCrystalStructure () const
	return true if the material has a crystal structure More...
void	setName (const tString &name)
	set the name of the material
const tString &	getName () const
	get the name of the material
void	setAtomicSpinMoment (const tReal &mu_s)
	set the atomic spin moment in unit of Bohr magneton \( \mu_B \) More...
const tReal &	getAtomicSpinMoment () const
	get the atomic spin moment in unit of Bohr magneton \( \mu_B \) More...
const tReal &	getAtomicSpinMoment_SIU () const
	get the atomic moment in international sytem unit : J.T^{-1} More...
void	setAnisotropyType (const tFlag &crystalType)
	set anisotropy type More...
const tFlag &	getAnisotropyType () const
	get anisotropy type More...
void	setAnisotropyEnergyFactor (const tReal &k)
	set the anisotropy energy More...
const tReal &	getAnisotropyEnergyFactor () const
	get the anisotropy energy More...
void	setAnisotropyDirections (const std::array< tReal, SM_Constants::DIM *SM_Constants::DIM > &U)
	set the anisotropy directions More...
void	setAnisotropyDirections (const std::vector< tReal > &U)
	set the anisotropy directions More...
const std::valarray< tReal > &	getAnisotropyDirections () const
	get the anisotropy directions More...
void	setExchangeEnergyFactor (const tReal &J)
	set the exchange energy More...
const tReal &	getExchangeEnergyFactor () const
	get the exchange energy More...
void	setDMIEnergyFactor (const std::array< tReal, SM_Constants::DIM > &D)
	set the DMI energy More...
const std::array< tReal, SM_Constants::DIM > &	getDMIEnergyFactor () const
	get the DMI energy More...
void	setSpinWaveMFCorrection (const tReal &eps)
	set the spin wave MF correction
const tReal &	getSpinWaveMFCorrection () const
	get the spin wave MF correction
void	computeCharacteristicValues (const tBoolean &isAdimensionized)
	compute the characteristic values More...
const tReal &	getCharacteristicTime () const
	get the characteristic time in s More...
const tReal &	getCharacteristicEnergy () const
	get the characteristic energy in J More...
const tReal &	getCharacteristicField () const
	get the characteristic field in T More...
const tReal &	getAdimensionizedExchangeEnergyFactor () const
	get the characteristic exchange energy factor More...
const std::array< tReal, SM_Constants::DIM > &	getAdimensionizedDMIEnergyFactor () const
	get the characteristic DMI energy factor More...
const tReal &	getAdimensionizedAnisotropyEnergyFactor () const
	get the characteristic anisotropy energy factor More...
const tReal &	getAdimensionizedDipolarEnergyFactor () const
	get the characteristic dipolar energy factor More...
const tReal &	getAdimensionizedDerivativeEnergyFactor () const
	get the characteristic dipolar energy factor 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_Material >	New ()
	build a new instance of a Grid3D 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...

Additional Inherited Members
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 describes a materials defined by state attributes:

• size of the cell of the structure \( a \) in unit of angstroms \( A=10^{-10}\)
• the atomic spin momment \( \mu_s\) in unit of \(\mu_B \)
• the wave MF correction \( \varepsilon \)
• the exchange energy \( J \) in J/link
• the DMI energy \( D \in R^3 \) in J/link
• the anisotropy energy \( K \) in J/atom
• the anisotropy directions \( U \in ((R^3)^3)\)
• the anisotropy crystal type
  • SM_Constants::UNIAXIAL
  • SM_Constants::PLANAR
  • SM_Constants::CUBIC

It compute the characteristics values depending on if normalization varibles is used or not:

• With variable normalization:
  • characteristic time : \( \bar t= \displaystyle \frac{a^3A^3}{\gamma.\mu_0.\mu_s . \mu_B} \) in s
  • characteristic energy : \( \bar e =\displaystyle \frac{\mu_0 . \mu_B^2.\mu_s^2 }{a^3.A^3} \) in J
  • characteristic field : \( \bar h =\displaystyle \frac{\mu_0 . \mu_B.\mu_s }{a^3.A^3} \) in T
  • \( \tilde J = \displaystyle \frac{J_{ij}}{\bar e} \) such that \( H_{exc}^i=\tilde J \sum_{j \neq i} S_j \)
  • \( \tilde D = \displaystyle \frac{D_{ij}}{\bar e} \) such that \( H_{dmi}^i[k]=\displaystyle \tilde D \sum_{j \neq i} \delta_k \wedge S_j \)
  • \( \tilde K = \displaystyle \frac{K}{\bar e} \) such that \( H_{ani}^i= \displaystyle \tilde k \nabla \Phi_U(S_i) \)
  • \( \tilde V = 1 \) such that \( H_{dip}^i= \displaystyle -\frac{V}{4.\pi} . \sum_{j\neq i} F(S_i,S_j,r_{ij}) \)
  • \( \tilde \mu_s= 1 \) such that \( H= \displaystyle -\frac{1}{\tilde \mu_s} \frac{\partial E}{\partial S} \)

• With no normalisation :

  • characteristic time : \( \bar t= 1 \) in s
  • characteristic energy : \( \bar e =1 \) in J
  • characteristic field : \( \bar h =1 \) in T
  • \( \tilde J = \displaystyle \frac{J_{ij}}{\mu_s.\mu_B} \) such that \( H_{exc}^i=\displaystyle \tilde J \sum_{j \neq i} S_j \)
  • \( \tilde D = \displaystyle \frac{D_{ij}}{\mu_s.\mu_B} \) such that \( H_{dmi}^i[k]=\displaystyle \tilde D \sum_{j \neq i} \delta_k \wedge S_j \)
  • \( \tilde K = \displaystyle \frac{K}{\mu_s . \mu_B} \) such that \( H_{ani}^i= \displaystyle \tilde K . \nabla Phi_U(S_i) \)
  • \( \tilde V = \mu_0.\mu_B.\mu_s \) such that \( H_{dip}^i=\displaystyle -\frac{V}{4.\pi} . \sum_{j\neq i} F(S_i,S_j,r_{ij}) \)
  • \( \tilde \mu_s = \mu_s.\mu_B \) such that \( H=\displaystyle -\frac{1}{\tilde \mu_s} \frac{\partial E}{\partial S} \)

  The class is linked to a strcuture SM_CrystalStructure

  The adimensionized values is computed by the method SM_Material::computeCharacteristicValues()

  Author

  Stephane Despreaux

  Version

  3.0

Member Function Documentation

computeCharacteristicValues()

void SM_Material::computeCharacteristicValues

(

const tBoolean &

isAdimensionized

)

compute the characteristic values

Parameters

[in]

isAdimensionized

: to adimensionize variables

getAdimensionizedAnisotropyEnergyFactor()

const tReal& SM_Material::getAdimensionizedAnisotropyEnergyFactor ( ) const

inline

get the characteristic anisotropy energy factor

Returns

\(\tilde K\) such that \( e_{ani}^i= \tilde K . \Phi_U(S_i) \)

getAdimensionizedDerivativeEnergyFactor()

const tReal& SM_Material::getAdimensionizedDerivativeEnergyFactor ( ) const

inline

get the characteristic dipolar energy factor

Returns

\( \tilde mu_s \) such that \( h=-\frac{1}{\tilde \mu_s} de/dS\)

getAdimensionizedDipolarEnergyFactor()

const tReal& SM_Material::getAdimensionizedDipolarEnergyFactor ( ) const

inline

get the characteristic dipolar energy factor

Returns

\( \tilde V\) such that \( e_{dip}^i= \frac{\tilde E_{dip}.\mu_s^2}{4.\pi} . \sum_{j\neq i} F(S_i,S_j,r_{ij}) \)

getAdimensionizedDMIEnergyFactor()

const std::array<tReal,SM_Constants::DIM>& SM_Material::getAdimensionizedDMIEnergyFactor ( ) const

inline

get the characteristic DMI energy factor

Returns

\(\tilde D\) such that \( e_{dmi}^i=-\tilde D \sum_{j \neq i} . S_i \wedge S_j \)

getAdimensionizedExchangeEnergyFactor()

const tReal& SM_Material::getAdimensionizedExchangeEnergyFactor ( ) const

inline

get the characteristic exchange energy factor

Returns

\(\tilde J\) such that \( e_{exc}^i=-\tilde J \sum_{j \neq i} . <S_i,S_j> \)

getAnisotropyDirections()

const std::valarray<tReal>& SM_Material::getAnisotropyDirections ( ) const

inline

get the anisotropy directions

Returns

directions of anisotropy

getAnisotropyEnergyFactor()

const tReal& SM_Material::getAnisotropyEnergyFactor ( ) const

inline

get the anisotropy energy

Returns

the value of the anisotropy constant energy

getAnisotropyType()

const tFlag& SM_Material::getAnisotropyType ( ) const

inline

get anisotropy type

Returns

the crystal type in {SM_Constants::UNIAXIAL,SM_Constants::PLANAR,SM_Constants::CUBIC}

getAtomicSpinMoment()

const tReal& SM_Material::getAtomicSpinMoment ( ) const

inline

get the atomic spin moment in unit of Bohr magneton \( \mu_B \)

Returns

atomic spin moment value

getAtomicSpinMoment_SIU()

const tReal& SM_Material::getAtomicSpinMoment_SIU ( ) const

inline

get the atomic moment in international sytem unit : J.T^{-1}

Returns

\( \mu_s.\mu_B\)

getCharacteristicEnergy()

const tReal& SM_Material::getCharacteristicEnergy ( ) const

inline

get the characteristic energy in J

Returns

the characteristic energy \( \bar e = \mu_0 . \mu_B^2 A^{-3} \)

getCharacteristicField()

const tReal& SM_Material::getCharacteristicField ( ) const

inline

get the characteristic field in T

Returns

the characteristic field \( \bar h = \mu_0 . \mu_B A^{-3} \)

getCharacteristicTime()

const tReal& SM_Material::getCharacteristicTime ( ) const

inline

get the characteristic time in s

Returns

the characteristic time \( \bar t = \frac{A^3}{\gamma.\mu_0.\mu_B} \)

getContentsMemorySize()

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

getCrystalStructure() [1/2]

SM_CrystalStructure& SM_Material::getCrystalStructure ( )

inline

get the crystal structure

Returns

crystal structure

getCrystalStructure() [2/2]

const SM_CrystalStructure& SM_Material::getCrystalStructure ( ) const

inline

get the crystal structure

Returns

crystal structure

getDMIEnergyFactor()

const std::array<tReal,SM_Constants::DIM>& SM_Material::getDMIEnergyFactor ( ) const

inline

get the DMI energy

Returns

the value of the dmi constant energy

getExchangeEnergyFactor()

const tReal& SM_Material::getExchangeEnergyFactor ( ) const

inline

get the exchange energy

Returns

the value of the exchange constant energy

getMemorySize()

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

hasCrystalStructure()

tBoolean SM_Material::hasCrystalStructure ( ) const

inline

return true if the material has a crystal structure

Returns

crystal structure

New()

static CORE_UniquePointer<SM_Material> SM_Material::New ( )

inlinestatic

build a new instance of a Grid3D

Returns

an unique pointer of Grid3D

setAnisotropyDirections() [1/2]

void SM_Material::setAnisotropyDirections ( const std::array< tReal, SM_Constants::DIM *SM_Constants::DIM > &  U )

inline

set the anisotropy directions

Parameters

[in]

U

: directions of anisotropy

setAnisotropyDirections() [2/2]

void SM_Material::setAnisotropyDirections ( const std::vector< tReal > &  U )

inline

set the anisotropy directions

Parameters

[in]

U

: directions of anisotropy

setAnisotropyEnergyFactor()

void SM_Material::setAnisotropyEnergyFactor ( const tReal &  k )

inline

set the anisotropy energy

Parameters

[in]

k

: value of the anisotropy constant energy

setAnisotropyType()

void SM_Material::setAnisotropyType ( const tFlag &  crystalType )

inline

set anisotropy type

Parameters

[in]

crystalType

: crystal type in {"uniaxial","planar","cubic"}

setAtomicSpinMoment()

void SM_Material::setAtomicSpinMoment ( const tReal &  mu_s )

inline

set the atomic spin moment in unit of Bohr magneton \( \mu_B \)

Parameters

[in]

mu_s

: atomic spin moment value

setCrystalStructure()

void SM_Material::setCrystalStructure ( CORE_UniquePointer< SM_CrystalStructure >  cStructure )

inline

set the crystal structure

Parameters

[in]

cStructure

crystal structure

setDMIEnergyFactor()

void SM_Material::setDMIEnergyFactor ( const std::array< tReal, SM_Constants::DIM > &  D )

inline

set the DMI energy

Parameters

[in]

D

: value of the DMI constant energy

setExchangeEnergyFactor()

void SM_Material::setExchangeEnergyFactor ( const tReal &  J )

inline

set the exchange energy

Parameters

[in]

J

: value of the exchange constant energy

toString()

tString SM_Material::toString ( ) const

overridevirtual

turn the class into a string representation

Returns

a string representation of the class

Reimplemented from CORE_Object.

---

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

• /home/despreau/Developpement/CPP/devcpp20/include/stochmagnet/core/SM_Material.h
• /home/despreau/Developpement/CPP/devcpp20/src/stochmagnet/core/SM_Material.cpp