Commit 56b9a826 authored by Timo Koch's avatar Timo Koch
Browse files

[examples][tracer] Replace raw HTML <details> by [[details]]

parent 05c9c4a4
......@@ -153,7 +153,7 @@ struct LocalResidual<TypeTag, TTag::IncompressibleTest> { using type = OnePIncom
Apart from that, we also set some properties related to memory management
throughout the simulation.
<details>
<details><summary> Click to show caching properties</summary>
In Dumux, one has the option to activate/deactive the grid-wide caching of
geometries and variables. If active, the CPU time can be significantly reduced
......@@ -431,7 +431,7 @@ We reference to the permeability field. This is used in the main function to wri
The remainder of this class contains a convenient function to determine if
a position is inside the lens and defines the data members.
<details>
<details><summary> Click to show private data members and member functions</summary>
```cpp
private:
......
......@@ -21,7 +21,7 @@ the transport of an initial contamination through the model domain.
## Included header files
<details>
<details><summary> Click to show includes</summary>
These are DUNE helper classes related to parallel computations, time measurements and file I/O
```cpp
......@@ -383,7 +383,7 @@ before the program is terminated.
### Exception handling
In this part of the main file we catch and print possible exceptions that could
occur during the simulation.
<details>
<details><summary> Click to show exception handler</summary>
```cpp
// errors related to run-time parameters
......
......@@ -31,8 +31,8 @@ which we then specialize `properties` to the needs of the desired setup.
<summary><b>Click to hide/show the file documentation</b> (or inspect the [source code](../properties_tracer.hh))</summary>
### Include files
<details>
### Includes
<details><summary> Click to show includes</summary>
As for the single-phase problem, atype tag is defined also for this simulation.
Here, we inherit all properties of the `Tracer` type tag, a convenience type tag
that specializes most of the required properties for tracer transport flow simulations in DuMuX.
......@@ -190,7 +190,7 @@ struct UseMoles<TypeTag, TTag::TracerTest> { static constexpr bool value = false
```
Moreover, we specialize several properties related to efficiency optimizations
<details>
<details><summary> Click to show caching properties</summary>
```cpp
// In Dumux, one has the option to activate/deactive the grid-wide caching of geometries
......
......@@ -28,7 +28,7 @@
// [[content]]
//
// ## Included header files
// <details>
// [[details]] includes
// [[exclude]]
// Some generic includes.
#include <config.h>
......@@ -66,7 +66,7 @@
// at the documentation provided therein.
#include "properties_1p.hh"
#include "properties_tracer.hh"
// </details>
// [[/details]]
//
// ## The main function
......@@ -340,7 +340,7 @@ int main(int argc, char** argv) try
// ### Exception handling
// In this part of the main file we catch and print possible exceptions that could
// occur during the simulation.
// <details>
// [[details]] exception handler
// [[codeblock]]
// errors related to run-time parameters
catch (Dumux::ParameterException &e)
......@@ -371,5 +371,5 @@ catch (...)
return 4;
}
// [[/codeblock]]
// </details>
// [[/details]]
// [[/content]]
......@@ -122,7 +122,7 @@ struct LocalResidual<TypeTag, TTag::IncompressibleTest> { using type = OnePIncom
// Apart from that, we also set some properties related to memory management
// throughout the simulation.
// <details>
// [[details]] caching properties
//
// In Dumux, one has the option to activate/deactive the grid-wide caching of
// geometries and variables. If active, the CPU time can be significantly reduced
......@@ -144,6 +144,6 @@ struct EnableGridGeometryCache<TypeTag, TTag::IncompressibleTest> { static const
} // end namespace Dumux::Properties
// [[/codeblock]]
// </details>
// [[/details]]
// [[/content]]
#endif
......@@ -27,8 +27,8 @@
//
// [[content]]
//
// ### Include files
// <details>
// ### Includes
// [[details]] includes
// As for the single-phase problem, atype tag is defined also for this simulation.
// Here, we inherit all properties of the `Tracer` type tag, a convenience type tag
// that specializes most of the required properties for tracer transport flow simulations in DuMuX.
......@@ -46,7 +46,7 @@
// We include the problem and spatial parameter headers used for this simulation.
#include "problem_tracer.hh"
#include "spatialparams_tracer.hh"
// </details>
// [[/details]]
//
// ### Definition of a custom fluid system
//
......@@ -159,7 +159,7 @@ template<class TypeTag>
struct UseMoles<TypeTag, TTag::TracerTest> { static constexpr bool value = false; };
// Moreover, we specialize several properties related to efficiency optimizations
// <details>
// [[details]] caching properties
// [[codeblock]]
// In Dumux, one has the option to activate/deactive the grid-wide caching of geometries
// and variables. If active, the CPU time can be significantly reduced as less dynamic
......@@ -183,6 +183,6 @@ struct SolutionDependentMolecularDiffusion<TypeTag, TTag::TracerTest>
} // end namespace Properties
} // end namespace Dumux
// [[/codeblock]]
// </details>
// [[/details]]
// [[/content]]
#endif
......@@ -136,7 +136,7 @@ public:
// The remainder of this class contains a convenient function to determine if
// a position is inside the lens and defines the data members.
// <details>
// [[details]] private data members and member functions
// [[codeblock]]
private:
// The following function returns true if a given position is inside the lens.
......@@ -159,6 +159,6 @@ private:
}; // end class definition of OnePTestSpatialParams
} // end namespace Dumux
// [[/codeblock]]
// </details>
// [[/details]]
// [[/content]]
#endif
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