Commit 9f5b86cc authored by Lukas Riedel's avatar Lukas Riedel

Add user docs on initial conditions

parent 6b0836b9
......@@ -42,6 +42,7 @@ dune_cmake_sphinx_doc(SPHINX_CONF ${CMAKE_CURRENT_SOURCE_DIR}/conf.py.in
python-dorie-utilities.rst
man-bcfile.rst
man-cookbook.rst
man-initial.rst
man-installation.rst
man-config-file.rst
man-parameter-file.rst
......
......@@ -50,8 +50,9 @@ Manual
man-config-file
man-grid
man-bcfile
man-cookbook
man-parameter-file
man-initial
man-cookbook
public-api
.. _c-reference:
......
Initial Conditions
==================
DORiE computes transient solutions, and hence needs a solution from which it
can start. There are multiple ways of specifying an initial condition.
All have in common that the data provided must be interpolated on the
respective solution grid function space. Depending on the actual input data,
this means that information can be lost and specific features can be distorted.
Users are responsible to ensure that the solution grid function space and the
input data for initial conditions match in this sense.
Initial conditions can generally be stated in several physical quantities, as
long as the respective quantity has a unique transformation to the solver
solution quantity.
Initial condition input is controlled entirely via the
:doc:`Configuration File <man-config-file>`.
Input Types
-----------
This is an overview of all input types for initial conditions.
They are controlled by the ``initial.type`` key and available for every model.
.. object:: Linear Function
* ``type = linear``
This type of initial condition defines an analytic linear function
:math:`f(h)` which only depends on height :math:`h`. The user specifies
the value at height zero, :math:`f_0 = f(h = 0 \, \mathrm{m})`, and a
gradient :math:`\Delta f`. The function defining the solution is then
given by
.. math::
f (h) = f_0 + h \cdot \Delta f
Transformation Types
--------------------
This is an overview of the transformation types of all models.
They are controlled via the ``initial.quantity`` key.
Richards
^^^^^^^^
Initial condition tranformations for the Richards solver.
.. object:: No Transformation
* ``quantity = matricHead``
The input data is directly interpreted as matric head
:math:`h_m [\mathrm{m}]`.
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