structure.ts

import { ChildNub } from "../internal_modules";
import { CalculatorType } from "../internal_modules";
import { ParamCalculability, ParamDefinition, ParamFamily } from "../internal_modules";
import { Props } from "../internal_modules";
import { Message, MessageCode } from "../internal_modules";
import { Result } from "../internal_modules";
import { StructureParams } from "../internal_modules";
import { LoiDebit, StructureProperties } from "../internal_modules";
import { ParallelStructure } from "../internal_modules";
import { round } from "../internal_modules";
import { Nub } from "../internal_modules";

/**
 * Flow mode: weir or orifice flow
 */
export enum StructureFlowMode {
    /** Weir flow */
    WEIR,
    /** Orifice flow */
    ORIFICE,
    /** Zéro flow */
    NULL
}

/**
 * Flow regime: free flow, partially submerged or submerged
 */
export enum StructureFlowRegime {
    /** Free flow (unsubmerged) */
    FREE,
    /** Partially submerged flow */
    PARTIAL,
    /** Submerged flow */
    SUBMERGED,
    /** Zéro flow */
    NULL
}

/** Type de jet : Sans objet (orifice), plongeant, de surface */
export enum StructureJetType {
    /** Plongeant */
    PLONGEANT,
    /** De surface */
    SURFACE,
    /** Sans objet (orifice) */
    SO
}

/**
 * classe de calcul sur la conduite distributrice
 */
export abstract class Structure extends ChildNub {

    /**
     * Test générique si VarCalc="Q" pour l'utilisation de Equation
     */
    public static CheckEquation(sVarCalc: string) {
        if (sVarCalc !== "Q") { throw new Error("Structure.Equation() : invalid parameter name " + sVarCalc); }
    }

    /**
     * calcul du pourcentage d'ennoiement arrondi à l'unité
     */
    public computeSubmergencePercentage(H2?: number): number {
        const h1 = this._prms.get("h1").v;
        const h2 = H2 === undefined ? this._prms.get("h2").v : H2;
        return Structure.computeSubmergencePercentage(h1, h2);
    }

    /**