From c76a9fcc3924a8c5392d44b161cc9a9100d8d297 Mon Sep 17 00:00:00 2001
From: Timo Koch <timokoch@uio.no>
Date: Thu, 29 Jun 2023 00:49:18 +0200
Subject: [PATCH] [examples][cleanup] Replace handbook references by
documentation links
---
examples/1ptracer/README.md | 3 ++-
examples/1ptracer/doc/_intro.md | 3 ++-
examples/2pinfiltration/README.md | 1 -
examples/2pinfiltration/doc/_intro.md | 1 -
examples/embedded_network_1d3d/README.md | 2 +-
examples/embedded_network_1d3d/doc/_intro.md | 2 +-
examples/freeflowchannel/README.md | 2 +-
examples/freeflowchannel/doc/_intro.md | 2 +-
examples/liddrivencavity/README.md | 2 +-
examples/liddrivencavity/doc/_intro.md | 2 +-
10 files changed, 10 insertions(+), 10 deletions(-)
diff --git a/examples/1ptracer/README.md b/examples/1ptracer/README.md
index 6bf2726c92..d627b2a395 100644
--- a/examples/1ptracer/README.md
+++ b/examples/1ptracer/README.md
@@ -85,7 +85,8 @@ The primary variable used in this model is the tracer mass fraction $`X^\kappa`$
In this example, all equations are discretized using cell-centered finite volumes with two-point flux
approximation as spatial discretization scheme. For details on the discretization schemes available in
-DuMuX, have a look at the [handbook](https://dumux.org/handbook). We use the implicit Euler method as
+DuMuX, have a look at the [code documentation](https://dumux.org/docs/doxygen/master/group___discretization.html).
+We use the [implicit Euler method](https://dumux.org/docs/doxygen/master/basic-numerics.html) as
time discretization scheme for the tracer component balance equation solved in the _tracer model_.
# Implementation
diff --git a/examples/1ptracer/doc/_intro.md b/examples/1ptracer/doc/_intro.md
index 4b37aa1f54..9aeb98ff7f 100644
--- a/examples/1ptracer/doc/_intro.md
+++ b/examples/1ptracer/doc/_intro.md
@@ -83,7 +83,8 @@ The primary variable used in this model is the tracer mass fraction $`X^\kappa`$
In this example, all equations are discretized using cell-centered finite volumes with two-point flux
approximation as spatial discretization scheme. For details on the discretization schemes available in
-DuMuX, have a look at the [handbook](https://dumux.org/handbook). We use the implicit Euler method as
+DuMuX, have a look at the [code documentation](https://dumux.org/docs/doxygen/master/group___discretization.html).
+We use the [implicit Euler method](https://dumux.org/docs/doxygen/master/basic-numerics.html) as
time discretization scheme for the tracer component balance equation solved in the _tracer model_.
# Implementation
diff --git a/examples/2pinfiltration/README.md b/examples/2pinfiltration/README.md
index 1e64fe95cf..9d179cafb3 100644
--- a/examples/2pinfiltration/README.md
+++ b/examples/2pinfiltration/README.md
@@ -56,7 +56,6 @@ In addition, the DNAPL is injected at a point source at x = 0.502m and y = 3.02m
We discretize the equations with a cell-centered finite volume TPFA scheme in space and an implicit Euler scheme in time. We use Newton's method to solve the system of nonlinear equations.
The grid is adapitvely refined around the injection. The adaptive behaviour can be changed with input parameters in the `params.input` file.
-For more information about the discretization please have a look at the [handbook](https://dumux.org/handbook).
# Implementation
diff --git a/examples/2pinfiltration/doc/_intro.md b/examples/2pinfiltration/doc/_intro.md
index f6b8c23d27..2a5af29546 100644
--- a/examples/2pinfiltration/doc/_intro.md
+++ b/examples/2pinfiltration/doc/_intro.md
@@ -54,7 +54,6 @@ In addition, the DNAPL is injected at a point source at x = 0.502m and y = 3.02m
We discretize the equations with a cell-centered finite volume TPFA scheme in space and an implicit Euler scheme in time. We use Newton's method to solve the system of nonlinear equations.
The grid is adapitvely refined around the injection. The adaptive behaviour can be changed with input parameters in the `params.input` file.
-For more information about the discretization please have a look at the [handbook](https://dumux.org/handbook).
# Implementation
diff --git a/examples/embedded_network_1d3d/README.md b/examples/embedded_network_1d3d/README.md
index 978a15e711..e100ab6944 100644
--- a/examples/embedded_network_1d3d/README.md
+++ b/examples/embedded_network_1d3d/README.md
@@ -65,7 +65,7 @@ as spatial discretization method with tracer mole fraction as primary variables.
`Tracer` model, an advection-diffusion-reaction model for porous media. In time, we use an implicit Euler scheme.
The arising linear system is solved with a stabilized bi-conjugate gradient solver (`BiCGSTAB`) with a block-diagonal
zero-fill incomplete LU factorization (`ILU0`) preconditioner. For details on the spatial discretization scheme,
-we recommend the [DuMu<sup>x</sup> handbook](https://dumux.org/handbook)
+we recommend the [DuMu<sup>x</sup> documentation](https://dumux.org/docs/doxygen/master/group___discretization.html).
or the [DuMu<sup>x</sup> paper](https://doi.org/10.1016/j.camwa.2020.02.012).
# Implementation
diff --git a/examples/embedded_network_1d3d/doc/_intro.md b/examples/embedded_network_1d3d/doc/_intro.md
index 84604ceb01..8b0348d784 100644
--- a/examples/embedded_network_1d3d/doc/_intro.md
+++ b/examples/embedded_network_1d3d/doc/_intro.md
@@ -63,7 +63,7 @@ as spatial discretization method with tracer mole fraction as primary variables.
`Tracer` model, an advection-diffusion-reaction model for porous media. In time, we use an implicit Euler scheme.
The arising linear system is solved with a stabilized bi-conjugate gradient solver (`BiCGSTAB`) with a block-diagonal
zero-fill incomplete LU factorization (`ILU0`) preconditioner. For details on the spatial discretization scheme,
-we recommend the [DuMu<sup>x</sup> handbook](https://dumux.org/handbook)
+we recommend the [DuMu<sup>x</sup> documentation](https://dumux.org/docs/doxygen/master/group___discretization.html).
or the [DuMu<sup>x</sup> paper](https://doi.org/10.1016/j.camwa.2020.02.012).
# Implementation
diff --git a/examples/freeflowchannel/README.md b/examples/freeflowchannel/README.md
index 23a79587eb..bbdcd71dab 100644
--- a/examples/freeflowchannel/README.md
+++ b/examples/freeflowchannel/README.md
@@ -36,7 +36,7 @@ Furthermore, isothermal conditions with a homogeneous temperature distribution o
All equations are discretized with the staggered-grid finite-volume scheme as spatial discretization
with pressures and velocity components as primary variables. For details on the discretization scheme,
-have a look at the Dumux [handbook](https://dumux.org/handbook).
+have a look at the DuMu<sup>x</sup> [documentation](https://dumux.org/docs/doxygen/master/group___discretization.html).
## Problem set-up
This example considers stationary flow of a fluid between two parallel solid plates in two dimensions.
diff --git a/examples/freeflowchannel/doc/_intro.md b/examples/freeflowchannel/doc/_intro.md
index 4007f34ec7..d3325394f4 100644
--- a/examples/freeflowchannel/doc/_intro.md
+++ b/examples/freeflowchannel/doc/_intro.md
@@ -34,7 +34,7 @@ Furthermore, isothermal conditions with a homogeneous temperature distribution o
All equations are discretized with the staggered-grid finite-volume scheme as spatial discretization
with pressures and velocity components as primary variables. For details on the discretization scheme,
-have a look at the Dumux [handbook](https://dumux.org/handbook).
+have a look at the DuMu<sup>x</sup> [documentation](https://dumux.org/docs/doxygen/master/group___discretization.html).
## Problem set-up
This example considers stationary flow of a fluid between two parallel solid plates in two dimensions.
diff --git a/examples/liddrivencavity/README.md b/examples/liddrivencavity/README.md
index fc695a9400..c1b94d5fca 100644
--- a/examples/liddrivencavity/README.md
+++ b/examples/liddrivencavity/README.md
@@ -60,7 +60,7 @@ Mass and momentum balance are given by
where $`\bold{v}`$ and p are the velocity and pressure of the fluid (primary variables). $`\rho`$ and $`\mu=\rho\nu`$ are the mass density and dynamic viscosity (fluid properties).
-All equations are discretized with the staggered-grid finite-volume scheme as spatial discretization with pressures and velocity components as primary variables. For details on the discretization scheme, we refer to the DuMu<sup>x</sup> [handbook](https://dumux.org/docs/handbook/master/dumux-handbook.pdf).
+All equations are discretized with the staggered-grid finite-volume scheme as spatial discretization with pressures and velocity components as primary variables. For details on the discretization scheme, we refer to the DuMu<sup>x</sup> [documentation](https://dumux.org/docs/doxygen/master/group___discretization.html).
# Implementation & Postprocessing
diff --git a/examples/liddrivencavity/doc/_intro.md b/examples/liddrivencavity/doc/_intro.md
index c0de3615e9..063b8ae285 100644
--- a/examples/liddrivencavity/doc/_intro.md
+++ b/examples/liddrivencavity/doc/_intro.md
@@ -58,6 +58,6 @@ Mass and momentum balance are given by
where $`\bold{v}`$ and p are the velocity and pressure of the fluid (primary variables). $`\rho`$ and $`\mu=\rho\nu`$ are the mass density and dynamic viscosity (fluid properties).
-All equations are discretized with the staggered-grid finite-volume scheme as spatial discretization with pressures and velocity components as primary variables. For details on the discretization scheme, we refer to the DuMu<sup>x</sup> [handbook](https://dumux.org/docs/handbook/master/dumux-handbook.pdf).
+All equations are discretized with the staggered-grid finite-volume scheme as spatial discretization with pressures and velocity components as primary variables. For details on the discretization scheme, we refer to the DuMu<sup>x</sup> [documentation](https://dumux.org/docs/doxygen/master/group___discretization.html).
# Implementation & Postprocessing
--
GitLab