From 444b03068f9d0c5198dd213676fae981062c7c9a Mon Sep 17 00:00:00 2001 From: Martin Schneider <martin.schneider@iws.uni-stuttgart.de> Date: Tue, 16 Jul 2024 18:15:43 +0200 Subject: [PATCH] [ex][basic][doc] Formatting --- exercises/exercise-basic/README.md | 19 +++++-------------- 1 file changed, 5 insertions(+), 14 deletions(-) diff --git a/exercises/exercise-basic/README.md b/exercises/exercise-basic/README.md index ecd78ecf..57dc3f3f 100644 --- a/exercises/exercise-basic/README.md +++ b/exercises/exercise-basic/README.md @@ -1,5 +1,4 @@ # Exercise Basics (DuMuX course) -<br> ## Problem set-up @@ -14,9 +13,7 @@ The aquifer is situated 2700 m below sea level and the domain size is 60 m x 40 This exercise deals with two problems: a two-phase immiscible problem (__2p__) and a two-phase non-isothermal problem (__2pni__). They both set up the same scenario with the difference that the 2pni model introduces an extra energy equation. -<br><br> -### Task 1: Getting familiar with the code -<hr> +## Task 1: Getting familiar with the code Locate all the files you will need for this exercise * The __main file__ for the __2p__ problem : `2pmain.cc` @@ -27,9 +24,7 @@ Locate all the files you will need for this exercise * The shared __spatial parameters file__: `injection2pspatialparams.hh` * The shared __input file__: `params.input` -<br><br> -### Task 2: Compiling and running an executable -<hr> +## Task 2: Compiling and running an executable * Change to the build-directory @@ -55,9 +50,7 @@ make exercise_basic_2p paraview injection-2p.pvd ``` -<br><br> -### Task 3: Setting up a new executable (for a non-isothermal simulation) -<hr> +## Task 3: Setting up a new executable (for a non-isothermal simulation) * Copy the main file `2pmain.cc` and rename it to `2pnimain.cc` * In `2pnimain.cc`, include the header `properties2pni.hh` instead of `properties2p.hh`. @@ -67,7 +60,7 @@ paraview injection-2p.pvd ```cmake # the two-phase non-isothermal simulation program dumux_add_test(NAME exercise_basic_2pni - SOURCES 2pnimain.cc) + SOURCES 2pnimain.cc) ``` * In the respective build-cmake folder, test that everything compiles without error @@ -77,9 +70,7 @@ make # should rerun cmake make exercise_basic_2pni # builds new executable ``` -<br><br> -### Task 4: Setting up a non-isothermal __2pni__ test problem -<hr> +## Task 4: Setting up a non-isothermal __2pni__ test problem * Open the files `injection2pniproblem.hh` and `properties2pni.hh`. These are copies of the `injection2pproblem.hh` and `properties2p.hh` files, with some useful comments on how to implement a non-isothermal model. -- GitLab