QMCPACK
SPOInfo Struct Reference

base class to describe a single orbital in an SPOSet More...

+ Inheritance diagram for SPOInfo:
+ Collaboration diagram for SPOInfo:

Public Types

enum  { DIM = OHMMS_DIM }
 
using RealType = QMCTraits::RealType
 

Public Member Functions

 SPOInfo ()
 
 SPOInfo (int orb_index, RealType en=no_energy)
 
virtual ~SPOInfo ()
 
bool has_index () const
 
bool has_energy () const
 
bool has_degeneracy () const
 
SPOInfocopy ()
 
void report (const std::string &pad="") const
 write orbital info to stdout More...
 

Public Attributes

int index
 original orbital index in the maximal basis More...
 
int degeneracy
 energetic degeneracy of the orbital More...
 
RealType energy
 energy of the orbital (in Hartree units) More...
 

Static Public Attributes

static const int no_index = -1
 
static const int no_degeneracy = -1
 
static const RealType no_energy = std::numeric_limits<RealType>::max()
 

Detailed Description

base class to describe a single orbital in an SPOSet

Definition at line 23 of file SPOInfo.h.

Member Typedef Documentation

◆ RealType

Definition at line 25 of file SPOInfo.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
DIM 

Definition at line 27 of file SPOInfo.h.

28  {
29  DIM = OHMMS_DIM
30  };
#define OHMMS_DIM
Definition: config.h:64

Constructor & Destructor Documentation

◆ SPOInfo() [1/2]

SPOInfo ( )

Definition at line 26 of file SPOInfo.cpp.

References SPOInfo::degeneracy, SPOInfo::energy, SPOInfo::index, SPOInfo::no_degeneracy, SPOInfo::no_energy, and SPOInfo::no_index.

Referenced by SPOInfo::copy().

27 {
28  index = no_index;
30  energy = no_energy;
31 }
static const RealType no_energy
Definition: SPOInfo.h:34
int index
original orbital index in the maximal basis
Definition: SPOInfo.h:37
RealType energy
energy of the orbital (in Hartree units)
Definition: SPOInfo.h:43
static const int no_index
Definition: SPOInfo.h:32
static const int no_degeneracy
Definition: SPOInfo.h:33
int degeneracy
energetic degeneracy of the orbital
Definition: SPOInfo.h:40

◆ SPOInfo() [2/2]

SPOInfo ( int  orb_index,
RealType  en = no_energy 
)

Definition at line 33 of file SPOInfo.cpp.

References SPOInfo::degeneracy, SPOInfo::energy, SPOInfo::index, and SPOInfo::no_degeneracy.

34 {
35  index = orb_index;
37  energy = en;
38 }
int index
original orbital index in the maximal basis
Definition: SPOInfo.h:37
RealType energy
energy of the orbital (in Hartree units)
Definition: SPOInfo.h:43
static const int no_degeneracy
Definition: SPOInfo.h:33
int degeneracy
energetic degeneracy of the orbital
Definition: SPOInfo.h:40

◆ ~SPOInfo()

virtual ~SPOInfo ( )
inlinevirtual

Definition at line 49 of file SPOInfo.h.

49 {}

Member Function Documentation

◆ copy()

SPOInfo* copy ( )
inline

Definition at line 58 of file SPOInfo.h.

References SPOInfo::SPOInfo().

Referenced by SPOSetInfo::add().

58 { return new SPOInfo(*this); }

◆ has_degeneracy()

bool has_degeneracy ( ) const
inline

Definition at line 56 of file SPOInfo.h.

References SPOInfo::degeneracy, and SPOInfo::no_degeneracy.

Referenced by SPOInfo::report().

56 { return degeneracy != no_degeneracy; }
static const int no_degeneracy
Definition: SPOInfo.h:33
int degeneracy
energetic degeneracy of the orbital
Definition: SPOInfo.h:40

◆ has_energy()

bool has_energy ( ) const
inline

Definition at line 54 of file SPOInfo.h.

References SPOInfo::energy, and SPOInfo::no_energy.

Referenced by SPOInfo::report().

54 { return energy != no_energy; }
static const RealType no_energy
Definition: SPOInfo.h:34
RealType energy
energy of the orbital (in Hartree units)
Definition: SPOInfo.h:43

◆ has_index()

bool has_index ( ) const
inline

Definition at line 52 of file SPOInfo.h.

References SPOInfo::index, and SPOInfo::no_index.

Referenced by SPOInfo::report().

52 { return index != no_index; }
int index
original orbital index in the maximal basis
Definition: SPOInfo.h:37
static const int no_index
Definition: SPOInfo.h:32

◆ report()

void report ( const std::string &  pad = "") const

write orbital info to stdout

Definition at line 40 of file SPOInfo.cpp.

References qmcplusplus::app_log(), SPOInfo::degeneracy, SPOInfo::energy, SPOInfo::has_degeneracy(), SPOInfo::has_energy(), SPOInfo::has_index(), and SPOInfo::index.

41 {
42  if (has_index())
43  app_log() << pad << "index = " << index << std::endl;
44  else
45  app_log() << pad << "index = not assigned" << std::endl;
46  if (has_energy())
47  app_log() << pad << "energy = " << energy << std::endl;
48  else
49  app_log() << pad << "energy = not assigned" << std::endl;
50  if (has_degeneracy())
51  app_log() << pad << "degeneracy = " << degeneracy << std::endl;
52  else
53  app_log() << pad << "degeneracy = not assigned" << std::endl;
54  app_log().flush();
55 }
std::ostream & app_log()
Definition: OutputManager.h:65
bool has_energy() const
Definition: SPOInfo.h:54
bool has_degeneracy() const
Definition: SPOInfo.h:56
int index
original orbital index in the maximal basis
Definition: SPOInfo.h:37
RealType energy
energy of the orbital (in Hartree units)
Definition: SPOInfo.h:43
bool has_index() const
Definition: SPOInfo.h:52
int degeneracy
energetic degeneracy of the orbital
Definition: SPOInfo.h:40

Member Data Documentation

◆ degeneracy

int degeneracy

energetic degeneracy of the orbital

Definition at line 40 of file SPOInfo.h.

Referenced by SPOInfo::has_degeneracy(), SPOInfo::report(), and SPOInfo::SPOInfo().

◆ energy

◆ index

◆ no_degeneracy

const int no_degeneracy = -1
static

Definition at line 33 of file SPOInfo.h.

Referenced by SPOInfo::has_degeneracy(), and SPOInfo::SPOInfo().

◆ no_energy

const RealType no_energy = std::numeric_limits<RealType>::max()
static

Definition at line 34 of file SPOInfo.h.

Referenced by SPOInfo::has_energy(), and SPOInfo::SPOInfo().

◆ no_index

const int no_index = -1
static

Definition at line 32 of file SPOInfo.h.

Referenced by SPOInfo::has_index(), and SPOInfo::SPOInfo().


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