Commit 4a44821d authored by Timo Koch's avatar Timo Koch
Browse files

[examples][tracer] Add inter-document links

parent c5bc15e4
......@@ -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) |
|---:|
# 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
......
<!-- 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
......
......@@ -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) |
|---:|
......@@ -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_]]
......
# 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
......
<!-- 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
......
......@@ -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_]]
//
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment