Commit 56b5728c authored by Timo Koch's avatar Timo Koch Committed by Simon Scholz
Browse files

[doc] Improve example readme

parent 42562647
Examples
===============
# Examples
To get started with DuMu<sup>x</sup>, we recommend the following documented examples. Each example folder contains a ready-to-use DuMu<sup>x</sup> simulation example.
The description in each folder (best viewed online by following the link) explains each line of the code.
The description in each folder (best viewed online by following the link) explains each line of the code example.
### [:open_file_folder: Example 1: One-phase flow and tracer transport](https://git.iws.uni-stuttgart.de/dumux-repositories/dumux/tree/master/examples/1ptracer)
In this example, we simulate tracer transport through a confined aquifer with a randomly distributed permeability field.
We first solve the pressure field, compute the steady state flow field, and then solve the tracer transport equation.
You learn how to
* generate a randomly distributed permeability field
* solve a one-phase flow in porous media problem
* compute the flow field from a pressure solution to pass to a tracer problem
* sequentially solve two types of problems after each other
* [Example 1: One phase flow with a tracer model:](https://git.iws.uni-stuttgart.de/dumux-repositories/dumux/tree/master/examples/1ptracer)
### [:open_file_folder: Example 2: Two-phase flow with infiltration and adaptive grid](https://git.iws.uni-stuttgart.de/dumux-repositories/dumux/tree/master/examples/2pinfiltration)
In this example we simulate tracer transport through a confined aquifer with a randomly distributed permeability field. We first solve the pressure field, compute the steady state flow field,
and then solve the tracer transport equation.
In this example we model a soil contamination problem where DNAPL infiltrates a water-saturated porous medium (two-phase flow).
The initial distribution of DNAPL is read in from a txt-file.
The grid is adapitvely refined where DNAPL enters the domain, around the plume, and around an injection well.
You learn how to
* [Example 2: Two-phase flow with infiltration and adaptive grid:](https://git.iws.uni-stuttgart.de/dumux-repositories/dumux/tree/master/examples/2pinfiltration)
* solve a two-phase flow in porous media problem with two immiscible phases
* set boundary conditions and a simple injection well
* implement a problem with heterogenous material parameters
* use adaptive grid refinement around the saturation front
In this example we model a soil contamination problem where DNAPL infiltrates a water-saturated porous medium (two-phase flow).
The initial distribution of DNAPL is read it from a txt-file.
The grid is adapitvely refined where DNAPL enters the domain, around the plume, and around an injection well.
### [:open_file_folder: Example 3: Shallow water model](https://git.iws.uni-stuttgart.de/dumux-repositories/dumux/tree/master/examples/shallowwaterfriction)
* [Example 3: Shallow water model:](https://git.iws.uni-stuttgart.de/dumux-repositories/dumux/tree/master/examples/shallowwaterfriction)
The shallow water flow model is applied to simulate steady subcritical flow in a river including a bottom friction model.
You learn how to
The shallow water flow model is applied to simulate steady subcritical flow in a river including a bottom friction model.
* solve a shallow water flow problem including bottom friction
* computate and output (VTK) an analytical reference solution
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