TBTK
TBTK::WignerSeitzCell Class Reference

#include <WignerSeitzCell.h>

Inheritance diagram for TBTK::WignerSeitzCell:
TBTK::ParallelepipedCell TBTK::SpacePartition TBTK::BrillouinZone

Public Member Functions

 WignerSeitzCell ()
 
 WignerSeitzCell (const std::vector< std::vector< double >> &basisVectors, MeshType meshType)
 
virtual ~WignerSeitzCell ()
 
virtual Index getMajorCellIndex (const std::vector< double > &coordinates) const
 
virtual Index getMinorCellIndex (const std::vector< double > &coordinates, const std::vector< unsigned int > &numMeshPoints) const
 
virtual std::vector< std::vector< double > > getMajorMesh (const std::vector< unsigned int > &numMeshPoints) const
 
virtual std::vector< std::vector< double > > getMinorMesh (const std::vector< unsigned int > &numMeshPoints) const
 
virtual std::vector< double > getMinorMeshPoint (const std::vector< unsigned int > &meshPoint, const std::vector< unsigned int > &numMeshPoints) const
 
- Public Member Functions inherited from TBTK::ParallelepipedCell
 ParallelepipedCell ()
 
 ParallelepipedCell (const std::vector< std::vector< double >> &basisVectors, MeshType meshType)
 
virtual ~ParallelepipedCell ()
 
- Public Member Functions inherited from TBTK::SpacePartition
 SpacePartition ()
 
 SpacePartition (const std::vector< std::vector< double >> &basisVectors, MeshType meshType)
 
virtual ~SpacePartition ()
 
unsigned int getNumDimensions () const
 

Additional Inherited Members

- Public Types inherited from TBTK::SpacePartition
enum  MeshType { Nodal, Interior }
 
- Protected Member Functions inherited from TBTK::SpacePartition
const std::vector< Vector3d > & getBasisVectors () const
 
MeshType getMeshType () const
 

Detailed Description

Wigner-Seitz cell.

Constructor & Destructor Documentation

◆ WignerSeitzCell() [1/2]

TBTK::WignerSeitzCell::WignerSeitzCell ( )

Constructor.

◆ WignerSeitzCell() [2/2]

TBTK::WignerSeitzCell::WignerSeitzCell ( const std::vector< std::vector< double >> &  basisVectors,
MeshType  meshType 
)

Constructor.

◆ ~WignerSeitzCell()

virtual TBTK::WignerSeitzCell::~WignerSeitzCell ( )
virtual

Destructor.

Member Function Documentation

◆ getMajorCellIndex()

virtual Index TBTK::WignerSeitzCell::getMajorCellIndex ( const std::vector< double > &  coordinates) const
virtual

Implements SpacePartition::getCellIndex().

Reimplemented from TBTK::ParallelepipedCell.

◆ getMajorMesh()

virtual std::vector<std::vector<double> > TBTK::WignerSeitzCell::getMajorMesh ( const std::vector< unsigned int > &  numMeshPoints) const
virtual

◆ getMinorCellIndex()

virtual Index TBTK::WignerSeitzCell::getMinorCellIndex ( const std::vector< double > &  coordinates,
const std::vector< unsigned int > &  numMeshPoints 
) const
virtual

Implements SpacePartition::getCellIndex().

Reimplemented from TBTK::ParallelepipedCell.

◆ getMinorMesh()

virtual std::vector<std::vector<double> > TBTK::WignerSeitzCell::getMinorMesh ( const std::vector< unsigned int > &  numMeshPoints) const
virtual

◆ getMinorMeshPoint()

virtual std::vector<double> TBTK::WignerSeitzCell::getMinorMeshPoint ( const std::vector< unsigned int > &  meshPoint,
const std::vector< unsigned int > &  numMeshPoints 
) const
virtual

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