Commit 3d209140 authored by Lukas Riedel's avatar Lukas Riedel

Update user docs

* Data I/O: Fix formatting. At units of output quantities.
* Features: Add formula for total solute. Sanitize line lengths

[skip ci]
parent 54132ea0
......@@ -47,21 +47,29 @@ Output Files
saved into the directory from which DORiE was executed.
* VTK Files (``.vtu``): The output data in unstructured grid format.
It contains multiple datasets:
.. object:: Richards
- ``head``: Matric head
- ``K0``: Saturated conductivity
- ``flux``: Water flux (not reconstructed!)
- ``flux_RT<k-1>``: Water flux reconstructed (if enabled!)
- ``theta_w``: Volumetric water content
- ``Theta``: Water saturation
.. object:: Transport
- ``solute``: Solute concentration
- ``solute_total``: Total solute
- ``flux_RT<k-1>``: Solute flux reconstructed (if enabled!)
It contains multiple multiple datasets depending on the type of model:
.. object:: Richards
- ``head``: Matric head :math:`h_m \, [\mathrm{m}]`
- ``K0``: Saturated conductivity :math:`K_0 \, [\mathrm{ms}^{-1}]`
- ``flux``: Water flux :math:`\mathbf{j}_w \, [\mathrm{ms}^{-1}]`
(not reconstructed!)
- ``flux_RT<k-1>``: Reconstructed water flux
:math:`\mathbf{j}_{w, \mathrm{rc}} \, [\mathrm{ms}^{-1}]`
(if enabled!)
- ``theta_w``: Volumetric water content :math:`\theta \, [\mathrm{-}]`
- ``Theta``: Water saturation :math:`\Theta \, [\mathrm{-}]`
.. object:: Transport
- ``solute``: Solute concentration in water phase
:math:`c_w \, [\mathrm{kg}/\mathrm{m}^3]`
- ``solute_total``: Total solute concentration
:math:`c_t \, [\mathrm{kg}/\mathrm{m}^3]`
- ``flux_RT<k-1>``: Reconstructed solute flux
:math:`\mathbf{j}_{s, \mathrm{rc}} \, [\mathrm{kg}/\mathrm{m}^{-2}\mathrm{s}^{-1}]`
(if enabled!)
* VTK Parallel Collection Files (``.pvtu``): Merging multiple VTK files in case
DORiE is run in parallel.
......
......@@ -36,12 +36,13 @@ soil. Depending on the soil architecture, the hydraulic parameters may be
discontinuous which would lead to water content and conductivity exhibiting
singularities.
Use the value ``richards`` in the ``simulation.mode`` keyword to run the Richards solver.
Use the value ``richards`` in the ``simulation.mode`` keyword to run the
standalone Richards solver.
Solute transport Solver
Solute Transport Solver
=======================
The solute transport equation for unsaturated media describes movement of
The solute transport equation for unsaturated media describes movement of
solute by the *solute concentration* :math:`c_w \, [\mathrm{kg}/\mathrm{m}^3]`,
.. math::
......@@ -51,13 +52,23 @@ solute by the *solute concentration* :math:`c_w \, [\mathrm{kg}/\mathrm{m}^3]`,
\right]
= 0,
where :math:`D \, [\mathrm{m}^2/\mathrm{s}]` is the effective hydrodynamic dispersion tensor, and :math:`\vec{j}_w` is the water flux. Currently, :math:`D` can only be used as a constant parameter by the keyword ``effHydrDips`` in the configuration file.
where :math:`D \, [\mathrm{m}^2/\mathrm{s}]` is the effective hydrodynamic
dispersion tensor, and :math:`\vec{j}_w` is the water flux. Currently,
:math:`D` can only be used as a constant parameter by the keyword
``effHydrDips`` in the configuration file. The solute concentration per total
volume :math:`c_t \, [\mathrm{kg}/\mathrm{m}^3]` is calculated by multiplying
the concentration in the water phase with the volumetric water content,
.. TODO: Update effective hydrodynamic dispersion description once parameterization is merged in master.
.. math::
c_t = c_w \theta_w
.. TODO: Update effective hydrodynamic dispersion description once
parameterization is merged in master.
The solute transport requires a water flux of the unsaturated media, hence,
the Richards solver must be utilized to solve them. Use the value
``richards+transport`` in the ``simulation.mode`` keyword to run the solute
The solute transport requires a water flux of the unsaturated media, hence,
the Richards solver must be utilized to solve them. Use the value
``richards+transport`` in the ``simulation.mode`` keyword to run the solute
transport solver.
.. _DUNE: https://www.dune-project.org/
......
Markdown is supported
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