Add checks related to vegetation and variable friction

[margrietpalm]

I added a load of checks. See detailed description below (ticket was not very clear). Note that the contents of these checks needs to be double checked by @GolnesaK or @nvolp.

Note that the tests fail because threedi-schema 0.219 hasn't been released, see nens/threedi-schema#51.

Added checks

The added checks involve variable friction, vegetation and variable vegetation.

Type checks for variable properties

• table: CrossSectionDefinition
• columns: friction_values, vegetation_drag_coefficients, vegetation_heights, vegetation_stem_diameters, vegetation_stem_densities
• conditions:
  • string is space-separated
  • each element can be converted to a float
• effect: raise error

Check column length of variable properties

• table: CrossSectionDefinition
• columns: friction_values, vegetation_drag_coefficients, vegetation_heights, vegetation_stem_diameters, vegetation_stem_densities
• conditions:
  • the number of values in each column should be exactly one less than those in CrossSectionDefinition.width and CrossSectionDefinition.height
• effect: raise error

Range checks for variable friction and vegetation properties

Vegetation

• table: CrossSectionLocation
• columns: vegetation_drag_coefficient, vegetation_height, vegetation_stem_diameter, vegetation_stem_density
• conditions: every value is >= 0
• effect: raise error

Variable vegetation

• table: CrossSectionDefinition
• columns: vegetation_drag_coefficients, vegetation_heights, vegetation_stem_diameters, vegetation_stem_densities
• conditions: every value is >= 0
• effect: raise error

Variable friction

• table: CrossSectionDefinition
• column: friction_values
• conditions:
  • all values >= 0
  • all values < 1 in case of Manning friction
• effect: raise error

Limit to open channels

• table: CrossSectionDefinition
• columns: friction_values, vegetation_drag_coefficients, vegetation_heights, vegetation_stem_diameters, vegetation_stem_densities
• condition: column is defined and the profile is open and the y coordinate is monotonically increasing
• effect: raise error

Missing friction values

• columns: CrossSectionDefinition.friction_values and CrossSectionLocation.friction_value
• conditions:
  • CrossSectionLocation.shape is not TABULED_YZ and CrossSectionLocation.friction_value is defined
  • CrossSectionLocation.shape is TABULED_YZ and CrossSectionLocation.friction_value and/or CrossSectionDefinition.friction_values is defined
• effect: raise error

Limit variable friction and vegetation to cross section shape TABULATED_YZ

• table: CrossSectionLocation
• columns: vegetation_drag_coefficient, vegetation_height, vegetation_stem_diameter, vegetation_stem_density
• condition:
  • shape must be TABULATED_YZ
• effect: raise error

Dependence friction type and vegetation

• Fixed parameters:
  • table: CrossSectionLocation
  • columns: vegetation_drag_coefficient, vegetation_height, vegetation_stem_diameter, vegetation_stem_density
• Variable parameters
  • table: CrossSectionDefinition
  • columns: friction_values, vegetation_drag_coefficients, vegetation_heights, vegetation_stem_diameters, vegetation_stem_densities
• condition: friction type is CHEZY or CHEZY_CONVEYANCE
• effect: raise

Handling cases with fixed and variable parameters defined for friciton of vegetation

• non-conveyance friction: raise warning mentioning that fixed value (from CrossSectionLocation) is used
• conveyance friction: raise warning mentioning that variable value (from CrossSectionDefinition) is used

[elisalle]

Note that the tests fail because threedi-schema 0.219 hasn't been released, see nens/threedi-schema#51.

nens/threedi-schema#51 has been approved with one requested change; could you fix, merge and release it to see if the tests run afterwards? @margrietpalm

[elisalle]

Mostly looks fine; I haven't tested the checks in depth. Again just a few small changes, and the changelog needs updating.

[elisalle]

Suggested change

	for col in vegetation_parameter_columns
	for col in [
	*vegetation_parameter_columns,
	models.CrossSectionDefinition.friction_values
	]

if they use the same error code it would be nice if the checks are together

[margrietpalm]

Changed to draft because a check has to be added that all vegetation parameters are present together.

[elisalle]

This is really neat! I like the new base check; very useful.