Commit 895b9214 authored by Lukas Riedel's avatar Lukas Riedel

Fix class names in guided doxygen docs

parent 3c18ce02
......@@ -46,17 +46,13 @@ for computing the solution.
.. doxygenfunction:: build_grid_cube
.. doxygenfunction:: RichardsSolverSimplex
.. doxygenfunction:: RichardsSolverRectangular
.. _code-solver:
Solver Routine
--------------
The Solver Routine receives the assembled Grid Function Space and initializes the PDELab Backends
Simulation
----------
The Simulation template receives the assembled Grid Function Space and initializes the PDELab Backends
to compute the solution.
.. doxygenfunction:: RichardsSolver
.. doxygenclass:: Dune::Dorie::Simulation
.. _code-param:
Richards Equation Classes
......@@ -66,7 +62,10 @@ have to be represented. This is achieved by building objects which provide appro
Boundary Conditions, Parameters and Sink/Source terms, depending on both time and space. There are
three classes with standardized function queries for these tasks:
.. doxygenclass:: Dune::Dorie::RichardsEquationParameter
.. doxygenclass:: Dune::Dorie::ParameterizationBase
:members:
.. doxygenclass:: Dune::Dorie::MualemVanGenuchten
:members:
.. doxygenclass:: Dune::Dorie::FlowBoundary
......@@ -82,10 +81,10 @@ The local operators bind to the PDELab backend and compute the local residual al
They represent the numeric implementation of the PDE's *strong formulation*.
DORiE uses the mass conserving Discontinuous Galerkin (DG) discretization scheme.
.. doxygenclass:: Dune::Dorie::RichardsDGSpatialOperator
.. doxygenclass:: Dune::Dorie::Operator::RichardsDGSpatialOperator
:members:
.. doxygenclass:: Dune::Dorie::RichardsDGTemporalOperator
.. doxygenclass:: Dune::Dorie::Operator::RichardsDGTemporalOperator
:members:
.. _code-controller:
......@@ -106,8 +105,8 @@ local residuals along the grid. The residual represents the estimated error of t
on an estimation on the error in the water flux along an grid interface. Depending on the refinement
scheme, the grid is then refined or coarsened at positions of large or small errors, respectively.
.. doxygenclass:: Dune::Dorie::FluxErrorEstimator
.. doxygenclass:: Dune::Dorie::Operator::FluxErrorEstimator
:members:
.. doxygenclass:: Dune::Dorie::AdaptivityController
.. doxygenclass:: Dune::Dorie::AdaptivityHandler
:members:
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