Skip to content
Snippets Groups Projects
Commit 8cf5bfa2 authored by Timo Koch's avatar Timo Koch
Browse files

[doc] Improve docstring of fluid-matrix and constitutive models

parent 131ccae0
No related branches found
No related tags found
1 merge request!3725Improve Documentation for porous medium models with diffusion and heat conduction
......@@ -10,9 +10,23 @@
@defgroup Parameter Parameters and runtime configuration
@defgroup Material Constitutive modeling
@brief Constitutive model framework - Constitutive relations for fluids, solids, fluid-matrix-interactions and more
@details Constitutive relations formalize the functional dependence among physical variables, thereby providing the missing equations to close systems.
@defgroup Material Constitutive models
@brief Constitutive relations for fluids, solids, fluid-matrix interactions, and more
@details Constitutive relations formalize the functional dependence among physical variables, thereby providing the missing equations to close systems. Some constitutive relations, in particular if they are ad-hoc (e.g. Hooke's law) or empirical
and not derived from basic principles, are also called material laws.
Implementations of the functional relationships available in DuMu<sup>x</sup> are collected in the folder `dumux/material`.
Most implementations follow one of the following paradigms
* free functions (in nested namespaces),
* stateless classes with static member functions where all parameters are function arguments,
* statefull classes that contain parameters that need to be initialized.
Stateless, purely static classes have the advantage that only the class type needs to be known to
the class using them. Statefull classes need to be instantiated
and the instantiated object is passed to the consumer class.
To view the description of individual constitutive models and classes, click on one the modules below.
@defgroup MultiDomain Multidomain framework
@brief Coupling of several regular DuMu<sup>x</sup> problems
......
......@@ -17,7 +17,7 @@
<!-- Components -->
@defgroup Components Thermodynamical properties of chemical species
@brief Thermodynamical properties of single chemical species or fixed mixtures of species (\f$ \text{CO}_2, \text{H}_2\text{O}, \text{Air}, ... \f$)
@brief Thermodynamical properties of single chemical species or fixed mixtures of species ($ \text{CO}_2, \text{H}_2\text{O}, \text{Air}, ... $)
@details Components provide the thermodynamic relations for the liquid, gaseous and/or solid state of a single
chemical species or a _fixed_ mixture of species. Fluid systems use components to compute thermodynamic quantities of phases. An example would be the dynamic viscosity at different temperatures and pressures.
@ingroup Material
......@@ -45,8 +45,8 @@ chemical species or a _fixed_ mixture of species. Fluid systems use components t
<!-- Fluidmatrixinteractions -->
@defgroup Fluidmatrixinteractions Fluid-matrix interactions
@brief Constitutive relations such as pc-Sw relations, kr-Sw relations, effective diffusion coefficients, friction laws
@details Constitutive models for interaction of fluids and solids. The relations depend on the fluid state as well as material parameters of the matrix. For example, in porous media theory, the effective heat conductivity depends on the solid heat conductivity, the fluid heat conductivity, as well as the porosity of the solid and the fluid saturation.
@brief Constitutive models for interaction of fluids and solids
@details This module includes constitutive relations such as pc-Sw relations, kr-Sw relations, effective diffusion coefficients, friction laws. The relations depend on both the fluid state as well as material parameters of the solid matrix. For example, in porous media theory, the effective heat conductivity depends on the solid heat conductivity, the fluid heat conductivity, as well as the porosity of the solid and the fluid saturation.
@ingroup Material
<!-- Fluidmatrixinteractions subgroups -->
......
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