CASM
1.1.0
A Clusters Approach to Statistical Mechanics
|
#include <CanonicalSettings.hh>
Definition at line 11 of file CanonicalSettings.hh.
Public Types | |
typedef Index | size_type |
Public Member Functions | |
CanonicalSettings () | |
Default constructor. More... | |
CanonicalSettings (const PrimClex &primclex, const fs::path &read_path) | |
Construct EquilibriumMonteSettings by reading a settings JSON file. More... | |
CanonicalConditions | initial_conditions () const |
Expects initial_conditions. More... | |
CanonicalConditions | final_conditions () const |
Expects final_conditions. More... | |
CanonicalConditions | incremental_conditions () const |
Expects incremental_conditions. More... | |
std::vector< CanonicalConditions > | custom_conditions () const |
Expects custom_conditions. More... | |
ClexDescription | formation_energy (const PrimClex &primclex) const |
Get formation energy cluster expansion. More... | |
template<typename SamplerInsertIterator > | |
SamplerInsertIterator | samplers (const PrimClex &primclex, SamplerInsertIterator result) const |
Construct MonteSamplers as specified in the MonteSettings. More... | |
bool | all_correlations () const |
Return true if all correlations should be sampled. More... | |
bool | sample_by_pass () const |
Sample by pass? More... | |
bool | sample_by_step () const |
Sample by step? More... | |
size_type | sample_period () const |
Figure out how often to take samples. More... | |
bool | is_equilibration_passes_first_run () const |
Returns true if explicit equilibration passes for the first run have been specified. More... | |
size_type | equilibration_passes_first_run () const |
Number of explicit equilibration passes requsted for the first run. More... | |
bool | is_equilibration_passes_each_run () const |
Returns true if explicit equilibration passes for each run have been specified. More... | |
size_type | equilibration_passes_each_run () const |
Number of explicit equilibration passes requsted for each run. More... | |
bool | is_N_pass () const |
Returns true if the number of passes has been specified. More... | |
size_type | N_pass () const |
Returns the number of passes requested. More... | |
bool | is_N_step () const |
Returns true if the number of steps has been specified. More... | |
size_type | N_step () const |
Returns the number of steps requested. More... | |
bool | is_N_sample () const |
Returns true if the number of samples has been specified. More... | |
size_type | N_sample () const |
Returns the number of samples requested. More... | |
bool | is_max_pass () const |
Returns true if a maximum number of passes has been specified. More... | |
size_type | max_pass () const |
Maximum number of passes, required if sample by pass. More... | |
bool | is_min_pass () const |
Returns true if a minimum number of passes has been specified. More... | |
size_type | min_pass () const |
Minimum number of passes, default 0 if sample by pass. More... | |
bool | is_max_step () const |
Returns true if a maximum number of steps has been specified. More... | |
size_type | max_step () const |
Maximum number of steps, required if sample by step. More... | |
bool | is_min_step () const |
Returns true if a minimum number of steps has been specified. More... | |
size_type | min_step () const |
Minimum number of steps, default 0 if sample by step. More... | |
bool | is_max_sample () const |
Returns true if a maximum number of samples has been specified. More... | |
size_type | max_sample () const |
Maximum number of steps, default std::numeric_limit<size_type>::max() More... | |
bool | is_min_sample () const |
Returns true if a minimum number of samples has been specified. More... | |
size_type | min_sample () const |
Minimum number of steps, default 0. More... | |
size_type | max_data_length () const |
Figure out how large data containers should be. More... | |
fs::path | root () const |
const PrimClex & | primclex () const |
Monte::ENSEMBLE | ensemble () const |
Return type of Monte Carlo ensemble. More... | |
Monte::METHOD | method () const |
Return type of Monte Carlo method. More... | |
bool | debug () const |
Run in debug mode? More... | |
void | set_debug (bool _debug) |
Set debug mode. More... | |
bool | is_motif_configname () const |
Returns true if configname of configuration to use as starting motif has been specified. More... | |
std::string | motif_configname () const |
Configname of configuration to use as starting motif. More... | |
bool | is_motif_configdof () const |
Returns true if path to ConfigDoF file to use as starting motif has been specified. More... | |
ConfigDoF | motif_configdof (Index supercell_volume) const |
ConfigDoF to use as starting motif. More... | |
fs::path | motif_configdof_path () const |
Path to ConfigDoF file to use as starting motif. More... | |
Eigen::Matrix3l | simulation_cell_matrix () const |
Supercell matrix defining the simulation cell. More... | |
virtual const Monte::DRIVE_MODE | drive_mode () const |
Given a settings jsonParser figure out the drive mode. Expects drive_mode/incremental,custom. More... | |
bool | dependent_runs () const |
If dependent runs, start subsequent calculations with the final state of the previous calculation. Default true. More... | |
double | confidence () const |
Given a settings jsonParser figure out the global tolerance (probably for == operator). Expects tolerance/value. More... | |
bool | write_trajectory () const |
Returns true if snapshots are requested. More... | |
bool | write_POSCAR_snapshots () const |
Returns true if POSCARs of snapshots are requsted. Requires write_trajectory. More... | |
bool | write_observations () const |
Writes all observations. More... | |
bool | write_csv () const |
Write csv versions of files? (csv is the default format if no 'output_format' given) More... | |
bool | write_json () const |
Write json versions of files? More... | |
const fs::path | output_directory () const |
Directory where output should go. More... | |
bool | is_enumeration () const |
Returns true if enumeration is requested. (Default false) More... | |
std::string | enumeration_metric_args () const |
Returns 'casm query'-like enumeration metric args. More... | |
std::string | enumeration_check_args () const |
Returns 'casm query'-like enumeration check args. More... | |
Monte::ENUM_SAMPLE_MODE | enumeration_sample_mode () const |
Enumeration sample mode (default Monte::ENUM_SAMPLE_MODE::ON_SAMPLE) More... | |
bool | enumeration_insert_canonical () const |
Insert configurations in their canonical form. More... | |
bool | enumeration_check_existence () const |
Only insert configurations that are not already enumerated. More... | |
Index | enumeration_N_halloffame () const |
Returns enumeration halloffame max size (default 100) More... | |
double | enumeration_tol () const |
Returns enumeration halloffame tolerance (default 1e-8) More... | |
void | print (std::ostream &stream, unsigned int indent=2, unsigned int prec=12) const |
Print json to stream. More... | |
void | write (const std::string &file_name, unsigned int indent=2, unsigned int prec=12) const |
Write json to file. More... | |
void | write (const boost::filesystem::path &mypath, unsigned int indent=2, unsigned int prec=12) const |
Write json to file. More... | |
bool | operator!= (const jsonParser &json) const |
Protected Types | |
typedef jsonParserIterator< false > | iterator |
typedef jsonParserIterator< true > | const_iterator |
Protected Member Functions | |
bool | _is_setting (std::string level1, std::string level2) const |
Returns true if (*this)[level1].contains(level2) More... | |
bool | _is_setting (std::string level1, std::string level2, std::string level3) const |
Returns true if (*this)[level1][level2].contains(level3) More... | |
template<typename T > | |
T | _get_setting (std::string level1, std::string msg) const |
Returns (*this)[level1].get<T>();. More... | |
template<typename T > | |
T | _get_setting (std::string level1, std::string level2, std::string msg) const |
Returns (*this)[level1][level2].get<T>();. More... | |
template<typename T > | |
T | _get_setting (std::string level1, std::string level2, std::string level3, std::string msg) const |
Returns (*this)[level1][level2][level3].get<T>();. More... | |
jsonParser | _json () const |
void | print (std::ostream &stream, unsigned int indent=2, unsigned int prec=12) const |
Print json to stream. More... | |
void | write (const std::string &file_name, unsigned int indent=2, unsigned int prec=12) const |
Write json to file. More... | |
void | write (const boost::filesystem::path &mypath, unsigned int indent=2, unsigned int prec=12) const |
Write json to file. More... | |
bool | operator!= (const jsonParser &json) const |
bool | read (std::istream &stream) |
Reads json from the stream. More... | |
bool | read (const boost::filesystem::path &mypath) |
Reads json from a path. More... | |
bool | almost_equal (const jsonParser &B, double tol) const |
bool | is_null () const |
Check if null type. More... | |
bool | is_bool () const |
Check if bool type. More... | |
bool | is_int () const |
Check if int type. More... | |
bool | is_float () const |
Check if number type (not including int) More... | |
bool | is_number () const |
Check if number type (including int) More... | |
bool | is_string () const |
Check if string. More... | |
bool | is_obj () const |
Check if object type. More... | |
bool | is_array () const |
Check if array type. More... | |
jsonParser & | operator[] (const std::string &name) |
const jsonParser & | operator[] (const std::string &name) const |
jsonParser & | operator[] (const size_type &element) |
const jsonParser & | operator[] (const size_type &element) const |
jsonParser & | at (const fs::path &path) |
const jsonParser & | at (const fs::path &path) const |
jsonParser & | at (const size_type &element) |
const jsonParser & | at (const size_type &element) const |
size_type | size () const |
iterator | begin () |
Returns const_iterator to beginning of JSON object or JSON array. More... | |
const_iterator | begin () const |
Returns iterator to beginning of JSON object or JSON array. More... | |
iterator | end () |
Returns iterator to end of JSON object or JSON array. More... | |
const_iterator | end () const |
Returns const_iterator to end of JSON object or JSON array. More... | |
const_iterator | cbegin () const |
Returns const_iterator to beginning of JSON object or JSON array. More... | |
const_iterator | cend () const |
Returns const_iterator to end of JSON object or JSON array. More... | |
iterator | find (const std::string &name) |
Return iterator to JSON object value with 'name'. More... | |
const_iterator | find (const std::string &name) const |
Return const_iterator to JSON object value with 'name'. More... | |
jsonParser::iterator | find_at (const fs::path &path) |
Return iterator to sub-object or element, or 'end' if not found. More... | |
jsonParser::const_iterator | find_at (const fs::path &path) const |
Return iterator to sub-object or element, or 'end' if not found. More... | |
bool | contains (const std::string &name) const |
Return true if JSON object contains 'name'. More... | |
size_type | erase (const std::string &name) |
Erase key:value pair from an object. More... | |
template<typename T , typename... Args> | |
T | get (Args &&... args) const |
Get data from json, using one of several alternatives. More... | |
template<typename T , typename... Args> | |
void | get (T &t, Args &&... args) const |
template<typename T , typename... Args> | |
bool | get_if (T &t, const std::string &key, Args &&... args) const |
template<typename T , typename... Args> | |
T | get_if_else (const std::string &key, const T &default_value, Args &&... args) const |
template<typename T , typename... Args> | |
bool | get_else (T &t, const std::string &key, const T &default_value, Args &&... args) const |
template<typename T , typename... Args> | |
std::unique_ptr< T > | make (Args &&... args) const |
Get data from json. More... | |
template<typename T , typename... Args> | |
void | make (std::unique_ptr< T > &ptr, Args &&... args) const |
Get data from json. More... | |
template<typename T , typename... Args> | |
bool | make_if (std::unique_ptr< T > &ptr, const std::string &key, Args &&... args) const |
Get data from json if key exists. More... | |
template<typename T , typename... Args> | |
std::unique_ptr< T > | make_optional (const std::string &key, Args &&... args) const |
Get data from json if key exists, else return empty ptr. More... | |
template<typename T , typename... Args> | |
std::unique_ptr< T > | make_if_else (const std::string &key, std::unique_ptr< T > default_value, Args &&... args) const |
Get data from json if 'this' contains 'key', else return 'default_value'. More... | |
template<typename T , typename... Args> | |
bool | make_else (std::unique_ptr< T > &ptr, const std::string &key, std::unique_ptr< T > default_value, Args &&... args) const |
Get data from json if key exists, else assign default_value. More... | |
template<typename T , typename... Args> | |
jsonParser & | push_back (const T &value, Args &&... args) |
template<typename T > | |
jsonParser & | put (const T &value) |
jsonParser & | put_obj () |
Puts new empty JSON object. More... | |
template<typename Iterator > | |
jsonParser & | put_obj (Iterator begin, Iterator end) |
jsonParser & | put_array () |
Puts new empty JSON array. More... | |
jsonParser & | put_array (size_type N) |
Puts new JSON array. More... | |
template<typename T > | |
jsonParser & | put_array (size_type N, const T &t) |
Puts new JSON array, using the same value. More... | |
template<typename Iterator , typename... Args, typename CASM_TMP::enable_if_iterator< Iterator >::type * = nullptr> | |
jsonParser & | put_array (Iterator begin, Iterator end, Args &&... args) |
Puts new JSON array, from iterators. More... | |
jsonParser & | put_null () |
Puts 'null' JSON value. More... | |
Static Protected Member Functions | |
static jsonParser | parse (const std::string &str) |
Construct a jsonParser from a string containing JSON data. More... | |
static jsonParser | parse (const fs::path &path) |
Construct a jsonParser from a file containing JSON data. More... | |
static jsonParser | parse (std::istream &stream) |
Construct a jsonParser from a stream containing JSON data. More... | |
static jsonParser | object () |
Returns an empty json object. More... | |
template<typename Iterator > | |
static jsonParser | object (Iterator begin, Iterator end) |
static jsonParser | array () |
Returns an empty json array. More... | |
static jsonParser | array (size_type N) |
Returns an empty json array. More... | |
template<typename T > | |
static jsonParser | array (size_type N, const T &t) |
Puts new JSON array, using the same value. More... | |
template<typename Iterator > | |
static jsonParser | array (Iterator begin, Iterator end, typename CASM_TMP::enable_if_iterator< Iterator >::type *=nullptr) |
Puts new JSON array, from iterators. More... | |
static jsonParser | null () |
Returns a null JSON value. More... | |
Private Member Functions | |
CanonicalConditions | _conditions (std::string name) const |
CanonicalConditions | _conditions (const jsonParser &json) const |
template<typename jsonParserIteratorType > | |
std::tuple< bool, double > | _get_precision (jsonParserIteratorType it) const |
template<typename jsonParserIteratorType , typename SamplerInsertIterator > | |
SamplerInsertIterator | _make_all_correlations_samplers (const PrimClex &primclex, jsonParserIteratorType it, SamplerInsertIterator result) const |
template<typename jsonParserIteratorType , typename SamplerInsertIterator > | |
SamplerInsertIterator | _make_non_zero_eci_correlations_samplers (const PrimClex &primclex, jsonParserIteratorType it, SamplerInsertIterator result) const |
template<typename jsonParserIteratorType , typename SamplerInsertIterator > | |
SamplerInsertIterator | _make_query_samplers (const PrimClex &primclex, jsonParserIteratorType it, SamplerInsertIterator result) const |
Private Attributes | |
CompositionConverter | m_comp_converter |
fs::path | m_root |
fs::path | m_output_directory |
const PrimClex * | m_primclex |
|
inherited |
Definition at line 89 of file jsonParser.hh.
|
inherited |
Definition at line 88 of file jsonParser.hh.
|
inherited |
Definition at line 55 of file MonteSettings.hh.
|
inline |
Default constructor.
Definition at line 14 of file CanonicalSettings.hh.
CASM::Monte::CanonicalSettings::CanonicalSettings | ( | const PrimClex & | primclex, |
const fs::path & | read_path | ||
) |
Construct EquilibriumMonteSettings by reading a settings JSON file.
Definition at line 34 of file CanonicalSettings.cc.
|
private |
Definition at line 180 of file CanonicalSettings.cc.
|
private |
Definition at line 164 of file CanonicalSettings.cc.
|
private |
Definition at line 119 of file CanonicalSettings_impl.hh.
|
protectedinherited |
Returns (*this)[level1][level2][level3].get<T>();.
Definition at line 369 of file MonteSettings.hh.
|
protectedinherited |
Returns (*this)[level1][level2].get<T>();.
Definition at line 332 of file MonteSettings.hh.
|
protectedinherited |
Returns (*this)[level1].get<T>();.
Returns (*this)[level1][level2].get<T>();.
Definition at line 306 of file MonteSettings.hh.
|
protectedinherited |
Returns true if (*this)[level1].contains(level2)
Definition at line 394 of file MonteSettings.cc.
|
protectedinherited |
Returns true if (*this)[level1][level2].contains(level3)
Definition at line 408 of file MonteSettings.cc.
|
inlineprotectedinherited |
Definition at line 193 of file MonteSettings.hh.
|
private |
Definition at line 129 of file CanonicalSettings_impl.hh.
|
private |
Definition at line 165 of file CanonicalSettings_impl.hh.
|
private |
Definition at line 205 of file CanonicalSettings_impl.hh.
bool CASM::Monte::CanonicalSettings::all_correlations | ( | ) | const |
Return true if all correlations should be sampled.
Definition at line 141 of file CanonicalSettings.cc.
|
inherited |
Definition at line 218 of file jsonParser.cc.
|
inlinestaticinherited |
Returns an empty json array.
Definition at line 409 of file jsonParser.hh.
|
inlinestaticinherited |
Puts new JSON array, from iterators.
Definition at line 429 of file jsonParser.hh.
|
inlinestaticinherited |
Returns an empty json array.
Definition at line 415 of file jsonParser.hh.
|
inlinestaticinherited |
Puts new JSON array, using the same value.
Definition at line 422 of file jsonParser.hh.
|
inherited |
Return a reference to the sub-jsonParser (JSON value) with specified relative path Will throw if the 'path' doesn't exist.
Return a reference to the sub-jsonParser (JSON value) with specified relative path Will throw if the 'path' doesn't exist.
Definition at line 316 of file jsonParser.cc.
|
inherited |
Return a reference to the sub-jsonParser (JSON value) with specified relative path Will throw if the 'path' doesn't exist.
Return a reference to the sub-jsonParser (JSON value) with specified relative path Will throw if the 'path' doesn't exist.
Definition at line 328 of file jsonParser.cc.
|
inherited |
Return a reference to the sub-jsonParser (JSON value) from index 'element' iff jsonParser is a JSON array
Definition at line 397 of file jsonParser.cc.
|
inherited |
Return a const reference to the sub-jsonParser (JSON value) from index 'element' iff jsonParser is a JSON array
Definition at line 410 of file jsonParser.cc.
|
inherited |
Returns const_iterator to beginning of JSON object or JSON array.
Returns iterator to beginning of JSON object or JSON array.
Definition at line 497 of file jsonParser.cc.
|
inherited |
Returns iterator to beginning of JSON object or JSON array.
Returns const_iterator to beginning of JSON object or JSON array.
Definition at line 507 of file jsonParser.cc.
|
inherited |
Returns const_iterator to beginning of JSON object or JSON array.
Returns const iterator to beginning of const JSON object or JSON array.
Definition at line 510 of file jsonParser.cc.
|
inherited |
Returns const_iterator to end of JSON object or JSON array.
Definition at line 533 of file jsonParser.cc.
|
inherited |
Given a settings jsonParser figure out the global tolerance (probably for == operator). Expects tolerance/value.
Requested confidence level. Default 0.95.
Definition at line 143 of file MonteSettings.cc.
|
inherited |
Return true if JSON object contains 'name'.
Definition at line 601 of file jsonParser.cc.
std::vector< CanonicalConditions > CASM::Monte::CanonicalSettings::custom_conditions | ( | ) | const |
Expects custom_conditions.
Expects incremental_conditions.
Definition at line 66 of file CanonicalSettings.cc.
|
inherited |
Run in debug mode?
Definition at line 51 of file MonteSettings.cc.
|
inherited |
If dependent runs, start subsequent calculations with the final state of the previous calculation. Default true.
Definition at line 121 of file MonteSettings.cc.
|
virtualinherited |
Given a settings jsonParser figure out the drive mode. Expects drive_mode/incremental,custom.
Definition at line 114 of file MonteSettings.cc.
|
inherited |
Returns iterator to end of JSON object or JSON array.
Definition at line 520 of file jsonParser.cc.
|
inherited |
Returns const_iterator to end of JSON object or JSON array.
Returns iterator to end of JSON object or JSON array.
Definition at line 530 of file jsonParser.cc.
|
inherited |
Return type of Monte Carlo ensemble.
Definition at line 41 of file MonteSettings.cc.
|
inherited |
Returns 'casm query'-like enumeration check args.
Returns 'casm query'-like enumeration check.
Expects a string that will convert to true if the current Configuration should be scored for enumeration. For instance, perhaps you only want to enumerate Configurations that are near or below the currently predicted convex hull. Then, use 'lt(clex_hull_dist(ALL),0.005)'. Default always returns true.
Uses boost::lexical_cast<bool> on the output to determine the result.
Definition at line 307 of file MonteSettings.cc.
|
inherited |
Only insert configurations that are not already enumerated.
Insert configurations in their canonical form (default true)
Definition at line 330 of file MonteSettings.cc.
|
inherited |
Insert configurations in their canonical form.
Insert configurations in their canonical form (default true)
Definition at line 344 of file MonteSettings.cc.
|
inherited |
Returns 'casm query'-like enumeration metric args.
Returns 'casm query'-like enumeration metric.
Expects a string containing the Configuration scoring metric. For instance, 'clex_hull_dist(ALL)' (which is the default).
Uses boost::lexical_cast<double> on the output to determine the result.
Definition at line 279 of file MonteSettings.cc.
|
inherited |
Returns enumeration halloffame max size (default 100)
Definition at line 368 of file MonteSettings.cc.
|
inherited |
Enumeration sample mode (default Monte::ENUM_SAMPLE_MODE::ON_SAMPLE)
Definition at line 321 of file MonteSettings.cc.
|
inherited |
Returns enumeration halloffame tolerance (default 1e-8)
Definition at line 381 of file MonteSettings.cc.
|
inherited |
Number of explicit equilibration passes requsted for each run.
Definition at line 484 of file MonteSettings.cc.
|
inherited |
Number of explicit equilibration passes requsted for the first run.
Definition at line 470 of file MonteSettings.cc.
|
inherited |
Erase key:value pair from an object.
Erase key:value pair from an object Returns the number of elements erased, which will be 0 or 1
Definition at line 607 of file jsonParser.cc.
CanonicalConditions CASM::Monte::CanonicalSettings::final_conditions | ( | ) | const |
Expects final_conditions.
Definition at line 56 of file CanonicalSettings.cc.
|
inherited |
Return iterator to JSON object value with 'name'.
Definition at line 543 of file jsonParser.cc.
|
inherited |
Return const_iterator to JSON object value with 'name'.
Definition at line 548 of file jsonParser.cc.
|
inherited |
Return iterator to sub-object or element, or 'end' if not found.
Return iterator to sub-object or element, or 'end' if not found
Definition at line 556 of file jsonParser.cc.
|
inherited |
Return iterator to sub-object or element, or 'end' if not found.
Return iterator to sub-object or element, or 'end' if not found
Definition at line 596 of file jsonParser.cc.
ClexDescription CASM::Monte::CanonicalSettings::formation_energy | ( | const PrimClex & | primclex | ) | const |
Get formation energy cluster expansion.
Definition at line 90 of file CanonicalSettings.cc.
CanonicalConditions CASM::Monte::CanonicalSettings::incremental_conditions | ( | ) | const |
Expects incremental_conditions.
Definition at line 61 of file CanonicalSettings.cc.
CanonicalConditions CASM::Monte::CanonicalSettings::initial_conditions | ( | ) | const |
Expects initial_conditions.
Definition at line 45 of file CanonicalSettings.cc.
|
inherited |
Check if array type.
Definition at line 275 of file jsonParser.cc.
|
inherited |
Check if bool type.
Definition at line 257 of file jsonParser.cc.
|
inherited |
Returns true if enumeration is requested. (Default false)
Definition at line 266 of file MonteSettings.cc.
|
inherited |
Returns true if explicit equilibration passes for each run have been specified.
Definition at line 478 of file MonteSettings.cc.
|
inherited |
Returns true if explicit equilibration passes for the first run have been specified.
Definition at line 464 of file MonteSettings.cc.
|
inherited |
Check if number type (not including int)
Definition at line 263 of file jsonParser.cc.
|
inherited |
Check if int type.
Definition at line 260 of file jsonParser.cc.
|
inherited |
Returns true if a maximum number of passes has been specified.
Definition at line 524 of file MonteSettings.cc.
|
inherited |
Returns true if a maximum number of samples has been specified.
Definition at line 568 of file MonteSettings.cc.
|
inherited |
Returns true if a maximum number of steps has been specified.
Definition at line 546 of file MonteSettings.cc.
|
inherited |
Returns true if a minimum number of passes has been specified.
Definition at line 535 of file MonteSettings.cc.
|
inherited |
Returns true if a minimum number of samples has been specified.
Returns true if a minimum number of sample has been specified.
Definition at line 580 of file MonteSettings.cc.
|
inherited |
Returns true if a minimum number of steps has been specified.
Definition at line 557 of file MonteSettings.cc.
|
inherited |
Returns true if path to ConfigDoF file to use as starting motif has been specified.
Definition at line 80 of file MonteSettings.cc.
|
inherited |
Returns true if configname of configuration to use as starting motif has been specified.
Definition at line 66 of file MonteSettings.cc.
|
inherited |
Returns true if the number of passes has been specified.
Definition at line 490 of file MonteSettings.cc.
|
inherited |
Returns true if the number of samples has been specified.
Definition at line 513 of file MonteSettings.cc.
|
inherited |
Returns true if the number of steps has been specified.
Definition at line 501 of file MonteSettings.cc.
|
inherited |
Check if null type.
Definition at line 254 of file jsonParser.cc.
|
inherited |
Check if number type (including int)
Definition at line 266 of file jsonParser.cc.
|
inherited |
Check if object type.
Definition at line 272 of file jsonParser.cc.
|
inherited |
Check if string.
Definition at line 269 of file jsonParser.cc.
|
inherited |
Figure out how large data containers should be.
Definition at line 594 of file MonteSettings.cc.
|
inherited |
Maximum number of passes, required if sample by pass.
Definition at line 529 of file MonteSettings.cc.
|
inherited |
Maximum number of steps, default std::numeric_limit<size_type>::max()
Maximum number of steps.
Definition at line 573 of file MonteSettings.cc.
|
inherited |
Maximum number of steps, required if sample by step.
Maximum number of steps.
Definition at line 551 of file MonteSettings.cc.
|
inherited |
Return type of Monte Carlo method.
Definition at line 46 of file MonteSettings.cc.
|
inherited |
Minimum number of passes, default 0 if sample by pass.
Minimum number of passes.
Definition at line 540 of file MonteSettings.cc.
|
inherited |
Minimum number of steps, default 0.
Definition at line 585 of file MonteSettings.cc.
|
inherited |
Minimum number of steps, default 0 if sample by step.
Minimum number of steps.
Definition at line 562 of file MonteSettings.cc.
ConfigDoF to use as starting motif.
Definition at line 85 of file MonteSettings.cc.
|
inherited |
Path to ConfigDoF file to use as starting motif.
Definition at line 96 of file MonteSettings.cc.
|
inherited |
Configname of configuration to use as starting motif.
Definition at line 71 of file MonteSettings.cc.
|
inherited |
Returns the number of passes requested.
Definition at line 495 of file MonteSettings.cc.
|
inherited |
Returns the number of samples requested.
Definition at line 518 of file MonteSettings.cc.
|
inherited |
Returns the number of steps requested.
Definition at line 507 of file MonteSettings.cc.
|
inlinestaticinherited |
Returns a null JSON value.
Definition at line 437 of file jsonParser.hh.
|
inlinestaticinherited |
Returns an empty json object.
Definition at line 395 of file jsonParser.hh.
|
inlinestaticinherited |
Puts new JSON object, from iterators over a range of values of type std::pair<std::string, T>
Definition at line 403 of file jsonParser.hh.
|
inlineinherited |
Definition at line 173 of file jsonParser.hh.
|
inlineinherited |
Definition at line 173 of file jsonParser.hh.
|
inherited |
Return a reference to the sub-jsonParser (JSON value) from index 'element' iff jsonParser is a JSON array
Definition at line 385 of file jsonParser.cc.
|
inherited |
Return a const reference to the sub-jsonParser (JSON value) from index 'element' iff jsonParser is a JSON array
Definition at line 391 of file jsonParser.cc.
|
inherited |
Return a reference to the sub-jsonParser (JSON value) with 'name' if it exists If it does not exist, create it with an empty JSON object and return a reference to it
Return a reference to the sub-jsonParser (JSON value) with 'name' if it exists If it does not exist, create it with value == 'null' and return a reference
Definition at line 283 of file jsonParser.cc.
|
inherited |
Return a reference to the sub-jsonParser (JSON value) with 'name' if it exists. Will throw if the 'name' doesn't exist.
Definition at line 297 of file jsonParser.cc.
|
inherited |
Directory where output should go.
Definition at line 136 of file MonteSettings.cc.
|
staticinherited |
Construct a jsonParser from a file containing JSON data.
Definition at line 614 of file jsonParser.cc.
|
inlinestaticinherited |
Construct a jsonParser from a string containing JSON data.
Definition at line 382 of file jsonParser.hh.
|
inlinestaticinherited |
Construct a jsonParser from a stream containing JSON data.
Definition at line 392 of file jsonParser.hh.
|
inherited |
Definition at line 36 of file MonteSettings.cc.
|
inherited |
|
inherited |
|
inlineinherited |
Puts new empty JSON array.
Definition at line 362 of file jsonParser.hh.
|
inlineinherited |
Puts new JSON array.
Definition at line 365 of file jsonParser.hh.
|
inlineinherited |
Puts 'null' JSON value.
Definition at line 377 of file jsonParser.hh.
|
inlineinherited |
Puts new empty JSON object.
Definition at line 354 of file jsonParser.hh.
|
inherited |
Reads json from a path.
|
inherited |
Reads json from the stream.
Definition at line 168 of file jsonParser.cc.
|
inherited |
Definition at line 34 of file MonteSettings.cc.
|
inherited |
Sample by pass?
Definition at line 433 of file MonteSettings.cc.
|
inherited |
Sample by step?
Definition at line 440 of file MonteSettings.cc.
|
inherited |
Figure out how often to take samples.
Definition at line 447 of file MonteSettings.cc.
SamplerInsertIterator CASM::Monte::CanonicalSettings::samplers | ( | const PrimClex & | primclex, |
SamplerInsertIterator | result | ||
) | const |
Construct MonteSamplers as specified in the MonteSettings.
The requested MonteSamplers are inserted in 'result' as std::pair<std::string, notstd::cloneable_ptr<MonteSampler> >
Definition at line 21 of file CanonicalSettings_impl.hh.
|
inherited |
Set debug mode.
Definition at line 60 of file MonteSettings.cc.
|
inherited |
Supercell matrix defining the simulation cell.
Definition at line 102 of file MonteSettings.cc.
|
inherited |
Returns array size if *this is a JSON array, object size if *this is a JSON object, 1 otherwise
Definition at line 487 of file jsonParser.cc.
|
inherited |
Write json to file.
|
inherited |
Write json to file.
|
inherited |
Write json to file.
Definition at line 196 of file jsonParser.cc.
|
inherited |
Write json to file.
Definition at line 138 of file jsonParser.cc.
|
inherited |
Write csv versions of files? (csv is the default format if no 'output_format' given)
Definition at line 194 of file MonteSettings.cc.
|
inherited |
Write json versions of files?
Definition at line 229 of file MonteSettings.cc.
|
inherited |
Writes all observations.
Definition at line 180 of file MonteSettings.cc.
|
inherited |
Returns true if POSCARs of snapshots are requsted. Requires write_trajectory.
Definition at line 167 of file MonteSettings.cc.
|
inherited |
Returns true if snapshots are requested.
Definition at line 153 of file MonteSettings.cc.
|
private |
Definition at line 49 of file CanonicalSettings.hh.
|
privateinherited |
Definition at line 197 of file MonteSettings.hh.
|
privateinherited |
Definition at line 198 of file MonteSettings.hh.
|
privateinherited |
Definition at line 196 of file MonteSettings.hh.