TBTK
Need a break? Support the development by playing Polarity Puzzles
Static Public Member Functions | List of all members
TBTK::FileReader Class Reference

#include <FileReader.h>

Static Public Member Functions

static Model * readModel (std::string name="Model", std::string path="/")
 
static HoppingAmplitudeSet * readHoppingAmplitudeSet (std::string name="HoppingAmplitudeSet", std::string path="/")
 
static Geometry * readGeometry (Model *model, std::string name="Geometry", std::string path="/")
 
static IndexTree * readIndexTree (std::string name="IndexTree", std::string path="/")
 
static Property::EigenValues * readEigenValues (std::string name="EigenValues", std::string path="/")
 
static Property::WaveFunctions * readWaveFunctions (std::string name="WaveFunctions", std::string pat="/")
 
static Property::DOS * readDOS (std::string name="DOS", std::string path="/")
 
static Property::Density * readDensity (std::string name="Density", std::string path="/")
 
static Property::Magnetization * readMagnetization (std::string name="Magnetization", std::string path="/")
 
static Property::LDOS * readLDOS (std::string name="LDOS", std::string path="/")
 
static Property::SpectralFunction * readSpectralFunction (std::string name="SpectralFunction", std::string path="/")
 
static Property::SpinPolarizedLDOS * readSpinPolarizedLDOS (std::string name="SpinPolarizedLDOS", std::string path="/")
 
static ParameterSet * readParameterSet (std::string name="ParameterSet", std::string path="/")
 
static void read (int **data, int *rank, int **dims, std::string name, std::string path="/")
 
static void read (double **data, int *rank, int **dims, std::string name, std::string path="/")
 
static void read (std::complex< double > **data, int *rank, int **dims, std::string name, std::string path="/")
 
static void readAttributes (int *attributes, std::string *attribute_names, int num, std::string name, std::string path="/")
 
static void readAttributes (double *attributes, std::string *attribute_names, int num, std::string name, std::string path="/")
 
static void setFileName (std::string filename)
 
static void clear ()
 
static bool exists ()
 

Detailed Description

Reads data from a .hdf5-file. The default file name is TBTKResults.h5. Can be used to read custom n-dimensional arrays of data and parameters from datasets with custom names. It can also be used to read data such as eigenvalues, DOS, Density etc. written by the FileWriter.

Member Function Documentation

◆ clear()

void TBTK::FileReader::clear ( )
inlinestatic

Remove any file from the current folder with the file name set by FileReader::setFileName

◆ exists()

static bool TBTK::FileReader::exists ( )
static

Returns true if current input file exists.

◆ read() [1/3]

static void TBTK::FileReader::read ( int **  data,
int *  rank,
int **  dims,
std::string  name,
std::string  path = "/" 
)
static

Read custom n-dimensional arrays from file of type int.

◆ read() [2/3]

static void TBTK::FileReader::read ( double **  data,
int *  rank,
int **  dims,
std::string  name,
std::string  path = "/" 
)
static

Read custom n-dimensional arrays from file of type double.

◆ read() [3/3]

static void TBTK::FileReader::read ( std::complex< double > **  data,
int *  rank,
int **  dims,
std::string  name,
std::string  path = "/" 
)
static

Read custom n-dimensional arrays from file of type complex<double>.

◆ readAttributes() [1/2]

static void TBTK::FileReader::readAttributes ( int *  attributes,
std::string *  attribute_names,
int  num,
std::string  name,
std::string  path = "/" 
)
static

Read custom attributes from file of type int.

◆ readAttributes() [2/2]

static void TBTK::FileReader::readAttributes ( double *  attributes,
std::string *  attribute_names,
int  num,
std::string  name,
std::string  path = "/" 
)
static

Read custom attributes from file of type double.

◆ readDensity()

static Property::Density* TBTK::FileReader::readDensity ( std::string  name = "Density",
std::string  path = "/" 
)
static

Read density from file.

◆ readDOS()

static Property::DOS* TBTK::FileReader::readDOS ( std::string  name = "DOS",
std::string  path = "/" 
)
static

Read density of states from file.

◆ readEigenValues()

static Property::EigenValues* TBTK::FileReader::readEigenValues ( std::string  name = "EigenValues",
std::string  path = "/" 
)
static

Read eigenvalues from file.

◆ readGeometry()

static Geometry* TBTK::FileReader::readGeometry ( Model *  model,
std::string  name = "Geometry",
std::string  path = "/" 
)
static

Read geometry from file.

◆ readHoppingAmplitudeSet()

static HoppingAmplitudeSet* TBTK::FileReader::readHoppingAmplitudeSet ( std::string  name = "HoppingAmplitudeSet",
std::string  path = "/" 
)
static

Experimental. Read HoppingAmplitudeSet from file.

◆ readIndexTree()

static IndexTree* TBTK::FileReader::readIndexTree ( std::string  name = "IndexTree",
std::string  path = "/" 
)
static

Read IndexTree from file.

◆ readLDOS()

static Property::LDOS* TBTK::FileReader::readLDOS ( std::string  name = "LDOS",
std::string  path = "/" 
)
static

Read local density of states from file.

◆ readMagnetization()

static Property::Magnetization* TBTK::FileReader::readMagnetization ( std::string  name = "Magnetization",
std::string  path = "/" 
)
static

Read magnetization from file.

◆ readModel()

static Model* TBTK::FileReader::readModel ( std::string  name = "Model",
std::string  path = "/" 
)
static

Read model from file.

◆ readParameterSet()

static ParameterSet* TBTK::FileReader::readParameterSet ( std::string  name = "ParameterSet",
std::string  path = "/" 
)
static

Read ParameterSet from file.

◆ readSpectralFunction()

Property::SpectralFunction * TBTK::FileReader::readSpectralFunction ( std::string  name = "SpectralFunction",
std::string  path = "/" 
)
inlinestatic

Read spectral function from file.

◆ readSpinPolarizedLDOS()

static Property::SpinPolarizedLDOS* TBTK::FileReader::readSpinPolarizedLDOS ( std::string  name = "SpinPolarizedLDOS",
std::string  path = "/" 
)
static

Read spin-polarized local density of states from file.

◆ readWaveFunctions()

static Property::WaveFunctions* TBTK::FileReader::readWaveFunctions ( std::string  name = "WaveFunctions",
std::string  pat = "/" 
)
static

Read WaveFunctionw from file.

◆ setFileName()

void TBTK::FileReader::setFileName ( std::string  filename)
inlinestatic

Set input file name. Default is TBTKResults.h5.

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