macrorugo.ts

import { Nub } from "../nub";
import { ParamCalculability } from "../param/param-definition";
import { ParamValueMode } from "../param/param-value-mode";
import { Result } from "../util/result";
import { MacrorugoParams } from "./macrorugo_params";

export { MacrorugoParams };

export enum MacroRugoFlowType {
    EMERGENT,
    QUASI_EMERGENT,
    IMMERGE
}

export class MacroRugo extends Nub {

    private static readonly g = 9.81;

    /** nu: water kinematic viscosity  */
    private static readonly nu = 1E-6;
    // Water at 20 °C has a kinematic viscosity of about 10−6 m2·s−1
    // (https://en.wikipedia.org/wiki/Viscosity#Kinematic_viscosity,_%CE%BD)

    /** Ratio between the width (perpendicular to flow) and the lenght (parallel to flow) of a cell (-) */
    private static readonly fracAxAy = 1;

    /** Limit between emergent and submerged flow */
    private static readonly limitSubmerg = 1.1;

    /** Rugosité de fond (m) */
    private ks: number;

    /** Averaged velocity (m.s-1) */
    private U0: number;

    /** Velocity at the bed (m.s-1) */
    private u0: number;

    private _cache: { [key: string]: number };

    constructor(prms: MacrorugoParams, dbg: boolean = false) {
        super(prms, dbg);
        this._cache = {};
    }

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

    /**
     * Calcul du débit total, de la cote amont ou aval ou d'un paramètre d'une structure
     * @param sVarCalc Nom du paramètre à calculer :
     *                 "Q", "Z1", "Z2" ou "n.X" avec "n" l'index de l'ouvrage et "X" son paramètre
     * @param rInit Valeur initiale
     * @param rPrec Précision attendue
     */
    public Calc(sVarCalc: string, rInit?: number, rPrec: number = 0.001): Result {
        /** @todo Voir pour déclarer le paramètre en calcul dans nub */
        this.getParameter(sVarCalc).valueMode = ParamValueMode.CALCUL;
        const r: Result = super.Calc(sVarCalc, rInit, rPrec);
        // Ajout des résultats complémentaires
        // Cote de fond aval
        r.extraResults.ZF2 = this.prms.ZF1.v - this.prms.If.v * this.prms.L.v;
        // Vitesse débitante
        r.extraResults.Vdeb = this.V(this.prms.Q) / this.prms.B.v / this.prms.Y.v;
        // Froude
        r.extraResults.Fr = r.extraResults.Vdeb / (1 - Math.sqrt(MacroRugo.fracAxAy * this.prms.C.v))