From 9fdea603a1e20ee62a1b73b6ebe05b44a6d804b4 Mon Sep 17 00:00:00 2001
From: Thomas Fischer <thomas.fischer@ufz.de>
Date: Wed, 12 Apr 2017 14:59:26 +0200
Subject: [PATCH] Documenation of parameters.
---
...reference_concentration.md => t_reference_concentration.md} | 0
...uid_density_reference_density.md => t_reference_density.md} | 0
Documentation/ProjectFile/material/fluid/density/i_density.md | 1 +
.../ProjectFile/material/fluid/viscosity/i_viscosity.md | 1 +
.../process/ComponentTransport/c_ComponentTransport.md | 1 +
.../prj/processes/process/ComponentTransport/fluid/i_fluid.md | 1 +
.../processes/process/ComponentTransport/fluid/t_density.md | 1 +
.../processes/process/ComponentTransport/fluid/t_viscosity.md | 1 +
.../ComponentTransport/porous_medium/i_porous_medium.md | 1 +
.../ComponentTransport/porous_medium/porous_medium/a_id.md | 3 +++
.../porous_medium/porous_medium/i_porous_medium.md | 2 ++
.../porous_medium/porous_medium/t_permeability.md | 1 +
.../porous_medium/porous_medium/t_porosity.md | 1 +
.../porous_medium/porous_medium/t_storage.md | 1 +
.../process_variables/i_process_variables.md | 1 +
.../ComponentTransport/process_variables/t_concentration.md | 1 +
.../process/ComponentTransport/process_variables/t_pressure.md | 1 +
.../prj/processes/process/ComponentTransport/t_decay_rate.md | 1 +
.../process/ComponentTransport/t_fluid_reference_density.md | 1 +
.../process/ComponentTransport/t_retardation_factor.md | 1 +
.../process/ComponentTransport/t_specific_body_force.md | 3 +++
21 files changed, 24 insertions(+)
rename Documentation/ProjectFile/material/fluid/density/ConcentrationDependent/{t_fluid_density_reference_concentration.md => t_reference_concentration.md} (100%)
rename Documentation/ProjectFile/material/fluid/density/ConcentrationDependent/{t_fluid_density_reference_density.md => t_reference_density.md} (100%)
create mode 100644 Documentation/ProjectFile/material/fluid/density/i_density.md
create mode 100644 Documentation/ProjectFile/material/fluid/viscosity/i_viscosity.md
create mode 100644 Documentation/ProjectFile/prj/processes/process/ComponentTransport/c_ComponentTransport.md
create mode 100644 Documentation/ProjectFile/prj/processes/process/ComponentTransport/fluid/i_fluid.md
create mode 100644 Documentation/ProjectFile/prj/processes/process/ComponentTransport/fluid/t_density.md
create mode 100644 Documentation/ProjectFile/prj/processes/process/ComponentTransport/fluid/t_viscosity.md
create mode 100644 Documentation/ProjectFile/prj/processes/process/ComponentTransport/porous_medium/i_porous_medium.md
create mode 100644 Documentation/ProjectFile/prj/processes/process/ComponentTransport/porous_medium/porous_medium/a_id.md
create mode 100644 Documentation/ProjectFile/prj/processes/process/ComponentTransport/porous_medium/porous_medium/i_porous_medium.md
create mode 100644 Documentation/ProjectFile/prj/processes/process/ComponentTransport/porous_medium/porous_medium/t_permeability.md
create mode 100644 Documentation/ProjectFile/prj/processes/process/ComponentTransport/porous_medium/porous_medium/t_porosity.md
create mode 100644 Documentation/ProjectFile/prj/processes/process/ComponentTransport/porous_medium/porous_medium/t_storage.md
create mode 100644 Documentation/ProjectFile/prj/processes/process/ComponentTransport/process_variables/i_process_variables.md
create mode 100644 Documentation/ProjectFile/prj/processes/process/ComponentTransport/process_variables/t_concentration.md
create mode 100644 Documentation/ProjectFile/prj/processes/process/ComponentTransport/process_variables/t_pressure.md
create mode 100644 Documentation/ProjectFile/prj/processes/process/ComponentTransport/t_decay_rate.md
create mode 100644 Documentation/ProjectFile/prj/processes/process/ComponentTransport/t_fluid_reference_density.md
create mode 100644 Documentation/ProjectFile/prj/processes/process/ComponentTransport/t_retardation_factor.md
create mode 100644 Documentation/ProjectFile/prj/processes/process/ComponentTransport/t_specific_body_force.md
diff --git a/Documentation/ProjectFile/material/fluid/density/ConcentrationDependent/t_fluid_density_reference_concentration.md b/Documentation/ProjectFile/material/fluid/density/ConcentrationDependent/t_reference_concentration.md
similarity index 100%
rename from Documentation/ProjectFile/material/fluid/density/ConcentrationDependent/t_fluid_density_reference_concentration.md
rename to Documentation/ProjectFile/material/fluid/density/ConcentrationDependent/t_reference_concentration.md
diff --git a/Documentation/ProjectFile/material/fluid/density/ConcentrationDependent/t_fluid_density_reference_density.md b/Documentation/ProjectFile/material/fluid/density/ConcentrationDependent/t_reference_density.md
similarity index 100%
rename from Documentation/ProjectFile/material/fluid/density/ConcentrationDependent/t_fluid_density_reference_density.md
rename to Documentation/ProjectFile/material/fluid/density/ConcentrationDependent/t_reference_density.md
diff --git a/Documentation/ProjectFile/material/fluid/density/i_density.md b/Documentation/ProjectFile/material/fluid/density/i_density.md
new file mode 100644
index 00000000000..4e66f4d9591
--- /dev/null
+++ b/Documentation/ProjectFile/material/fluid/density/i_density.md
@@ -0,0 +1 @@
+Various constitutive relationships for the fluid density.
diff --git a/Documentation/ProjectFile/material/fluid/viscosity/i_viscosity.md b/Documentation/ProjectFile/material/fluid/viscosity/i_viscosity.md
new file mode 100644
index 00000000000..d4bdf12871b
--- /dev/null
+++ b/Documentation/ProjectFile/material/fluid/viscosity/i_viscosity.md
@@ -0,0 +1 @@
+List of constitutive relationships for viscosity models.
diff --git a/Documentation/ProjectFile/prj/processes/process/ComponentTransport/c_ComponentTransport.md b/Documentation/ProjectFile/prj/processes/process/ComponentTransport/c_ComponentTransport.md
new file mode 100644
index 00000000000..64ccf4a965a
--- /dev/null
+++ b/Documentation/ProjectFile/prj/processes/process/ComponentTransport/c_ComponentTransport.md
@@ -0,0 +1 @@
+Implementation of the component transport.
diff --git a/Documentation/ProjectFile/prj/processes/process/ComponentTransport/fluid/i_fluid.md b/Documentation/ProjectFile/prj/processes/process/ComponentTransport/fluid/i_fluid.md
new file mode 100644
index 00000000000..82d8c9d5455
--- /dev/null
+++ b/Documentation/ProjectFile/prj/processes/process/ComponentTransport/fluid/i_fluid.md
@@ -0,0 +1 @@
+Description of the fluid properties using constitutive relations.
diff --git a/Documentation/ProjectFile/prj/processes/process/ComponentTransport/fluid/t_density.md b/Documentation/ProjectFile/prj/processes/process/ComponentTransport/fluid/t_density.md
new file mode 100644
index 00000000000..254641a5414
--- /dev/null
+++ b/Documentation/ProjectFile/prj/processes/process/ComponentTransport/fluid/t_density.md
@@ -0,0 +1 @@
+The constitutive relation for the fluid density model.
diff --git a/Documentation/ProjectFile/prj/processes/process/ComponentTransport/fluid/t_viscosity.md b/Documentation/ProjectFile/prj/processes/process/ComponentTransport/fluid/t_viscosity.md
new file mode 100644
index 00000000000..9c6e090a7ee
--- /dev/null
+++ b/Documentation/ProjectFile/prj/processes/process/ComponentTransport/fluid/t_viscosity.md
@@ -0,0 +1 @@
+The constitutive relation for the fluid viscosity model.
diff --git a/Documentation/ProjectFile/prj/processes/process/ComponentTransport/porous_medium/i_porous_medium.md b/Documentation/ProjectFile/prj/processes/process/ComponentTransport/porous_medium/i_porous_medium.md
new file mode 100644
index 00000000000..b0d0a13f289
--- /dev/null
+++ b/Documentation/ProjectFile/prj/processes/process/ComponentTransport/porous_medium/i_porous_medium.md
@@ -0,0 +1 @@
+Tag to specify various porous media.
diff --git a/Documentation/ProjectFile/prj/processes/process/ComponentTransport/porous_medium/porous_medium/a_id.md b/Documentation/ProjectFile/prj/processes/process/ComponentTransport/porous_medium/porous_medium/a_id.md
new file mode 100644
index 00000000000..15139e4fbcf
--- /dev/null
+++ b/Documentation/ProjectFile/prj/processes/process/ComponentTransport/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/ComponentTransport/porous_medium/porous_medium/i_porous_medium.md b/Documentation/ProjectFile/prj/processes/process/ComponentTransport/porous_medium/porous_medium/i_porous_medium.md
new file mode 100644
index 00000000000..d877e666d2a
--- /dev/null
+++ b/Documentation/ProjectFile/prj/processes/process/ComponentTransport/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/ComponentTransport/porous_medium/porous_medium/t_permeability.md b/Documentation/ProjectFile/prj/processes/process/ComponentTransport/porous_medium/porous_medium/t_permeability.md
new file mode 100644
index 00000000000..18b24ec305f
--- /dev/null
+++ b/Documentation/ProjectFile/prj/processes/process/ComponentTransport/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/ComponentTransport/porous_medium/porous_medium/t_porosity.md b/Documentation/ProjectFile/prj/processes/process/ComponentTransport/porous_medium/porous_medium/t_porosity.md
new file mode 100644
index 00000000000..989158e5409
--- /dev/null
+++ b/Documentation/ProjectFile/prj/processes/process/ComponentTransport/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/ComponentTransport/porous_medium/porous_medium/t_storage.md b/Documentation/ProjectFile/prj/processes/process/ComponentTransport/porous_medium/porous_medium/t_storage.md
new file mode 100644
index 00000000000..ae3f924782c
--- /dev/null
+++ b/Documentation/ProjectFile/prj/processes/process/ComponentTransport/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/ComponentTransport/process_variables/i_process_variables.md b/Documentation/ProjectFile/prj/processes/process/ComponentTransport/process_variables/i_process_variables.md
new file mode 100644
index 00000000000..52ddbe66f7f
--- /dev/null
+++ b/Documentation/ProjectFile/prj/processes/process/ComponentTransport/process_variables/i_process_variables.md
@@ -0,0 +1 @@
+List of tags for the specification of the name of the process variables.
diff --git a/Documentation/ProjectFile/prj/processes/process/ComponentTransport/process_variables/t_concentration.md b/Documentation/ProjectFile/prj/processes/process/ComponentTransport/process_variables/t_concentration.md
new file mode 100644
index 00000000000..5181c9dbab8
--- /dev/null
+++ b/Documentation/ProjectFile/prj/processes/process/ComponentTransport/process_variables/t_concentration.md
@@ -0,0 +1 @@
+Definition of the process variable for the transport process, i.e., the concentration.
diff --git a/Documentation/ProjectFile/prj/processes/process/ComponentTransport/process_variables/t_pressure.md b/Documentation/ProjectFile/prj/processes/process/ComponentTransport/process_variables/t_pressure.md
new file mode 100644
index 00000000000..bb11eb313da
--- /dev/null
+++ b/Documentation/ProjectFile/prj/processes/process/ComponentTransport/process_variables/t_pressure.md
@@ -0,0 +1 @@
+Definition of the process variable for the hydraulic process, i.e., the pressure.
diff --git a/Documentation/ProjectFile/prj/processes/process/ComponentTransport/t_decay_rate.md b/Documentation/ProjectFile/prj/processes/process/ComponentTransport/t_decay_rate.md
new file mode 100644
index 00000000000..b4992a3ad7e
--- /dev/null
+++ b/Documentation/ProjectFile/prj/processes/process/ComponentTransport/t_decay_rate.md
@@ -0,0 +1 @@
+Parameter to specify the decay rate.
diff --git a/Documentation/ProjectFile/prj/processes/process/ComponentTransport/t_fluid_reference_density.md b/Documentation/ProjectFile/prj/processes/process/ComponentTransport/t_fluid_reference_density.md
new file mode 100644
index 00000000000..7a9d865b220
--- /dev/null
+++ b/Documentation/ProjectFile/prj/processes/process/ComponentTransport/t_fluid_reference_density.md
@@ -0,0 +1 @@
+Parameter for the specification of the reference density of the fluid.
diff --git a/Documentation/ProjectFile/prj/processes/process/ComponentTransport/t_retardation_factor.md b/Documentation/ProjectFile/prj/processes/process/ComponentTransport/t_retardation_factor.md
new file mode 100644
index 00000000000..418ad86524a
--- /dev/null
+++ b/Documentation/ProjectFile/prj/processes/process/ComponentTransport/t_retardation_factor.md
@@ -0,0 +1 @@
+Parameter for the specification of the retardation factor.
diff --git a/Documentation/ProjectFile/prj/processes/process/ComponentTransport/t_specific_body_force.md b/Documentation/ProjectFile/prj/processes/process/ComponentTransport/t_specific_body_force.md
new file mode 100644
index 00000000000..0a6e4c9cc98
--- /dev/null
+++ b/Documentation/ProjectFile/prj/processes/process/ComponentTransport/t_specific_body_force.md
@@ -0,0 +1,3 @@
+Specific body forces applied to fluid.
+
+It is usually used to apply gravitational forces. Given as a 2d or 3d vector.
--
GitLab