MADNESS 0.10.1
madness::QCCalculationParametersBase Class Referenceabstract

class for holding the parameters for calculation More...

#include <QCCalculationParametersBase.h>

Inheritance diagram for madness::QCCalculationParametersBase:

Public Types

using all_parameter_types
using all_parameter_types

Public Member Functions

virtual std::set< std::string > case_sensitive_keys () const
 keys whose string values must NOT be case-folded
virtual std::set< std::string > case_sensitive_keys () const
 keys whose string values must NOT be case-folded
bool file_exists (World &world, std::string filename) const
bool file_exists (World &world, std::string filename) const
void from_json (const json &j)
void from_json (const json &j)
template<typename T>
T get (const std::string key) const
template<typename T>
T get (const std::string key) const
ParameterContainerT get_all_parameters () const
ParameterContainerT get_all_parameters () const
QCParameter & get_parameter (const std::string key)
QCParameter & get_parameter (const std::string key)
virtual std::string get_tag () const =0
virtual std::string get_tag () const =0
hashT hash () const
hashT hash () const
bool is_user_defined (std::string key) const
bool is_user_defined (std::string key) const
bool keeps_case (const std::string &key) const
bool keeps_case (const std::string &key) const
bool parameter_exists (const std::string &key) const
bool parameter_exists (const std::string &key) const
void print (const std::string header="", const std::string footer="") const
 print all parameters
void print (const std::string header="", const std::string footer="") const
 print all parameters
std::string print_to_string (const std::list< std::string > precedences={"all"}) const
std::string print_to_string (const std::list< std::string > precedences={"all"}) const
template<typename... Types>
void qcparameter_to_json (json &j, const std::pair< std::string, QCParameter > &p, const std::tuple< Types... > &) const
template<typename... Types>
void qcparameter_to_json (json &j, const std::pair< std::string, QCParameter > &p, const std::tuple< Types... > &) const
template<typename Tuple>
void qcparameter_to_json_from_tuple (json &j, const std::pair< std::string, QCParameter > &p, const Tuple &) const
template<typename Tuple>
void qcparameter_to_json_from_tuple (json &j, const std::pair< std::string, QCParameter > &p, const Tuple &) const
void read_commandline_options (World &world, const commandlineparser &parser, const std::string tag)
 read the parameters from the command line and broadcast
void read_commandline_options (World &world, const commandlineparser &parser, const std::string tag)
virtual void read_internal (World &world, std::string &filecontents, std::string tag)
 read the stream, starting from tag
virtual void read_internal (World &world, std::string &filecontents, std::string tag)
 read the stream, starting from tag
template<typename Archive>
void serialize (Archive &ar)
template<typename Archive>
void serialize (Archive &ar)
template<typename T>
void set_derived_value (const std::string &key, const T &value)
template<typename T>
void set_derived_value (const std::string &key, const T &value)
template<typename T>
void set_user_defined_value (const std::string &key, const T &value)
template<typename T>
void set_user_defined_value (const std::string &key, const T &value)
json to_json () const
 convert all parameters to a json object
json to_json () const
 convert all parameters to a json object
void to_json (json &j) const
 convert all parameters to a json object
void to_json (json &j) const
 convert all parameters to a json object
json to_json_if_precedence (const std::string &precedence) const
 convert all parameters to a json object, but only those with a given precedence
json to_json_if_precedence (const std::string &precedence) const
 convert all parameters to a json object, but only those with a given precedence
template<typename T>
std::string to_stored_string (const std::string &key, const T &value) const
 stringify value for storage, honoring case_sensitive_keys()
template<typename T>
std::string to_stored_string (const std::string &key, const T &value) const
 stringify value for storage, honoring case_sensitive_keys()
template<typename... Types>
bool try_set_from_json (QCParameter &parameter, const nlohmann::json &value)
template<typename... Types>
bool try_set_from_json (QCParameter &parameter, const nlohmann::json &value)

Static Public Member Functions

static std::string add_quotes (const std::string arg)
static std::string add_quotes (const std::string arg)
template<typename T>
static bool check_type (const std::string key, const QCParameter &parameter)
template<typename T>
static bool check_type (const std::string key, const QCParameter &parameter)
template<typename T>
static bool check_type_silent (const QCParameter &parameter)
template<typename T>
static bool check_type_silent (const QCParameter &parameter)
template<typename T>
static std::enable_if< std::is_same< T, bool >::value, T >::type fromstring (const std::string &arg)
template<typename T>
static std::enable_if<!std::is_same< T, bool >::value, T >::type fromstring (const std::string &arg)
template<typename T>
static std::enable_if< std::is_same< T, bool >::value, T >::type fromstring (const std::string &arg)
template<typename T>
static std::enable_if<!std::is_same< T, bool >::value, T >::type fromstring (const std::string &arg)
template<typename T>
static std::enable_if<!std::is_floating_point< T >::value, void >::type overwrite_if_inf (std::string &str, const T &arg)
template<typename T>
static std::enable_if< std::is_floating_point< T >::value, void >::type overwrite_if_inf (std::string &str, const T &arg)
template<typename T>
static std::enable_if<!std::is_floating_point< T >::value, void >::type overwrite_if_inf (std::string &str, const T &arg)
template<typename T>
static std::enable_if< std::is_floating_point< T >::value, void >::type overwrite_if_inf (std::string &str, const T &arg)
template<typename T>
static std::enable_if<!std::is_same< T, std::string >::value, T >::type read_quotes (std::stringstream &ssvalue)
template<typename T>
static std::enable_if< std::is_same< T, std::string >::value, T >::type read_quotes (std::stringstream &ssvalue)
template<typename T>
static std::enable_if<!std::is_same< T, std::string >::value, T >::type read_quotes (std::stringstream &ssvalue)
template<typename T>
static std::enable_if< std::is_same< T, std::string >::value, T >::type read_quotes (std::stringstream &ssvalue)
static std::string tostring (const bool &arg)
static std::string tostring (const bool &arg)
template<typename T>
static std::string tostring (const T &arg)
template<typename T>
static std::string tostring (const T &arg)
static std::string trim_blanks (const std::string arg)
static std::string trim_blanks (const std::string arg)
static std::string trim_quotes (const std::string arg)
static std::string trim_quotes (const std::string arg)

Protected Types

typedef std::map< std::string, QCParameter > ParameterContainerT
typedef std::map< std::string, QCParameter > ParameterContainerT

Protected Member Functions

 QCCalculationParametersBase ()
 ctor for testing
 QCCalculationParametersBase ()
 ctor for testing
 QCCalculationParametersBase (const QCCalculationParametersBase &other)
 copy ctor
 QCCalculationParametersBase (const QCCalculationParametersBase &other)
 copy ctor
virtual ~QCCalculationParametersBase ()
 destructor
virtual ~QCCalculationParametersBase ()
 destructor
const QCParameter & get_parameter (const std::string &key) const
const QCParameter & get_parameter (const std::string &key) const
template<typename T>
void initialize (const std::string &key, const T &value, const std::string comment="", const std::vector< T > allowed_values={})
template<typename T>
void initialize (const std::string &key, const T &value, const std::string comment="", const std::vector< T > allowed_values={})
void read_input_and_commandline_options (World &world, const commandlineparser &parser, const std::string tag)
void read_input_and_commandline_options (World &world, const commandlineparser &parser, const std::string tag)
template<typename Tuple>
bool try_setting_any (const std::string &key, const std::string &value)
 helper function for try_setting_user_defined_value
template<typename Tuple>
bool try_setting_any (const std::string &key, const std::string &value)
 helper function for try_setting_user_defined_value
template<typename Tuple, std::size_t... I>
bool try_setting_any_impl (const std::string &key, const std::string &value, Tuple, std::index_sequence< I... >)
 helper function for try_setting_user_defined_value
template<typename Tuple, std::size_t... I>
bool try_setting_any_impl (const std::string &key, const std::string &value, Tuple, std::index_sequence< I... >)
 helper function for try_setting_user_defined_value
template<typename T>
bool try_setting_user_defined_value (const std::string &key, const std::string &val)
 helper function for try_setting_user_defined_value
template<typename T>
bool try_setting_user_defined_value (const std::string &key, const std::string &val)
 helper function for try_setting_user_defined_value

Protected Attributes

bool ignore_unknown_keys = true
bool ignore_unknown_keys_silently = false
ParameterContainerT parameters
bool print_debug = false
bool throw_if_datagroup_not_found = false

Private Member Functions

void read_input (World &world, const std::string filename, const std::string tag)
 read the parameters from file
void read_input (World &world, const std::string filename, const std::string tag)
 read the parameters from file

Friends

bool operator== (const QCCalculationParametersBase &p1, const QCCalculationParametersBase &p2)
bool operator== (const QCCalculationParametersBase &p1, const QCCalculationParametersBase &p2)

Detailed Description

class for holding the parameters for calculation

Actual parameter classes will be derived from this class with a simple constructor (see test_QCCalculationParametersBase.cc for an example) and convenience getters for the parameters of each parameter class. Having the base class will allow consistent parameter input/output handling for all madness programs and reuse of the parsing methods. Even if the same parameter is used in different programs, default might differ (i.e. econv for 3D/6D calculations). The parameter class will effectively serve as a factory for the calculation classes (SCF, nemo, mp2, etc)

parameters are kept in a map with key (string) and value (QCParameter), types are converted whenever a parameter is accessed (i.e. should not be done too frequently in an inner loop)

Member Typedef Documentation

◆ all_parameter_types [1/2]

Initial value:
std::tuple<
double, int, unsigned int, long, std::size_t, bool, std::string,
std::vector<double>, std::vector<int>, std::vector<std::size_t>,
std::vector<std::string>, std::pair<std::string, double>>

◆ all_parameter_types [2/2]

Initial value:
std::tuple<
double, int, unsigned int, long, std::size_t, bool, std::string,
std::vector<double>, std::vector<int>, std::vector<std::size_t>,
std::vector<std::string>, std::pair<std::string, double>>

◆ ParameterContainerT [1/2]

◆ ParameterContainerT [2/2]

Constructor & Destructor Documentation

◆ QCCalculationParametersBase() [1/4]

◆ QCCalculationParametersBase() [2/4]

madness::QCCalculationParametersBase::QCCalculationParametersBase ( const QCCalculationParametersBase & other)
inlineprotected

◆ ~QCCalculationParametersBase() [1/2]

virtual madness::QCCalculationParametersBase::~QCCalculationParametersBase ( )
inlineprotectedvirtual

destructor

◆ QCCalculationParametersBase() [3/4]

madness::QCCalculationParametersBase::QCCalculationParametersBase ( )
inlineprotected

ctor for testing

◆ QCCalculationParametersBase() [4/4]

madness::QCCalculationParametersBase::QCCalculationParametersBase ( const QCCalculationParametersBase & other)
inlineprotected

◆ ~QCCalculationParametersBase() [2/2]

virtual madness::QCCalculationParametersBase::~QCCalculationParametersBase ( )
inlineprotectedvirtual

destructor

Member Function Documentation

◆ add_quotes() [1/2]

std::string madness::QCCalculationParametersBase::add_quotes ( const std::string arg)
inlinestatic

References madness::arg().

Referenced by get().

◆ add_quotes() [2/2]

std::string madness::QCCalculationParametersBase::add_quotes ( const std::string arg)
inlinestatic

References madness::arg().

◆ case_sensitive_keys() [1/2]

virtual std::set< std::string > madness::QCCalculationParametersBase::case_sensitive_keys ( ) const
inlinevirtual

keys whose string values must NOT be case-folded

String parameter values are lowercased on the way in so that enum-like knobs match their lowercased allowed_values (xc=HF, units=Bohr). That is wrong for free-form values such as paths and filenames, which are case-sensitive on the filesystem. Derived classes list those keys here and they are then stored verbatim – the parameter-store analogue of commandlineparser::set_keyval_keep_case.

Reimplemented in madness::Molecule::GeometryParameters.

Referenced by keeps_case().

◆ case_sensitive_keys() [2/2]

virtual std::set< std::string > madness::QCCalculationParametersBase::case_sensitive_keys ( ) const
inlinevirtual

keys whose string values must NOT be case-folded

String parameter values are lowercased on the way in so that enum-like knobs match their lowercased allowed_values (xc=HF, units=Bohr). That is wrong for free-form values such as paths and filenames, which are case-sensitive on the filesystem. Derived classes list those keys here and they are then stored verbatim – the parameter-store analogue of commandlineparser::set_keyval_keep_case.

Reimplemented in madness::Molecule::GeometryParameters.

◆ check_type() [1/2]

template<typename T>
bool madness::QCCalculationParametersBase::check_type ( const std::string key,
const QCParameter & parameter )
inlinestatic

◆ check_type() [2/2]

template<typename T>
bool madness::QCCalculationParametersBase::check_type ( const std::string key,
const QCParameter & parameter )
inlinestatic

◆ check_type_silent() [1/2]

template<typename T>
bool madness::QCCalculationParametersBase::check_type_silent ( const QCParameter & parameter)
inlinestatic

◆ check_type_silent() [2/2]

template<typename T>
bool madness::QCCalculationParametersBase::check_type_silent ( const QCParameter & parameter)
inlinestatic

◆ file_exists() [1/2]

bool madness::QCCalculationParametersBase::file_exists ( World & world,
std::string filename ) const

◆ file_exists() [2/2]

bool madness::QCCalculationParametersBase::file_exists ( World & world,
std::string filename ) const

References madness::filename.

◆ from_json() [1/2]

void madness::QCCalculationParametersBase::from_json ( const json & j)
inline

◆ from_json() [2/2]

void madness::QCCalculationParametersBase::from_json ( const json & j)
inline

◆ fromstring() [1/4]

template<typename T>
std::enable_if< std::is_same< T, bool >::value, T >::type madness::QCCalculationParametersBase::fromstring ( const std::string & arg)
inlinestatic

References madness::arg(), and errmsg().

◆ fromstring() [2/4]

template<typename T>
std::enable_if<!std::is_same< T, bool >::value, T >::type madness::QCCalculationParametersBase::fromstring ( const std::string & arg)
inlinestatic

◆ fromstring() [3/4]

template<typename T>
std::enable_if< std::is_same< T, bool >::value, T >::type madness::QCCalculationParametersBase::fromstring ( const std::string & arg)
inlinestatic

References madness::arg(), and errmsg().

◆ fromstring() [4/4]

template<typename T>
std::enable_if<!std::is_same< T, bool >::value, T >::type madness::QCCalculationParametersBase::fromstring ( const std::string & arg)
inlinestatic

◆ get() [1/2]

template<typename T>
T madness::QCCalculationParametersBase::get ( const std::string key) const
inline

References add_quotes(), check_type(), fromstring(), get_parameter(), madness::QCParameter::get_value(), and MADNESS_ASSERT.

Referenced by madness::OEP::OEP(), madness::OEP::OEP(), madness::F12Parameters::abs_c(), madness::F12Parameters::abs_u(), madness::PNOParameters::active_pairs_of_orbital(), madness::PNOParameters::adaptive_solver(), DiracParameters::ansatz(), madness::CalculationParameters::aobasis(), madness::CalculationParameters::aocc(), madness::PCMParameters::area(), madness::F12Parameters::auxbas_file(), madness::CalculationParameters::bocc(), madness::Nemo_complex_Parameters::box(), madness::CalculationParameters::bsh_apply(), madness::F12Parameters::cabs_thresh(), madness::CCParameters::calc_type(), madness::PNOParameters::canonicalize_pno(), madness::PCMParameters::cavity_type(), madness::MolecularOptimizationParameters::cg_method(), DiracParameters::charge(), madness::CalculationParameters::charge(), madness::PNOParameters::chunk(), madness::PNOParameters::cispd(), MemoryParameters::cloud_distribution(), MemoryParameters::cloud_storage(), madness::CalculationParameters::converge_bsh_residual(), madness::CalculationParameters::converge_density(), madness::CalculationParameters::converge_each_energy(), madness::CalculationParameters::converge_total_energy(), madness::Molecule::GeometryParameters::core_type(), madness::PCMParameters::correction(), madness::CCParameters::cp_diagnostics(), Parameters::criteria(), madness::TDHFParameters::damping_width(), madness::CalculationParameters::dconv(), madness::Complex_CIS_Parameters::dconv(), madness::MP2::Parameters::dconv(), madness::PNOParameters::dconv(), madness::TDHFParameters::dconv(), Parameters::dconv(), madness::CCParameters::dconv_3D(), madness::CCParameters::dconv_6D(), madness::CCParameters::debug(), madness::PNOParameters::debug(), madness::TDHFParameters::debug(), madness::CCParameters::decompose_Q(), madness::OEP_Parameters::dens_thresh_hi(), madness::OEP_Parameters::dens_thresh_inv(), madness::OEP_Parameters::dens_thresh_lo(), madness::CalculationParameters::deriv(), madness::CalculationParameters::derivatives(), madness::CalculationParameters::dft_deriv(), madness::TDHFParameters::dft_deriv(), madness::PNOParameters::diagonal(), madness::CalculationParameters::dipole(), madness::CalculationParameters::dispersion(), madness::CalculationParameters::dispersion_atm(), madness::CalculationParameters::dispersion_functional(), madness::CCParameters::dmin(), madness::TDHFParameters::do_oep(), madness::CalculationParameters::econv(), madness::CCParameters::econv(), madness::MP2::Parameters::econv(), madness::TDHFParameters::econv(), Parameters::econv(), madness::PNOParameters::econv_macro(), madness::PNOParameters::econv_micro(), madness::CCParameters::econv_pairs(), madness::PNOParameters::econv_pairs(), madness::F12Parameters::energytype(), madness::Molecule::GeometryParameters::eprec(), madness::PCMParameters::epsilon(), madness::PNOParameters::exchange(), madness::CCParameters::excitations(), madness::TDHFParameters::excitations(), madness::PNOParameters::exop(), madness::PNOParameters::exop_trigo(), madness::Complex_CIS_Parameters::exops(), madness::TDHFParameters::exops(), madness::Nemo_complex_Parameters::explicit_B(), madness::F12Parameters::f12(), madness::PNOParameters::f12(), madness::LowRankFunctionParameters::f12type(), madness::Molecule::GeometryParameters::field(), madness::CCParameters::freeze(), madness::Complex_CIS_Parameters::freeze(), madness::MP2::Parameters::freeze(), madness::PNOParameters::freeze(), madness::TDHFParameters::freeze(), madness::CalculationParameters::freeze_occupied(), madness::PNOParameters::freeze_pairs(), madness::PNOParameters::freeze_pairs_of_orbital(), madness::CCParameters::gamma(), madness::F12Parameters::gamma(), madness::LowRankFunctionParameters::gamma(), madness::MolecularOptimizationParameters::gradient_precision(), madness::LowRankFunctionParameters::gridtype(), madness::Nemo_complex_Parameters::guess(), madness::TDHFParameters::guess_cm(), madness::TDHFParameters::guess_dconv(), madness::TDHFParameters::guess_diag(), madness::TDHFParameters::guess_econv(), madness::Complex_CIS_Parameters::guess_excitation_operators(), madness::TDHFParameters::guess_excitation_operators(), madness::Complex_CIS_Parameters::guess_excitations(), madness::TDHFParameters::guess_excitations(), madness::Nemo_complex_Parameters::guess_functions(), madness::Complex_CIS_Parameters::guess_maxiter(), madness::TDHFParameters::guess_maxiter(), madness::PNOParameters::guesstype(), madness::Nemo::NemoCalculationParameters::hessian(), madness::CalculationParameters::hfex_accumulation(), madness::CalculationParameters::hfex_cost_aware(), madness::CalculationParameters::hfex_granularity(), madness::CalculationParameters::hfexalg(), madness::MP2::Parameters::i(), madness::TDHFParameters::irrep(), madness::CCParameters::iter_max(), madness::CCParameters::iter_max_3D(), madness::CCParameters::iter_max_6D(), madness::TDHFParameters::iterating_excitations(), madness::MP2::Parameters::j(), madness::CalculationParameters::k(), madness::CCParameters::kain(), madness::PNOParameters::kain(), madness::OEP_Parameters::kain_param(), madness::CCParameters::kain_subspace(), madness::PNOParameters::kain_subspace(), madness::TDHFParameters::kain_subspace(), madness::CCParameters::kffk_algorithm(), madness::CCParameters::kffk_alpha(), madness::CCParameters::kffk_volume_element(), madness::CalculationParameters::L(), madness::OEP_Parameters::levelshift(), madness::LowRankFunctionParameters::lmax(), DiracParameters::lo(), madness::CalculationParameters::lo(), madness::CCParameters::lo(), madness::CalculationParameters::loadbalparts(), Parameters::local(), Parameters::localize(), madness::CalculationParameters::localize_method(), madness::CalculationParameters::maxiter(), madness::Complex_CIS_Parameters::maxiter(), madness::MolecularOptimizationParameters::maxiter(), madness::MP2::Parameters::maxiter(), madness::OEP_Parameters::maxiter(), madness::TDHFParameters::maxiter(), Parameters::maxiter(), madness::PNOParameters::maxiter_macro(), madness::PNOParameters::maxiter_micro(), madness::PNOParameters::maxiter_t(), madness::PNOParameters::maxrank(), madness::CalculationParameters::maxrotn(), madness::CalculationParameters::maxsub(), madness::MP2::Parameters::maxsub(), madness::CalculationParameters::memory(), MemoryParameters::memory_algorithm(), madness::PCMParameters::min_radius(), madness::OEP_Parameters::model(), madness::CalculationParameters::nalpha(), madness::CalculationParameters::nbeta(), madness::Nemo::NemoCalculationParameters::ncf(), Parameters::ncf(), madness::TDHFParameters::nexcitations(), madness::CalculationParameters::nmo_alpha(), madness::CalculationParameters::nmo_beta(), madness::CCParameters::no_compute(), madness::MP2::Parameters::no_compute(), madness::OEP_Parameters::no_compute(), madness::PNOParameters::no_compute(), madness::CCParameters::no_compute_cc2(), madness::CCParameters::no_compute_cispd(), madness::CCParameters::no_compute_gs(), madness::CCParameters::no_compute_lrcc2(), madness::CCParameters::no_compute_mp2(), madness::CCParameters::no_compute_mp2_constantpart(), madness::CCParameters::no_compute_response(), madness::PNOParameters::no_guess(), madness::PNOParameters::no_opt(), madness::PNOParameters::no_opt_in_first_iteration(), madness::Molecule::GeometryParameters::no_orient(), madness::CalculationParameters::nopen(), madness::PlotParameters::npoints(), DiracParameters::nstates(), DiracParameters::nucrad(), madness::CalculationParameters::nv_extra(), madness::CalculationParameters::nv_its(), madness::CalculationParameters::nv_step(), madness::CalculationParameters::nvalpha(), madness::CalculationParameters::nvbeta(), madness::CalculationParameters::nwfile(), madness::Complex_CIS_Parameters::omega(), madness::CCParameters::only_pair(), madness::PNOParameters::op_thresh(), madness::LowRankFunctionParameters::optimize(), madness::CalculationParameters::orbitalshift(), madness::PlotParameters::origin(), madness::CCParameters::output_prec(), madness::PNOParameters::partial_wave(), madness::CalculationParameters::pcm_data(), madness::Nemo_complex_Parameters::physical_B(), madness::PlotParameters::plane(), madness::CCParameters::plot(), madness::TDHFParameters::plot(), madness::CalculationParameters::plot_cell(), madness::CalculationParameters::pointgroup(), madness::CalculationParameters::population(), madness::CalculationParameters::population_basis(), madness::CalculationParameters::population_minbasis(), madness::Nemo_complex_Parameters::potential_radius(), madness::PNOParameters::predefined_guess(), madness::CalculationParameters::prefix(), madness::CalculationParameters::print_level(), madness::TDHFParameters::print_level(), madness::Complex_CIS_Parameters::printlevel(), madness::Nemo_complex_Parameters::printlevel(), madness::MolecularOptimizationParameters::printtest(), madness::PCMParameters::probe_radius(), madness::CalculationParameters::protocol(), madness::PNOParameters::protocol(), madness::Molecule::GeometryParameters::psp_calc(), madness::Molecule::GeometryParameters::pure_ae(), qcparameter_to_json(), madness::CCParameters::QtAnsatz(), madness::PCMParameters::radii_set(), madness::LowRankFunctionParameters::radius(), madness::PNOParameters::rank_increase(), madness::MP2::Parameters::read_and_set_derived_values(), Parameters::read_and_set_derived_values(), madness::MolecularOptimizationParameters::remove_dof(), madness::TDHFParameters::response_kernel(), madness::CalculationParameters::restart(), madness::CCParameters::restart(), madness::MP2::Parameters::restart(), madness::OEP_Parameters::restart(), madness::PNOParameters::restart(), madness::TDHFParameters::restart(), madness::CalculationParameters::restart_cphf(), madness::PCMParameters::restart_name(), madness::CalculationParameters::save(), madness::OEP_Parameters::save_iter_corrections(), madness::PNOParameters::save_pnos(), madness::OEP_Parameters::saving_amount(), madness::PCMParameters::scaling(), madness::CalculationParameters::set_derived_values(), madness::OEP_Parameters::set_derived_values(), madness::PNOParameters::set_derived_values(), madness::TDHFParameters::set_derived_values(), DiracParameters::shift(), madness::Nemo_complex_Parameters::shift(), madness::PCMParameters::solvent(), madness::PCMParameters::solver_type(), madness::Molecule::GeometryParameters::source_name(), madness::Molecule::GeometryParameters::source_type(), madness::CalculationParameters::spin_restricted(), madness::TDHFParameters::store_potential(), madness::Complex_CIS_Parameters::swap_ab(), madness::Molecule::GeometryParameters::symtol(), MemoryParameters::target_distribution(), madness::LowRankFunctionParameters::tempered(), madness::CCParameters::test(), test_lowrank_function(), madness::Complex_CIS_Parameters::thresh(), madness::MP2::Parameters::thresh(), madness::PNOParameters::thresh(), madness::TDHFParameters::thresh(), madness::CCParameters::thresh_3D(), madness::CCParameters::thresh_6D(), madness::CCParameters::thresh_bsh_3D(), madness::CCParameters::thresh_bsh_6D(), madness::CCParameters::thresh_f12(), madness::CCParameters::thresh_poisson(), madness::CCParameters::thresh_Ue(), madness::CCParameters::tight_thresh_3D(), madness::CCParameters::tight_thresh_6D(), madness::LowRankFunctionParameters::tol(), madness::MolecularOptimizationParameters::tol(), madness::PNOParameters::tpno(), madness::PNOParameters::tpno_tight(), madness::TDHFParameters::triplet(), madness::Molecule::GeometryParameters::units(), madness::MolecularOptimizationParameters::update(), DiracParameters::use_ble(), DiracParameters::use_bsp(), madness::Nemo_complex_Parameters::use_v_vector(), madness::MolecularOptimizationParameters::value_precision(), madness::CalculationParameters::vnucextra(), madness::LowRankFunctionParameters::volume_element(), madness::CalculationParameters::xc(), Parameters::xc(), madness::CalculationParameters::xc_weak_gga(), and madness::PlotParameters::zoom().

◆ get() [2/2]

template<typename T>
T madness::QCCalculationParametersBase::get ( const std::string key) const
inline

◆ get_all_parameters() [1/2]

ParameterContainerT madness::QCCalculationParametersBase::get_all_parameters ( ) const
inline

References parameters.

◆ get_all_parameters() [2/2]

ParameterContainerT madness::QCCalculationParametersBase::get_all_parameters ( ) const
inline

References parameters.

◆ get_parameter() [1/4]

◆ get_parameter() [2/4]

const QCParameter & madness::QCCalculationParametersBase::get_parameter ( const std::string & key) const
inlineprotected

References parameter_exists(), and parameters.

◆ get_parameter() [3/4]

QCParameter & madness::QCCalculationParametersBase::get_parameter ( const std::string key)
inline

◆ get_parameter() [4/4]

QCParameter & madness::QCCalculationParametersBase::get_parameter ( const std::string key)
inline

◆ get_tag() [1/2]

◆ get_tag() [2/2]

◆ hash() [1/2]

hashT madness::QCCalculationParametersBase::hash ( ) const
inline

◆ hash() [2/2]

hashT madness::QCCalculationParametersBase::hash ( ) const
inline

◆ initialize() [1/2]

◆ initialize() [2/2]

template<typename T>
void madness::QCCalculationParametersBase::initialize ( const std::string & key,
const T & value,
const std::string comment = "",
const std::vector< T > allowed_values = {} )
inlineprotected

◆ is_user_defined() [1/2]

◆ is_user_defined() [2/2]

bool madness::QCCalculationParametersBase::is_user_defined ( std::string key) const
inline

◆ keeps_case() [1/2]

bool madness::QCCalculationParametersBase::keeps_case ( const std::string & key) const
inline

References case_sensitive_keys().

Referenced by read_internal(), and to_stored_string().

◆ keeps_case() [2/2]

bool madness::QCCalculationParametersBase::keeps_case ( const std::string & key) const
inline

References case_sensitive_keys().

◆ overwrite_if_inf() [1/4]

template<typename T>
std::enable_if<!std::is_floating_point< T >::value, void >::type madness::QCCalculationParametersBase::overwrite_if_inf ( std::string & str,
const T & arg )
inlinestatic

References madness::arg().

◆ overwrite_if_inf() [2/4]

template<typename T>
std::enable_if< std::is_floating_point< T >::value, void >::type madness::QCCalculationParametersBase::overwrite_if_inf ( std::string & str,
const T & arg )
inlinestatic

◆ overwrite_if_inf() [3/4]

template<typename T>
std::enable_if<!std::is_floating_point< T >::value, void >::type madness::QCCalculationParametersBase::overwrite_if_inf ( std::string & str,
const T & arg )
inlinestatic

References madness::arg().

◆ overwrite_if_inf() [4/4]

template<typename T>
std::enable_if< std::is_floating_point< T >::value, void >::type madness::QCCalculationParametersBase::overwrite_if_inf ( std::string & str,
const T & arg )
inlinestatic

◆ parameter_exists() [1/2]

bool madness::QCCalculationParametersBase::parameter_exists ( const std::string & key) const
inline

◆ parameter_exists() [2/2]

bool madness::QCCalculationParametersBase::parameter_exists ( const std::string & key) const
inline

References parameters.

◆ print() [1/2]

◆ print() [2/2]

void madness::QCCalculationParametersBase::print ( const std::string header = "",
const std::string footer = "" ) const

print all parameters

◆ print_to_string() [1/2]

std::string madness::QCCalculationParametersBase::print_to_string ( const std::list< std::string > precedences = {"all"}) const

◆ print_to_string() [2/2]

std::string madness::QCCalculationParametersBase::print_to_string ( const std::list< std::string > precedences = {"all"}) const

◆ qcparameter_to_json() [1/2]

template<typename... Types>
void madness::QCCalculationParametersBase::qcparameter_to_json ( json & j,
const std::pair< std::string, QCParameter > & p,
const std::tuple< Types... > &  ) const
inline

◆ qcparameter_to_json() [2/2]

template<typename... Types>
void madness::QCCalculationParametersBase::qcparameter_to_json ( json & j,
const std::pair< std::string, QCParameter > & p,
const std::tuple< Types... > &  ) const
inline

References check_type_silent(), get(), and p().

◆ qcparameter_to_json_from_tuple() [1/2]

template<typename Tuple>
void madness::QCCalculationParametersBase::qcparameter_to_json_from_tuple ( json & j,
const std::pair< std::string, QCParameter > & p,
const Tuple &  ) const
inline

References p(), and qcparameter_to_json().

Referenced by to_json(), and to_json_if_precedence().

◆ qcparameter_to_json_from_tuple() [2/2]

template<typename Tuple>
void madness::QCCalculationParametersBase::qcparameter_to_json_from_tuple ( json & j,
const std::pair< std::string, QCParameter > & p,
const Tuple &  ) const
inline

References p(), and qcparameter_to_json().

◆ read_commandline_options() [1/2]

void madness::QCCalculationParametersBase::read_commandline_options ( World & world,
const commandlineparser & parser,
const std::string tag )

read the parameters from the command line and broadcast

Apply --<tag>=key=val command-line overrides on top of the current values. Public so ParameterManager::initFromJson can layer CLI overrides after from_json (the text path gets them via the ctor's read_input_and_commandline_options; JSON decks otherwise ignored them).

syntax is: qcprogram –mp2='maxiter 10; freeze 1' –dft:maxiter=20 –Xmpi:debug=true the argument in quotes is the value of the parser keys

References madness::WorldGopInterface::broadcast_serializable(), madness::Future< void >::value, madness::World::gop, madness::commandlineparser::key_exists(), q(), madness::World::rank(), read_internal(), and madness::commandlineparser::value().

Referenced by madness::Molecule::GeometryParameters::GeometryParameters(), and read_input_and_commandline_options().

◆ read_commandline_options() [2/2]

void madness::QCCalculationParametersBase::read_commandline_options ( World & world,
const commandlineparser & parser,
const std::string tag )

Apply --<tag>=key=val command-line overrides on top of the current values. Public so ParameterManager::initFromJson can layer CLI overrides after from_json (the text path gets them via the ctor's read_input_and_commandline_options; JSON decks otherwise ignored them).

◆ read_input() [1/2]

void madness::QCCalculationParametersBase::read_input ( World & world,
const std::string filename,
const std::string tag )
private

read the parameters from file

read the parameters from file and broadcast

only world.rank()==0 reads the input file and broadcasts to all other nodes, so we don't need to serialize the ParameterMap

References madness::WorldGopInterface::broadcast(), madness::WorldGopInterface::broadcast_serializable(), e(), errmsg(), madness::f, madness::filename, madness::World::gop, madness::World::rank(), read_internal(), and throw_if_datagroup_not_found.

Referenced by read_input_and_commandline_options().

◆ read_input() [2/2]

void madness::QCCalculationParametersBase::read_input ( World & world,
const std::string filename,
const std::string tag )
private

read the parameters from file

only world.rank()==0 reads the input file and broadcasts to all other nodes, so we don't need to serialize the ParameterMap

References madness::filename, ignore_unknown_keys, ignore_unknown_keys_silently, print_debug, and throw_if_datagroup_not_found.

◆ read_input_and_commandline_options() [1/2]

◆ read_input_and_commandline_options() [2/2]

void madness::QCCalculationParametersBase::read_input_and_commandline_options ( World & world,
const commandlineparser & parser,
const std::string tag )
inlineprotected

◆ read_internal() [1/2]

void madness::QCCalculationParametersBase::read_internal ( World & world,
std::string & filecontents,
std::string tag )
virtual

◆ read_internal() [2/2]

virtual void madness::QCCalculationParametersBase::read_internal ( World & world,
std::string & filecontents,
std::string tag )
virtual

read the stream, starting from tag

only parameters that are defined in the constructor will be processed, all others will be discarded.

◆ read_quotes() [1/4]

template<typename T>
std::enable_if<!std::is_same< T, std::string >::value, T >::type madness::QCCalculationParametersBase::read_quotes ( std::stringstream & ssvalue)
inlinestatic

◆ read_quotes() [2/4]

template<typename T>
std::enable_if< std::is_same< T, std::string >::value, T >::type madness::QCCalculationParametersBase::read_quotes ( std::stringstream & ssvalue)
inlinestatic

References madness::arg(), errmsg(), trim_blanks(), and trim_quotes().

Referenced by fromstring().

◆ read_quotes() [3/4]

template<typename T>
std::enable_if<!std::is_same< T, std::string >::value, T >::type madness::QCCalculationParametersBase::read_quotes ( std::stringstream & ssvalue)
inlinestatic

◆ read_quotes() [4/4]

template<typename T>
std::enable_if< std::is_same< T, std::string >::value, T >::type madness::QCCalculationParametersBase::read_quotes ( std::stringstream & ssvalue)
inlinestatic

◆ serialize() [1/2]

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

References parameters, and print_debug.

◆ serialize() [2/2]

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

References parameters, and print_debug.

◆ set_derived_value() [1/2]

◆ set_derived_value() [2/2]

template<typename T>
void madness::QCCalculationParametersBase::set_derived_value ( const std::string & key,
const T & value )
inline

◆ set_user_defined_value() [1/2]

◆ set_user_defined_value() [2/2]

template<typename T>
void madness::QCCalculationParametersBase::set_user_defined_value ( const std::string & key,
const T & value )
inline

◆ to_json() [1/4]

json madness::QCCalculationParametersBase::to_json ( ) const
inlinenodiscard

convert all parameters to a json object

References to_json().

Referenced by to_json().

◆ to_json() [2/4]

json madness::QCCalculationParametersBase::to_json ( ) const
inlinenodiscard

convert all parameters to a json object

References to_json().

◆ to_json() [3/4]

void madness::QCCalculationParametersBase::to_json ( json & j) const
inline

convert all parameters to a json object

References p(), parameters, and qcparameter_to_json_from_tuple().

◆ to_json() [4/4]

void madness::QCCalculationParametersBase::to_json ( json & j) const
inline

convert all parameters to a json object

References p(), parameters, and qcparameter_to_json_from_tuple().

◆ to_json_if_precedence() [1/2]

json madness::QCCalculationParametersBase::to_json_if_precedence ( const std::string & precedence) const
inlinenodiscard

convert all parameters to a json object, but only those with a given precedence

References p(), parameters, and qcparameter_to_json_from_tuple().

◆ to_json_if_precedence() [2/2]

json madness::QCCalculationParametersBase::to_json_if_precedence ( const std::string & precedence) const
inlinenodiscard

convert all parameters to a json object, but only those with a given precedence

References p(), parameters, and qcparameter_to_json_from_tuple().

◆ to_stored_string() [1/2]

template<typename T>
std::string madness::QCCalculationParametersBase::to_stored_string ( const std::string & key,
const T & value ) const
inline

stringify value for storage, honoring case_sensitive_keys()

References madness::Future< void >::value, keeps_case(), and tostring().

Referenced by set_derived_value(), and set_user_defined_value().

◆ to_stored_string() [2/2]

template<typename T>
std::string madness::QCCalculationParametersBase::to_stored_string ( const std::string & key,
const T & value ) const
inline

stringify value for storage, honoring case_sensitive_keys()

References madness::Future< void >::value, keeps_case(), and tostring().

◆ tostring() [1/4]

std::string madness::QCCalculationParametersBase::tostring ( const bool & arg)
inlinestatic

◆ tostring() [2/4]

std::string madness::QCCalculationParametersBase::tostring ( const bool & arg)
inlinestatic

References madness::arg().

◆ tostring() [3/4]

template<typename T>
std::string madness::QCCalculationParametersBase::tostring ( const T & arg)
inlinestatic

◆ tostring() [4/4]

template<typename T>
std::string madness::QCCalculationParametersBase::tostring ( const T & arg)
inlinestatic

◆ trim_blanks() [1/2]

std::string madness::QCCalculationParametersBase::trim_blanks ( const std::string arg)
inlinestatic

References madness::arg().

Referenced by read_quotes().

◆ trim_blanks() [2/2]

std::string madness::QCCalculationParametersBase::trim_blanks ( const std::string arg)
inlinestatic

References madness::arg().

◆ trim_quotes() [1/2]

std::string madness::QCCalculationParametersBase::trim_quotes ( const std::string arg)
inlinestatic

References madness::arg().

Referenced by read_quotes().

◆ trim_quotes() [2/2]

std::string madness::QCCalculationParametersBase::trim_quotes ( const std::string arg)
inlinestatic

References madness::arg().

◆ try_set_from_json() [1/2]

template<typename... Types>
bool madness::QCCalculationParametersBase::try_set_from_json ( QCParameter & parameter,
const nlohmann::json & value )
inline

◆ try_set_from_json() [2/2]

template<typename... Types>
bool madness::QCCalculationParametersBase::try_set_from_json ( QCParameter & parameter,
const nlohmann::json & value )
inline

◆ try_setting_any() [1/2]

template<typename Tuple>
bool madness::QCCalculationParametersBase::try_setting_any ( const std::string & key,
const std::string & value )
inlineprotected

helper function for try_setting_user_defined_value

References madness::Future< void >::value, and try_setting_any_impl().

Referenced by read_internal().

◆ try_setting_any() [2/2]

template<typename Tuple>
bool madness::QCCalculationParametersBase::try_setting_any ( const std::string & key,
const std::string & value )
inlineprotected

helper function for try_setting_user_defined_value

References madness::Future< void >::value, and try_setting_any_impl().

◆ try_setting_any_impl() [1/2]

template<typename Tuple, std::size_t... I>
bool madness::QCCalculationParametersBase::try_setting_any_impl ( const std::string & key,
const std::string & value,
Tuple ,
std::index_sequence< I... >  )
inlineprotected

helper function for try_setting_user_defined_value

References madness::Future< void >::value, and try_setting_user_defined_value().

Referenced by try_setting_any().

◆ try_setting_any_impl() [2/2]

template<typename Tuple, std::size_t... I>
bool madness::QCCalculationParametersBase::try_setting_any_impl ( const std::string & key,
const std::string & value,
Tuple ,
std::index_sequence< I... >  )
inlineprotected

helper function for try_setting_user_defined_value

References madness::Future< void >::value, and try_setting_user_defined_value().

◆ try_setting_user_defined_value() [1/2]

template<typename T>
bool madness::QCCalculationParametersBase::try_setting_user_defined_value ( const std::string & key,
const std::string & val )
inlineprotected

◆ try_setting_user_defined_value() [2/2]

template<typename T>
bool madness::QCCalculationParametersBase::try_setting_user_defined_value ( const std::string & key,
const std::string & val )
inlineprotected

◆ operator== [1/2]

◆ operator== [2/2]

bool operator== ( const QCCalculationParametersBase & p1,
const QCCalculationParametersBase & p2 )
friend

Member Data Documentation

◆ ignore_unknown_keys

bool madness::QCCalculationParametersBase::ignore_unknown_keys = true
protected

◆ ignore_unknown_keys_silently

bool madness::QCCalculationParametersBase::ignore_unknown_keys_silently = false
protected

◆ parameters

◆ print_debug

bool madness::QCCalculationParametersBase::print_debug = false
protected

◆ throw_if_datagroup_not_found

bool madness::QCCalculationParametersBase::throw_if_datagroup_not_found = false
protected

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