From fab3fb50fcbeb03e51f8866edbb7f8495e83d1e6 Mon Sep 17 00:00:00 2001
From: melaniel <melanie.lipp@iws.uni-stuttgart.de>
Date: Tue, 11 Feb 2020 16:53:49 +0100
Subject: [PATCH] [example][freeflowchannel] Further improve documentation.
---
examples/freeflowchannel/README.md | 23 ++++++++++++++---------
examples/freeflowchannel/main.cc | 15 ++++++++++++---
2 files changed, 26 insertions(+), 12 deletions(-)
diff --git a/examples/freeflowchannel/README.md b/examples/freeflowchannel/README.md
index 3b66c2bc87..eb948e3b31 100644
--- a/examples/freeflowchannel/README.md
+++ b/examples/freeflowchannel/README.md
@@ -81,18 +81,12 @@ The problem class specifies initial and boundary conditions:
template<class TypeTag>
struct Problem<TypeTag, TTag::ChannelExample> { using type = Dumux::ChannelExampleProblem<TypeTag> ; };
```
-In the following we define our fluid properties.
+This is where we define the fluid system, which contains information about the properties of the fluid we're simulating. To define the fluid system we first define the property Scalar. We then use this type to create a fluid system that consists of an incompressible fluid of constant visosity.
```cpp
template<class TypeTag>
struct FluidSystem<TypeTag, TTag::ChannelExample>
{
-```
-We define a convenient shortcut to the property Scalar:
-```cpp
using Scalar = GetPropType<TypeTag, Properties::Scalar>;
-```
-We create a fluid system that consists of an incompressible fluid of constant visosity
-```cpp
using type = FluidSystems::OnePLiquid<Scalar, Components::Constant<1, Scalar> >;
};
```
@@ -534,8 +528,11 @@ We set the assembler.
```
</details>
-#### Solution
-We set the linear and non-linear solver, solve the non-linear system and calculate mass and volume fluxes over the planes.
+#### Calculations
+Calculations are done in the following:
+
+##### Solution
+We set the linear and non-linear solver and solve the non-linear system.
<details>
<summary>Click to toggle details</summary>
@@ -547,7 +544,15 @@ We set the linear and non-linear solver, solve the non-linear system and calcula
NewtonSolver nonLinearSolver(assembler, linearSolver);
nonLinearSolver.solve(x);
+```
+</details>
+##### Postprocessing
+We calculate mass and volume fluxes over the planes.
+<details>
+<summary>Click to toggle details</summary>
+
+```cpp
flux.calculateMassOrMoleFluxes();
flux.calculateVolumeFluxes();
```
diff --git a/examples/freeflowchannel/main.cc b/examples/freeflowchannel/main.cc
index 6cbea1d2e3..720fbee130 100644
--- a/examples/freeflowchannel/main.cc
+++ b/examples/freeflowchannel/main.cc
@@ -219,8 +219,11 @@ int main(int argc, char** argv) try
auto assembler = std::make_shared<Assembler>(problem, gridGeometry, gridVariables);
// </details>
//
- // #### Solution
- // We set the linear and non-linear solver, solve the non-linear system and calculate mass and volume fluxes over the planes.
+ // #### Calculations
+ // Calculations are done in the following:
+ //
+ // ##### Solution
+ // We set the linear and non-linear solver and solve the non-linear system.
//<details>
// <summary>Click to toggle details</summary>
//
@@ -231,7 +234,13 @@ int main(int argc, char** argv) try
NewtonSolver nonLinearSolver(assembler, linearSolver);
nonLinearSolver.solve(x);
-
+ // </details>
+ //
+ // ##### Postprocessing
+ // We calculate mass and volume fluxes over the planes.
+ //<details>
+ // <summary>Click to toggle details</summary>
+ //
flux.calculateMassOrMoleFluxes();
flux.calculateVolumeFluxes();
// </details>
--
GitLab