TBTK
TBTK::SingleParticleContext Class Reference

The context for the single particle part of a Model. More...

#include <SingleParticleContext.h>

Inheritance diagram for TBTK::SingleParticleContext:
TBTK::Serializable

Public Member Functions

 SingleParticleContext ()
 
 SingleParticleContext (const std::vector< unsigned int > &capacity)
 
 SingleParticleContext (const SingleParticleContext &singleParticleContext)
 
 SingleParticleContext (SingleParticleContext &&singleParticleContext)
 
 SingleParticleContext (const std::string &serialization, Mode mode)
 
virtual ~SingleParticleContext ()
 
SingleParticleContextoperator= (const SingleParticleContext &rhs)
 
SingleParticleContextoperator= (SingleParticleContext &&rhs)
 
void setStatistics (Statistics statistics)
 
Statistics getStatistics () const
 
void sortHoppingAmplitudes ()
 
void constructCOO ()
 
HoppingAmplitudeSetgetHoppingAmplitudeSet ()
 
const HoppingAmplitudeSetgetHoppingAmplitudeSet () const
 
SourceAmplitudeSetgetSourceAmplitudeSet ()
 
const SourceAmplitudeSetgetSourceAmplitudeSet () const
 
void createGeometry (int dimensions, int numSpecifiers=0)
 
GeometrygetGeometry ()
 
std::string serialize (Mode mode) const
 

Friends

class FileReader
 

Additional Inherited Members

- Public Types inherited from TBTK::Serializable
enum  Mode { Debug, Binary, XML, JSON }
 
- Static Public Member Functions inherited from TBTK::Serializable
static bool hasID (const std::string &serialization, Mode mode)
 
static std::string getID (const std::string &serialization, Mode mode)
 
static std::string extractComponent (const std::string &serialization, const std::string &containerID, const std::string &componentID, const std::string &componentName, Mode mode)
 
- Static Protected Member Functions inherited from TBTK::Serializable
static bool validate (const std::string &serialization, const std::string &id, Mode mode)
 
static std::string getContent (const std::string &serialization, Mode mode)
 
static std::vector< std::string > split (const std::string &content, Mode mode)
 
static std::string serialize (bool b, Mode mode)
 
static void deserialize (const std::string &serialization, bool *b, Mode mode)
 
static std::string serialize (int i, Mode mode)
 
static void deserialize (const std::string &serialization, int *i, Mode mode)
 
static std::string serialize (unsigned int u, Mode mode)
 
static void deserialize (const std::string &serialization, unsigned int *u, Mode mode)
 
static std::string serialize (double d, Mode mode)
 
static void deserialize (const std::string &serialization, double *d, Mode mode)
 
static std::string serialize (std::complex< double > c, Mode mode)
 
static void deserialize (const std::string &serialization, std::complex< double > *c, Mode mode)
 
static std::string serialize (Statistics s, Mode mode)
 
static void deserialize (const std::string &serialization, Statistics *s, Mode mode)
 
static std::string extract (const std::string &serialization, Mode mode, std::string component)
 

Detailed Description

The context for the single particle part of a Model.

Constructor & Destructor Documentation

TBTK::SingleParticleContext::SingleParticleContext ( )

Constructor.

TBTK::SingleParticleContext::SingleParticleContext ( const std::vector< unsigned int > &  capacity)

Constructor.

TBTK::SingleParticleContext::SingleParticleContext ( const SingleParticleContext singleParticleContext)

Copy constructor.

TBTK::SingleParticleContext::SingleParticleContext ( SingleParticleContext &&  singleParticleContext)

Move constructor.

TBTK::SingleParticleContext::SingleParticleContext ( const std::string &  serialization,
Mode  mode 
)

Constructor. Constructs the SingleParticleContext from a serializeation string.

virtual TBTK::SingleParticleContext::~SingleParticleContext ( )
virtual

Destructor.

Member Function Documentation

void TBTK::SingleParticleContext::constructCOO ( )
inline

Construct Hamiltonian on COO format.

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

Create Geometry.

Geometry * TBTK::SingleParticleContext::getGeometry ( )
inline

Get Geometry.

HoppingAmplitudeSet & TBTK::SingleParticleContext::getHoppingAmplitudeSet ( )
inline

Get the contained HoppingAmplitudeSet.

Returns
The contained HoppingAmplitudeSet.
const HoppingAmplitudeSet & TBTK::SingleParticleContext::getHoppingAmplitudeSet ( ) const
inline

Get the contained HoppingAmplitudeSet.

Returns
The contained HoppingAmplitudeSet.
SourceAmplitudeSet & TBTK::SingleParticleContext::getSourceAmplitudeSet ( )
inline

Get the contained SourceAmplitudeSet.

Returns
The contained SourceAmplitudeSet.
const SourceAmplitudeSet & TBTK::SingleParticleContext::getSourceAmplitudeSet ( ) const
inline

Get the contained SourceAmplitudeSet.

Returns
The contained SourceAmplitudeSet.
Statistics TBTK::SingleParticleContext::getStatistics ( ) const
inline

Get statistics.

Returns
The currently set Statistics.
SingleParticleContext& TBTK::SingleParticleContext::operator= ( const SingleParticleContext rhs)

Assignment operator.

SingleParticleContext& TBTK::SingleParticleContext::operator= ( SingleParticleContext &&  rhs)

Move assignment operator.

std::string TBTK::SingleParticleContext::serialize ( Mode  mode) const
virtual
void TBTK::SingleParticleContext::setStatistics ( Statistics  statistics)
inline

Set statistics.

Parameters
statisticsThe Statistics to use.

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 file: