TBTK
Public Member Functions | Protected Member Functions | List of all members
TBTK::Lattice::BravaisLattice Class Reference
Inheritance diagram for TBTK::Lattice::BravaisLattice:
TBTK::Lattice::D2::MonoclinicPrimitive TBTK::Lattice::D3::TriclinicPrimitive TBTK::Lattice::D2::HexagonalPrimitive TBTK::Lattice::D2::OrthorhombicPrimitive TBTK::Lattice::D3::HexagonalPrimitive TBTK::Lattice::D3::MonoclinicPrimitive TBTK::Lattice::D3::OrthorhombicPrimitive TBTK::Lattice::D2::OrthorhombicCentered TBTK::Lattice::D2::TetragonalPrimitive TBTK::Lattice::D3::HexagonalRhombohedralDiagonal TBTK::Lattice::D3::MonoclinicBaseCentered TBTK::Lattice::D3::OrthorhombicBaseCentered TBTK::Lattice::D3::OrthorhombicBodyCentered TBTK::Lattice::D3::OrthorhombicFaceCentered TBTK::Lattice::D3::TetragonalPrimitive

Public Member Functions

 BravaisLattice ()
 
 ~BravaisLattice ()
 
int getNumLatticeVectors () const
 
int getNumAdditionalSites () const
 
const std::vector< double > & getLatticeVector (int n) const
 
const std::vector< double > & getAdditionalSite (int n) const
 
const std::vector< std::vector< double > > & getLatticeVectors () const
 
const std::vector< std::vector< double > > & getAdditionalSites () const
 
virtual void makePrimitive ()
 

Protected Member Functions

void setLatticeVectors (const std::vector< std::vector< double >> &latticeVectors)
 
void setAdditionalSites (const std::vector< std::vector< double >> &additionalSites)
 

Constructor & Destructor Documentation

◆ BravaisLattice()

TBTK::Lattice::BravaisLattice::BravaisLattice ( )

Constructor.

◆ ~BravaisLattice()

TBTK::Lattice::BravaisLattice::~BravaisLattice ( )

Destructor.

Member Function Documentation

◆ getAdditionalSite()

const std::vector< double > & TBTK::Lattice::BravaisLattice::getAdditionalSite ( int  n) const
inline

Get additional site.

◆ getAdditionalSites()

const std::vector< std::vector< double > > & TBTK::Lattice::BravaisLattice::getAdditionalSites ( ) const
inline

Get additional sites.

◆ getLatticeVector()

const std::vector< double > & TBTK::Lattice::BravaisLattice::getLatticeVector ( int  n) const
inline

Get lattice vector.

◆ getLatticeVectors()

const std::vector< std::vector< double > > & TBTK::Lattice::BravaisLattice::getLatticeVectors ( ) const
inline

Get lattice vectors.

◆ getNumAdditionalSites()

int TBTK::Lattice::BravaisLattice::getNumAdditionalSites ( ) const
inline

Get number of additional sites.

◆ getNumLatticeVectors()

int TBTK::Lattice::BravaisLattice::getNumLatticeVectors ( ) const
inline

Get number of lattice vectors.

◆ makePrimitive()

virtual void TBTK::Lattice::BravaisLattice::makePrimitive ( )
virtual

Converts the basis vectors to ensure that they span primitive cells.

Reimplemented in TBTK::Lattice::D3::OrthorhombicFaceCentered, TBTK::Lattice::D3::MonoclinicBaseCentered, TBTK::Lattice::D3::CubicFaceCentered, TBTK::Lattice::D3::HexagonalRhombohedralDiagonal, TBTK::Lattice::D3::OrthorhombicBaseCentered, TBTK::Lattice::D3::OrthorhombicBodyCentered, TBTK::Lattice::D3::TetragonalBodyCentered, TBTK::Lattice::D3::CubicBodyCentered, and TBTK::Lattice::D2::OrthorhombicCentered.

◆ setAdditionalSites()

void TBTK::Lattice::BravaisLattice::setAdditionalSites ( const std::vector< std::vector< double >> &  additionalSites)
protected

Set additional sites.

◆ setLatticeVectors()

void TBTK::Lattice::BravaisLattice::setLatticeVectors ( const std::vector< std::vector< double >> &  latticeVectors)
protected

Set lattice vectors.

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