Merge branch 'master' into margriet_45_geopackage

CHANGES.rst

@@ -2,12 +2,19 @@ Changelog of threedi-modelchecker
 =================================
 
 
-2.6.1 (unreleased)
+2.6.2 (unreleased)
 ------------------
 
 - Nothing changed yet.
 
 
+2.6.1 (2024-02-20)
+------------------
+
+- Add warning check (1500) to warn about a friction value <= 1 for Chezy friction
+- Add warning check (1501) to warn about friction values <= 1 or Chezy friction
+
+
 2.6.0 (2024-01-31)
 ------------------
 

threedi_modelchecker/__init__.py

@@ -1,5 +1,5 @@
 from .model_checks import *  # NOQA
 
 # fmt: off
-__version__ = '2.6.1.dev0'
+__version__ = '2.6.2.dev0'
 # fmt: on

threedi_modelchecker/checks/cross_section_definitions.py

@@ -616,6 +616,7 @@ def __init__(
         max_value=None,
         left_inclusive=True,
         right_inclusive=True,
+        message=None,
         *args,
         **kwargs,
     ):
@@ -641,6 +642,7 @@ def __init__(
             )
             str_parts.append(f"{'> ' if right_inclusive else '>= '}{max_value}")
         self.range_str = " and/or ".join(str_parts)
+        self.message = message
         super().__init__(*args, **kwargs)
 
     def get_invalid(self, session):
@@ -661,7 +663,10 @@ def get_invalid(self, session):
         return invalids
 
     def description(self):
-        return f"some values in {self.column_name} are {self.range_str}"
+        if self.message is None:
+            return f"some values in {self.column_name} are {self.range_str}"
+        else:
+            return self.message
 
 
 class CrossSectionVariableFrictionRangeCheck(CrossSectionVariableRangeCheck):

threedi_modelchecker/config.py

@@ -333,7 +333,6 @@ def is_none_or_empty(col):
     )
 ]
 
-
 ## 003x: CALCULATION TYPE
 
 CHECKS += [
@@ -3004,7 +3003,6 @@ def is_none_or_empty(col):
     for col in vegetation_parameter_columns
     + [models.CrossSectionDefinition.friction_values]
 ]
-
 ## Friction values range
 CHECKS += [
     CrossSectionVariableFrictionRangeCheck(
@@ -3123,6 +3121,52 @@ def is_none_or_empty(col):
     ),
 ]
 
+# Checks for nonsensical Chezy friction values
+CHECKS += [
+    RangeCheck(
+        error_code=1500,
+        level=CheckLevel.WARNING,
+        column=table.friction_value,
+        filters=table.friction_type == constants.FrictionType.CHEZY.value,
+        min_value=1,
+        message=f"{table.__tablename__}.friction_value is less than 1 while CHEZY friction is selected. This may cause nonsensical results.",
+    )
+    for table in [
+        models.CrossSectionLocation,
+        models.Culvert,
+        models.Pipe,
+    ]
+]
+CHECKS += [
+    RangeCheck(
+        error_code=1500,
+        level=CheckLevel.WARNING,
+        column=table.friction_value,
+        filters=(table.friction_type == constants.FrictionType.CHEZY.value)
+        & (table.crest_type == constants.CrestType.BROAD_CRESTED.value),
+        min_value=1,
+        message=f"{table.__tablename__}.friction_value is less than 1 while CHEZY friction is selected. This may cause nonsensical results.",
+    )
+    for table in [
+        models.Orifice,
+        models.Weir,
+    ]
+]
+CHECKS += [
+    CrossSectionVariableFrictionRangeCheck(
+        min_value=1,
+        level=CheckLevel.WARNING,
+        error_code=1501,
+        column=models.CrossSectionDefinition.friction_values,
+        shapes=(constants.CrossSectionShape.TABULATED_YZ,),
+        friction_types=[
+            constants.FrictionType.CHEZY.value,
+            constants.FrictionType.CHEZY_CONVEYANCE.value,
+        ],
+        message="Some values in CrossSectionDefinition.friction_values are less than 1 while CHEZY friction is selected. This may cause nonsensical results.",
+    )
+]
+
 # These checks are optional, depending on a command line argument
 beta_features_check = []
 beta_features_check += [