Skip to content
Snippets Groups Projects
Commit 6f2da7b1 authored by wenqing's avatar wenqing
Browse files

[DocLF] Corrected the documentation for LiquidFlow

parent 23edf8a8
No related branches found
No related tags found
No related merge requests found
Showing
with 26 additions and 14 deletions
\ogs_missing_documentation \copydoc ProcessLib::LiquidFlow::LiquidFlowProcess
\ogs_missing_documentation A tag for the gravity term of the Darcy velocity.
\ogs_missing_documentation The ID of the axis, where the gravity force exists.
It can be 0, 1, or the dimension of space minus one.
\ogs_missing_documentation The gravitational acceleration. If it is zero, there is not gravity term.
A tag for fluid properties.
\ No newline at end of file
A tag for viscosity model.
\ No newline at end of file
A tag for density model.
\ No newline at end of file
A tag for the properties of a series of porous media.
\ No newline at end of file
It specifies the material ID of a porous medium. The material IDs of elements
are given in mesh data. If a mesh data is given in vtu format, the scalar
variable name of MaterialIDs leads the element ID data.
A tag for the properties of a porous medium with material ID.
\ No newline at end of file
A tag for the relative permeability model of a porous medium.
\ No newline at end of file
A tag for the porosity model of a porous medium.
\ No newline at end of file
A tag for the storage model of a porous medium.
\ No newline at end of file
\ogs_missing_documentation A tag for material properties of the liquid flow process.
...@@ -37,39 +37,39 @@ LiquidFlowMaterialProperties::LiquidFlowMaterialProperties( ...@@ -37,39 +37,39 @@ LiquidFlowMaterialProperties::LiquidFlowMaterialProperties(
{ {
DBUG("Reading material properties of liquid flow process."); DBUG("Reading material properties of liquid flow process.");
//! \ogs_file_param{prj__material_property__fluid} //! \ogs_file_param{process__LIQUID_FLOW__material_property__fluid}
auto const& fluid_config = config.getConfigSubtree("fluid"); auto const& fluid_config = config.getConfigSubtree("fluid");
// Get fluid properties // Get fluid properties
//! \ogs_file_param{prj__material_property__fluid__density} //! \ogs_file_param{process__LIQUID_FLOW__material_property__fluid__density}
auto const& rho_conf = fluid_config.getConfigSubtree("density"); auto const& rho_conf = fluid_config.getConfigSubtree("density");
_liquid_density = MaterialLib::Fluid::createFluidDensityModel(rho_conf); _liquid_density = MaterialLib::Fluid::createFluidDensityModel(rho_conf);
//! \ogs_file_param{prj__material_property__fluid__viscosity} //! \ogs_file_param{process__LIQUID_FLOW__material_property__fluid__viscosity}
auto const& mu_conf = fluid_config.getConfigSubtree("viscosity"); auto const& mu_conf = fluid_config.getConfigSubtree("viscosity");
_viscosity = MaterialLib::Fluid::createViscosityModel(mu_conf); _viscosity = MaterialLib::Fluid::createViscosityModel(mu_conf);
// Get porous properties // Get porous properties
std::vector<int> mat_ids; std::vector<int> mat_ids;
//! \ogs_file_param{prj__material_property__porous_medium} //! \ogs_file_param{process__LIQUID_FLOW__material_property__porous_medium}
auto const& poro_config = config.getConfigSubtree("porous_medium"); auto const& poro_config = config.getConfigSubtree("porous_medium");
//! \ogs_file_param{prj__material_property__porous_medium__porous_medium} //! \ogs_file_param{process__LIQUID_FLOW__material_property__porous_medium__porous_medium}
for (auto const& conf : poro_config.getConfigSubtreeList("porous_medium")) for (auto const& conf : poro_config.getConfigSubtreeList("porous_medium"))
{ {
//! \ogs_file_attr{prj__material_property__porous_medium__porous_medium__id} //! \ogs_file_attr{process__LIQUID_FLOW__material_property__porous_medium__porous_medium__id}
auto const id = conf.getConfigAttributeOptional<int>("id"); auto const id = conf.getConfigAttributeOptional<int>("id");
mat_ids.push_back(*id); mat_ids.push_back(*id);
//! \ogs_file_param{prj__material_property__porous_medium__porous_medium__permeability} //! \ogs_file_param{process__LIQUID_FLOW__material_property__porous_medium__porous_medium__permeability}
auto const& perm_conf = conf.getConfigSubtree("permeability"); auto const& perm_conf = conf.getConfigSubtree("permeability");
_intrinsic_permeability_models.emplace_back( _intrinsic_permeability_models.emplace_back(
MaterialLib::PorousMedium::createPermeabilityModel(perm_conf)); MaterialLib::PorousMedium::createPermeabilityModel(perm_conf));
//! \ogs_file_param{prj__material_property__porous_medium__porous_medium__porosity} //! \ogs_file_param{process__LIQUID_FLOW__material_property__porous_medium__porous_medium__porosity}
auto const& poro_conf = conf.getConfigSubtree("porosity"); auto const& poro_conf = conf.getConfigSubtree("porosity");
auto n = MaterialLib::PorousMedium::createPorosityModel(poro_conf); auto n = MaterialLib::PorousMedium::createPorosityModel(poro_conf);
_porosity_models.emplace_back(std::move(n)); _porosity_models.emplace_back(std::move(n));
//! \ogs_file_param{prj__material_property__porous_medium__porous_medium__storage} //! \ogs_file_param{process__LIQUID_FLOW__material_property__porous_medium__porous_medium__storage}
auto const& stora_conf = conf.getConfigSubtree("storage"); auto const& stora_conf = conf.getConfigSubtree("storage");
auto beta = MaterialLib::PorousMedium::createStorageModel(stora_conf); auto beta = MaterialLib::PorousMedium::createStorageModel(stora_conf);
_storage_models.emplace_back(std::move(beta)); _storage_models.emplace_back(std::move(beta));
......
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