MomentumDistributionInput Class Reference

Native representation for Momentum Distribution Estimators inputs. More...

Collaboration diagram for MomentumDistributionInput:

Classes
class	MomentumDistributionInputSection

Public Types
using	Consumer = MomentumDistribution
using	Real = QMCTraits::FullPrecRealType

Public Member Functions
	MomentumDistributionInput (xmlNodePtr cur)
	MomentumDistributionInput (const MomentumDistributionInput &)=default
	default copy constructor This is required due to MDI being part of a variant used as a vector element. More...
const std::string &	get_name () const
const std::string &	get_type () const
const int &	get_samples () const
const Real &	get_kmax () const
const Real &	get_kmax0 () const
const Real &	get_kmax1 () const
const Real &	get_kmax2 () const

Private Attributes
MomentumDistributionInputSection	input_section_
std::string	name_ {"nofk"}
std::string	type_
int	samples_ = 40
	number of samples More...
Real	kmax_ = 0.0
Real	kmax0_ = 0.0
Real	kmax1_ = 0.0
Real	kmax2_ = 0.0

Detailed Description

Native representation for Momentum Distribution Estimators inputs.

Definition at line 23 of file MomentumDistributionInput.h.

Member Typedef Documentation

Consumer

using Consumer = MomentumDistribution

Definition at line 26 of file MomentumDistributionInput.h.

Real

using Real = QMCTraits::FullPrecRealType

Definition at line 27 of file MomentumDistributionInput.h.

Constructor & Destructor Documentation

MomentumDistributionInput() [1/2]

MomentumDistributionInput

(

xmlNodePtr

cur

)

Definition at line 16 of file MomentumDistributionInput.cpp.

References MomentumDistributionInput::input_section_, MomentumDistributionInput::kmax0_, MomentumDistributionInput::kmax1_, MomentumDistributionInput::kmax2_, MomentumDistributionInput::kmax_, MomentumDistributionInput::name_, InputSection::readXML(), MomentumDistributionInput::samples_, InputSection::setIfInInput(), and MomentumDistributionInput::type_.

{
  // This results in checkParticularValidity being called on MomentumDistributionInput
  input_section_.readXML(cur);

  auto setIfInInput = [&](auto& var, const std::string& tag) -> bool { return input_section_.setIfInInput(var, tag); };
  setIfInInput(name_, "name");
  setIfInInput(type_, "type");
  setIfInInput(samples_, "samples");
  setIfInInput(kmax_, "kmax");
  setIfInInput(kmax0_, "kmax0");
  setIfInInput(kmax1_, "kmax1");
  setIfInInput(kmax2_, "kmax2");
}

MomentumDistributionInput() [2/2]

MomentumDistributionInput ( const MomentumDistributionInput &  )

default

default copy constructor This is required due to MDI being part of a variant used as a vector element.

Member Function Documentation

get_kmax()

const Real& get_kmax ( ) const

inline

Definition at line 69 of file MomentumDistributionInput.h.

References MomentumDistributionInput::kmax_.

Referenced by MomentumDistribution::MomentumDistribution().

{ return kmax_; }

get_kmax0()

const Real& get_kmax0 ( ) const

inline

Definition at line 70 of file MomentumDistributionInput.h.

References MomentumDistributionInput::kmax0_.

Referenced by MomentumDistribution::MomentumDistribution().

{ return kmax0_; }

get_kmax1()

const Real& get_kmax1 ( ) const

inline

Definition at line 71 of file MomentumDistributionInput.h.

References MomentumDistributionInput::kmax1_.

Referenced by MomentumDistribution::MomentumDistribution().

{ return kmax1_; }

get_kmax2()

const Real& get_kmax2 ( ) const

inline

Definition at line 72 of file MomentumDistributionInput.h.

References MomentumDistributionInput::kmax2_.

Referenced by MomentumDistribution::MomentumDistribution().

{ return kmax2_; }  

get_name()

const std::string& get_name ( ) const

inline

Definition at line 66 of file MomentumDistributionInput.h.

References MomentumDistributionInput::name_.

Referenced by MomentumDistribution::MomentumDistribution().

{ return name_; }

get_samples()

const int& get_samples ( ) const

inline

Definition at line 68 of file MomentumDistributionInput.h.

References MomentumDistributionInput::samples_.

Referenced by MomentumDistribution::accumulate(), and MomentumDistribution::MomentumDistribution().

{ return samples_; }

get_type()

const std::string& get_type ( ) const

inline

Definition at line 67 of file MomentumDistributionInput.h.

References MomentumDistributionInput::type_.

{ return type_; }

Member Data Documentation

input_section_

MomentumDistributionInputSection input_section_

private

Definition at line 52 of file MomentumDistributionInput.h.

Referenced by MomentumDistributionInput::MomentumDistributionInput().

kmax0_

Real kmax0_ = 0.0

private

Definition at line 61 of file MomentumDistributionInput.h.

Referenced by MomentumDistributionInput::get_kmax0(), and MomentumDistributionInput::MomentumDistributionInput().

kmax1_

Real kmax1_ = 0.0

private

Definition at line 62 of file MomentumDistributionInput.h.

Referenced by MomentumDistributionInput::get_kmax1(), and MomentumDistributionInput::MomentumDistributionInput().

kmax2_

Real kmax2_ = 0.0

private

Definition at line 63 of file MomentumDistributionInput.h.

Referenced by MomentumDistributionInput::get_kmax2(), and MomentumDistributionInput::MomentumDistributionInput().

kmax_

Real kmax_ = 0.0

private

Definition at line 59 of file MomentumDistributionInput.h.

Referenced by MomentumDistributionInput::get_kmax(), and MomentumDistributionInput::MomentumDistributionInput().

name_

std::string name_ {"nofk"}

private

Definition at line 54 of file MomentumDistributionInput.h.

Referenced by MomentumDistributionInput::get_name(), and MomentumDistributionInput::MomentumDistributionInput().

samples_

int samples_ = 40

private

number of samples

Definition at line 57 of file MomentumDistributionInput.h.

Referenced by MomentumDistributionInput::get_samples(), and MomentumDistributionInput::MomentumDistributionInput().

type_

std::string type_

private

Definition at line 55 of file MomentumDistributionInput.h.

Referenced by MomentumDistributionInput::get_type(), and MomentumDistributionInput::MomentumDistributionInput().

---

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

• /home/pk7/projects/qmc/for_cron_doxygen/qmcpack/src/Estimators/MomentumDistributionInput.h
• /home/pk7/projects/qmc/for_cron_doxygen/qmcpack/src/Estimators/MomentumDistributionInput.cpp