Fix #254 - Verificateur: trigger error when a criterion is missing

spec/session/session.verificateur.first.ts

@@ -152,7 +152,7 @@ export const sessionVerificateurFirst = {
                     value: 0.4
                 },
                 {
-                    symbol: "VMax",
+                    symbol: "VeMax",
                     mode: "SINGLE",
                     value: 2.5
                 },
@@ -343,7 +343,7 @@ export const sessionVerificateurFirst = {
                     value: 0.4
                 },
                 {
-                    symbol: "VMax",
+                    symbol: "VeMax",
                     mode: "SINGLE",
                     value: 2.5
                 },

spec/session/session.verificateur.last.ts

@@ -136,7 +136,7 @@ export const sessionVerificateurLast = {
                     value: 0.4
                 },
                 {
-                    symbol: "VMax",
+                    symbol: "VeMax",
                     mode: "SINGLE",
                     value: 2.5
                 },
@@ -327,7 +327,7 @@ export const sessionVerificateurLast = {
                     value: 0.4
                 },
                 {
-                    symbol: "VMax",
+                    symbol: "VeMax",
                     mode: "SINGLE",
                     value: 2.5
                 },

src/session.ts

@@ -709,7 +709,7 @@ export class Session {
                         2.5,    // LMinP
                         0.3,    // HMin
                         0.4,    // YMin
-                        2.5,    // VMax
+                        2.5,    // VeMax
                         0.2,    // YMinSB
                         0.3,    // YMinPB
                         200     // PVMax

src/util/message.ts

@@ -191,6 +191,9 @@ export enum MessageCode {
     /** Vérificateur : la passe à vérifier contient des erreurs */
     ERROR_VERIF_ERRORS_IN_PASS,
 
+    /** Vérificateur : le critère testé %var_criterion% est indéfini */
+    ERROR_VERIF_MISSING_CRITERION,
+
     /** Vérificateur : la passe variée à vérifier contient des erreurs à l'itération %i% */
     ERROR_VERIF_VARYING_ERRORS_IN_PASS,
 

src/verification/espece.ts

@@ -240,51 +240,51 @@ export class Espece extends Nub implements Observer {
         this.presets[CalculatorType.MacroRugo] = {};
         this.presets[CalculatorType.MacroRugo][FishSpecies.SPECIES_1] = {
             YMin: 0.4,
-            VMax: 2.5
+            VeMax: 2.5
         };
         this.presets[CalculatorType.MacroRugo][FishSpecies.SPECIES_2] = {
             YMin: 0.3,
-            VMax: 2.5
+            VeMax: 2.5
         };
         this.presets[CalculatorType.MacroRugo][FishSpecies.SPECIES_3a] =
         this.presets[CalculatorType.MacroRugo][FishSpecies.SPECIES_3b] = {
             YMin: 0.4,
-            VMax: 2
+            VeMax: 2
         };
         this.presets[CalculatorType.MacroRugo][FishSpecies.SPECIES_3c] = {
             YMin: 0.15,
-            VMax: 2
+            VeMax: 2
         };
         this.presets[CalculatorType.MacroRugo][FishSpecies.SPECIES_4a] = {
             YMin: 0.3,
-            VMax: 2
+            VeMax: 2
         };
         this.presets[CalculatorType.MacroRugo][FishSpecies.SPECIES_4b] = {
             YMin: 0.2,
-            VMax: 2
+            VeMax: 2
         };
         this.presets[CalculatorType.MacroRugo][FishSpecies.SPECIES_5] =
         this.presets[CalculatorType.MacroRugo][FishSpecies.SPECIES_6] =
         this.presets[CalculatorType.MacroRugo][FishSpecies.SPECIES_7a] = {
             YMin: 0.3,
-            VMax: 2
+            VeMax: 2
         };
         this.presets[CalculatorType.MacroRugo][FishSpecies.SPECIES_7b] = {
             YMin: 0.15,
-            VMax: 2
+            VeMax: 2
         };
         this.presets[CalculatorType.MacroRugo][FishSpecies.SPECIES_8a] =
         this.presets[CalculatorType.MacroRugo][FishSpecies.SPECIES_8b] =
         this.presets[CalculatorType.MacroRugo][FishSpecies.SPECIES_8c] =
         this.presets[CalculatorType.MacroRugo][FishSpecies.SPECIES_8d] = {
             YMin: 0.3,
-            VMax: 1.5
+            VeMax: 1.5
         };
         this.presets[CalculatorType.MacroRugo][FishSpecies.SPECIES_9a] =
         this.presets[CalculatorType.MacroRugo][FishSpecies.SPECIES_9b] =
         this.presets[CalculatorType.MacroRugo][FishSpecies.SPECIES_10] = {
             YMin: 0.2,
-            VMax: 1.5
+            VeMax: 1.5
         };
     }
 
@@ -306,6 +306,31 @@ export class Espece extends Nub implements Observer {
         this.loadPredefinedParametersValues();
     }
 
+    /**
+     * Check that all given criteria are defined before controlling their values
+     * @param symbols list of symbols of criteria that have to be defined
+     * @return undefined if all criteria are present, a Result with appropriate error
+     *      log messages otherwise
+     */
+    protected checkCriteriaPresence(symbols: string[]): Result {
+        const r = new Result();
+        r.addResultElement(new ResultElement());
+        let error = false;
+        for (const s of symbols) {
+            if (this.getParameter(s).singleValue === undefined) {
+                error = true;
+                const m = new Message(MessageCode.ERROR_VERIF_MISSING_CRITERION);
+                m.extraVar.var_criterion = s;
+                r.log.add(m);
+            }
+        }
+        if (error) {
+            return r;
+        } else {
+            return undefined; // everything OK
+        }
+    }
+
     /** Returns 1 if the fish can go through the pass, 0 if it cannot */
     public Equation(): Result {
         // default result is 1 (OK)
@@ -337,6 +362,34 @@ export class Espece extends Nub implements Observer {
                 case CalculatorType.Pab:
                     const passB = this._passToCheck as Pab;
 
+                    // Check criteria presence (depends on jet types)
+                    let hasAtLeastOneSurfaceJet = false;
+                    let hasAtLeastOneDivingJet = false;
+                    for (const wall of passB.children) {
+                        hasAtLeastOneSurfaceJet = hasAtLeastOneSurfaceJet || this.hasJet(wall, [ StructureJetType.SURFACE, StructureJetType.SO ]);
+                        hasAtLeastOneDivingJet = hasAtLeastOneDivingJet || this.hasJet(wall, StructureJetType.PLONGEANT);
+                    }
+                    hasAtLeastOneSurfaceJet = hasAtLeastOneSurfaceJet || this.hasJet(passB.downWall, [ StructureJetType.SURFACE, StructureJetType.SO ]);
+                    hasAtLeastOneDivingJet = hasAtLeastOneDivingJet || this.hasJet(passB.downWall, StructureJetType.PLONGEANT);
+
+                    let cpRetPAB: Result;
+                    let criteriaToCheck: string[] = [];
+                    if (hasAtLeastOneSurfaceJet) {
+                        criteriaToCheck = criteriaToCheck.concat([ "PVMax", "DHMaxS", "BMin", "PMinS", "LMinS" ]);
+                    }
+                    if (hasAtLeastOneDivingJet) {
+                        criteriaToCheck = criteriaToCheck.concat([ "PVMax", "DHMaxP", "PMinP", "LMinP", "HMin" ]);
+                    }
+                    if (criteriaToCheck.length > 0) {
+                        criteriaToCheck = criteriaToCheck.filter(
+                            (item, index) => criteriaToCheck.indexOf(item) === index // deduplicate
+                        );
+                        cpRetPAB = this.checkCriteriaPresence(criteriaToCheck);
+                        if (cpRetPAB !== undefined) {
+                            return cpRetPAB;
+                        }
+                    }
+
                     // A -- walls
                     let cloisonNumber = 1;
                     for (const wall of passB.children) {
@@ -429,12 +482,25 @@ export class Espece extends Nub implements Observer {
                         res.log.add(m);
                     }
 
-
                     break;
 
                 case CalculatorType.ParSimulation:
                     const passR = this._passToCheck as ParSimulation;
 
+                    // Check criteria presence, depending on baffle type
+                    let parCriteria: string[] = [];
+                    if ([ ParType.PLANE, ParType.FATOU ].includes(passR.parType)) {
+                        parCriteria = [ "YMinPB" ];
+                    } else if ([ ParType.SUPERACTIVE, ParType.CHEVRON ].includes(passR.parType)) {
+                        parCriteria = [ "YMinSB" ];
+                    }
+                    if (parCriteria.length > 0) {
+                        const cpRetPAR = this.checkCriteriaPresence(parCriteria);
+                        if (cpRetPAR !== undefined) {
+                            return cpRetPAR;
+                        }
+                    }
+
                     // 1. species groups 3a, 3b, 7b are discouraged
                     if ([ FishSpecies.SPECIES_3a, FishSpecies.SPECIES_3b, FishSpecies.SPECIES_7b ].includes(this.species)) {
                         res.log.add(new Message(MessageCode.WARNING_VERIF_PAR_SPECIES_GROUP));
@@ -459,6 +525,13 @@ export class Espece extends Nub implements Observer {
 
                 case CalculatorType.MacroRugoCompound:
                     const passMRC = this._passToCheck as MacrorugoCompound;
+
+                    // Check criteria presence
+                    const cpRetMRC = this.checkCriteriaPresence([ "YMin", "VeMax" ]);
+                    if (cpRetMRC !== undefined) {
+                        return cpRetMRC;
+                    }
+
                     let atLeastOneOK = false;
                     let apronNumber = 1;
                     const consecutiveWidths: number[] = [];
@@ -501,11 +574,17 @@ export class Espece extends Nub implements Observer {
                     break;
 
                 case CalculatorType.MacroRugo:
+                    // Check criteria presence
+                    const cpRetMR = this.checkCriteriaPresence([ "YMin", "VeMax" ]);
+                    if (cpRetMR !== undefined) {
+                        return cpRetMR;
+                    }
                     res.vCalc = this.checkMacroRugo(this._passToCheck as MacroRugo, r, res);
                     break;
 
                 default:
                     // should never happen
+                    throw new Error(`Espece.Equation(): undefined pass type ${CalculatorType[this._passToCheck.calcType]}`);
             }
         }
 
@@ -896,7 +975,7 @@ export class Espece extends Nub implements Observer {
         }
 
         // 2. speed
-        if (this.prms.VMax.singleValue !== undefined && isGreaterThan(passResult.values.Vmax, this.prms.VMax.singleValue, 1e-3)) {
+        if (this.prms.VeMax.singleValue !== undefined && isGreaterThan(passResult.values.Vmax, this.prms.VeMax.singleValue, 1e-3)) {
             val = 0;
             let m: Message;
             if (apronNumber !== undefined) {
@@ -906,7 +985,7 @@ export class Espece extends Nub implements Observer {
                 m = new Message(MessageCode.ERROR_VERIF_MR_VMAX);
             }
             m.extraVar.V = passResult.values.Vmax;
-            m.extraVar.maxV = this.prms.VMax.singleValue;
+            m.extraVar.maxV = this.prms.VeMax.singleValue;
             verifResult.log.add(m);
         }
 

src/verification/espece_params.ts

@@ -35,7 +35,7 @@ export class EspeceParams extends ParamsEquation {
     private _YMin: ParamDefinition;
 
     /** Vitesse d'écoulement maximale (m) (MacroRugo enrochements régulièrement répartis) */
-    private _VMax: ParamDefinition;
+    private _VeMax: ParamDefinition;
 
     /** Tirant d'eau minimum sur les ralentisseurs suractifs de fond (m) */
     private _YMinSB: ParamDefinition;
@@ -48,7 +48,7 @@ export class EspeceParams extends ParamsEquation {
 
     constructor(
         rDHMaxS: number, rDHMaxP?: number, rBMin?: number, rPMinS?: number, rPMinP?: number, rLMinS?: number,
-        rLMinP?: number,rHMin?: number, rYMin?: number, rVMax?: number, rYMinSB?: number, rYMinPB?: number, rPVMax?: number
+        rLMinP?: number,rHMin?: number, rYMin?: number, rVeMax?: number, rYMinSB?: number, rYMinPB?: number, rPVMax?: number
     ) {
         super();
         this._OK = new ParamDefinition(this, "OK", ParamDomainValue.POS, "");
@@ -61,7 +61,7 @@ export class EspeceParams extends ParamsEquation {
         this._LMinP = new ParamDefinition(this, "LMinP", ParamDomainValue.POS, "m", rLMinP);
         this._HMin = new ParamDefinition(this, "HMin", ParamDomainValue.POS, "m", rHMin);
         this._YMin = new ParamDefinition(this, "YMin", ParamDomainValue.POS, "m", rYMin);
-        this._VMax = new ParamDefinition(this, "VMax", ParamDomainValue.POS, "m", rVMax);
+        this._VeMax = new ParamDefinition(this, "VeMax", ParamDomainValue.POS, "m", rVeMax);
         this._YMinSB = new ParamDefinition(this, "YMinSB", ParamDomainValue.POS, "m", rYMinSB);
         this._YMinPB = new ParamDefinition(this, "YMinPB", ParamDomainValue.POS, "m", rYMinPB);
         this._PVMax = new ParamDefinition(this, "PVMax", ParamDomainValue.POS, "W/m³", rPVMax);
@@ -76,7 +76,7 @@ export class EspeceParams extends ParamsEquation {
         this.addParamDefinition(this._LMinP);
         this.addParamDefinition(this._HMin);
         this.addParamDefinition(this._YMin);
-        this.addParamDefinition(this._VMax);
+        this.addParamDefinition(this._VeMax);
         this.addParamDefinition(this._YMinSB);
         this.addParamDefinition(this._YMinPB);
         this.addParamDefinition(this._PVMax);
@@ -122,8 +122,8 @@ export class EspeceParams extends ParamsEquation {
         return this._YMin;
     }
 
-    public get VMax(): ParamDefinition {
-        return this._VMax;
+    public get VeMax(): ParamDefinition {
+        return this._VeMax;
     }
 
     public get YMinSB(): ParamDefinition {