From 8c6fa51ad7d57fb56462dc537f23bc4e9956370e Mon Sep 17 00:00:00 2001
From: Christoph Lehmann <christoph.lehmann@ufz.de>
Date: Tue, 23 Aug 2016 18:09:59 +0200
Subject: [PATCH] added prj param doxygen comments
---
NumLib/ODESolver/ConvergenceCriterionDeltaX.cpp | 4 ++++
.../ConvergenceCriterionPerComponentDeltaX.cpp | 4 ++++
.../ConvergenceCriterionPerComponentResidual.cpp | 4 ++++
.../ODESolver/ConvergenceCriterionResidual.cpp | 4 ++++
ProcessLib/Utils/ParseSecondaryVariables.cpp | 16 ++++++++--------
5 files changed, 24 insertions(+), 8 deletions(-)
diff --git a/NumLib/ODESolver/ConvergenceCriterionDeltaX.cpp b/NumLib/ODESolver/ConvergenceCriterionDeltaX.cpp
index 2c2249c1dbd..8f903ee4996 100644
--- a/NumLib/ODESolver/ConvergenceCriterionDeltaX.cpp
+++ b/NumLib/ODESolver/ConvergenceCriterionDeltaX.cpp
@@ -54,11 +54,15 @@ void ConvergenceCriterionDeltaX::checkDeltaX(const GlobalVector& minus_delta_x,
std::unique_ptr<ConvergenceCriterionDeltaX> createConvergenceCriterionDeltaX(
const BaseLib::ConfigTree& config)
{
+ //! \ogs_file_param{process__convergence_criterion__type}
config.checkConfigParameter("type", "DeltaX");
+ //! \ogs_file_param{process__convergence_criterion__DeltaX__abstol}
auto abstol = config.getConfigParameterOptional<double>("abstol");
+ //! \ogs_file_param{process__convergence_criterion__DeltaX__reltol}
auto reltol = config.getConfigParameterOptional<double>("reltol");
auto const norm_type_str =
+ //! \ogs_file_param{process__convergence_criterion__DeltaX__norm_type}
config.getConfigParameter<std::string>("norm_type");
auto const norm_type = MathLib::convertStringToVecNormType(norm_type_str);
diff --git a/NumLib/ODESolver/ConvergenceCriterionPerComponentDeltaX.cpp b/NumLib/ODESolver/ConvergenceCriterionPerComponentDeltaX.cpp
index 9615ab813d1..6fac5ce7945 100644
--- a/NumLib/ODESolver/ConvergenceCriterionPerComponentDeltaX.cpp
+++ b/NumLib/ODESolver/ConvergenceCriterionPerComponentDeltaX.cpp
@@ -80,13 +80,17 @@ void ConvergenceCriterionPerComponentDeltaX::setDOFTable(
std::unique_ptr<ConvergenceCriterionPerComponentDeltaX>
createConvergenceCriterionPerComponentDeltaX(const BaseLib::ConfigTree& config)
{
+ //! \ogs_file_param{process__convergence_criterion__type}
config.checkConfigParameter("type", "PerComponentDeltaX");
auto abstols =
+ //! \ogs_file_param{process__convergence_criterion__PerComponentDeltaX__abstols}
config.getConfigParameterOptional<std::vector<double>>("abstols");
auto reltols =
+ //! \ogs_file_param{process__convergence_criterion__PerComponentDeltaX__reltols}
config.getConfigParameterOptional<std::vector<double>>("reltols");
auto const norm_type_str =
+ //! \ogs_file_param{process__convergence_criterion__PerComponentDeltaX__norm_type}
config.getConfigParameter<std::string>("norm_type");
if ((!abstols) && (!reltols))
diff --git a/NumLib/ODESolver/ConvergenceCriterionPerComponentResidual.cpp b/NumLib/ODESolver/ConvergenceCriterionPerComponentResidual.cpp
index 155857c71fc..4b8cad55d93 100644
--- a/NumLib/ODESolver/ConvergenceCriterionPerComponentResidual.cpp
+++ b/NumLib/ODESolver/ConvergenceCriterionPerComponentResidual.cpp
@@ -90,13 +90,17 @@ std::unique_ptr<ConvergenceCriterionPerComponentResidual>
createConvergenceCriterionPerComponentResidual(
const BaseLib::ConfigTree& config)
{
+ //! \ogs_file_param{process__convergence_criterion__type}
config.checkConfigParameter("type", "PerComponentResidual");
auto abstols =
+ //! \ogs_file_param{process__convergence_criterion__PerComponentResidual__abstols}
config.getConfigParameterOptional<std::vector<double>>("abstols");
auto reltols =
+ //! \ogs_file_param{process__convergence_criterion__PerComponentResidual__reltols}
config.getConfigParameterOptional<std::vector<double>>("reltols");
auto const norm_type_str =
+ //! \ogs_file_param{process__convergence_criterion__PerComponentResidual__norm_type}
config.getConfigParameter<std::string>("norm_type");
if ((!abstols) && (!reltols))
diff --git a/NumLib/ODESolver/ConvergenceCriterionResidual.cpp b/NumLib/ODESolver/ConvergenceCriterionResidual.cpp
index 141245a4492..96a5b7c338c 100644
--- a/NumLib/ODESolver/ConvergenceCriterionResidual.cpp
+++ b/NumLib/ODESolver/ConvergenceCriterionResidual.cpp
@@ -58,11 +58,15 @@ void ConvergenceCriterionResidual::checkResidual(const GlobalVector& residual)
std::unique_ptr<ConvergenceCriterionResidual>
createConvergenceCriterionResidual(const BaseLib::ConfigTree& config)
{
+ //! \ogs_file_param{process__convergence_criterion__type}
config.checkConfigParameter("type", "Residual");
+ //! \ogs_file_param{process__convergence_criterion__Residual__abstol}
auto abstol = config.getConfigParameterOptional<double>("abstol");
+ //! \ogs_file_param{process__convergence_criterion__Residual__reltol}
auto reltol = config.getConfigParameterOptional<double>("reltol");
auto const norm_type_str =
+ //! \ogs_file_param{process__convergence_criterion__Residual__norm_type}
config.getConfigParameter<std::string>("norm_type");
auto const norm_type = MathLib::convertStringToVecNormType(norm_type_str);
diff --git a/ProcessLib/Utils/ParseSecondaryVariables.cpp b/ProcessLib/Utils/ParseSecondaryVariables.cpp
index 1595481e717..075ebf37513 100644
--- a/ProcessLib/Utils/ParseSecondaryVariables.cpp
+++ b/ProcessLib/Utils/ParseSecondaryVariables.cpp
@@ -20,24 +20,24 @@ void parseSecondaryVariables(
NumLib::NamedFunctionCaller& named_function_caller)
{
auto sec_vars_config =
- // \ogs_file_param{process__secondary_variables}
+ //! \ogs_file_param{process__secondary_variables}
config.getConfigSubtreeOptional("secondary_variables");
if (!sec_vars_config)
return;
for (auto sec_var_config :
- // \ogs_file_param{process__secondary_variables__secondary_variable}
+ //! \ogs_file_param{process__secondary_variables__secondary_variable}
sec_vars_config->getConfigSubtreeList("secondary_variable"))
{
auto const type =
- // \ogs_file_attr{process__secondary_variables__secondary_variable__type}
+ //! \ogs_file_attr{process__secondary_variables__secondary_variable__type}
sec_var_config.getConfigAttribute<std::string>("type");
auto const internal_name =
- // \ogs_file_attr{process__secondary_variables__secondary_variable__internal_name}
+ //! \ogs_file_attr{process__secondary_variables__secondary_variable__internal_name}
sec_var_config.getConfigAttribute<std::string>("internal_name");
auto const output_name =
- // \ogs_file_attr{process__secondary_variables__secondary_variable__output_name}
+ //! \ogs_file_attr{process__secondary_variables__secondary_variable__output_name}
sec_var_config.getConfigAttribute<std::string>("output_name");
secondary_variables.addNameMapping(internal_name, output_name);
@@ -48,14 +48,14 @@ void parseSecondaryVariables(
auto const& sink_fct = internal_name;
for (auto const plug :
- // \ogs_file_param{process__secondary_variables__secondary_variable__plug}
+ //! \ogs_file_param{process__secondary_variables__secondary_variable__plug}
sec_var_config.getConfigParameterList("plug"))
{
auto const sink_arg =
- // \ogs_file_attr{process__secondary_variables__secondary_variable__sink_arg}
+ //! \ogs_file_attr{process__secondary_variables__secondary_variable__sink_arg}
plug.getConfigAttribute<std::string>("sink_arg");
auto const source_fct =
- // \ogs_file_attr{process__secondary_variables__secondary_variable__source_fct}
+ //! \ogs_file_attr{process__secondary_variables__secondary_variable__source_fct}
plug.getConfigAttribute<std::string>("source_fct");
named_function_caller.plug(sink_fct, sink_arg, source_fct);
--
GitLab