From a10f74a25fb2ad32619f57c909e1159845c7c92b Mon Sep 17 00:00:00 2001 From: jeremiah Date: Mon, 10 Jul 2023 11:01:43 -0700 Subject: [PATCH] update calc_status description --- include/casm/clex/Calculable.hh | 3 +++ src/casm/clex/Calculable.cc | 5 ++++- src/casm/clex/ConfigIO.cc | 6 +++++- 3 files changed, 12 insertions(+), 2 deletions(-) diff --git a/include/casm/clex/Calculable.hh b/include/casm/clex/Calculable.hh index 461b5b63d..4af1aaf96 100644 --- a/include/casm/clex/Calculable.hh +++ b/include/casm/clex/Calculable.hh @@ -68,6 +68,9 @@ template void reset_properties(ConfigType &config); /// \brief Status of calculation +/// A calculation that has been run successfully will be marked 'complete'. +/// Mapped or imported configurations may have 'is_calculated = 1' without +/// 'calc_status = complete'. template std::string calc_status(const ConfigType &_config, std::string calctype = ""); diff --git a/src/casm/clex/Calculable.cc b/src/casm/clex/Calculable.cc index d1e831e87..aae9be770 100644 --- a/src/casm/clex/Calculable.cc +++ b/src/casm/clex/Calculable.cc @@ -151,7 +151,10 @@ void reset_properties(ConfigType &config) { config.set_calc_properties(MappedProperties(), ""); } -/// \brief Status of calculation +/// \brief Status of calculation. +/// A calculation that has been run successfully will be marked 'complete'. +/// Mapped or imported configurations may have 'is_calculated = 1' without +/// 'calc_status = complete'. template std::string calc_status(const ConfigType &config, std::string calctype) { if (calctype == "") { diff --git a/src/casm/clex/ConfigIO.cc b/src/casm/clex/ConfigIO.cc index ef1b3d23e..d22ea3053 100644 --- a/src/casm/clex/ConfigIO.cc +++ b/src/casm/clex/ConfigIO.cc @@ -880,7 +880,11 @@ GenericConfigFormatter scelname() { GenericConfigFormatter calc_status() { return GenericConfigFormatter( - "calc_status", "Status of calculation.", + "calc_status", + "Status of calculation." + "A calculation that has been run successfully will be marked 'complete'." + "Mapped or imported configurations may have 'is_calculated = 1' without " + "'calc_status = complete'.", [](const Configuration &config) -> std::string { return CASM::calc_status(config); },