diff --git a/examples/1ptracer/README.md b/examples/1ptracer/README.md index 86700edac27f95bbe5ea0af578e9d9754c3cc4c0..010b7710d3099ced281ebd2fddaf2126c0732e1b 100644 --- a/examples/1ptracer/README.md +++ b/examples/1ptracer/README.md @@ -110,8 +110,17 @@ In the documentations behind the links provided in the following, you will find mentioned settings and classes are realized in this example. Finally, it is discussed how the two simulations are solved sequentially in the main file (`main.cc`). -## [Implementation of the single-phase flow simulation setup](doc/1pmodel.md) +## Part 1: Single-phase flow simulation setup -## [Implementation of the tracer transport simulation setup](doc/tracermodel.md) +| [:arrow_right: Click to continue with part 1 of the code documentation](doc/1pmodel.md) | +|---:| -## [Main program flow](doc/main.md) +## Part 2: Tracer transport simulation setup + +| [:arrow_right: Click to continue with part 2 of the code documentation](doc/tracermodel.md) | +|---:| + +## Part 3: Main program flow + +| [:arrow_right: Click to continue with part 3 of the code documentation](doc/main.md) | +|---:| diff --git a/examples/1ptracer/doc/1pintro.md b/examples/1ptracer/doc/1pintro.md index 61a8f95eedf92ef5fe9628b553e7ea4bb5800438..707a370eafb62e6a962cb8dcc568d2054d52232d 100644 --- a/examples/1ptracer/doc/1pintro.md +++ b/examples/1ptracer/doc/1pintro.md @@ -1,4 +1,7 @@ -# Implementation of the single-phase flow simulation setup +| [:arrow_left: Back to the main documentation](../README.md) | [:arrow_right: Continue with part 2](tracermodel.md) | +|---|---:| + +# Part 1: Implementation of the single-phase flow simulation setup The single-phase flow setup is implemented in the files `properties_1p.hh`, `problem_1p.hh` and `spatialparams_1p.hh`. In the first of these files, a new diff --git a/examples/1ptracer/doc/1pmodel.md b/examples/1ptracer/doc/1pmodel.md index 48b55e6dacf68f3f0f7dc79e9715a3a3b9bef1f6..a7ac8a5f30b1383131d1b31db5f6a2bbf1f29f26 100644 --- a/examples/1ptracer/doc/1pmodel.md +++ b/examples/1ptracer/doc/1pmodel.md @@ -1,6 +1,9 @@ <!-- Important: This file has been automatically generated by generate_example_docs.py. Do not edit this file directly! --> -# Implementation of the single-phase flow simulation setup +| [:arrow_left: Back to the main documentation](../README.md) | [:arrow_right: Continue with part 2](tracermodel.md) | +|---|---:| + +# Part 1: Implementation of the single-phase flow simulation setup The single-phase flow setup is implemented in the files `properties_1p.hh`, `problem_1p.hh` and `spatialparams_1p.hh`. In the first of these files, a new diff --git a/examples/1ptracer/doc/intro.md b/examples/1ptracer/doc/intro.md index cf08a89f0f70a61502972c93590e14ac7ddfb08e..9eaf89136c81a1ed8b416e4c7f831fc7a77a4edd 100644 --- a/examples/1ptracer/doc/intro.md +++ b/examples/1ptracer/doc/intro.md @@ -108,8 +108,17 @@ In the documentations behind the links provided in the following, you will find mentioned settings and classes are realized in this example. Finally, it is discussed how the two simulations are solved sequentially in the main file (`main.cc`). -## [Implementation of the single-phase flow simulation setup](doc/1pmodel.md) +## Part 1: Single-phase flow simulation setup -## [Implementation of the tracer transport simulation setup](doc/tracermodel.md) +| [:arrow_right: Click to continue with part 1 of the code documentation](doc/1pmodel.md) | +|---:| -## [Main program flow](doc/main.md) +## Part 2: Tracer transport simulation setup + +| [:arrow_right: Click to continue with part 2 of the code documentation](doc/tracermodel.md) | +|---:| + +## Part 3: Main program flow + +| [:arrow_right: Click to continue with part 3 of the code documentation](doc/main.md) | +|---:| diff --git a/examples/1ptracer/doc/main.md b/examples/1ptracer/doc/main.md index 89137a34275791aec347b7620f55f115ab7394a7..510acc6ec0bc697d436844857c9bd5fb535ea81e 100644 --- a/examples/1ptracer/doc/main.md +++ b/examples/1ptracer/doc/main.md @@ -2,7 +2,10 @@ -# Main program flow (`main.cc`) +| [:arrow_left: Back to the main documentation](../README.md) | +|---:| + +# Part 3: Main program flow (`main.cc`) [[_TOC_]] diff --git a/examples/1ptracer/doc/tracerintro.md b/examples/1ptracer/doc/tracerintro.md index 9b64df8053674d60f52afae69e3bb65c6e7ddc5a..e894e458052efb39062947321478ec698882c746 100644 --- a/examples/1ptracer/doc/tracerintro.md +++ b/examples/1ptracer/doc/tracerintro.md @@ -1,4 +1,7 @@ -# Implementation of the tracer transport simulation setup +| [:arrow_left: Back to the main documentation](../README.md) | [:arrow_right: Continue with part 3](main.md) | +|---|---:| + +# Part 2: Implementation of the tracer transport simulation setup The tracer transport setup is implemented in the files `properties_tracer.hh`, `problem_tracer.hh` and `spatialparams_tracer.hh`. In the first of these files, a new diff --git a/examples/1ptracer/doc/tracermodel.md b/examples/1ptracer/doc/tracermodel.md index 3a6f3ac2c04cb52f72d989407437d5c4a9b636e0..00334457fe82f2164021788cfbb192a7d3497ac0 100644 --- a/examples/1ptracer/doc/tracermodel.md +++ b/examples/1ptracer/doc/tracermodel.md @@ -1,6 +1,9 @@ <!-- Important: This file has been automatically generated by generate_example_docs.py. Do not edit this file directly! --> -# Implementation of the tracer transport simulation setup +| [:arrow_left: Back to the main documentation](../README.md) | [:arrow_right: Continue with part 3](main.md) | +|---|---:| + +# Part 2: Implementation of the tracer transport simulation setup The tracer transport setup is implemented in the files `properties_tracer.hh`, `problem_tracer.hh` and `spatialparams_tracer.hh`. In the first of these files, a new diff --git a/examples/1ptracer/main.cc b/examples/1ptracer/main.cc index b1c6b23f88752f431aee14777a2bab70d690e46b..5425a700fee240326508e5b1b86be2ed6fbf5053 100644 --- a/examples/1ptracer/main.cc +++ b/examples/1ptracer/main.cc @@ -16,8 +16,10 @@ * You should have received a copy of the GNU General Public License * * along with this program. If not, see <http://www.gnu.org/licenses/>. * *****************************************************************************/ - -// # Main program flow (`main.cc`) +// | [:arrow_left: Back to the main documentation](../README.md) | +// |---:| +// +// # Part 3: Main program flow (`main.cc`) // // [[_TOC_]] //