MADNESS 0.10.1
madness::RestartPlan Struct Reference

the decision: one source, one starting rung, one reason More...

#include <RestartPlan.h>

Public Member Functions

bool needs_load () const
 true if orbitals have to be read from disk before anything else happens
std::string print_to_string () const
template<typename Archive>
void serialize (Archive &ar)
 serialization, so the plan can be decided on one rank and broadcast

Public Attributes

bool archive_converged = false
std::size_t archive_nmo_alpha = 0
bool archive_same_hamiltonian = false
bool iterate = true
 false means "return what is on disk without solving anything"
RestartMode mode = RestartMode::automatic
 what was asked for
std::size_t protocol_start = 0
 rung of protocol() to start at; rungs below it are already covered
RestartSource source = RestartSource::initial_guess
double stale_energy = 1.e10
 energy from the archive, meaningful only when iterate==false
bool warn = false
std::string why
 one line, for the log and for the results json

Detailed Description

the decision: one source, one starting rung, one reason

Member Function Documentation

◆ needs_load()

bool madness::RestartPlan::needs_load ( ) const
inline

true if orbitals have to be read from disk before anything else happens

References madness::initial_guess, and source.

Referenced by madness::SCF::get_initial_orbitals(), and madness::Nemo::value().

◆ print_to_string()

std::string madness::RestartPlan::print_to_string ( ) const
inline

◆ serialize()

template<typename Archive>
void madness::RestartPlan::serialize ( Archive & ar)
inline

serialization, so the plan can be decided on one rank and broadcast

References archive_converged, archive_nmo_alpha, archive_same_hamiltonian, iterate, m, mode, protocol_start, source, stale_energy, warn, and why.

Member Data Documentation

◆ archive_converged

bool madness::RestartPlan::archive_converged = false

when source is restartdata: the header records a convergence at some rung, and its eprec, xc and nuclear correlation factor agree with this run's

Referenced by madness::plan_restart(), serialize(), and madness::MolecularEnergy::value().

◆ archive_nmo_alpha

std::size_t madness::RestartPlan::archive_nmo_alpha = 0

alpha orbitals the archive holds when source is restartdata, 0 when unknown. Fewer than requested means the missing virtuals start from the atomic guess.

Referenced by madness::plan_restart(), serialize(), and madness::MolecularEnergy::value().

◆ archive_same_hamiltonian

bool madness::RestartPlan::archive_same_hamiltonian = false

◆ iterate

bool madness::RestartPlan::iterate = true

◆ mode

◆ protocol_start

std::size_t madness::RestartPlan::protocol_start = 0

rung of protocol() to start at; rungs below it are already covered

Referenced by madness::SCF::get_initial_orbitals(), madness::plan_restart(), print_to_string(), serialize(), madness::MolecularEnergy::value(), and madness::Nemo::value().

◆ source

◆ stale_energy

double madness::RestartPlan::stale_energy = 1.e10

energy from the archive, meaningful only when iterate==false

Referenced by madness::plan_restart(), serialize(), madness::MolecularEnergy::value(), and madness::Nemo::value().

◆ warn

bool madness::RestartPlan::warn = false

true if this decision should be logged as a WARNING rather than as info

Two cases: a file was there but could not be used (silently recomputing would hide a disk fault or a wrong prefix), and read_only handing back an energy that does not meet the requested precision.

Referenced by madness::make_restart_plan(), madness::plan_restart(), and serialize().

◆ why

std::string madness::RestartPlan::why

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