OilfieldToolsNet/opm-simulators
4
0
Fork 0
mirror of https://github.com/OPM/opm-simulators.git synced 2025-02-25 18:55:30 -06:00
Code Issues Packages Projects Releases Wiki Activity

Parameters::printParamUsage can now be an implementation detail

Browse Source
This commit is contained in:
Arne Morten Kvarving 2024-09-02 15:59:20 +02:00
parent 77dc5ad895
commit faa963056d
2 changed files with 87 additions and 90 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

174
opm/models/utils/parametersystem.cpp
View File

@ -55,7 +55,6 @@ void getFlattenedKeyList(std::list<std::string>& dest,
}
}
std::string parseKey(std::string& s)
{
unsigned i;
@ -117,6 +116,93 @@ std::string parseUnquotedValue(std::string& s, const std::string&)
return ret;
}
void printParamUsage(std::ostream& os,
const Opm::Parameters::ParamInfo& paramInfo)
{
std::string paramMessage, paramType, paramDescription;
int ttyWidth = Opm::Parameters::getTtyWidth();
// convert the CamelCase name to a command line --parameter-name.
std::string cmdLineName = "-";
const std::string camelCaseName = paramInfo.paramName;
for (unsigned i = 0; i < camelCaseName.size(); ++i) {
if (isupper(camelCaseName[i]))
cmdLineName += "-";
cmdLineName += static_cast<char>(std::tolower(camelCaseName[i]));
}
// assemble the printed output
paramMessage = " ";
paramMessage += cmdLineName;
// add the =VALUE_TYPE part
bool isString = false;
if (paramInfo.paramTypeName == Dune::className<std::string>()
|| paramInfo.paramTypeName == "const char *")
{
paramMessage += "=STRING";
isString = true;
}
else if (paramInfo.paramTypeName == Dune::className<float>()
|| paramInfo.paramTypeName == Dune::className<double>()
|| paramInfo.paramTypeName == Dune::className<long double>()
#if HAVE_QUAD
|| paramInfo.paramTypeName == Dune::className<quad>()
#endif // HAVE_QUAD
)
paramMessage += "=SCALAR";
else if (paramInfo.paramTypeName == Dune::className<int>()
|| paramInfo.paramTypeName == Dune::className<unsigned int>()
|| paramInfo.paramTypeName == Dune::className<short>()
|| paramInfo.paramTypeName == Dune::className<unsigned short>())
paramMessage += "=INTEGER";
else if (paramInfo.paramTypeName == Dune::className<bool>())
paramMessage += "=BOOLEAN";
else if (paramInfo.paramTypeName.empty()) {
// the parameter is a flag. Do nothing!
}
else {
// unknown type
paramMessage += "=VALUE";
}
// fill up the up help string to the 50th character
paramMessage += " ";
while (paramMessage.size() < 50)
paramMessage += " ";
// append the parameter usage string.
paramMessage += paramInfo.usageString;
// add the default value
if (!paramInfo.paramTypeName.empty()) {
if (paramMessage.back() != '.')
paramMessage += '.';
paramMessage += " Default: ";
if (paramInfo.paramTypeName == "bool") {
if (paramInfo.defaultValue == "0")
paramMessage += "false";
else
paramMessage += "true";
}
else if (isString) {
paramMessage += "\"";
paramMessage += paramInfo.defaultValue;
paramMessage += "\"";
}
else
paramMessage += paramInfo.defaultValue;
}
paramMessage = Opm::Parameters::breakLines(paramMessage, /*indent=*/52, ttyWidth);
paramMessage += "\n";
// print everything
os << paramMessage;
}
void removeLeadingSpace(std::string& s)
{
unsigned i;
@ -359,92 +445,6 @@ void endRegistration()
MetaData::registrationOpen() = false;
}
void printParamUsage(std::ostream& os, const ParamInfo& paramInfo)
{
std::string paramMessage, paramType, paramDescription;
int ttyWidth = getTtyWidth();
// convert the CamelCase name to a command line --parameter-name.
std::string cmdLineName = "-";
const std::string camelCaseName = paramInfo.paramName;
for (unsigned i = 0; i < camelCaseName.size(); ++i) {
if (isupper(camelCaseName[i]))
cmdLineName += "-";
cmdLineName += static_cast<char>(std::tolower(camelCaseName[i]));
}
// assemble the printed output
paramMessage = " ";
paramMessage += cmdLineName;
// add the =VALUE_TYPE part
bool isString = false;
if (paramInfo.paramTypeName == Dune::className<std::string>()
|| paramInfo.paramTypeName == "const char *")
{
paramMessage += "=STRING";
isString = true;
}
else if (paramInfo.paramTypeName == Dune::className<float>()
|| paramInfo.paramTypeName == Dune::className<double>()
|| paramInfo.paramTypeName == Dune::className<long double>()
#if HAVE_QUAD
|| paramInfo.paramTypeName == Dune::className<quad>()
#endif // HAVE_QUAD
)
paramMessage += "=SCALAR";
else if (paramInfo.paramTypeName == Dune::className<int>()
|| paramInfo.paramTypeName == Dune::className<unsigned int>()
|| paramInfo.paramTypeName == Dune::className<short>()
|| paramInfo.paramTypeName == Dune::className<unsigned short>())
paramMessage += "=INTEGER";
else if (paramInfo.paramTypeName == Dune::className<bool>())
paramMessage += "=BOOLEAN";
else if (paramInfo.paramTypeName.empty()) {
// the parameter is a flag. Do nothing!
}
else {
// unknown type
paramMessage += "=VALUE";
}
// fill up the up help string to the 50th character
paramMessage += " ";
while (paramMessage.size() < 50)
paramMessage += " ";
// append the parameter usage string.
paramMessage += paramInfo.usageString;
// add the default value
if (!paramInfo.paramTypeName.empty()) {
if (paramMessage.back() != '.')
paramMessage += '.';
paramMessage += " Default: ";
if (paramInfo.paramTypeName == "bool") {
if (paramInfo.defaultValue == "0")
paramMessage += "false";
else
paramMessage += "true";
}
else if (isString) {
paramMessage += "\"";
paramMessage += paramInfo.defaultValue;
paramMessage += "\"";
}
else
paramMessage += paramInfo.defaultValue;
}
paramMessage = breakLines(paramMessage, /*indent=*/52, ttyWidth);
paramMessage += "\n";
// print everything
os << paramMessage;
}
void getLists(std::vector<Parameter>& usedParams,
std::vector<Parameter>& unusedParams)
{

3
opm/models/utils/parametersystem.hpp
View File

@ -169,9 +169,6 @@ private:
}
};
// function prototype declarations
void printParamUsage(std::ostream& os, const ParamInfo& paramInfo);
std::string breakLines(const std::string& msg,
int indentWidth,
int maxWidth);