structure.ts

import { Nub } from "../nub";
import { ParamCalculability } from "../param/param-definition";
import { Message, MessageCode } from "../util/message";
import { Result } from "../util/result";

import { StructureParams } from "./structure_params";

export { StructureParams };

/**
 * 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,
}

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

    /**
     * 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); }
    }

    /** Constante utile : Racine de 2g */
    protected static readonly R2G: number = Math.sqrt(2 * 9.81);

    /** Peut-on calculer ZDV ? */
    protected _isZDVcalculable: boolean;

    constructor(prms: StructureParams, dbg: boolean = false) {
        super(prms, dbg);
        this._isZDVcalculable = true;
    }

    get isZDVcalculable(): boolean {
        return this._isZDVcalculable;
    }

    /**
     * paramètres castés au bon type
     */
    get prms(): StructureParams {
        return this._prms as StructureParams;
    }

    /**