TBTK::Model Class Reference

#include <Model.h>

Public Types
enum	Statistics { FermiDirac, BoseEinstein }

Public Member Functions
	Model ()
	~Model ()
void	addHA (HoppingAmplitude ha)
void	addHAAndHC (HoppingAmplitude ha)
int	getBasisIndex (Index index)
int	getBasisSize ()
void	construct ()
bool	getIsConstructed ()
void	constructCOO ()
void	destructCOO ()
void	reconstructCOO ()
void	setTemperature (double temperature)
double	getTemperature ()
void	setChemicalPotential (double chemicalPotential)
double	getChemicalPotential ()
void	setStatistics (Statistics statistics)
Statistics	getStatistics ()
AmplitudeSet *	getAmplitudeSet ()
void	createGeometry (int dimensions, int numSpecifiers=0)
Geometry *	getGeometry ()
void	saveEV (std::string path="./", std::string filename="EV.dat")
void	setTalkative (bool isTalkative)

Friends
class	FileReader

Detailed Description

The Model conatins all information about the Hamiltonian. It is currently a wrapper for AmplitudeSet, but can in the future come to be extended with further properties.

Member Enumeration Documentation

enum TBTK::Model::Statistics

strong

Enums for Fermi-Dirac and Bose-Einstein statistics.

Constructor & Destructor Documentation

TBTK::Model::Model

(

)

Constructor.

TBTK::Model::~Model

(

)

Destructor.

Member Function Documentation

void TBTK::Model::addHA ( HoppingAmplitude  ha )

inline

Add a HoppingAmplitude.

void TBTK::Model::addHAAndHC ( HoppingAmplitude  ha )

inline

Add a HoppingAmplitude and its Hermitian conjugate.

void TBTK::Model::construct

(

)

Construct Hilbert space. No more HoppingAmplitudes should be added after this call.

void TBTK::Model::constructCOO ( )

inline

Construct Hamiltonian on COO format.

void TBTK::Model::createGeometry	(	int	dimensions,
		int	numSpecifiers = 0
	)

Create geometry.

void TBTK::Model::destructCOO ( )

inline

Destruct Hamiltonian on COO format.

AmplitudeSet * TBTK::Model::getAmplitudeSet ( )

inline

Get amplitude set.

int TBTK::Model::getBasisIndex ( Index  index )

inline

Get Hilbert space index corresponding to given 'from'-index.

Parameters

index

'From'-index to get Hilbert space index for.

int TBTK::Model::getBasisSize ( )

inline

Get size of Hilbert space.

double TBTK::Model::getChemicalPotential ( )

inline

Get chemical potential.

Geometry * TBTK::Model::getGeometry ( )

inline

Get geometry.

bool TBTK::Model::getIsConstructed ( )

inline

Returns true if the Hilbert space basis has been constructed.

Model::Statistics TBTK::Model::getStatistics ( )

inline

Get statistics.

double TBTK::Model::getTemperature ( )

inline

Get temperature.

void TBTK::Model::reconstructCOO ( )

inline

To be called when HoppingAmplitudes need to be reevaluated. This is required if the AmplitudeSet in addition to its standard storage format also utilizes a more effective format such as COO format and some HoppingAmplitudes are evaluated through the use of callbacks.

void TBTK::Model::setChemicalPotential ( double  chemicalPotential )

inline

Set chemical potential.

void TBTK::Model::setStatistics ( Statistics  statistics )

inline

Set statistics.

void TBTK::Model::setTemperature ( double  temperature )

inline

Set temperature.

Friends And Related Function Documentation

friend class FileReader

friend

FileReader is a friend class to allow it to write Model data.

---

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

• /home/kristofer/TBTK/TBTK/calc/TightBindingLib/include/Model.h
• /home/kristofer/TBTK/TBTK/calc/TightBindingLib/src/Model.cpp