public-api.rst 1009 Bytes
Newer Older
1 2 3
**********
Public API
**********
Lukas Riedel's avatar
Lukas Riedel committed
4 5 6 7 8 9 10 11 12 13 14

DORiE's Public API comprises the usage of the compiled program as well as the
main code segments for using instances of DORiE in other (DUNE) modules and
programs.

Command Line API
================

The compiled program and the Docker application are executed via the
:doc:`Command Line Interface <python-dorie-wrapper>`. The specifications for the
respective configuration files are given in the
15
:doc:`Config File Guide <man-config-file>`.
Lukas Riedel's avatar
Lukas Riedel committed
16 17

The main routine (`dorie run <config>`) also requires input files for
18 19
:doc:`boundary conditions <man-bcfile>` and
:doc:`soil parameters <man-parameter-file>`.
Lukas Riedel's avatar
Lukas Riedel committed
20 21 22 23 24 25 26

Code API
========

DORiE supplies the `Simulation` template. This is the main class for assembling
and running the solver.

27
.. doxygenclass:: Dune::Dorie::RichardsSimulation
Lukas Riedel's avatar
Lukas Riedel committed
28 29 30 31 32 33 34 35
   :members:

The simulation template requires compile-time type specifications wrapped in a
suitable `Traits` structure.

.. doxygenstruct:: Dune::Dorie::BaseTraits
   :members:
   :undoc-members: