TBTK
TBTK::Property::SpinPolarizedLDOS Class Reference

Property container for spin-polarized local density of states (spin-polarized LDOS). More...

#include <SpinPolarizedLDOS.h>

Inheritance diagram for TBTK::Property::SpinPolarizedLDOS:
TBTK::Property::AbstractProperty< SpinMatrix > TBTK::Serializable

Public Member Functions

 SpinPolarizedLDOS (int dimensions, const int *ranges, double lowerBound, double upperBound, int resolution)
 
 SpinPolarizedLDOS (int dimensions, const int *ranges, double lowerBound, double upperBound, int resolution, const SpinMatrix *data)
 
 SpinPolarizedLDOS (const IndexTree &indexTree, double lowerBound, double upperBound, int resolution)
 
 SpinPolarizedLDOS (const IndexTree &indexTree, double lowerBound, double upperBound, int resolution, const SpinMatrix *data)
 
 SpinPolarizedLDOS (const std::string &serialization, Mode mode)
 
double getLowerBound () const
 
double getUpperBound () const
 
int getResolution () const
 
std::string serialize (Mode mode) const
 
- Public Member Functions inherited from TBTK::Property::AbstractProperty< SpinMatrix >
unsigned int getBlockSize () const
 
unsigned int getSize () const
 
const std::vector< SpinMatrix > & getData () const
 
std::vector< SpinMatrix > & getDataRW ()
 
unsigned int getDimensions () const
 
std::vector< int > getRanges () const
 
int getOffset (const Index &index) const
 
const IndexDescriptorgetIndexDescriptor () const
 
bool contains (const Index &index) const
 
virtual const SpinMatrixoperator() (const Index &index, unsigned int offset=0) const
 
virtual SpinMatrixoperator() (const Index &index, unsigned int offset=0)
 
SpinMatrixoperator() (const std::initializer_list< int > &index)
 
const SpinMatrixoperator() (const std::initializer_list< int > &index) const
 
SpinMatrixoperator() (const std::initializer_list< unsigned int > &index)
 
const SpinMatrixoperator() (const std::initializer_list< unsigned int > &index) const
 
virtual const SpinMatrixoperator() (unsigned int offset) const
 
virtual SpinMatrixoperator() (unsigned int offset)
 
void setAllowIndexOutOfBoundsAccess (bool allowIndexOutOfBoundsAccess)
 
void setDefaultValue (const SpinMatrix &defaultValue)
 

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)
 
- Protected Member Functions inherited from TBTK::Property::AbstractProperty< SpinMatrix >
 AbstractProperty ()
 
 AbstractProperty (unsigned int blockSize)
 
 AbstractProperty (unsigned int blockSize, const SpinMatrix *data)
 
 AbstractProperty (unsigned int dimensions, const int *ranges, unsigned int blockSize)
 
 AbstractProperty (unsigned int dimensions, const int *ranges, unsigned int blockSize, const SpinMatrix *data)
 
 AbstractProperty (const IndexTree &indexTree, unsigned int blockSize)
 
 AbstractProperty (const IndexTree &indexTree, unsigned int blockSize, const SpinMatrix *data)
 
 AbstractProperty (const AbstractProperty &abstractProperty)
 
 AbstractProperty (AbstractProperty &&abstractProperty)
 
 AbstractProperty (const std::string &serialization, Mode mode)
 
virtual ~AbstractProperty ()
 
AbstractPropertyoperator= (const AbstractProperty &abstractProperty)
 
AbstractPropertyoperator= (AbstractProperty &&abstractProperty)
 
- 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

Property container for spin-polarized local density of states (spin-polarized LDOS).

Constructor & Destructor Documentation

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

Constructs a SpinPolarizedDOS on the Ranges format. [See AbstractProperty for detailed information about the Ranges format.]

Parameters
dimensionsNumber of dimensions for the grid.
rangesThe upper limits (exclusive) for the corresponding dimensions.
lowerBoundLower bound for the energy.
upperBoundUpper bound for the energy.
resolutionNumber of points to use for the energy.
TBTK::Property::SpinPolarizedLDOS::SpinPolarizedLDOS ( int  dimensions,
const int *  ranges,
double  lowerBound,
double  upperBound,
int  resolution,
const SpinMatrix data 
)

Constructs a SpinPolarizedDOS on the Ranges format and initializes it with data. [See AbstractProperty for detailed information about the Ranges format and the raw data format.]

Parameters
dimensionsNumber of dimensions for the grid.
rangesThe upper limits (exclusive) for the corresponding dimensions.
lowerBoundLower bound for the energy.
upperBoundUpper bound for the energy.
resolutionNumber of points to use for the energy.
dataRaw data to initialize the SpinPolarizedLDOS with.
TBTK::Property::SpinPolarizedLDOS::SpinPolarizedLDOS ( const IndexTree indexTree,
double  lowerBound,
double  upperBound,
int  resolution 
)

Constructs a SpinPolarizedDOS on the Custom format. [See AbstractProperty for detailed information about the Custom format.]

Parameters
indexTreeIndexTree containing the Indices for which the SpinPolarizedLDOS is contained.
lowerBoundLower bound for the energy.
upperBoundUpper bound for the energy.
resolutionNumber of points to use for the energy.
TBTK::Property::SpinPolarizedLDOS::SpinPolarizedLDOS ( const IndexTree indexTree,
double  lowerBound,
double  upperBound,
int  resolution,
const SpinMatrix data 
)

Constructs a SpinPolarizedDOS on the Custom format and initialize it with data. [See AbstractProperty for detailed information about the Custom format and the raw data format.]

Parameters
indexTreeIndexTree containing the Indices for which the SpinPolarizedLDOS is contained.
lowerBoundLower bound for the energy.
upperBoundUpper bound for the energy.
resolutionNumber of points to use for the energy.
dataRaw data to initialize the SpinPolarizedLDOS with.
TBTK::Property::SpinPolarizedLDOS::SpinPolarizedLDOS ( const std::string &  serialization,
Mode  mode 
)

Copy constructor. Move constructor. Constructor. Construct the SpinPolarizedLDOS from a serialization string.

Parameters
serializationSerialization string from which to construct the SpinPolarizedLDOS.
modeMode with which the string has been serialized.

Member Function Documentation

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

Destructor. Get lower bound for the energy.

Returns
Lower bound for the energy.
int TBTK::Property::SpinPolarizedLDOS::getResolution ( ) const
inline

Get the energy resolution (number of points used for the energy axis).

Returns
The energy resolution.
double TBTK::Property::SpinPolarizedLDOS::getUpperBound ( ) const
inline

Get upper bound for the energy.

Returns
Upper bound for the energy.
std::string TBTK::Property::SpinPolarizedLDOS::serialize ( Mode  mode) const
virtual

Assignment operator. Move assignment operator. Overrides AbstractProperty::serialize().

Reimplemented from TBTK::Property::AbstractProperty< SpinMatrix >.


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