Commit 6cd9e90d authored by Santiago's avatar Santiago

[Doc] Update documentation on analytic initial conditions

parent 9cfddfbc
......@@ -21,19 +21,39 @@ 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
.. object:: Analytic
* ``type = linear``
* ``type = analytic``
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
This type of initial condition defines an analytic function
:math:`f(x,y,z)` by the keyword ``initial.equation``.
.. math::
f (h) = f_0 + h \cdot \Delta f
f(x,y,z)
Possible variables
* ``x``
* ``y``
* ``z`` (Only in 3D)
* ``pi``
* ``dim``
Possible operations
* The mos common ones. Check out the complete list in muParser_.
.. _muParser: http://beltoforion.de/article.php?a=muparser&p=features
Richards
For instance, for Richards simulations it is useful to
set a gravity flow regime with the equation ``-y``
(or ``-z``) for 2 (or 3) dimensions.
Transport
Another example is to set a pulse in the middle of the domain for the
solute concentration in the transport model, in such case, the a possible
equation may be
``exp(-sqrt((x-0.5)^2+(y-0.5)^2)/(4.*0.002))/(4*pi*0.002)^(2/dim)``.
Transformation Types
--------------------
......@@ -50,3 +70,14 @@ Initial condition tranformations for the Richards solver.
The input data is directly interpreted as matric head
:math:`h_m [\mathrm{m}]`.
Transport
^^^^^^^^
Initial condition tranformations for the Transport solver.
.. object:: No Transformation
* ``quantity = soluteConcentration``
The input data is directly interpreted as solute concentration
:math:`c_w`.
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