From e2c9b904a7b289abc8e313e33f36e411a06f588d Mon Sep 17 00:00:00 2001 From: Timo Koch <timo.koch@iws.uni-stuttgart.de> Date: Tue, 8 Oct 2019 18:59:45 +0200 Subject: [PATCH] [examples] Update intro README.md --- examples/README.md | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/examples/README.md b/examples/README.md index 362a00f38a..6ea88da777 100644 --- a/examples/README.md +++ b/examples/README.md @@ -1,15 +1,19 @@ Examples =============== -The following resources are useful to get started with DuMuX: +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. * [Example 1: One phase flow with a tracer model:](https://git.iws.uni-stuttgart.de/dumux-repositories/dumux/tree/master/examples/1ptracer) - This example contains a contaminant transported by a base groundwater flow in a randomly distributed permeability field. + 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. * [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 model a soil contamination problem where DNAPL infiltrates a porous medium. The initial distribution of DNAPL is known and we can read it from a txt-file. The grid is adapitvely refined around the injection. + 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. * [Example 3: Shallow water model:](https://git.iws.uni-stuttgart.de/dumux-repositories/dumux/tree/master/examples/shallowwaterfriction) - This example shows how the shallow water flow model can be applied to simulate steady subcritical flow including bottom friction. + The shallow water flow model is applied to simulate steady subcritical flow in a river including a bottom friction model. -- GitLab