From 719c1deab509c0bfa49c0bcccaafe700ec0229cd Mon Sep 17 00:00:00 2001 From: "mathias.chouet" <mathias.chouet@irstea.fr> Date: Thu, 3 Sep 2020 12:13:03 +0200 Subject: [PATCH] Fix #449 - remove variable names in Verificateur doc --- docs/en/calculators/verif/macrorugo.md | 8 ++++---- docs/en/calculators/verif/pab.md | 24 ++++++++++++------------ docs/en/calculators/verif/par.md | 7 ++----- docs/fr/calculators/verif/macrorugo.md | 8 ++++---- docs/fr/calculators/verif/pab.md | 24 ++++++++++++------------ docs/fr/calculators/verif/par.md | 7 ++----- 6 files changed, 36 insertions(+), 42 deletions(-) diff --git a/docs/en/calculators/verif/macrorugo.md b/docs/en/calculators/verif/macrorugo.md index bb41fb93f..f01f3c09b 100644 --- a/docs/en/calculators/verif/macrorugo.md +++ b/docs/en/calculators/verif/macrorugo.md @@ -10,13 +10,13 @@ Maximum crossable width, wich is the maximum of the sums of the widths of contig ## Criteria -### Minimum water level \(YMin\), in m +### Minimum water level, in m -Water level \(Y\) in the pass should be greater than minimum water level. +Water level in the pass should be greater than minimum water level. -### Limit maximum flow velocity \(VeMax\), in m/s +### Limit maximum flow velocity, in m/s -Maximum flow velocity \(VMax\) in the pass should be lower than limit maximum flow velocity. +Maximum flow velocity in the pass should be lower than limit maximum flow velocity. ## Criteria values for predefined species groups diff --git a/docs/en/calculators/verif/pab.md b/docs/en/calculators/verif/pab.md index 6d5a7e7ca..a6863a140 100644 --- a/docs/en/calculators/verif/pab.md +++ b/docs/en/calculators/verif/pab.md @@ -12,29 +12,29 @@ Orifices are considered uncrossable. Some species do not support diving jets. For such species, each device leading to a diving jet is marked as not crossable. -### Maximum fall \(DHMaxS\) and \(DHMaxP\), in m +### Maximum fall, in m -Basin fall \(DH\) must be lower than maximum fall. +Basin fall must be lower than maximum fall. -### Minimum slot width \(BMin\), in m (surface jet only) +### Minimum slot width, in m (surface jet only) -Slot width \(L\) must be greater than minimum width. For orifices, surface \(S\) must be greater than minimum width squared. +Slot width must be greater than minimum width. For orifices, surface must be greater than minimum width squared. -### Minimum head on weir \(HMin\), in m +### Minimum head on weir, in m -Head \(h1\) on weir must be greater than minimum head. +Head on weir must be greater than minimum head. -### Minimum basin depth \(PMinS\) and \(PMinP\), in m +### Minimum basin depth, in m -Basin depth \(YMOY\) must be greater than minimum depth. For diving jets, depth must be greater than twice the basin fall \(DH\). +Basin depth must be greater than minimum depth. For diving jets, depth must be greater than twice the basin fall. -### Minimum basin length \(LMinS\) and \(LMinP\), in m +### Minimum basin length, in m -Basin length \(LB\) must be greater than minimum length. +Basin length must be greater than minimum length. -### Recommanded maximum dissipated power \(PVMaxPrec\) and limit maximum dissipated power \(PVMaxLim\), in W/m³ +### Recommanded maximum dissipated power and limit maximum dissipated power, in W/m³ -Maximal dissipated power \(PVMax\) in the basin must be lower than limit maximum dissipated power. If it is greater than recommanded maximum dissipated power, a warning is thrown. +Maximal dissipated power in the basin must be lower than limit maximum dissipated power. If it is greater than recommanded maximum dissipated power, a warning is thrown. **Important:** maximum dissipated power verification is **disabled** in the current Cassiopée version. diff --git a/docs/en/calculators/verif/par.md b/docs/en/calculators/verif/par.md index 9340ef55d..00137ac17 100644 --- a/docs/en/calculators/verif/par.md +++ b/docs/en/calculators/verif/par.md @@ -8,12 +8,9 @@ Species groups 3a, 3b and 7b are discouraged for crossing baffle fishways. This Species groups 8a, 8b, 8c, 8d, 9a, 9b and 10 are unable to cross baffle fishways. -### Minimum water level \(YMinPB\) and \(YMinSB\), in m +### Minimum water level, in m -Water level \(h\) in the pass must be greater than the minimum water level, depending on baffles type: - - * plane and Fatou baffles: \(YMinPB\) - * superactive and chevron baffles: \(YMinSB\) +Water level in the pass must be greater than the minimum water level. ## Criteria values for predefined species groups diff --git a/docs/fr/calculators/verif/macrorugo.md b/docs/fr/calculators/verif/macrorugo.md index 4cab10c41..3ce610865 100644 --- a/docs/fr/calculators/verif/macrorugo.md +++ b/docs/fr/calculators/verif/macrorugo.md @@ -10,13 +10,13 @@ La largeur maximale franchissable, maximum des sommes des largeurs des radiers f ## Critères -### Tirant d'eau minimal \(YMin\), en m +### Tirant d'eau minimal, en m -Le tirant d'eau \(Y\) dans la passe doit être supérieur au tirant d'eau minimal. +Le tirant d'eau dans la passe doit être supérieur au tirant d'eau minimal. -### Vitesse d'écoulement maximale limite \(VeMax\), en m/s +### Vitesse d'écoulement maximale limite, en m/s -La vitesse d'écoulement maximale \(VMax\) dans la passe doit être inférieure à la vitesse d'écoulement maximale limite. +La vitesse d'écoulement maximale dans la passe doit être inférieure à la vitesse d'écoulement maximale limite. ## Valeurs des critères pour les groupes d'espèces prédéfinis diff --git a/docs/fr/calculators/verif/pab.md b/docs/fr/calculators/verif/pab.md index b86c8b864..89c5d4fdd 100644 --- a/docs/fr/calculators/verif/pab.md +++ b/docs/fr/calculators/verif/pab.md @@ -12,29 +12,29 @@ Les orifices sont considérés comme infranchissables. Certaines espèces ne supportent pas les jets plongeants. Pour ces espèces, chaque ouvrage donnant lieu à un jet plongeant est marqué comme infranchissable. -### Chute maximale \(DHMaxS\) et \(DHMaxP\), en m +### Chute maximale, en m -La chute \(DH\) du bassin doit être inférieure à la chute maximale. +La chute du bassin doit être inférieure à la chute maximale. -### Largeur minimale de fente ou échancrure latérale \(BMin\), en m (jet de surface seulement) +### Largeur minimale de fente ou échancrure latérale, en m (jet de surface seulement) -La largeur \(L\) de la fente ou échancrure doit être supérieure à la largeur minimale. Dans le cas d'un orifice, la surface \(S\) de l'orifice doit être supérieure à la largeur minimale au carré. +La largeur de la fente ou échancrure doit être supérieure à la largeur minimale. Dans le cas d'un orifice, la surface de l'orifice doit être supérieure à la largeur minimale au carré. -### Charge minimale sur l'échancrure \(HMin\), en m +### Charge minimale sur l'échancrure, en m -La charge \(h1\) sur l'échancrure doit être supérieure à la charge minimale. +La charge sur l'échancrure doit être supérieure à la charge minimale. -### Profondeur minimale de bassin \(PMinS\) et \(PMinP\), en m +### Profondeur minimale de bassin, en m -La profondeur \(YMOY\) du bassin doit être supérieure à la profondeur minimale. Dans le cas d'un jet plongeant, la profondeur doit être supérieure au double de la chute \(DH\) du bassin. +La profondeur du bassin doit être supérieure à la profondeur minimale. Dans le cas d'un jet plongeant, la profondeur doit être supérieure au double de la chute du bassin. -### Longueur minimale de bassin \(LMinS\) et \(LMinP\), en m +### Longueur minimale de bassin, en m -La longueur \(LB\) du bassin doit être supérieure à la longueur minimale. +La longueur du bassin doit être supérieure à la longueur minimale. -### Puissance dissipée maximale préconisée \(PVMaxPrec\) et maximale limite \(PVMaxLim\), en W/m³ +### Puissance dissipée maximale préconisée et maximale limite, en W/m³ -La puissance dissipée maximale \(PVMax\) dans le bassin doit être inférieure à la puissance dissipée maximale limite. Si elle est supérieure à la puissance dissipée maximale préconisée, un avertissement est émis. +La puissance dissipée maximale dans le bassin doit être inférieure à la puissance dissipée maximale limite. Si elle est supérieure à la puissance dissipée maximale préconisée, un avertissement est émis. **Important :** la vérification de la puissance dissipée maximale est **désactivée** dans la version actuelle de Cassiopée diff --git a/docs/fr/calculators/verif/par.md b/docs/fr/calculators/verif/par.md index e053af8fa..0bd3a5173 100644 --- a/docs/fr/calculators/verif/par.md +++ b/docs/fr/calculators/verif/par.md @@ -8,12 +8,9 @@ Les groupes d'espèces 3a, 3b et 7b sont déconseillés pour le franchissement d Les groupes d'espèces 8a, 8b, 8c, 8d, 9a, 9b et 10 sont incapables de franchir des passes à ralentisseurs. -### Tirant d'eau minimal \(YMinPB\) et \(YMinSB\), en m +### Tirant d'eau minimal, en m -Le tirant d'eau \(h\) dans la passe doit être supérieur au tirant d'eau minimal, selon le type de ralentisseurs : - - * ralentisseurs plans et Fatou : \(YMinPB\) - * ralentisseurs suractifs et chevrons : \(YMinSB\) +Le tirant d'eau dans la passe doit être supérieur au tirant d'eau minimal. ## Valeurs des critères pour les groupes d'espèces prédéfinis -- GitLab