macrorugo.ts

import { CalculatorType } from "../internal_modules";
import { Dichotomie } from "../internal_modules";
import { MacrorugoCompound } from "../internal_modules";
import { ParamCalculability, ParamFamily } from "../internal_modules";
import { ParamValueMode } from "../internal_modules";
import { SessionSettings } from "../internal_modules";
import { Message, MessageCode } from "../internal_modules";
import { Result } from "../internal_modules";
import { MacrorugoParams } from "../internal_modules";
import { MRCInclination } from "../internal_modules";
import { FishPass } from "../internal_modules";

export enum MacroRugoFlowType {
    EMERGENT,
    QUASI_EMERGENT,
    SUBMERGED
}

export class MacroRugo extends FishPass {

    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 length (parallel to flow) of a cell (-) */
    private static readonly fracAxAy = 1;

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

    /** Flag for submerged Flow */
    private flowType: MacroRugoFlowType;

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

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

    /** Coefficients used in f_h*(h*) */
    private paramFhStar: [number, number, number] = [1, 1, 2];

    /** Coefficient used in rQ */
    private paramRQ: [number, number] = [0.4, 0.7];

    /** Coefficient used in rQ */
    private paramRV: [number, number] = [0.4, 0.7];

    /** Maximum value for Cd */
    private paramMaxCd: number = Infinity;

    /** true: Cd0 * min(3, fh), false : min(6, Cd0 * fh) */
    private paramCdNewVersion: boolean = true;

    /**
     * { symbol => string } map that defines units for extra results
     */
    private static _resultsUnits = {
        PV: "W/m³",
        Vdeb: "m/s",
        Vmax: "m/s",
        Vg: "m/s",
        ZF2: "m",
        Strickler: "SI"
    };

    constructor(prms: MacrorugoParams, dbg: boolean = false) {
        super(prms, dbg);