ProjectData Class Reference

class ProjectData More...

Collaboration diagram for ProjectData:

Public Types
enum	DriverVersion { LEGACY, BATCH }
	Enum for global scope switch of design from legacy driver based to batch driver based. More...

Public Member Functions
	ProjectData (const std::string &atitle="", DriverVersion de=DriverVersion::LEGACY)
	constructor More...
bool	get (std::ostream &os) const
bool	put (std::istream &is)
bool	put (xmlNodePtr cur)
void	reset ()
	Construct the root name with title_ and m_series. More...
void	advance ()
	increment a series number and reset project_root_ More...
void	rewind ()
	roll-back a series number and reset project_root_ by one More...
void	setCommunicator (Communicate *c)
const std::string &	getTitle () const noexcept
	returns the title of the project <project id="det_qmc_short_sdbatch_vmcbatch_mwalkers" series="0"> translate to title_ = "det_qmc_short_sdbatch_vmcbatch_mwalkers" More...
const std::string &	currentMainRoot () const noexcept
	returns the projectmain of the project, the series id is incremented at every QMC section <project id="det_qmc_short_sdbatch_vmcbatch_mwalkers" series="0"> translate to project_main_ = "det_qmc_short_sdbatch_vmcbatch_mwalkers.s000" More...
const std::string &	nextRoot () const noexcept
	returns the nextroot of the project, the series id is incremented at every QMC section <project id="det_qmc_short_sdbatch_vmcbatch_mwalkers" series="0"> translate to project_main_ = "det_qmc_short_sdbatch_vmcbatch_mwalkers.s001" More...
bool	previousRoot (std::string &oldroot) const
	return the root of the previous sequence More...
int	getSeriesIndex () const noexcept
int	getMaxCPUSeconds () const noexcept
DriverVersion	getDriverVersion () const noexcept
bool	isComplex () const noexcept
const RuntimeOptions &	getRuntimeOptions () const noexcept

Static Private Member Functions
static DriverVersion	lookupDriverVersion (const std::string &enum_value)

Private Attributes
std::string	title_
	title of the project More...
std::string	host_
	name of the host where the job is running More...
std::string	date_
	date when the job is executed More...
std::string	project_main_
	main root for all the output engines More...
std::string	project_root_
	processor-dependent root for all the output engines More...
std::string	next_root_
	root for the next run More...
int	series_
	series index More...
Communicate *	my_comm_
	communicator More...
xmlNodePtr	cur_
	the xml node for <Project> More...
int	max_cpu_secs_
	max cpu seconds More...
DriverVersion	driver_version_
RuntimeOptions	runtime_options_

Static Private Attributes
static const std::unordered_map< std::string, DriverVersion >	lookup_input_enum_value

Detailed Description

class ProjectData

Encapsulate data for a project

Default: title_ = getDateAndTime("%Y%m%dT%H%M")

Todo:

This shouldn't contain MPI information it is only used to calculate the path information and the communication parameters should just be input params to that call.

This reduce the internal state.

Definition at line 36 of file ProjectData.h.

Member Enumeration Documentation

DriverVersion

enum DriverVersion

strong

Enum for global scope switch of design from legacy driver based to batch driver based.

This effects more than just which drivers are used. Currently it just effects the meaning of qmc section vmc, dmc, linear name attributes.

Enumerator
LEGACY
BATCH

Definition at line 43 of file ProjectData.h.

  {
    LEGACY,
    BATCH
  };

Constructor & Destructor Documentation

ProjectData()

ProjectData	(	const std::string &	atitle = "",
		ProjectData::DriverVersion	driver_version = DriverVersion::LEGACY
	)

constructor

Definition at line 35 of file ProjectData.cpp.

References OHMMS::Controller, getDateAndTime(), ProjectData::my_comm_, and ProjectData::title_.

    : title_(atitle),
      host_("none"),
      date_("none"),
      series_(0),
      cur_(NULL),
      max_cpu_secs_(360000),
      driver_version_(driver_version),
      runtime_options_(RuntimeOptions())
{
  my_comm_ = OHMMS::Controller;
  if (title_.empty())
    title_ = getDateAndTime("%Y%m%dT%H%M");
}

Member Function Documentation

advance()

void advance

(

)

increment a series number and reset project_root_

Definition at line 81 of file ProjectData.cpp.

References ProjectData::reset(), and ProjectData::series_.

Referenced by QMCMain::runQMC().

{
  series_++;
  reset();
}

currentMainRoot()

const std::string & currentMainRoot ( ) const

noexcept

returns the projectmain of the project, the series id is incremented at every QMC section <project id="det_qmc_short_sdbatch_vmcbatch_mwalkers" series="0"> translate to project_main_ = "det_qmc_short_sdbatch_vmcbatch_mwalkers.s000"

Definition at line 253 of file ProjectData.cpp.

References ProjectData::project_main_.

Referenced by QMCMain::execute(), QMCDriverNew::get_root_name(), QMCMain::runQMC(), and QMCAppBase::saveXml().

{ return project_main_; }

get()

bool get

(

std::ostream &

os

)

const

Definition at line 52 of file ProjectData.cpp.

References getDateAndTime(), ProjectData::host_, and ProjectData::title_.

Referenced by QMCMain::validateXML().

{
  os << "  Project = " << title_ << "\n";
  os << "  date    = " << getDateAndTime("%Y-%m-%d %H:%M:%S %Z\n");
  os << "  host    = " << host_ << "\n";
  return true;
}

getDriverVersion()

ProjectData::DriverVersion getDriverVersion ( ) const

noexcept

Definition at line 261 of file ProjectData.cpp.

References ProjectData::driver_version_.

Referenced by QMCDriverFactory::readSection(), and qmcplusplus::TEST_CASE().

{ return driver_version_; }

getMaxCPUSeconds()

int getMaxCPUSeconds ( ) const

noexcept

Definition at line 259 of file ProjectData.cpp.

References ProjectData::max_cpu_secs_.

Referenced by VMCBatched::run(), and DMCBatched::run().

{ return max_cpu_secs_; }

getRuntimeOptions()

const RuntimeOptions & getRuntimeOptions ( ) const

noexcept

Definition at line 265 of file ProjectData.cpp.

References ProjectData::runtime_options_.

Referenced by SetupPools::SetupPools(), qmcplusplus::TEST_CASE(), qmcplusplus::test_hcpBe_rotation(), and VMCBatchedTest::testCalcDefaultLocalWalkers().

{ return runtime_options_; }

getSeriesIndex()

int getSeriesIndex ( ) const

noexcept

Definition at line 257 of file ProjectData.cpp.

References ProjectData::series_.

Referenced by VMCBatched::run(), and qmcplusplus::TEST_CASE().

{ return series_; }

getTitle()

const std::string & getTitle ( ) const

noexcept

returns the title of the project <project id="det_qmc_short_sdbatch_vmcbatch_mwalkers" series="0"> translate to title_ = "det_qmc_short_sdbatch_vmcbatch_mwalkers"

Definition at line 251 of file ProjectData.cpp.

References ProjectData::title_.

Referenced by QMCAppBase::getTitle(), VMCBatched::run(), DMCBatched::run(), and qmcplusplus::TEST_CASE().

{ return title_; }

isComplex()

bool isComplex ( ) const

noexcept

Definition at line 263 of file ProjectData.cpp.

References RuntimeOptions::is_complex, and ProjectData::runtime_options_.

Referenced by QMCMain::QMCMain(), and qmcplusplus::TEST_CASE().

{ return runtime_options_.is_complex; }

lookupDriverVersion()

ProjectData::DriverVersion lookupDriverVersion ( const std::string &  enum_value )

staticprivate

Definition at line 268 of file ProjectData.cpp.

References ProjectData::lookup_input_enum_value, and qmcplusplus::lowerCase().

Referenced by ProjectData::put().

{
  std::string enum_value_str(lowerCase(enum_value));
  try
  {
    return lookup_input_enum_value.at(enum_value_str);
  }
  catch (std::out_of_range& oor_exc)
  {
    throw UniformCommunicateError("bad_enum_tag_value: " + enum_value_str);
  }
}

nextRoot()

const std::string & nextRoot ( ) const

noexcept

returns the nextroot of the project, the series id is incremented at every QMC section <project id="det_qmc_short_sdbatch_vmcbatch_mwalkers" series="0"> translate to project_main_ = "det_qmc_short_sdbatch_vmcbatch_mwalkers.s001"

Definition at line 255 of file ProjectData.cpp.

References ProjectData::next_root_.

{ return next_root_; }

previousRoot()

bool previousRoot

(

std::string &

oldroot

)

const

return the root of the previous sequence

Parameters

oldroot

is composed by the title_ and series_

Definition at line 158 of file ProjectData.cpp.

References Communicate::getGroupID(), QMCState::mpi_groups, ProjectData::my_comm_, qmcplusplus::qmc_common, Communicate::rank(), ProjectData::series_, Communicate::size(), and ProjectData::title_.

{
  oldroot.clear();
  if (series_)
  {
    //int nproc_g = OHMMS::Controller->size();
    int nproc    = my_comm_->size();
    int nodeid   = my_comm_->rank();
    int groupid  = my_comm_->getGroupID();
    bool no_gtag = (qmc_common.mpi_groups == 1);
    std::array<char, 128> fileroot;
    int file_len{0};
    if (no_gtag)
    {
      if (nproc > 1)
        file_len = std::snprintf(fileroot.data(), fileroot.size(), ".s%03d.p%03d", series_ - 1, nodeid);
      else
        file_len = std::snprintf(fileroot.data(), fileroot.size(), ".s%03d", series_ - 1);
    }
    else
    {
      if (nproc > 1)
        file_len = std::snprintf(fileroot.data(), fileroot.size(), ".g%03d.s%03d.p%03d", groupid, series_ - 1, nodeid);
      else
        file_len = std::snprintf(fileroot.data(), fileroot.size(), ".g%03d.s%03d", groupid, series_ - 1);
    }
    if (file_len < 0)
      throw std::runtime_error("Error generating olfroot");
    oldroot = title_;
    oldroot.append(fileroot.data(), file_len);
    return true;
  }
  else
  {
    return false;
  }
}

put() [1/2]

bool put

(

std::istream &

is

)

Definition at line 60 of file ProjectData.cpp.

References ProjectData::date_, ProjectData::host_, ProjectData::reset(), ProjectData::series_, and ProjectData::title_.

Referenced by qmcplusplus::TEST_CASE(), and QMCMain::validateXML().

{
  std::string t1;
  while (!is.eof())
  {
    if (isdigit(t1[0]))
      series_ = atoi(t1.c_str());
    is >> t1;
    if (t1 == "series")
      is >> series_;
    else if (t1 == "host")
      is >> host_;
    else if (t1 == "date")
      is >> date_;
    else
      title_ = t1;
  }
  reset();
  return true;
}

put() [2/2]

bool put

(

xmlNodePtr

cur

)

first, overwrite the existing xml nodes

second, add xml nodes, if missing

Definition at line 196 of file ProjectData.cpp.

References ParameterSet::add(), ProjectData::cur_, ProjectData::date_, ProjectData::driver_version_, getDateAndTime(), getHostName(), getXMLAttributeValue(), ProjectData::host_, ProjectData::lookupDriverVersion(), ProjectData::max_cpu_secs_, ParameterSet::put(), ProjectData::reset(), ProjectData::series_, XMLNodeString::setXMLNodeContent(), and ProjectData::title_.

{
  cur_   = cur;
  title_ = getXMLAttributeValue(cur, "id");
  const std::string series_str(getXMLAttributeValue(cur, "series"));
  if (!series_str.empty())
    series_ = std::stoi(series_str);

  std::string driver_version_str;
  ParameterSet m_param;
  m_param.add(max_cpu_secs_, "max_seconds");
  m_param.add(driver_version_str, "driver_version");
  m_param.put(cur);

  if (!driver_version_str.empty())
    driver_version_ = lookupDriverVersion(driver_version_str);

  ///first, overwrite the existing xml nodes
  cur = cur->xmlChildrenNode;
  while (cur != NULL)
  {
    std::string cname((const char*)(cur->name));
    if (cname == "user")
    {
      // Removed
    }
    if (cname == "host")
    {
      host_ = getHostName();
      const XMLNodeString node_string(host_);
      node_string.setXMLNodeContent(cur);
    }
    if (cname == "date")
    {
      date_ = getDateAndTime();
      const XMLNodeString node_string(date_);
      node_string.setXMLNodeContent(cur);
    }
    cur = cur->next;
  }
  ///second, add xml nodes, if missing
  if (host_ == "none")
  {
    host_ = getHostName();
    xmlNewChild(cur_, cur_->ns, (const xmlChar*)"host", (const xmlChar*)(host_.c_str()));
  }
  if (date_ == "none")
  {
    date_ = getDateAndTime();
    xmlNewChild(cur_, cur_->ns, (const xmlChar*)"date", (const xmlChar*)(date_.c_str()));
  }
  reset();
  return true;
}

reset()

void reset

(

)

Construct the root name with title_ and m_series.

Definition at line 97 of file ProjectData.cpp.

References ProjectData::cur_, Communicate::getGroupID(), QMCState::mpi_groups, ProjectData::my_comm_, ProjectData::next_root_, ProjectData::project_main_, ProjectData::project_root_, qmcplusplus::qmc_common, Communicate::rank(), qmcplusplus::Units::time::s, ProjectData::series_, Communicate::setName(), Communicate::size(), and ProjectData::title_.

Referenced by ProjectData::advance(), ProjectData::put(), ProjectData::rewind(), and QMCMain::validateXML().

{
  //int nproc_g = OHMMS::Controller->size();
  int nproc   = my_comm_->size();
  int nodeid  = my_comm_->rank();
  int groupid = my_comm_->getGroupID();
  std::array<char, 256> fileroot;
  std::array<char, 256> nextroot;

  bool no_gtag = (qmc_common.mpi_groups == 1);
  int file_len{0};
  if (no_gtag) //qnproc_g == nproc)
    file_len = std::snprintf(fileroot.data(), fileroot.size(), "%s.s%03d", title_.c_str(), series_);
  else
    file_len = std::snprintf(fileroot.data(), fileroot.size(), "%s.g%03d.s%03d", title_.c_str(), groupid, series_);

  project_main_ = std::string(fileroot.data(), file_len);
  //set the communicator name
  my_comm_->setName(fileroot.data(), file_len);
  int next_len{0};
  if (no_gtag)
  {
    if (nproc > 1)
    {
      file_len = std::snprintf(fileroot.data(), fileroot.size(), ".s%03d.p%03d", series_, nodeid);
      next_len = std::snprintf(nextroot.data(), nextroot.size(), ".s%03d.p%03d", series_ + 1, nodeid);
    }
    else
    {
      file_len = std::snprintf(fileroot.data(), fileroot.size(), ".s%03d", series_);
      next_len = std::snprintf(nextroot.data(), nextroot.size(), ".s%03d", series_ + 1);
    }
  }
  else
  {
    if (nproc > 1)
    {
      file_len = std::snprintf(fileroot.data(), fileroot.size(), ".g%03d.s%03d.p%03d", groupid, series_, nodeid);
      next_len = std::snprintf(nextroot.data(), nextroot.size(), ".g%03d.s%03d.p%03d", groupid, series_ + 1, nodeid);
    }
    else
    {
      file_len = std::snprintf(fileroot.data(), fileroot.size(), ".g%03d.s%03d", groupid, series_);
      next_len = std::snprintf(nextroot.data(), nextroot.size(), ".g%03d.s%03d", groupid, series_ + 1);
    }
  }
  if (file_len < 0)
    throw std::runtime_error("Error generating project_root");
  if (next_len < 0)
    throw std::runtime_error("Error generating next_root");

  project_root_ = title_;
  project_root_.append(fileroot.data(), file_len);
  next_root_ = title_;
  next_root_.append(nextroot.data(), next_len);
  std::stringstream s;
  s << series_ + 1;
  if (cur_)
    xmlSetProp(cur_, (const xmlChar*)"series", (const xmlChar*)(s.str().c_str()));
}

rewind()

void rewind

(

)

roll-back a series number and reset project_root_ by one

Definition at line 87 of file ProjectData.cpp.

References ProjectData::reset(), and ProjectData::series_.

{
  if (series_ > 0)
    series_--;
  reset();
}

setCommunicator()

void setCommunicator

(

Communicate *

c

)

Definition at line 50 of file ProjectData.cpp.

References ProjectData::my_comm_.

Referenced by QMCMain::validateXML().

{ my_comm_ = c; }

Member Data Documentation

cur_

xmlNodePtr cur_

private

the xml node for <Project>

Definition at line 141 of file ProjectData.h.

Referenced by ProjectData::put(), and ProjectData::reset().

date_

std::string date_

private

date when the job is executed

Definition at line 123 of file ProjectData.h.

Referenced by ProjectData::put().

driver_version_

DriverVersion driver_version_

private

Definition at line 147 of file ProjectData.h.

Referenced by ProjectData::getDriverVersion(), and ProjectData::put().

host_

std::string host_

private

name of the host where the job is running

Definition at line 120 of file ProjectData.h.

Referenced by ProjectData::get(), and ProjectData::put().

lookup_input_enum_value

const std::unordered_map<std::string, DriverVersion> lookup_input_enum_value

inlinestaticprivate

Initial value:

{{"legacy",
                                                                                              DriverVersion::LEGACY},
                                                                                             {"batch",
                                                                                              DriverVersion::BATCH},
                                                                                             {"batched",
                                                                                              DriverVersion::BATCH}

  }

Definition at line 50 of file ProjectData.h.

Referenced by ProjectData::lookupDriverVersion().

max_cpu_secs_

int max_cpu_secs_

private

max cpu seconds

Definition at line 144 of file ProjectData.h.

Referenced by ProjectData::getMaxCPUSeconds(), and ProjectData::put().

my_comm_

Communicate* my_comm_

private

communicator

Definition at line 138 of file ProjectData.h.

Referenced by ProjectData::previousRoot(), ProjectData::ProjectData(), ProjectData::reset(), and ProjectData::setCommunicator().

next_root_

std::string next_root_

private

root for the next run

Definition at line 132 of file ProjectData.h.

Referenced by ProjectData::nextRoot(), and ProjectData::reset().

project_main_

std::string project_main_

private

main root for all the output engines

Definition at line 126 of file ProjectData.h.

Referenced by ProjectData::currentMainRoot(), and ProjectData::reset().

project_root_

std::string project_root_

private

processor-dependent root for all the output engines

Definition at line 129 of file ProjectData.h.

Referenced by ProjectData::reset().

runtime_options_

RuntimeOptions runtime_options_

private

Definition at line 150 of file ProjectData.h.

Referenced by ProjectData::getRuntimeOptions(), and ProjectData::isComplex().

series_

int series_

private

series index

Definition at line 135 of file ProjectData.h.

Referenced by ProjectData::advance(), ProjectData::getSeriesIndex(), ProjectData::previousRoot(), ProjectData::put(), ProjectData::reset(), and ProjectData::rewind().

title_

std::string title_

private

title of the project

Definition at line 117 of file ProjectData.h.

Referenced by ProjectData::get(), ProjectData::getTitle(), ProjectData::previousRoot(), ProjectData::ProjectData(), ProjectData::put(), and ProjectData::reset().

---

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

• /home/pk7/projects/qmc/for_cron_doxygen/qmcpack/src/Utilities/ProjectData.h
• /home/pk7/projects/qmc/for_cron_doxygen/qmcpack/src/Utilities/ProjectData.cpp