diff --git a/dune/dorie/model/richards/modules.dox b/dune/dorie/model/richards/modules.dox index ef12ec430b67b671945919165d5a7151e09f35c3..52dd574bdd80c38f11ff004b511c9ec6d4ec379c 100644 --- a/dune/dorie/model/richards/modules.dox +++ b/dune/dorie/model/richards/modules.dox @@ -11,6 +11,7 @@ @{ @ingroup Models @todo document richards model + @brief Solves the transient Richards equation @} @defgroup RichardsParam Parameterization diff --git a/dune/dorie/model/transport/local_operator_FV.hh b/dune/dorie/model/transport/local_operator_FV.hh index 301a033eeda3292b75aa84bf61f1581a45ddf218..ea2b13b6add20a79c883d18b46bed40ed24ad437 100644 --- a/dune/dorie/model/transport/local_operator_FV.hh +++ b/dune/dorie/model/transport/local_operator_FV.hh @@ -22,17 +22,19 @@ namespace Operator { * @brief Spatial local operator for the transport equation in unsaturated * media in a finite volume scheme. * @details It solves the spatial part of the transport equation: - * @f{eqnarray*}{ + * + * @f{eqnarray*}{ * \partial_t[\theta C_w] + * \nabla\cdot [\textbf{j}_w C_w] - - * \nabla [\theta \mathsf{D}_{eff}\nabla C_w]=0 &\qquad \text{in } + * \nabla [\theta \mathsf{D}_{\text{eff}}\nabla C_w]&=0 &\qquad \text{in } * \Omega\\ - * C_w = g &\qquad \text{on } \Gamma_D + * C_w &= g &\qquad \text{on } \Gamma_D * \subseteq\partial\Omega\\ - * \nabla C_w \cdot \textbf{n} = \textbf{j}_{\scriptscriptstyle + * \nabla C_w \cdot \textbf{n} &= \textbf{j}_{\scriptscriptstyle * C_w}& \qquad \text{on } \Gamma_N =\partial\Omega \backslash - * \Gamma_D}{ - * @f} + * \Gamma_D + * @f} + * * @author Santiago Ospina De Los Ríos * @date 2018 * @ingroup LocalOperators @@ -435,17 +437,19 @@ private: * @brief Temporal local operator for the transport equation in unsaturated * media in a finite volume scheme. * @details It solves the temporal part of the transport equation: - * @f{eqnarray*}{ + * + * @f{eqnarray*}{ * \partial_t[\theta C_w] + * \nabla\cdot [\textbf{j}_w C_w] - - * \nabla [\theta \mathsf{D}_{eff}\nabla C_w]=0 &\qquad \text{in } + * \nabla [\theta \mathsf{D}_{\text{eff}}\nabla C_w]&=0 &\qquad \text{in } * \Omega\\ - * C_w = g &\qquad \text{on } \Gamma_D + * C_w &= g &\qquad \text{on } \Gamma_D * \subseteq\partial\Omega\\ - * \nabla C_w \cdot \textbf{n} = \textbf{j}_{\scriptscriptstyle + * \nabla C_w \cdot \textbf{n} &= \textbf{j}_{\scriptscriptstyle * C_w}& \qquad \text{on } \Gamma_N =\partial\Omega \backslash - * \Gamma_D}{ - * @f} + * \Gamma_D + * @f} + * * @author Santiago Ospina De Los Ríos * @date 2018 * @ingroup LocalOperators diff --git a/dune/dorie/model/transport/modules.dox b/dune/dorie/model/transport/modules.dox index cf21df39ec227e274af9a0b6fd4a5f7ce792897b..abead292be65f6adc0bd88dcc57f483c3fafa908 100644 --- a/dune/dorie/model/transport/modules.dox +++ b/dune/dorie/model/transport/modules.dox @@ -8,27 +8,31 @@ @defgroup TransportModel Transport @{ -@ingroup Models + @brief Solves the transient passive transport equation for + unsaturated media + @ingroup Models + @details The transport model implements a class that fulfill the Dune::Dorie::SimulationBase class requirements (see @ref Models), and which specifically solves the transport equation for unsaturated media: + @f{eqnarray*}{ \partial_t[\theta C_w] + \nabla\cdot [\textbf{j}_w C_w] - - \nabla [\theta \mathsf{D}_{eff}\nabla C_w]=0 &\qquad \text{in } + \nabla [\theta \mathsf{D}_{\text{eff}}\nabla C_w]&=0 &\qquad \text{in } \Omega\\ - C_w = g &\qquad \text{on } \Gamma_D + C_w &= g &\qquad \text{on } \Gamma_D \subseteq\partial\Omega\\ - \nabla C_w \cdot \textbf{n} = \textbf{j}_{\scriptscriptstyle + \nabla C_w \cdot \textbf{n} &= \textbf{j}_{\scriptscriptstyle C_w}& \qquad \text{on } \Gamma_N =\partial\Omega \backslash \Gamma_D @f} - It implemented with a finite volume scheme and is written so that could be run - independently of the @ref RichardsModel model (e.g. with an - stationary case), or fully coupled with a transient case with fluxes provided - by the Dune::Dorie::RichardsSimulation class. + It implemented with a finite volume scheme and is written so that could + be run independently of the @ref RichardsModel model (e.g. with an + stationary case), or fully coupled with a transient case with fluxes + provided by the Dune::Dorie::RichardsSimulation class. @} **/