Feat/316 forcing vectorquantities #381

arthurvd · 2022-10-20T11:39:23Z

Fixes #316.

…ndaries * VectorQuantityUnitPairs object represents both the "vector=" headerline and *all* coupled vector elements's QuantityUnitPairs below. * `ScalarOrVectorQUP = Union[QuantityUnitPair, VectorQuantityUnitPairs]` for convenience. * same approach taken as was already done for the original QuantityUnitPair creation and the vertPositionIndex modification, namely via a root_validator (pre=True) in both TimeSeries and T3D. * the actual root_validator `_validate_vectordefinition_and_update_quantityunitpairs()` has been placed in `class ForcingBase` to share all code. * unit tests added, both reading from file and constructing in memory.

hydrolib/core/io/bc/models.py

tests/data/input/dflowfm_individual_files/FlowFM_boundaryconditions3d_and_vectors.bc

hydrolib/core/io/bc/models.py

tim-vd-aardweg · 2022-10-21T10:13:25Z

hydrolib/core/io/bc/models.py

+ # created VectorQUPs.
+ quantityunitpairs_with_vectors = []
+
+ # If one quantity is "time", it must be the first one.


Shouldn't the first quantity always be "time"? So shouldn't we raise an error if the first quantity is not "time"?

This is not required by D-HYDRO. We only use it in hydrolib-core as the only pragmatic way to detect where the vector elements start.

hydrolib/core/io/bc/models.py

* VectorQuantityUnitPairs now has Config, validate_assignment = True to re-run validators when its children quantityunitpair list gets re-assigned. * Some extra vector validation is now directly in VectorQuantityUnitPairs, when creating these objects from scratch (as opposed to reading from file) * the original vector validator that used to be in ForcingBase was now moved to dedicated class VectorQUPValidation, used by both TimeSeries and T3D. * This new class VectorQUPValidation also has separate subroutine for validating number of vector elements, again useful when constructing TimeSeries or T3D from scratch (as opposed to reading from file) * some extra unit tests asserting errors when quantity names are wrong or wrong amount. * test_bc, cleanup: time unit "m" -> parameter.