Skip to content
Snippets Groups Projects
Commit 4d06f7b0 authored by Tom Fischer's avatar Tom Fischer
Browse files

[PL/HT] Fix documentation pages.

parent 6960d94c
No related branches found
No related tags found
No related merge requests found
Showing
with 25 additions and 21 deletions
Tag that encloses the specification of the fluid properties density and viscosity.
Configuration for the constitutive laws for the fluid density from MaterialLib.
A tag describing the viscosity law for the process at hand.
Tag to specify various porous media.
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.
Tag to specify a porous medium property consisting of the permeability, storage
and porosity constitutive laws.
This tag describes the permeability model of the porous medium.
Tag describing the porosity model of the porous medium.
Tag describing the specific storage model of the porous medium.
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.}
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.
Intrinsic permeability
Porosity of the solid
The reference temperature used in temperature dependent viscosity.
Parameter for the specific storage.
Thermal expansion coefficient of the fluid.
Viscosity.
......@@ -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());
......
......@@ -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));
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment