public-api.rst 1.03 KB
Newer Older
Lukas Riedel's avatar
Lukas Riedel committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35
*********************
Public API Definition
*********************

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
:doc:`Config File Guide <quickstart-parameters>`.

The main routine (`dorie run <config>`) also requires input files for
:doc:`boundary conditions <quickstart-bcfile>` and
:doc:`soil parameters <quickstart-parameter-file>`.

Code API
========

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

.. doxygenclass:: Dune::Dorie::Simulation
   :members:

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

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