diff --git a/examples/2pinfiltration/README.md b/examples/2pinfiltration/README.md index ebf00a2315e58ee589ddc023e2d10566d2331af3..b0d3814b7a7764f8af9ee760d59f7382961401d8 100644 --- a/examples/2pinfiltration/README.md +++ b/examples/2pinfiltration/README.md @@ -75,7 +75,11 @@ For more information about the discretization please have a look at the [handboo ## The file `spatialparams.hh` +<details open> +<summary><b>Click to hide/show the file documentation</b> (or inspect the [source code](spatialparams.hh))</summary> + +### Includes we include the basic spatial parameters for finite volumes file from which we will inherit ```cpp @@ -94,7 +98,6 @@ namespace Dumux { In the TwoPTestSpatialParams class we define all functions needed to describe the porous matrix, e.g. porosity and permeability ```cpp - template<class GridGeometry, class Scalar> class TwoPTestSpatialParams : public FVSpatialParams<GridGeometry, Scalar, TwoPTestSpatialParams<GridGeometry, Scalar>> @@ -235,9 +238,18 @@ we have a convenience definition of the position of the lens ``` +</details> + +---------- ## The file `problem.hh` + +<details open> +<summary><b>Click to hide/show the file documentation</b> (or inspect the [source code](problem.hh))</summary> + + +### Includes We start with includes for `PorousMediumFlowProblem` and `readFileToContainer` (used below). ```cpp @@ -245,6 +257,7 @@ We start with includes for `PorousMediumFlowProblem` and `readFileToContainer` ( #include <dumux/io/container.hh> ``` +### Problem class The problem class `PointSourceProblem` implements boundary and initial conditions. It derives from the `PorousMediumFlowProblem` class. @@ -444,10 +457,18 @@ private: </details> +</details> + +---------- ## The file `properties.hh` +<details open> +<summary><b>Click to hide/show the file documentation</b> (or inspect the [source code](properties.hh))</summary> + + +### Includes The header includes will be mentioned in the text below. <details><summary>Click to show the header includes</summary> @@ -564,10 +585,16 @@ struct Formulation<TypeTag, TTag::PointSourceExample> ``` +</details> + +---------- ## The file `main.cc` +<details open> +<summary><b>Click to hide/show the file documentation</b> (or inspect the [source code](main.cc))</summary> + This is the main file for the 2pinfiltration example. Here we can see the programme sequence and how the system is solved using Newton's method ### Includes @@ -1090,3 +1117,6 @@ catch (...) ``` +</details> + +---------- diff --git a/examples/2pinfiltration/main.cc b/examples/2pinfiltration/main.cc index 72011070b806dff9ccd505dda9e25795ffacd8d5..32b1fbbc18c472e27977bb5de14dd990f924bd85 100644 --- a/examples/2pinfiltration/main.cc +++ b/examples/2pinfiltration/main.cc @@ -17,7 +17,7 @@ * along with this program. If not, see <http://www.gnu.org/licenses/>. * *****************************************************************************/ // ## The file `main.cc` -// +// [[content]] // // This is the main file for the 2pinfiltration example. Here we can see the programme sequence and how the system is solved using Newton's method // ### Includes @@ -303,3 +303,4 @@ catch (...) std::cerr << "Unknown exception thrown! ---> Abort!" << std::endl; return 4; } +// [[/content]] diff --git a/examples/2pinfiltration/problem.hh b/examples/2pinfiltration/problem.hh index 9dcf4b6c0469044f445667176484a1064367392f..8fb6e92095e38d3d0be301fd896385977282dff1 100644 --- a/examples/2pinfiltration/problem.hh +++ b/examples/2pinfiltration/problem.hh @@ -21,10 +21,14 @@ #define DUMUX_EXAMPLE_TWOP_INFILTRATION_PROBLEM_HH // ## The file `problem.hh` +// [[content]] +// +// ### Includes // We start with includes for `PorousMediumFlowProblem` and `readFileToContainer` (used below). #include <dumux/porousmediumflow/problem.hh> #include <dumux/io/container.hh> +// ### Problem class // The problem class `PointSourceProblem` implements boundary and initial conditions. // It derives from the `PorousMediumFlowProblem` class. namespace Dumux { @@ -198,5 +202,5 @@ private: } // end namespace Dumux // </details> - +// [[/content]] #endif diff --git a/examples/2pinfiltration/properties.hh b/examples/2pinfiltration/properties.hh index f73a61ccc1cc55297e2fcc4e7cabf315eb1158e4..31a977f21548d5bee363d91d5d454975f45cc838 100644 --- a/examples/2pinfiltration/properties.hh +++ b/examples/2pinfiltration/properties.hh @@ -21,7 +21,9 @@ #define DUMUX_EXAMPLE_TWOP_INFILTRATION_PROPERTIES_HH // ## The file `properties.hh` +// [[content]] // +// ### Includes // The header includes will be mentioned in the text below. // <details><summary>Click to show the header includes</summary> #include <dune/alugrid/grid.hh> @@ -117,5 +119,5 @@ struct Formulation<TypeTag, TTag::PointSourceExample> { static constexpr auto value = TwoPFormulation::p0s1; }; } // end namespace Dumux::Properties - +// [[/content]] #endif diff --git a/examples/2pinfiltration/spatialparams.hh b/examples/2pinfiltration/spatialparams.hh index f8b4bd01b3306580944af3054be8e6b74d5954dd..14cd6a117e511db4e19081bbeafe02fa5f466349 100644 --- a/examples/2pinfiltration/spatialparams.hh +++ b/examples/2pinfiltration/spatialparams.hh @@ -21,9 +21,10 @@ #define DUMUX_TWOP_INCOMPRESSIBLE_EXAMPLE_SPATIAL_PARAMS_HH // ## The file `spatialparams.hh` +// [[content]] // -// -//we include the basic spatial parameters for finite volumes file from which we will inherit +// ### Includes +// we include the basic spatial parameters for finite volumes file from which we will inherit #include <dumux/material/spatialparams/fv.hh> // we include all laws which are needed to define the interaction between the solid matrix and the fluids, e.g. laws for capillary pressure saturation relationships. @@ -32,8 +33,7 @@ namespace Dumux { -//In the TwoPTestSpatialParams class we define all functions needed to describe the porous matrix, e.g. porosity and permeability - +// In the TwoPTestSpatialParams class we define all functions needed to describe the porous matrix, e.g. porosity and permeability template<class GridGeometry, class Scalar> class TwoPTestSpatialParams : public FVSpatialParams<GridGeometry, Scalar, TwoPTestSpatialParams<GridGeometry, Scalar>> @@ -139,5 +139,5 @@ private: }; } // end namespace Dumux - +// [[/content]] #endif