TBTK
Public Member Functions | Friends | List of all members
TBTK::Property::LDOS Class Reference

#include <LDOS.h>

Public Member Functions

 LDOS (int dimensions, const int *ranges, double lowerBound, double upperBound, int resolution)
 
 ~LDOS ()
 
int getDimensions () const
 
const int * getRanges () const
 
double getLowerBound () const
 
double getUpperBound () const
 
int getResolution () const
 
int getSize () const
 
const double * getData () const
 

Friends

class TBTK::CPropertyExtractor
 
class TBTK::DPropertyExtractor
 
class TBTK::FileReader
 

Detailed Description

Container for local density of states (LDOS).

Constructor & Destructor Documentation

TBTK::Property::LDOS::LDOS ( int  dimensions,
const int *  ranges,
double  lowerBound,
double  upperBound,
int  resolution 
)

Constructor.

TBTK::Property::LDOS::~LDOS ( )

Destructor.

Member Function Documentation

const double * TBTK::Property::LDOS::getData ( ) const
inline

Get LDOS data.

int TBTK::Property::LDOS::getDimensions ( ) const
inline

Get the dimension of the LDOS. (Excluding energy dimension).

double TBTK::Property::LDOS::getLowerBound ( ) const
inline

Get lower bound for the energy.

const int * TBTK::Property::LDOS::getRanges ( ) const
inline

Get the ranges for the dimensions of the LDOS.

int TBTK::Property::LDOS::getResolution ( ) const
inline

Get energy resolution. (Number of energy intervals)

int TBTK::Property::LDOS::getSize ( ) const
inline

Get the number of data elements.

double TBTK::Property::LDOS::getUpperBound ( ) const
inline

Get upper bound for the energy.

Friends And Related Function Documentation

friend class TBTK::CPropertyExtractor
friend

CPropertyExtractor is a friend class to allow it to write LDOS data.

friend class TBTK::DPropertyExtractor
friend

DPropertyExtractor is a friend class to allow it to write LDOS data.

friend class TBTK::FileReader
friend

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


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