From 046947c42c2f3b41044524d127ed37b73d97a13a Mon Sep 17 00:00:00 2001
From: Christoph Lehmann <christoph.lehmann@ufz.de>
Date: Fri, 27 May 2016 11:08:37 +0200
Subject: [PATCH] added docu for adsorption materials
---
.../ProjectFile/materials/adsorption/c_adsorption.md | 0
.../materials/adsorption/reaction/CaOH2/c_CaOH2.md | 1 +
.../adsorption/reaction/CaOH2/t_ode_solver_config.md | 1 +
.../materials/adsorption/reaction/Sinusoidal/c_Sinusoidal.md | 1 +
.../adsorption/reaction/Sinusoidal/t_reaction_enthalpy.md | 1 +
.../ProjectFile/materials/adsorption/reaction/i_reaction.md | 1 +
.../ProjectFile/materials/adsorption/reaction/t_type.md | 1 +
Documentation/ProjectFile/materials/c_materials.md | 0
MaterialsLib/Adsorption/Reaction.cpp | 1 +
MaterialsLib/Adsorption/ReactionCaOH2.h | 5 +++--
MaterialsLib/Adsorption/ReactionSinusoidal.h | 5 +++--
11 files changed, 13 insertions(+), 4 deletions(-)
create mode 100644 Documentation/ProjectFile/materials/adsorption/c_adsorption.md
create mode 100644 Documentation/ProjectFile/materials/adsorption/reaction/CaOH2/c_CaOH2.md
create mode 100644 Documentation/ProjectFile/materials/adsorption/reaction/CaOH2/t_ode_solver_config.md
create mode 100644 Documentation/ProjectFile/materials/adsorption/reaction/Sinusoidal/c_Sinusoidal.md
create mode 100644 Documentation/ProjectFile/materials/adsorption/reaction/Sinusoidal/t_reaction_enthalpy.md
create mode 100644 Documentation/ProjectFile/materials/adsorption/reaction/i_reaction.md
create mode 100644 Documentation/ProjectFile/materials/adsorption/reaction/t_type.md
create mode 100644 Documentation/ProjectFile/materials/c_materials.md
diff --git a/Documentation/ProjectFile/materials/adsorption/c_adsorption.md b/Documentation/ProjectFile/materials/adsorption/c_adsorption.md
new file mode 100644
index 00000000000..e69de29bb2d
diff --git a/Documentation/ProjectFile/materials/adsorption/reaction/CaOH2/c_CaOH2.md b/Documentation/ProjectFile/materials/adsorption/reaction/CaOH2/c_CaOH2.md
new file mode 100644
index 00000000000..bbf877d7841
--- /dev/null
+++ b/Documentation/ProjectFile/materials/adsorption/reaction/CaOH2/c_CaOH2.md
@@ -0,0 +1 @@
+\todo document
diff --git a/Documentation/ProjectFile/materials/adsorption/reaction/CaOH2/t_ode_solver_config.md b/Documentation/ProjectFile/materials/adsorption/reaction/CaOH2/t_ode_solver_config.md
new file mode 100644
index 00000000000..bbf877d7841
--- /dev/null
+++ b/Documentation/ProjectFile/materials/adsorption/reaction/CaOH2/t_ode_solver_config.md
@@ -0,0 +1 @@
+\todo document
diff --git a/Documentation/ProjectFile/materials/adsorption/reaction/Sinusoidal/c_Sinusoidal.md b/Documentation/ProjectFile/materials/adsorption/reaction/Sinusoidal/c_Sinusoidal.md
new file mode 100644
index 00000000000..bbf877d7841
--- /dev/null
+++ b/Documentation/ProjectFile/materials/adsorption/reaction/Sinusoidal/c_Sinusoidal.md
@@ -0,0 +1 @@
+\todo document
diff --git a/Documentation/ProjectFile/materials/adsorption/reaction/Sinusoidal/t_reaction_enthalpy.md b/Documentation/ProjectFile/materials/adsorption/reaction/Sinusoidal/t_reaction_enthalpy.md
new file mode 100644
index 00000000000..bbf877d7841
--- /dev/null
+++ b/Documentation/ProjectFile/materials/adsorption/reaction/Sinusoidal/t_reaction_enthalpy.md
@@ -0,0 +1 @@
+\todo document
diff --git a/Documentation/ProjectFile/materials/adsorption/reaction/i_reaction.md b/Documentation/ProjectFile/materials/adsorption/reaction/i_reaction.md
new file mode 100644
index 00000000000..bbf877d7841
--- /dev/null
+++ b/Documentation/ProjectFile/materials/adsorption/reaction/i_reaction.md
@@ -0,0 +1 @@
+\todo document
diff --git a/Documentation/ProjectFile/materials/adsorption/reaction/t_type.md b/Documentation/ProjectFile/materials/adsorption/reaction/t_type.md
new file mode 100644
index 00000000000..bbf877d7841
--- /dev/null
+++ b/Documentation/ProjectFile/materials/adsorption/reaction/t_type.md
@@ -0,0 +1 @@
+\todo document
diff --git a/Documentation/ProjectFile/materials/c_materials.md b/Documentation/ProjectFile/materials/c_materials.md
new file mode 100644
index 00000000000..e69de29bb2d
diff --git a/MaterialsLib/Adsorption/Reaction.cpp b/MaterialsLib/Adsorption/Reaction.cpp
index 7f08aab83a1..0a571b1ba3b 100644
--- a/MaterialsLib/Adsorption/Reaction.cpp
+++ b/MaterialsLib/Adsorption/Reaction.cpp
@@ -32,6 +32,7 @@ std::unique_ptr<Reaction>
Reaction::
newInstance(BaseLib::ConfigTree const& conf)
{
+ //! \ogs_file_param{materials__adsorption__reaction__type}
auto const type = conf.getConfParam<std::string>("type");
if (type == "Z13XBF")
diff --git a/MaterialsLib/Adsorption/ReactionCaOH2.h b/MaterialsLib/Adsorption/ReactionCaOH2.h
index dba2d1b7a08..bb60d3170b4 100644
--- a/MaterialsLib/Adsorption/ReactionCaOH2.h
+++ b/MaterialsLib/Adsorption/ReactionCaOH2.h
@@ -26,8 +26,9 @@ namespace Adsorption
class ReactionCaOH2 final : public Reaction
{
public:
- explicit ReactionCaOH2(BaseLib::ConfigTree const& conf)
- : _ode_solver_config{conf.getConfSubtree("ode_solver_config")}
+ explicit ReactionCaOH2(BaseLib::ConfigTree const& conf) :
+ //! \ogs_file_param{materials__adsorption__reaction__CaOH2__ode_solver_config}
+ _ode_solver_config{conf.getConfSubtree("ode_solver_config")}
{}
double getEnthalpy(const double /*p_Ads*/, const double /*T_Ads*/,
diff --git a/MaterialsLib/Adsorption/ReactionSinusoidal.h b/MaterialsLib/Adsorption/ReactionSinusoidal.h
index 9fb4bb98abf..42415991a39 100644
--- a/MaterialsLib/Adsorption/ReactionSinusoidal.h
+++ b/MaterialsLib/Adsorption/ReactionSinusoidal.h
@@ -21,8 +21,9 @@ namespace Adsorption
class ReactionSinusoidal final : public Reaction
{
public:
- explicit ReactionSinusoidal(BaseLib::ConfigTree const& conf)
- : _enthalpy(conf.getConfParam<double>("reaction_enthalpy"))
+ explicit ReactionSinusoidal(BaseLib::ConfigTree const& conf) :
+ //! \ogs_file_param{materials__adsorption__reaction__Sinusoidal__reaction_enthalpy}
+ _enthalpy(conf.getConfParam<double>("reaction_enthalpy"))
{
}
--
GitLab