From 4d06f7b09efaf150ba6f5d1cde4b9bfb9a2728e7 Mon Sep 17 00:00:00 2001
From: Thomas Fischer <thomas.fischer@ufz.de>
Date: Mon, 30 Jan 2017 10:52:20 +0100
Subject: [PATCH] [PL/HT] Fix documentation pages.
---
.../prj/processes/process/HT/fluid/i_fluid.md | 1 +
.../prj/processes/process/HT/fluid/t_density.md | 1 +
.../prj/processes/process/HT/fluid/t_viscosity.md | 1 +
.../process/HT/porous_medium/i_porous_medium.md | 1 +
.../process/HT/porous_medium/porous_medium/a_id.md | 3 +++
.../HT/porous_medium/porous_medium/i_porous_medium.md | 2 ++
.../HT/porous_medium/porous_medium/t_permeability.md | 1 +
.../HT/porous_medium/porous_medium/t_porosity.md | 1 +
.../HT/porous_medium/porous_medium/t_storage.md | 1 +
.../prj/processes/process/HT/t_density_fluid.md | 5 -----
.../processes/process/HT/t_fluid_reference_density.md | 3 +++
.../processes/process/HT/t_intrinsic_permeability.md | 1 -
.../ProjectFile/prj/processes/process/HT/t_porosity.md | 1 -
.../processes/process/HT/t_reference_temperature.md | 1 -
.../prj/processes/process/HT/t_specific_storage.md | 1 -
.../HT/t_thermal_expansion_coefficient_fluid.md | 1 -
.../prj/processes/process/HT/t_viscosity.md | 1 -
ProcessLib/HT/CreateHTProcess.cpp | 10 +++++-----
ProcessLib/HT/CreatePorousMediaProperties.cpp | 10 +++++-----
19 files changed, 25 insertions(+), 21 deletions(-)
create mode 100644 Documentation/ProjectFile/prj/processes/process/HT/fluid/i_fluid.md
create mode 100644 Documentation/ProjectFile/prj/processes/process/HT/fluid/t_density.md
create mode 100644 Documentation/ProjectFile/prj/processes/process/HT/fluid/t_viscosity.md
create mode 100644 Documentation/ProjectFile/prj/processes/process/HT/porous_medium/i_porous_medium.md
create mode 100644 Documentation/ProjectFile/prj/processes/process/HT/porous_medium/porous_medium/a_id.md
create mode 100644 Documentation/ProjectFile/prj/processes/process/HT/porous_medium/porous_medium/i_porous_medium.md
create mode 100644 Documentation/ProjectFile/prj/processes/process/HT/porous_medium/porous_medium/t_permeability.md
create mode 100644 Documentation/ProjectFile/prj/processes/process/HT/porous_medium/porous_medium/t_porosity.md
create mode 100644 Documentation/ProjectFile/prj/processes/process/HT/porous_medium/porous_medium/t_storage.md
delete mode 100644 Documentation/ProjectFile/prj/processes/process/HT/t_density_fluid.md
create mode 100644 Documentation/ProjectFile/prj/processes/process/HT/t_fluid_reference_density.md
delete mode 100644 Documentation/ProjectFile/prj/processes/process/HT/t_intrinsic_permeability.md
delete mode 100644 Documentation/ProjectFile/prj/processes/process/HT/t_porosity.md
delete mode 100644 Documentation/ProjectFile/prj/processes/process/HT/t_reference_temperature.md
delete mode 100644 Documentation/ProjectFile/prj/processes/process/HT/t_specific_storage.md
delete mode 100644 Documentation/ProjectFile/prj/processes/process/HT/t_thermal_expansion_coefficient_fluid.md
delete mode 100644 Documentation/ProjectFile/prj/processes/process/HT/t_viscosity.md
diff --git a/Documentation/ProjectFile/prj/processes/process/HT/fluid/i_fluid.md b/Documentation/ProjectFile/prj/processes/process/HT/fluid/i_fluid.md
new file mode 100644
index 00000000000..b00e9581a71
--- /dev/null
+++ b/Documentation/ProjectFile/prj/processes/process/HT/fluid/i_fluid.md
@@ -0,0 +1 @@
+Tag that encloses the specification of the fluid properties density and viscosity.
diff --git a/Documentation/ProjectFile/prj/processes/process/HT/fluid/t_density.md b/Documentation/ProjectFile/prj/processes/process/HT/fluid/t_density.md
new file mode 100644
index 00000000000..806844735c2
--- /dev/null
+++ b/Documentation/ProjectFile/prj/processes/process/HT/fluid/t_density.md
@@ -0,0 +1 @@
+Configuration for the constitutive laws for the fluid density from MaterialLib.
diff --git a/Documentation/ProjectFile/prj/processes/process/HT/fluid/t_viscosity.md b/Documentation/ProjectFile/prj/processes/process/HT/fluid/t_viscosity.md
new file mode 100644
index 00000000000..6450f353bd4
--- /dev/null
+++ b/Documentation/ProjectFile/prj/processes/process/HT/fluid/t_viscosity.md
@@ -0,0 +1 @@
+A tag describing the viscosity law for the process at hand.
diff --git a/Documentation/ProjectFile/prj/processes/process/HT/porous_medium/i_porous_medium.md b/Documentation/ProjectFile/prj/processes/process/HT/porous_medium/i_porous_medium.md
new file mode 100644
index 00000000000..b0d0a13f289
--- /dev/null
+++ b/Documentation/ProjectFile/prj/processes/process/HT/porous_medium/i_porous_medium.md
@@ -0,0 +1 @@
+Tag to specify various porous media.
diff --git a/Documentation/ProjectFile/prj/processes/process/HT/porous_medium/porous_medium/a_id.md b/Documentation/ProjectFile/prj/processes/process/HT/porous_medium/porous_medium/a_id.md
new file mode 100644
index 00000000000..15139e4fbcf
--- /dev/null
+++ b/Documentation/ProjectFile/prj/processes/process/HT/porous_medium/porous_medium/a_id.md
@@ -0,0 +1,3 @@
+The 'id' attribute maps the porous medium property to the mesh elements assigned
+to the same 'MaterialIDs' id, where 'MaterialIDs' property vector stored as a
+property withinn the mesh.
diff --git a/Documentation/ProjectFile/prj/processes/process/HT/porous_medium/porous_medium/i_porous_medium.md b/Documentation/ProjectFile/prj/processes/process/HT/porous_medium/porous_medium/i_porous_medium.md
new file mode 100644
index 00000000000..d877e666d2a
--- /dev/null
+++ b/Documentation/ProjectFile/prj/processes/process/HT/porous_medium/porous_medium/i_porous_medium.md
@@ -0,0 +1,2 @@
+Tag to specify a porous medium property consisting of the permeability, storage
+and porosity constitutive laws.
diff --git a/Documentation/ProjectFile/prj/processes/process/HT/porous_medium/porous_medium/t_permeability.md b/Documentation/ProjectFile/prj/processes/process/HT/porous_medium/porous_medium/t_permeability.md
new file mode 100644
index 00000000000..18b24ec305f
--- /dev/null
+++ b/Documentation/ProjectFile/prj/processes/process/HT/porous_medium/porous_medium/t_permeability.md
@@ -0,0 +1 @@
+This tag describes the permeability model of the porous medium.
diff --git a/Documentation/ProjectFile/prj/processes/process/HT/porous_medium/porous_medium/t_porosity.md b/Documentation/ProjectFile/prj/processes/process/HT/porous_medium/porous_medium/t_porosity.md
new file mode 100644
index 00000000000..989158e5409
--- /dev/null
+++ b/Documentation/ProjectFile/prj/processes/process/HT/porous_medium/porous_medium/t_porosity.md
@@ -0,0 +1 @@
+Tag describing the porosity model of the porous medium.
diff --git a/Documentation/ProjectFile/prj/processes/process/HT/porous_medium/porous_medium/t_storage.md b/Documentation/ProjectFile/prj/processes/process/HT/porous_medium/porous_medium/t_storage.md
new file mode 100644
index 00000000000..ae3f924782c
--- /dev/null
+++ b/Documentation/ProjectFile/prj/processes/process/HT/porous_medium/porous_medium/t_storage.md
@@ -0,0 +1 @@
+Tag describing the specific storage model of the porous medium.
diff --git a/Documentation/ProjectFile/prj/processes/process/HT/t_density_fluid.md b/Documentation/ProjectFile/prj/processes/process/HT/t_density_fluid.md
deleted file mode 100644
index 15d0c542585..00000000000
--- a/Documentation/ProjectFile/prj/processes/process/HT/t_density_fluid.md
+++ /dev/null
@@ -1,5 +0,0 @@
-Density of the fluid.
-
-At the moment the density of the fluid is read as a parameter.
-
-\todo{Use constitutive laws for the liquid density from MaterialLib.}
diff --git a/Documentation/ProjectFile/prj/processes/process/HT/t_fluid_reference_density.md b/Documentation/ProjectFile/prj/processes/process/HT/t_fluid_reference_density.md
new file mode 100644
index 00000000000..c6a5d6d663d
--- /dev/null
+++ b/Documentation/ProjectFile/prj/processes/process/HT/t_fluid_reference_density.md
@@ -0,0 +1,3 @@
+Reference value of the fluid density used in the equation of state for the fluid
+density as well as in the calculation of the thermal dispersivity and head
+capacity.
diff --git a/Documentation/ProjectFile/prj/processes/process/HT/t_intrinsic_permeability.md b/Documentation/ProjectFile/prj/processes/process/HT/t_intrinsic_permeability.md
deleted file mode 100644
index 95363481618..00000000000
--- a/Documentation/ProjectFile/prj/processes/process/HT/t_intrinsic_permeability.md
+++ /dev/null
@@ -1 +0,0 @@
-Intrinsic permeability
diff --git a/Documentation/ProjectFile/prj/processes/process/HT/t_porosity.md b/Documentation/ProjectFile/prj/processes/process/HT/t_porosity.md
deleted file mode 100644
index d8f75290d5b..00000000000
--- a/Documentation/ProjectFile/prj/processes/process/HT/t_porosity.md
+++ /dev/null
@@ -1 +0,0 @@
-Porosity of the solid
diff --git a/Documentation/ProjectFile/prj/processes/process/HT/t_reference_temperature.md b/Documentation/ProjectFile/prj/processes/process/HT/t_reference_temperature.md
deleted file mode 100644
index a51d70c207d..00000000000
--- a/Documentation/ProjectFile/prj/processes/process/HT/t_reference_temperature.md
+++ /dev/null
@@ -1 +0,0 @@
-The reference temperature used in temperature dependent viscosity.
diff --git a/Documentation/ProjectFile/prj/processes/process/HT/t_specific_storage.md b/Documentation/ProjectFile/prj/processes/process/HT/t_specific_storage.md
deleted file mode 100644
index b9423c528fd..00000000000
--- a/Documentation/ProjectFile/prj/processes/process/HT/t_specific_storage.md
+++ /dev/null
@@ -1 +0,0 @@
-Parameter for the specific storage.
diff --git a/Documentation/ProjectFile/prj/processes/process/HT/t_thermal_expansion_coefficient_fluid.md b/Documentation/ProjectFile/prj/processes/process/HT/t_thermal_expansion_coefficient_fluid.md
deleted file mode 100644
index 2238652355a..00000000000
--- a/Documentation/ProjectFile/prj/processes/process/HT/t_thermal_expansion_coefficient_fluid.md
+++ /dev/null
@@ -1 +0,0 @@
-Thermal expansion coefficient of the fluid.
diff --git a/Documentation/ProjectFile/prj/processes/process/HT/t_viscosity.md b/Documentation/ProjectFile/prj/processes/process/HT/t_viscosity.md
deleted file mode 100644
index c2cbd2e942c..00000000000
--- a/Documentation/ProjectFile/prj/processes/process/HT/t_viscosity.md
+++ /dev/null
@@ -1 +0,0 @@
-Viscosity.
diff --git a/ProcessLib/HT/CreateHTProcess.cpp b/ProcessLib/HT/CreateHTProcess.cpp
index 4fa349f9d40..d85d6a02903 100644
--- a/ProcessLib/HT/CreateHTProcess.cpp
+++ b/ProcessLib/HT/CreateHTProcess.cpp
@@ -51,14 +51,14 @@ std::unique_ptr<Process> createHTProcess(
"pressure"});
auto const& porous_medium_configs =
- //! \ogs_file_param_special{prj__processes__process__HT__porous_medium}
+ //! \ogs_file_param{prj__processes__process__HT__porous_medium}
config.getConfigSubtree("porous_medium");
PorousMediaProperties porous_media_properties{
createPorousMediaProperties(mesh, porous_medium_configs)};
- //! \ogs_file_param_special{prj__processes__process__HT__fluid}
+ //! \ogs_file_param{prj__processes__process__HT__fluid}
auto const& fluid_config = config.getConfigSubtree("fluid");
- //! \ogs_file_param_special{prj__processes__process__HT__fluid__viscosity}
+ //! \ogs_file_param{prj__processes__process__HT__fluid__viscosity}
auto const& viscosity_conf = fluid_config.getConfigSubtree("viscosity");
auto viscosity_model =
MaterialLib::Fluid::createViscosityModel(viscosity_conf);
@@ -70,7 +70,7 @@ std::unique_ptr<Process> createHTProcess(
"density_solid", parameters, 1);
DBUG("Use \'%s\' as density_solid parameter.", density_solid.name.c_str());
- //! \ogs_file_param_special{prj__processes__process__HT__fluid__density}
+ //! \ogs_file_param{prj__processes__process__HT__fluid__density}
auto const& fluid_density_conf = fluid_config.getConfigSubtree("density");
auto fluid_density =
MaterialLib::Fluid::createFluidDensityModel(fluid_density_conf);
@@ -78,7 +78,7 @@ std::unique_ptr<Process> createHTProcess(
// Parameter for the density of the fluid.
auto& fluid_reference_density= findParameter<double>(
config,
- //! \ogs_file_param{prj__processes__process__HT__fluid_reference_density}
+ //! \ogs_file_param_special{prj__processes__process__HT__fluid_reference_density}
"fluid_reference_density", parameters, 1);
DBUG("Use \'%s\' as fluid_reference_density parameter.",
fluid_reference_density.name.c_str());
diff --git a/ProcessLib/HT/CreatePorousMediaProperties.cpp b/ProcessLib/HT/CreatePorousMediaProperties.cpp
index 13becc7d774..2c9e9833fa8 100644
--- a/ProcessLib/HT/CreatePorousMediaProperties.cpp
+++ b/ProcessLib/HT/CreatePorousMediaProperties.cpp
@@ -36,15 +36,15 @@ PorousMediaProperties createPorousMediaProperties(
std::vector<int> mat_ids;
for (auto const& porous_medium_config :
- //! \ogs_file_param_special{prj__processes__process__HT__porous_medium__porous_medium}
+ //! \ogs_file_param{prj__processes__process__HT__porous_medium__porous_medium}
porous_medium_configs.getConfigSubtreeList("porous_medium"))
{
- //! \ogs_file_param_special{prj__processes__process__HT__porous_medium__porous_medium__id}
+ //! \ogs_file_attr{prj__processes__process__HT__porous_medium__porous_medium__id}
auto const id = porous_medium_config.getConfigAttribute<int>("id");
mat_ids.push_back(id);
auto const& porosity_conf =
- //! \ogs_file_param_special{prj__processes__process__HT__porous_medium__porous_medium__porosity}
+ //! \ogs_file_param{prj__processes__process__HT__porous_medium__porous_medium__porosity}
porous_medium_config.getConfigSubtree("porosity");
porosity_models.emplace_back(
MaterialLib::PorousMedium::createPorosityModel(porosity_conf));
@@ -53,7 +53,7 @@ PorousMediaProperties createPorousMediaProperties(
// element,
// i.e., the isotropic case is handled at the moment)
auto const& permeability_conf =
- //! \ogs_file_param_special{prj__processes__process__HT__porous_medium__porous_medium__permeability}
+ //! \ogs_file_param{prj__processes__process__HT__porous_medium__porous_medium__permeability}
porous_medium_config.getConfigSubtree("permeability");
intrinsic_permeability_models.emplace_back(
MaterialLib::PorousMedium::createPermeabilityModel(
@@ -61,7 +61,7 @@ PorousMediaProperties createPorousMediaProperties(
// Parameter for the specific storage.
auto const& storage_conf =
- //! \ogs_file_param_special{prj__processes__process__HT__porous_medium__porous_medium__storage}
+ //! \ogs_file_param{prj__processes__process__HT__porous_medium__porous_medium__storage}
porous_medium_config.getConfigSubtree("storage");
storage_models.emplace_back(
MaterialLib::PorousMedium::createStorageModel(storage_conf));
--
GitLab