Commit caa29ced authored by Simon Praetorius's avatar Simon Praetorius
Browse files

Add links to the example files

parent 7a6b5899

docs/core/grid-info.md

+1 −1
Original line number Diff line number Diff line
@@ -42,7 +42,7 @@ Dune::gridinfo(*grid, "ImportedMesh"); 
```



!!! example "Runnable example"

    Code: `examples/04_grid_info/grid_info.cc`

    Code: [`examples/04_grid_info/grid_info.cc`](https://gitlab.com/spraetor/dune-tutorial/-/blob/main/examples/04_grid_info/grid_info.cc)



    Build and run:

docs/core/grid-integration.md

+1 −1
Original line number Diff line number Diff line
@@ -73,7 +73,7 @@ for (const auto& e : elements(gv)) 
```



!!! example "Runnable example"

    Code: `examples/03_grid_integration/integration.cc`

    Code: [`examples/03_grid_integration/integration.cc`](https://gitlab.com/spraetor/dune-tutorial/-/blob/main/examples/03_grid_integration/integration.cc)



    Build and run:

docs/core/grid-io.md

+1 −1
Original line number Diff line number Diff line
@@ -68,7 +68,7 @@ Dune::printGrid(grid, 
You can run gnuplot manually afterwards.



!!! example "Runnable example (`printGrid`)"

    Code: `examples/05_grid_printgrid/print_grid.cc`

    Code: [`examples/05_grid_printgrid/print_grid.cc`](https://gitlab.com/spraetor/dune-tutorial/-/blob/main/examples/05_grid_printgrid/print_grid.cc)



    Build and run:

docs/core/grid.md

+3 −3
Original line number Diff line number Diff line
@@ -35,7 +35,7 @@ int main() 
}

```



File: `examples/01_grid_creation/grid_creation.cc`

File: [`examples/01_grid_creation/grid_creation.cc`](https://gitlab.com/spraetor/dune-tutorial/-/blob/main/examples/01_grid_creation/grid_creation.cc)



## What this means
@@ -60,7 +60,7 @@ Which grid type you choose depends on: 
- whether your grid is structured or unstructured,

- which external grid managers/modules are available in your setup.



## Grid vs grid view

## Grid vs GridView



This distinction appears everywhere in DUNE:
@@ -118,7 +118,7 @@ int main() 
}

```



File: `examples/02_grid_traversal/traversal.cc`

File: [`examples/02_grid_traversal/traversal.cc`](https://gitlab.com/spraetor/dune-tutorial/-/blob/main/examples/02_grid_traversal/traversal.cc)



## Hierarchy preview

docs/getting-started/first-program.md

+3 −3
Original line number Diff line number Diff line
@@ -11,7 +11,7 @@ Each directory under `examples/` is treated as a small DUNE module: 


## 1. Minimal C++ program



Example source (`examples/01_grid_creation/grid_creation.cc`):

Example source ([`examples/01_grid_creation/grid_creation.cc`](https://gitlab.com/spraetor/dune-tutorial/-/blob/main/examples/01_grid_creation/grid_creation.cc)):



```cpp

#include <array>
@@ -36,7 +36,7 @@ int main() 


The module file declares dependencies between modules.



Example (`examples/01_grid_creation/dune.module`):

Example ([`examples/01_grid_creation/dune.module`](https://gitlab.com/spraetor/dune-tutorial/-/blob/main/examples/01_grid_creation/dune.module)):



```text

Module: dune-tutorial-example-01
@@ -51,7 +51,7 @@ There are additional `dune.module` fields, but we ignore them here and return to 


Use regular CMake package discovery and imported DUNE targets.



Example (`examples/01_grid_creation/CMakeLists.txt`):

Example ([`examples/01_grid_creation/CMakeLists.txt`](https://gitlab.com/spraetor/dune-tutorial/-/blob/main/examples/01_grid_creation/CMakeLists.txt)):



```cmake

cmake_minimum_required(VERSION 3.16)