Commit e051eec6 authored by Dennis Gläser's avatar Dennis Gläser
Browse files

[examples][1ptracer] add tables of contents

parent 55c52ad6
......@@ -8,4 +8,8 @@ settings for the simulation. Two exemplary `properties`, that are mandatory to b
specialized, are `Problem` and `SpatialParams`. With the first, one sets the
`Problem` class to be used, in which users can define initial and boundary conditions.
Similarly, in the `SpatialParams` class one implements the parameter distributions
(e.g. porosity and permeability) that should be used.
(e.g. porosity and permeability) that should be used by the model.
The documentation provided in the sequel is structured as follows:
[[_TOC_]]
......@@ -8,4 +8,8 @@ settings for the simulation. Two exemplary `properties`, that are mandatory to b
specialized, are `Problem` and `SpatialParams`. With the first, one sets the
`Problem` class to be used, in which users can define initial and boundary conditions.
Similarly, in the `SpatialParams` class one implements the parameter distributions
(e.g. porosity and permeability) that should be used.
(e.g. porosity and permeability) that should be used by the model.
The documentation provided in the sequel is structured as follows:
[[_TOC_]]
......@@ -17,14 +17,15 @@
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
*****************************************************************************/
// ## Main program flow (`main.cc`)
// # Main program flow (`main.cc`)
//
// [[_TOC_]]
//
// This file contains the main program flow. In this example, we solve a single-phase flow problem
// to obtain a pressure distribution in the domain. Subsequently, the distribution of volume fluxes
// is computed from that pressure distribution, which is then passed to a tracer problem to solve
// the transport of an initial contamination through the model domain.
// ### Included header files
// ## Included header files
// <details>
// [[exclude]]
// Some generic includes.
......@@ -66,7 +67,7 @@
// </details>
//
// ### The main function
// ## The main function
// We will now discuss the main program flow implemented within the `main` function.
// At the beginning of each program using Dune, an instance of `Dune::MPIHelper` has to
// be created. Moreover, we parse the run-time arguments from the command line and the
......
Supports Markdown
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