Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update calc_status description #303

Open
wants to merge 1 commit into
base: 1.X
Choose a base branch
from
Open

update calc_status description #303

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions include/casm/clex/Calculable.hh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,9 @@ template <typename ConfigType>
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 <typename ConfigType>
std::string calc_status(const ConfigType &_config, std::string calctype = "");

Expand Down
5 changes: 4 additions & 1 deletion src/casm/clex/Calculable.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <typename ConfigType>
std::string calc_status(const ConfigType &config, std::string calctype) {
if (calctype == "") {
Expand Down
6 changes: 5 additions & 1 deletion src/casm/clex/ConfigIO.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -880,7 +880,11 @@ GenericConfigFormatter<std::string> scelname() {

GenericConfigFormatter<std::string> calc_status() {
return GenericConfigFormatter<std::string>(
"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<Configuration>(config);
},
Expand Down