ParameterSet Struct Reference

class to handle a set of parameters More...

Inheritance diagram for ParameterSet:

Collaboration diagram for ParameterSet:

Public Member Functions
	ParameterSet (const char *aname="parameter")
bool	get (std::ostream &os) const override
	write to a std::ostream More...
bool	put (std::istream &is) override
	read from std::istream More...
bool	put (xmlNodePtr cur) override
	assign parameters to the set More...
void	reset () override
	reset member data More...
template<class PDT >
void	add (PDT &aparam, const std::string &aname_in, std::vector< PDT > candidate_values={}, TagStatus status=TagStatus::OPTIONAL)
	add a new parameter corresponding to an xmlNode <parameter> More...
template<class PDT >
void	setValue (const std::string &aname_in, PDT aval)
Public Member Functions inherited from OhmmsElementBase
	OhmmsElementBase (const char *aname="none")
	constructor with a name More...
virtual	~OhmmsElementBase ()
	destructor More...
const std::string &	getName () const
	return the name More...
void	setName (const std::string &aname)
	set name More...
void	setIOMode (int imode)
	set iomode More...
virtual bool	add (xmlNodePtr parent)
	add a xmlNode to the children list of parent More...
void	put (const std::string &s)
	read from string More...
virtual void	begin_node (std::ostream &os) const
	write the start of a node More...
virtual void	end_node (std::ostream &os) const
	write the end of a node More...

Public Attributes
std::map< std::string, std::unique_ptr< OhmmsElementBase > >	m_param

Additional Inherited Members
Public Types inherited from OhmmsElementBase
enum	{ useLIBXML = 0, useLIBXMLPP, usePLAIN }
	enumeration to choose the xml parser More...
Protected Attributes inherited from OhmmsElementBase
int	myIOMode
	the type of IO mode: default is useLIBXML More...
std::string	myName
	the name of the node, corresponds to the xml tag More...

Detailed Description

class to handle a set of parameters

Definition at line 27 of file ParameterSet.h.

Constructor & Destructor Documentation

ParameterSet()

ParameterSet ( const char *  aname = "parameter" )

inline

Definition at line 33 of file ParameterSet.h.

: OhmmsElementBase(aname) {}

Member Function Documentation

add()

template void add< float >	(	PDT &	aparam,
		const std::string &	aname_in,
		std::vector< PDT >	candidate_values = {},
		TagStatus	status = TagStatus::OPTIONAL
	)

add a new parameter corresponding to an xmlNode <parameter>

Parameters

aparam	reference the object which this parameter is assigned to.
aname_in	the value of the name attribute
candidate_values	candidate values to be checked against, the first element is the default value
status	Tag status, See OhmmsParameter.h for more details

Definition at line 58 of file ParameterSet.cpp.

References qmcplusplus::lowerCase(), and m_param.

Referenced by qmcplusplus::createDriftModifier(), RadialJastrowBuilder::createJ1(), qmcplusplus::createWalkerController(), CSUpdateBase::CSUpdateBase(), CSVMC::CSVMC(), DMC::DMC(), DriftModifierUNR::parseXML(), QMCFixedSampleLinearOptimizeBatched::process(), HybridEngine::processXML(), DescentEngine::processXML(), FiniteDiffErrData::put(), VMC::put(), DMC::put(), CSVMC::put(), RPAJastrow::put(), RMCUpdateAllWithDrift::put(), RMCUpdatePbyPWithDrift::put(), NonLocalTOperator::put(), QMCFixedSampleLinearOptimize::put(), ProjectData::put(), ForceCeperley::put(), WalkerControl::put(), QMCCostFunctionBase::put(), SymmetryBuilder::put(), ForceChiesaPBCAA::put(), WalkerControlBase::put(), PWParameterSet::PWParameterSet(), QMCDriver::QMCDriver(), QMCFixedSampleLinearOptimize::QMCFixedSampleLinearOptimize(), QMCFixedSampleLinearOptimizeBatched::QMCFixedSampleLinearOptimizeBatched(), WFOptDriverInput::readXML(), GradientTestInput::readXML(), VMCDriverInput::readXML(), DMCDriverInput::readXML(), QMCDriverInput::readXML(), SFNBranch::registerParameters(), SimpleFixedNodeBranch::registerParameters(), SimpleFixedNodeBranch::resetRun(), RMC::RMC(), WaveFunctionTester::runNodePlot(), QMCUpdateBase::setDefaults(), TEST_CASE(), VMC::VMC(), and WaveFunctionTester::WaveFunctionTester().

{
  using namespace qmcplusplus;
  std::string aname(lowerCase(aname_in));
  if (auto it = m_param.find(aname); it == m_param.end())
  {
    m_param[aname] = std::make_unique<OhmmsParameter<PDT>>(aparam, aname, std::move(candidate_values), status);
  }
}

get()

bool get ( std::ostream &  ) const

inlineoverridevirtual

write to a std::ostream

Implements OhmmsElementBase.

Definition at line 35 of file ParameterSet.h.

References OhmmsElementBase::get(), and m_param.

Referenced by VMC::put(), and CSVMC::put().

  {
    for (const auto& [name, param] : m_param)
      param->get(os);
    return true;
  }

put() [1/2]

bool put ( std::istream &  )

inlineoverridevirtual

read from std::istream

Implements OhmmsElementBase.

Definition at line 42 of file ParameterSet.h.

Referenced by qmcplusplus::createDriftModifier(), RadialJastrowBuilder::createJ1(), qmcplusplus::createWalkerController(), DriftModifierUNR::parseXML(), QMCFixedSampleLinearOptimizeBatched::process(), QMCFixedSampleLinearOptimize::processOptXML(), QMCFixedSampleLinearOptimizeBatched::processOptXML(), HybridEngine::processXML(), DescentEngine::processXML(), FiniteDiffErrData::put(), VMC::put(), RMC::put(), DMC::put(), CSVMC::put(), RPAJastrow::put(), RMCUpdateAllWithDrift::put(), RMCUpdatePbyPWithDrift::put(), NonLocalTOperator::put(), QMCFixedSampleLinearOptimize::put(), ProjectData::put(), ForceCeperley::put(), PWParameterSet::put(), WalkerControl::put(), QMCCostFunctionBase::put(), SymmetryBuilder::put(), ForceChiesaPBCAA::put(), WalkerControlBase::put(), QMCUpdateBase::put(), SFNBranch::put(), SimpleFixedNodeBranch::put(), QMCDriver::putQMCInfo(), WFOptDriverInput::readXML(), GradientTestInput::readXML(), VMCDriverInput::readXML(), DMCDriverInput::readXML(), QMCDriverInput::readXML(), RMC::resetRun(), SimpleFixedNodeBranch::resetRun(), WaveFunctionTester::runNodePlot(), and TEST_CASE().

{ return true; }

put() [2/2]

bool put ( xmlNodePtr  cur )

overridevirtual

assign parameters to the set

Parameters

cur	the xml node to work on

Returns

true, if any valid parameter is processed.

Accept both

• <aname> value </aname>
• <parameter name="aname"> value </parameter> aname is converted into lower cases.

Implements OhmmsElementBase.

Definition at line 22 of file ParameterSet.cpp.

References castXMLCharToChar(), getXMLAttributeValue(), qmcplusplus::lowerCase(), m_param, and OhmmsElementBase::myName.

{
  using namespace qmcplusplus;
  if (cur == NULL)
    return true; //handle empty node
  cur            = cur->xmlChildrenNode;
  bool something = false;
  while (cur != NULL)
  {
    std::string cname(lowerCase(castXMLCharToChar(cur->name)));
    if (auto it_tag = m_param.find(cname); it_tag == m_param.end())
    {
      if (cname == myName)
      {
        std::string aname(lowerCase(getXMLAttributeValue(cur, "name")));
        if (!aname.empty())
        {
          if (auto it = m_param.find(aname); it != m_param.end())
          {
            something = true;
            it->second->put(cur);
          }
        }
      }
    }
    else
    {
      something = true;
      it_tag->second->put(cur);
    }
    cur = cur->next;
  }
  return something;
}

reset()

void reset ( )

inlineoverridevirtual

reset member data

Implements OhmmsElementBase.

Definition at line 55 of file ParameterSet.h.

{}

setValue()

template void setValue< int >	(	const std::string &	aname_in,
		PDT	aval
	)

Definition at line 69 of file ParameterSet.cpp.

References qmcplusplus::lowerCase(), and m_param.

Referenced by QMCDriver::setValue().

{
  using namespace qmcplusplus;
  std::string aname(lowerCase(aname_in));
  if (auto it = m_param.find(aname); it != m_param.end())
  {
    (dynamic_cast<OhmmsParameter<PDT>&>(*it->second)).setValue(aval);
  }
}

Member Data Documentation

m_param

std::map<std::string, std::unique_ptr<OhmmsElementBase> > m_param

Definition at line 31 of file ParameterSet.h.

Referenced by add(), get(), put(), and setValue().

---

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

• /home/pk7/projects/qmc/for_cron_doxygen/qmcpack/src/io/OhmmsData/ParameterSet.h
• /home/pk7/projects/qmc/for_cron_doxygen/qmcpack/src/io/OhmmsData/ParameterSet.cpp