From d57575dd299573380fe697d904aec3299663b323 Mon Sep 17 00:00:00 2001
From: David Dorchies <david.dorchies@inrae.fr>
Date: Tue, 9 Jan 2024 14:43:36 +0000
Subject: [PATCH] docs: add documentation for macrorugo remous

Refs #609
---
 docs/en/calculators/pam/macrorugo_remous.md   | 30 +++++++++++++++++++
 docs/fr/calculators/pam/macrorugo_remous.md   | 27 +++++++++++++++++
 mkdocs/mkdocs-en.yml                          |  1 +
 mkdocs/mkdocs-fr.yml                          |  1 +
 .../calculators/macrorugoremous/config.json   |  2 +-
 5 files changed, 60 insertions(+), 1 deletion(-)
 create mode 100644 docs/en/calculators/pam/macrorugo_remous.md
 create mode 100644 docs/fr/calculators/pam/macrorugo_remous.md

diff --git a/docs/en/calculators/pam/macrorugo_remous.md b/docs/en/calculators/pam/macrorugo_remous.md
new file mode 100644
index 000000000..b5ad87f27
--- /dev/null
+++ b/docs/en/calculators/pam/macrorugo_remous.md
@@ -0,0 +1,30 @@
+# Backwater curve for a rock-ramp fishpass
+
+This module can be used to simulate the backwater curve of a
+[simple macro-roughness fishway](macrorugo.md) in order to determine the
+downstream flooding level of the fishway.
+
+## Operating principle
+
+The parameters of this module are :
+
+- The choice of the ["simple" rock-ramp fishpass](macrorugo.md) module among
+those present in the work session which will be used to perform the
+calculation&nbsp;
+- The water level downstream of the pass&nbsp;
+- The space step used to discretise the curve calculation.
+
+N.B.&nbsp;: As the backwater curve can only be calculated for one set of
+parameters, the [simple rock-ramp fishpass] module (macrorugo.md)
+cannot contain [varied parameters](../../general/principe_fonctionnement.md).
+
+The theoretical calculation carried out in the macro-roughness channel
+corresponds to the calculation of the water line in a uniform regime where the
+slope of the water is equal to the slope of the bottom of the channel.
+The rock-ramp fishpass module is used here to calculate the slope of the water
+in the non-uniform case.
+The fluvial backwater curve is then calculated from the water level
+downstream using the [trapezoid integration method](../../numerical_methods/integration_trapezes.md).
+
+This module is based on [the module for calculating the backwater curve of a
+section](../hsl/courbe_remous.md) to calculate and display the results.
diff --git a/docs/fr/calculators/pam/macrorugo_remous.md b/docs/fr/calculators/pam/macrorugo_remous.md
new file mode 100644
index 000000000..8eabb0c0c
--- /dev/null
+++ b/docs/fr/calculators/pam/macrorugo_remous.md
@@ -0,0 +1,27 @@
+# Courbe de remous d'une passe à macro-rugosité
+
+Ce module permet de simuler la courbe de remous d'une [passe à macro-rugosité dite "simple"](macrorugo.md) afin de déterminer le niveau d'ennoiement aval de la passe.
+
+## Principe de fonctionnement
+
+Les paramètres de ce module sont :
+
+- Le choix parmi les modules présents dans la session de travail du module de
+[passe à macro-rugosité dite "simple"](macrorugo.md) qui sera utilisé pour
+effectuer le calcul&nbsp;
+- La cote de l'eau à l'aval de la passe&nbsp;
+- Le pas d'espace utilisé pour la discrétisation du calcul de la courbe.
+
+N.B.&nbsp;: Comme le calcul de la courbe de remous ne peut se faire que pour un
+jeu de paramètres, le module de [passe à macro-rugosité dite "simple"](macrorugo.md)
+ne peut pas contenir de [paramètres "variés"](../../general/principe_fonctionnement.md).
+
+Le calcul théorique effectué dans la passe à macro-rugosité correspond à un
+calcul de ligne d'eau en régime uniforme où la pente de l'eau est égale à la pente
+du fond de la passe. On utilise ici le module de passe à macro-rugosité pour
+calculer la pente de l'eau dans le cas non-uniforme.
+Le calcul de la courbe de remous fluviale s'effectue alors depuis la cote de
+l'eau imposée à l'aval à l'aide de la méthode d'[intégration de trapèzes](../../methodes_numeriques/integration_trapezes.md).
+
+Ce module se base [le module de calcul de courbe de remous d'une section
+paramétrée](../hsl/courbe_remous.md) pour le calcul et l'affichage des résultats.
diff --git a/mkdocs/mkdocs-en.yml b/mkdocs/mkdocs-en.yml
index d486d643d..a266bf925 100644
--- a/mkdocs/mkdocs-en.yml
+++ b/mkdocs/mkdocs-en.yml
@@ -75,6 +75,7 @@ nav:
         - calculators/pam/macrorugo_theorie.md
         - calculators/pam/macrorugo_complexe.md
         - calculators/pam/concentration.md
+        - calculators/pam/macrorugo_remous.md
     - Baffle fishways:
         - Baffle fishway setup: calculators/par/calage.md
         - Baffle fishway simulation: calculators/par/simulation.md
diff --git a/mkdocs/mkdocs-fr.yml b/mkdocs/mkdocs-fr.yml
index e00d37a2f..06f56d2ed 100644
--- a/mkdocs/mkdocs-fr.yml
+++ b/mkdocs/mkdocs-fr.yml
@@ -75,6 +75,7 @@ nav:
         - calculators/pam/macrorugo_theorie.md
         - calculators/pam/macrorugo_complexe.md
         - calculators/pam/concentration.md
+        - calculators/pam/macrorugo_remous.md
     - Passes à ralentisseurs:
         - calculators/par/calage.md
         - calculators/par/simulation.md
diff --git a/src/app/calculators/macrorugoremous/config.json b/src/app/calculators/macrorugoremous/config.json
index 2ac5c9b9a..30f974cdd 100644
--- a/src/app/calculators/macrorugoremous/config.json
+++ b/src/app/calculators/macrorugoremous/config.json
@@ -46,7 +46,7 @@
     },
     {
         "type": "options",
-        "help": "hsl/courbe_remous.html",
+        "help": "pam/macrorugo_remous.html",
         "resultsHelp": {
             "B": "hsl/section_parametree.html#largeur-au-miroir-surface-et-perimetre-mouille",
             "P": "hsl/section_parametree.html#largeur-au-miroir-surface-et-perimetre-mouille",
-- 
GitLab