#include <FileWriter.h>

Static Public Member Functions
static void	writeModel (Model *model, std::string name="Model", std::string path="/")

static void	writeAmplitudeSet (AmplitudeSet *amplitudeSet, std::string name="AmplitudeSet", std::string path="/")

static void	writeGeometry (const Geometry *geometry, std::string name="Geometry", std::string path="/")

static void	writeEigenValues (const Property::EigenValues *ev, std::string name="EigenValues", std::string path="/")

static void	writeDOS (const Property::DOS *dos, std::string name="DOS", std::string path="/")

static void	writeDensity (const Property::Density *density, std::string name="Density", std::string path="/")

static void	writeMagnetization (const Property::Magnetization *magnetization, std::string name="Magnetization", std::string path="/")

static void	writeLDOS (const Property::LDOS *ldos, std::string name="LDOS", std::string path="/")

static void	writeSpinPolarizedLDOS (const Property::SpinPolarizedLDOS *spinPolarizedLDOS, std::string name="SpinPolarizedLDOS", std::string path="/")

static void	write (const double data, int rank, const int dims, std::string name, std::string path="/")

static void	writeAttributes (const int attributes, const std::string attribute_names, int num, std::string name, std::string path="/")

static void	writeAttributes (const double attributes, const std::string attribute_names, int num, std::string name, std::string path="/")

static void	writeParameterSet (const Util::ParameterSet *parameterSet, std::string name="ParameterSet", std::string path="/")

static void	setFileName (std::string filename)

static void	clear ()

static bool	exists ()

Detailed Description

Writes data to a .hdf5-file. The default file name is TBTKResults.h5. Can be used to write custom n-dimensional arrays of data and parameters to datasets with custom names. It can also be used to write data such as eigenvalues, DOS, Density etc. extracted by the PropertyExtractor. In the later case the data can immediately be plotted using the bundled python plotting scripts.

Member Function Documentation

void TBTK::FileWriter::clear ( )

inlinestatic

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

bool TBTK::FileWriter::exists ( )

static

Returns true if current input file exists.

void TBTK::FileWriter::setFileName ( std::string filename )

inlinestatic

Set output file name. Default is TBTKResults.h5.

void TBTK::FileWriter::write	(	const double *	data,
		int	rank,
		const int *	dims,
		std::string	name,
		std::string	path = `"/"`
	)

static

Write custom n-dimensional arrays to file of type double.

void TBTK::FileWriter::writeAmplitudeSet	(	AmplitudeSet *	amplitudeSet,
		std::string	name = `"AmplitudeSet"`,
		std::string	path = `"/"`
	)

static

Experimental. Write AmplitudeSet to file.

static void TBTK::FileWriter::writeAttributes	(	const int *	attributes,
		const std::string *	attribute_names,
		int	num,
		std::string	name,
		std::string	path = `"/"`
	)

static

Write custom attributes to file of type int.

static void TBTK::FileWriter::writeAttributes	(	const double *	attributes,
		const std::string *	attribute_names,
		int	num,
		std::string	name,
		std::string	path = `"/"`
	)

static

Write custom attributes to file of type double.

void TBTK::FileWriter::writeDensity	(	const Property::Density *	density,
		std::string	name = `"Density"`,
		std::string	path = `"/"`
	)

static

Write density to file.

void TBTK::FileWriter::writeDOS	(	const Property::DOS *	dos,
		std::string	name = `"DOS"`,
		std::string	path = `"/"`
	)

static

Write density of states to file.

void TBTK::FileWriter::writeEigenValues	(	const Property::EigenValues *	ev,
		std::string	name = `"EigenValues"`,
		std::string	path = `"/"`
	)

static

Write eigenvalues to file.

void TBTK::FileWriter::writeLDOS	(	const Property::LDOS *	ldos,
		std::string	name = `"LDOS"`,
		std::string	path = `"/"`
	)

static

Write local density of states to file.

void TBTK::FileWriter::writeMagnetization	(	const Property::Magnetization *	magnetization,
		std::string	name = `"Magnetization"`,
		std::string	path = `"/"`
	)

static

Write magnetization to file.

void TBTK::FileWriter::writeModel	(	Model *	model,
		std::string	name = `"Model"`,
		std::string	path = `"/"`
	)

static

Write model to file.

void TBTK::FileWriter::writeParameterSet	(	const Util::ParameterSet *	parameterSet,
		std::string	name = `"ParameterSet"`,
		std::string	path = `"/"`
	)

static

Write Util::ParamterSet to file.

void TBTK::FileWriter::writeSpinPolarizedLDOS	(	const Property::SpinPolarizedLDOS *	spinPolarizedLDOS,
		std::string	name = `"SpinPolarizedLDOS"`,
		std::string	path = `"/"`
	)

static

Write spin-polarized local density of states to file.

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

/home/kristofer/TBTK/TBTK/calc/TightBindingLib/include/FileWriter.h
/home/kristofer/TBTK/TBTK/calc/TightBindingLib/src/FileWriter.cpp

Static Public Member Functions

Detailed Description

Member Function Documentation