Commit 4137d6ad authored by Christoph Grueninger's avatar Christoph Grueninger
Browse files

Proof read Stokes documentation, fix broken formulas in Doxygen.


git-svn-id: svn://svn.iws.uni-stuttgart.de/DUMUX/dumux/trunk@11486 2fb0f335-1f38-0410-981e-8018bf24f1b0
parent 41261495
......@@ -39,7 +39,7 @@ namespace Dumux
* \f$ - \text{div}\, \mathbf{v}_t = - \text{div}\, (\lambda_t \mathbf{K} \text{grad}\, \Phi_w + f_n \lambda_t \mathbf{K} \text{grad}\, \Phi_{cap} ) = 0, \f$, or
* \f$ - \text{div}\, \mathbf{v}_t = - \text{div}\, (\lambda_t \mathbf{K} \text{grad}\, \Phi_n - f_w \lambda_t \mathbf{K} \text{grad}\, \Phi_{cap} ) = 0, \f$.
* \f$\Phi = g\f$ on \f$\Gamma_1\f$, and
* \f$-\text{div}\, \mathbf_{v}_t \cdot \mathbf{n} = J\f$
* \f$-\text{div}\, \mathbf{v}_t \cdot \mathbf{n} = J\f$
* on \f$\Gamma_2\f$. Here,
* \f$Phi_\alpha \f$ denotes the potential of phase \f$\alpha\f$, \f$K\f$ the intrinsic permeability,
* \f$\lambda_t\f$ the total mobility, \f$this->f_\alpha\f$ the phase fractional flow function.
......
......@@ -35,10 +35,10 @@ namespace Dumux
{
//! \ingroup diffusion
/*! Finite Volume-MPFAL-Implementation of the equation
* \f$ - \text{div}\, \mathbf_{v}_t = - \text{div}\, (\lambda_t \mathbf{K} \text{grad}\, \Phi_w + f_n \lambda_t \mathbf{K} \text{grad}\, \Phi_{cap} ) = 0, \f$, or
* \f$ - \text{div}\, \mathbf_{v}_t = - \text{div}\, (\lambda_t \mathbf{K} \text{grad}\, \Phi_n - f_w \lambda_t \mathbf{K} \text{grad}\, \Phi_{cap} ) = 0, \f$.
* \f$ - \text{div}\, \mathbf{v}_t = - \text{div}\, (\lambda_t \mathbf{K} \text{grad}\, \Phi_w + f_n \lambda_t \mathbf{K} \text{grad}\, \Phi_{cap} ) = 0, \f$, or
* \f$ - \text{div}\, \mathbf{v}_t = - \text{div}\, (\lambda_t \mathbf{K} \text{grad}\, \Phi_n - f_w \lambda_t \mathbf{K} \text{grad}\, \Phi_{cap} ) = 0, \f$.
* \f$\Phi = g\f$ on \f$\Gamma_1\f$, and
* \f$-\text{div}\, \mathbf_{v}_t \cdot \mathbf{n} = J\f$
* \f$-\text{div}\, \mathbf{v}_t \cdot \mathbf{n} = J\f$
* on \f$\Gamma_2\f$. Here,
* \f$Phi_\alpha \f$ denotes the potential of phase \f$\alpha\f$, \f$K\f$ the intrinsic permeability,
* \f$\lambda_t\f$ the total mobility, \f$this->f_\alpha\f$ the phase fractional flow function.
......
......@@ -39,10 +39,10 @@ namespace Dumux
* \ingroup ImplicitFluxVariables
* \brief This template class contains the data which is required to
* calculate the mass and momentum fluxes over the face of a
* sub-control volume for the Stokes box model.
* sub-control volume for the Stokes model.
*
* This means pressure gradients, phase densities, viscosities, etc.
* at the integration point of the sub-control-volume face
* at the integration point of the sub-control-volume face.
*/
template <class TypeTag>
class StokesFluxVariables
......
......@@ -38,7 +38,7 @@ namespace Dumux
* \ingroup BoxStokesModel
* \brief Adaption of the box scheme to the Stokes model.
*
* This model implements laminar Stokes flow of a single fluid, solving a momentum balance:
* This model implements laminar Stokes flow of a single fluid, solving the momentum balance equation
* \f[
\frac{\partial \left(\varrho_g {\boldsymbol{v}}_g\right)}{\partial t}
+ \boldsymbol{\nabla} \boldsymbol{\cdot} \left(p_g {\bf {I}}
......@@ -47,16 +47,17 @@ namespace Dumux
- \varrho_g {\bf g} = 0,
* \f]
*
* and the mass balance equation:
* and the mass balance equation
* \f[
\frac{\partial \varrho_g}{\partial t} + \boldsymbol{\nabla}\boldsymbol{\cdot}\left(\varrho_g {\boldsymbol{v}}_g\right) - q_g = 0
\frac{\partial \varrho_g}{\partial t} + \boldsymbol{\nabla}\boldsymbol{\cdot}\left(\varrho_g {\boldsymbol{v}}_g\right) - q_g = 0.
* \f]
*
* By setting the property <code>EnableNavierStokes</code> to <code>true</code> the Navier-Stokes
* equation can be solved. In this case an additional term is added to the momentum balance:
* equation can be solved. In this case an additional term
* \f[
\varrho_g \left(\boldsymbol{v}_g \boldsymbol{\cdot} \boldsymbol{\nabla} \right) \boldsymbol{v}_g
* \f]
* is added to the momentum balance equation.
*
* This is discretized by a fully-coupled vertex-centered finite volume
* (box) scheme in space and by the implicit Euler method in time.
......
......@@ -36,7 +36,7 @@ namespace Dumux
/*!
* \ingroup BoxStokesModel
* \ingroup ImplicitVolumeVariables
* \brief Contains the quantities which are are constant within a
* \brief Contains the quantities which are constant within a
* finite volume in the Stokes box model.
*/
template <class TypeTag>
......
......@@ -114,7 +114,7 @@ public:
* At this point we can assume that everything has been allocated,
* although some objects may not yet be completely initialized.
*
* \param prob The problem which we want to simulate.
* \param problem The problem which we want to simulate.
*/
void init(Problem &problem)
{
......
......@@ -87,7 +87,7 @@ SET_BOOL_PROP(StokesTestProblem, ProblemEnableGravity, false);
*
* This problem uses the \ref BoxStokesModel.
* To run the simulation execute the following line in shell:
* <tt>./test_stokes -parameterFile ./test_stokes.input</tt>
* <tt>./test_stokes</tt>
*/
template <class TypeTag>
class StokesTestProblem : public StokesProblem<TypeTag>
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment