Documenation of parameters.

ufz · Apr 18, 2017 · a7bb07e · a7bb07e
1 parent 3a70e94
commit a7bb07e
Show file tree

Hide file tree

Showing 21 changed files with 24 additions and 0 deletions.
diff --git a/..._fluid_density_reference_concentration.md → ...ionDependent/t_reference_concentration.md b/..._fluid_density_reference_concentration.md → ...ionDependent/t_reference_concentration.md
diff --git a/...dent/t_fluid_density_reference_density.md → ...entrationDependent/t_reference_density.md b/...dent/t_fluid_density_reference_density.md → ...entrationDependent/t_reference_density.md
diff --git a/Documentation/ProjectFile/material/fluid/density/i_density.md 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
@@ -0,0 +1 @@
+List of constitutive relationships for viscosity models.
diff --git a/...on/ProjectFile/prj/processes/process/ComponentTransport/c_ComponentTransport.md b/...on/ProjectFile/prj/processes/process/ComponentTransport/c_ComponentTransport.md
@@ -0,0 +1 @@
+Implementation of the component transport.
diff --git a/...mentation/ProjectFile/prj/processes/process/ComponentTransport/fluid/i_fluid.md b/...mentation/ProjectFile/prj/processes/process/ComponentTransport/fluid/i_fluid.md
@@ -0,0 +1 @@
+Description of the fluid properties using constitutive relations.
diff --git a/...ntation/ProjectFile/prj/processes/process/ComponentTransport/fluid/t_density.md b/...ntation/ProjectFile/prj/processes/process/ComponentTransport/fluid/t_density.md
@@ -0,0 +1 @@
+The constitutive relation for the fluid density model.
diff --git a/...ation/ProjectFile/prj/processes/process/ComponentTransport/fluid/t_viscosity.md b/...ation/ProjectFile/prj/processes/process/ComponentTransport/fluid/t_viscosity.md
@@ -0,0 +1 @@
+The constitutive relation for the fluid viscosity model.
diff --git a/...tFile/prj/processes/process/ComponentTransport/porous_medium/i_porous_medium.md b/...tFile/prj/processes/process/ComponentTransport/porous_medium/i_porous_medium.md
@@ -0,0 +1 @@
+Tag to specify various porous media.
diff --git a/...le/prj/processes/process/ComponentTransport/porous_medium/porous_medium/a_id.md b/...le/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/...esses/process/ComponentTransport/porous_medium/porous_medium/i_porous_medium.md b/...esses/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/...cesses/process/ComponentTransport/porous_medium/porous_medium/t_permeability.md b/...cesses/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/.../processes/process/ComponentTransport/porous_medium/porous_medium/t_porosity.md b/.../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/...j/processes/process/ComponentTransport/porous_medium/porous_medium/t_storage.md b/...j/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/...j/processes/process/ComponentTransport/process_variables/i_process_variables.md b/...j/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/...e/prj/processes/process/ComponentTransport/process_variables/t_concentration.md b/...e/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/...ctFile/prj/processes/process/ComponentTransport/process_variables/t_pressure.md b/...ctFile/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
@@ -0,0 +1 @@
+Parameter to specify the decay rate.
diff --git a/...ojectFile/prj/processes/process/ComponentTransport/t_fluid_reference_density.md b/...ojectFile/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/...on/ProjectFile/prj/processes/process/ComponentTransport/t_retardation_factor.md b/...on/ProjectFile/prj/processes/process/ComponentTransport/t_retardation_factor.md
@@ -0,0 +1 @@
+Parameter for the specification of the retardation factor.
diff --git a/...n/ProjectFile/prj/processes/process/ComponentTransport/t_specific_body_force.md b/...n/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.