NanoMagMC  v0.2
Monte Carlo Simulation Software for Atomistic Models of Magnetic Materials
Public Member Functions | List of all members
particle::td::functionObject Class Reference

#include <thermodynamics.hpp>

Public Member Functions

void setup (bool useJ, bool useD)
 
double calc_E (field::field_type &lattice, xt::xtensorf< double, xt::xshape< 4 >> &H)
 
double calc_dE (field::field_type &lattice, int position, xt::xtensorf< double, xt::xshape< 4 >> &H)
 
xt::xtensorf< double, xt::xshape< 4 > > calc_M (field::field_type &lattice)
 
xt::xtensorf< double, xt::xshape< 4 > > calc_subM (field::field_type &lattice, int subnumber)
 
xt::xtensorf< double, xt::xshape< 4 > > calc_sub4M (field::field_type &lattice)
 
std::vector< double > calc_TC (field::field_type &lattice)
 

Member Function Documentation

double particle::td::functionObject::calc_dE ( field::field_type lattice,
int  position,
xt::xtensorf< double, xt::xshape< 4 >> &  H 
)
inline

Calculate the energy change after a spin flip of a single spin

Parameters
latticeThe lattice
positionThe chosen spin
HThe external magnetic field
Returns
The change in energy
double particle::td::functionObject::calc_E ( field::field_type lattice,
xt::xtensorf< double, xt::xshape< 4 >> &  H 
)
inline

Calculate the energy of a given lattice

Parameters
latticeThe lattice
HThe external magnetic field
Returns
The energy
xt::xtensorf<double, xt::xshape<4> > particle::td::functionObject::calc_M ( field::field_type lattice)

Calculate the magnetisation of a lattice

Parameters
latticeThe lattice
Returns
The magnetisation vecotr of the lattice
xt::xtensorf<double, xt::xshape<4> > particle::td::functionObject::calc_sub4M ( field::field_type lattice)

Calculate the 4-fold rotation sublattice magnetisation

Parameters
latticeThe lattice
Returns
The magnetisation vector of the sublattice
xt::xtensorf<double, xt::xshape<4> > particle::td::functionObject::calc_subM ( field::field_type lattice,
int  subnumber 
)

Calculate the sublattice magnetisation

Parameters
latticeThe lattice
subnumberChoice of sublattice
Returns
The magnetisation vector of the sublattice
std::vector<double> particle::td::functionObject::calc_TC ( field::field_type lattice)

Calculate the topological charge of a given lattice

Parameters
latticeThe lattice
Returns
A vector containing the topological charge of each of the slicesof the lattice
void particle::td::functionObject::setup ( bool  useJ,
bool  useD 
)

Setup the thermodynamic functions

Parameters
useJShould the exchange be included?
useDShould the DMI be included?

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