Commit fdd6f7b1 authored by Lukas Riedel's avatar Lukas Riedel 📝

Add linear interpolator to user docs

parent ba96448a
......@@ -14,7 +14,7 @@ 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>`.
:doc:`Configuration File <config-file>`.
.. note::
The initial condition is projected onto the actual solution function space.
......@@ -74,6 +74,8 @@ They are controlled by the ``initial.type`` key and available for every model.
can be chosen using the setting ``initial.interpolation``. The input data
is automatically streched to match the grid extensions.
.. note:: For ``FEorder > 0``, linear interpolation is recommended.
Supported file extensions:
* ``.h5``: H5_ data file. ``initial.dataset`` may be a file-internal path
......
......@@ -98,8 +98,7 @@ scaling factors apply in all its child cells.
Supported Parameter File Types
------------------------------
This section lists the available types for parameterizations, scalings, and
interpolators in a understandable format. You can also dig through the code
documentation below, or the code itself, to retrieve this information.
interpolators in a understandable format.
Parameterizations
^^^^^^^^^^^^^^^^^
......@@ -210,10 +209,18 @@ Interpolators
.. object:: Nearest neighbor interpolator
Interprets dataset values as cell values.
* ``interpolation: nearest``
Interprets dataset values as cell values. No extrapolation is applied.
.. object:: Linear interpolator
* ``interpolation: linear``
Interprets dataset values as vertex values and linearaly interpolates
between them. No extrapolation is applied.
.. _YAML: https://gettaurus.org/docs/YAMLTutorial/
.. _HDF5: https://www.h5py.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