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 SpinPolarizedLDOS &spinPolarizedLDOS)
 
 SpinPolarizedLDOS (SpinPolarizedLDOS &&spinPolarizedLDOS)
 
 SpinPolarizedLDOS (const std::string &serialization, Mode mode)
 
 ~SpinPolarizedLDOS ()
 
double getLowerBound () const
 
double getUpperBound () const
 
int getResolution () const
 
SpinPolarizedLDOSoperator= (const SpinPolarizedLDOS &rhs)
 
SpinPolarizedLDOSoperator= (SpinPolarizedLDOS &&rhs)
 
std::string serialize (Mode mode) const
 
- Public Member Functions inherited from TBTK::Property::AbstractProperty< SpinMatrix >
unsigned int getBlockSize () const
 
void setSize (unsigned int size)
 
unsigned int getSize () const
 
const SpinMatrixgetData () const
 
SpinMatrixgetDataRW ()
 
unsigned int getSizeInBytes () const
 
char * getRawData ()
 
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)
 
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)
 
- 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 
)

Constructor.

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

Constructor.

TBTK::Property::SpinPolarizedLDOS::SpinPolarizedLDOS ( const IndexTree indexTree,
double  lowerBound,
double  upperBound,
int  resolution 
)

Constructor.

TBTK::Property::SpinPolarizedLDOS::SpinPolarizedLDOS ( const IndexTree indexTree,
double  lowerBound,
double  upperBound,
int  resolution,
const SpinMatrix data 
)

Constructor.

TBTK::Property::SpinPolarizedLDOS::SpinPolarizedLDOS ( const SpinPolarizedLDOS spinPolarizedLDOS)

Copy constructor.

TBTK::Property::SpinPolarizedLDOS::SpinPolarizedLDOS ( SpinPolarizedLDOS &&  spinPolarizedLDOS)

Move constructor.

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

Constructor. Construct the SpinPolarizedLDOS from a serialization string.

TBTK::Property::SpinPolarizedLDOS::~SpinPolarizedLDOS ( )

Destructor.

Member Function Documentation

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

Get lower bound for the energy.

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

Get energy resolution. (Number of energy intervals)

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

Get upper bound for the energy.

SpinPolarizedLDOS& TBTK::Property::SpinPolarizedLDOS::operator= ( const SpinPolarizedLDOS rhs)

Assignment operator.

SpinPolarizedLDOS& TBTK::Property::SpinPolarizedLDOS::operator= ( SpinPolarizedLDOS &&  rhs)

Move assignment operator.

std::string TBTK::Property::SpinPolarizedLDOS::serialize ( Mode  mode) const
virtual

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