QMCPACK
BandInfo Struct Reference
+ Collaboration diagram for BandInfo:

Public Member Functions

 BandInfo ()
 default constructor More...
 
bool operator< (BandInfo other) const
 operator to determine the order of any band More...
 

Public Attributes

int TwistIndex
 twist index More...
 
int BandIndex
 band index More...
 
int BandGroup
 band group index More...
 
int Spin
 spin index More...
 
double Energy
 energy associated with this band More...
 
bool MakeTwoCopies
 This is true if we should make distinct copies represeninting a +k, -k pair. More...
 

Detailed Description

Definition at line 26 of file BandInfo.h.

Constructor & Destructor Documentation

◆ BandInfo()

BandInfo ( )
inline

default constructor

Definition at line 41 of file BandInfo.h.

42  : TwistIndex(0), BandIndex(-1), BandGroup(0), Spin(0), Energy(1e9), MakeTwoCopies(false)
43  {}
double Energy
energy associated with this band
Definition: BandInfo.h:37
int BandIndex
band index
Definition: BandInfo.h:31
bool MakeTwoCopies
This is true if we should make distinct copies represeninting a +k, -k pair.
Definition: BandInfo.h:39
int TwistIndex
twist index
Definition: BandInfo.h:29
int BandGroup
band group index
Definition: BandInfo.h:33
int Spin
spin index
Definition: BandInfo.h:35

Member Function Documentation

◆ operator<()

bool operator< ( BandInfo  other) const
inline

operator to determine the order of any band

  • energy
  • twist index if the energies are similar

Definition at line 50 of file BandInfo.h.

References BandInfo::BandIndex, qmcplusplus::Units::charge::e, BandInfo::Energy, and BandInfo::TwistIndex.

51  {
52  if ((Energy < other.Energy + 1e-6) && (Energy > other.Energy - 1e-6))
53  {
54  if (TwistIndex == other.TwistIndex)
55  return BandIndex < other.BandIndex;
56  else
57  return TwistIndex < other.TwistIndex;
58  }
59  else
60  return Energy < other.Energy;
61  }
double Energy
energy associated with this band
Definition: BandInfo.h:37
int BandIndex
band index
Definition: BandInfo.h:31
int TwistIndex
twist index
Definition: BandInfo.h:29

Member Data Documentation

◆ BandGroup

int BandGroup

band group index

Definition at line 33 of file BandInfo.h.

◆ BandIndex

◆ Energy

double Energy

energy associated with this band

Definition at line 37 of file BandInfo.h.

Referenced by EinsplineSetBuilder::OccupyBands(), EinsplineSetBuilder::OccupyBands_ESHDF(), BandInfo::operator<(), and qmcplusplus::sortByIndex().

◆ MakeTwoCopies

bool MakeTwoCopies

This is true if we should make distinct copies represeninting a +k, -k pair.

Definition at line 39 of file BandInfo.h.

Referenced by EinsplineSetBuilder::OccupyBands(), and EinsplineSetBuilder::OccupyBands_ESHDF().

◆ Spin

int Spin

spin index

Definition at line 35 of file BandInfo.h.

Referenced by EinsplineSetBuilder::OccupyBands().

◆ TwistIndex


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