diff --git a/src/structure/rectangular_structure.ts b/src/structure/rectangular_structure.ts index 95ab58c007762f721a503518951df82cc5cce794..a835b146a9c764c11d7d25eac107557c4761c8c6 100644 --- a/src/structure/rectangular_structure.ts +++ b/src/structure/rectangular_structure.ts @@ -4,6 +4,9 @@ import { Structure } from "./structure"; export { RectangularStructureParams }; +/** + * Classe mère pour toutes les structures ayant une base rectangulaire (vannes, seuils) + */ export abstract class RectangularStructure extends Structure { constructor(prms: RectangularStructureParams, dbg: boolean = false) { diff --git a/src/structure/structure_cem88d.ts b/src/structure/structure_cem88d.ts index 6a9a6bce8c12ba094e2037012b8eb160d934ff71..8ddde8744cb93df31c65333fe725ae8583d6f80b 100644 --- a/src/structure/structure_cem88d.ts +++ b/src/structure/structure_cem88d.ts @@ -11,7 +11,7 @@ export { RectangularStructureParams }; export class StructureCem88d extends RectangularStructure { /** - * Calcul analytique Q = f(Cd, L, h1, h2, W) + * Calcul analytique Q = f(Cd, L, h1, h2, W) CEM88D * @param sVarCalc Variable à calculer (doit être "Q") */ public Equation(sVarCalc: string): Result { diff --git a/src/structure/structure_cem88v.ts b/src/structure/structure_cem88v.ts index 9391683dae04169a47c54246b1f2ea926142108c..457f430006452b553bedd14f5b744a29ed1bafff 100644 --- a/src/structure/structure_cem88v.ts +++ b/src/structure/structure_cem88v.ts @@ -11,7 +11,7 @@ export { RectangularStructureParams }; export class StructureCem88v extends RectangularStructure { /** - * Calcul analytique Q = f(Cd, L, h1, h2, W) + * Calcul analytique Q = f(Cd, L, h1, h2, W) CEM88V * @param sVarCalc Variable à calculer (doit être "Q") */ public Equation(sVarCalc: string): Result { diff --git a/src/structure/structure_cunge80.ts b/src/structure/structure_cunge80.ts index aaac4821be41edc69416d8da713265e2a1a87c6b..d9cc8f448aad3ae941fb0198a1c8d4e375339889 100644 --- a/src/structure/structure_cunge80.ts +++ b/src/structure/structure_cunge80.ts @@ -6,11 +6,11 @@ import { Structure, StructureFlowMode, StructureFlowRegime } from "./structure"; export { RectangularStructureParams }; /** - * Equation classique orifice noyé + * Equation Cunge80 */ export class StructureCunge80 extends RectangularStructure { /** - * Calcul du débit avec l'équation classique d'un orifice noyé + * Calcul du débit avec l'équation Cunge80 * @param sVarCalc Variable à calculer (doit être égale à Q ici) */ public Equation(sVarCalc: string): Result { diff --git a/src/structure/structure_weir_free.ts b/src/structure/structure_weir_free.ts index d1176cb257b088764e70b05cbd39c54f212e30fb..fd1246406f35b38b10429ab821e34edc7d8f3831 100644 --- a/src/structure/structure_weir_free.ts +++ b/src/structure/structure_weir_free.ts @@ -9,6 +9,10 @@ export { RectangularStructureParams }; * Equation classique seuil dénoyé */ export class StructureWeirFree extends RectangularStructure { + /** + * Calcul analytique Q = f(Cd, L, h1, h2, W) seuil dénoyé + * @param sVarCalc Variable à calculer (doit être "Q") + */ public Equation(sVarCalc: string): Result { const res: Result = super.Equation(sVarCalc); // TODO : Warning si les conditions hydrauliques ne correspondent pas à un seuil dénoyé