From fdc893cfa5a2530dd746f4fbfdd7d7beead72ad0 Mon Sep 17 00:00:00 2001 From: Timo Koch <timo.koch@iws.uni-stuttgart.de> Date: Fri, 3 Apr 2020 13:13:19 +0200 Subject: [PATCH] [examples][tracer] Slighty adjust wording in main intro doc --- examples/1ptracer/doc/main.md | 14 ++++++++------ examples/1ptracer/doc/mainintro.md | 12 +++++++----- 2 files changed, 15 insertions(+), 11 deletions(-) diff --git a/examples/1ptracer/doc/main.md b/examples/1ptracer/doc/main.md index 5a6279518d..f2005ef8a5 100644 --- a/examples/1ptracer/doc/main.md +++ b/examples/1ptracer/doc/main.md @@ -6,12 +6,14 @@ # Part 3: Main program flow -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. - -The subsequent code documentation is structured as follows: +We want to solve a single-phase flow problem +to obtain a pressure distribution in the domain. Subsequently, we compute a volume fluxes field +based on the obtained pressure distribution and pass it to the tracer problem. +Finally, we solve a transient transport problem for a tracer using the computed volume fluxes. +This main program flow is implemented in the `main()` function +of the program which is defined in the file `main.cc` described below. + +The code documentation is structured as follows: [[_TOC_]] diff --git a/examples/1ptracer/doc/mainintro.md b/examples/1ptracer/doc/mainintro.md index 7295bf55e2..99a4d831a4 100644 --- a/examples/1ptracer/doc/mainintro.md +++ b/examples/1ptracer/doc/mainintro.md @@ -1,10 +1,12 @@ # Part 3: Main program flow -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. +We want to solve a single-phase flow problem +to obtain a pressure distribution in the domain. Subsequently, we compute a volume fluxes field +based on the obtained pressure distribution and pass it to the tracer problem. +Finally, we solve a transient transport problem for a tracer using the computed volume fluxes. +This main program flow is implemented in the `main()` function +of the program which is defined in the file `main.cc` described below. -The subsequent code documentation is structured as follows: +The code documentation is structured as follows: [[_TOC_]] -- GitLab