HydPy 6.2.dev1__cp313-cp313-win_amd64.whl

hydpy/models/hland/hland_factors.py

@@ -0,0 +1,57 @@
+# pylint: disable=missing-module-docstring
+
+# import...
+# ...from HydPy
+from hydpy.core import sequencetools
+
+# ...from hland
+from hydpy.models.hland import hland_masks
+from hydpy.models.hland import hland_sequences
+
+
+class TC(hland_sequences.Factor1DSequence):
+    """Corrected temperature [°C]."""
+
+    mask = hland_masks.Complete()
+
+
+class FracRain(hland_sequences.Factor1DSequence):
+    """Fraction rainfall / total precipitation [-]."""
+
+    mask = hland_masks.Complete()
+
+
+class RfC(hland_sequences.Factor1DSequence):
+    """Actual precipitation correction related to liquid precipitation [-]."""
+
+    mask = hland_masks.Complete()
+
+
+class SfC(hland_sequences.Factor1DSequence):
+    """Actual precipitation correction related to frozen precipitation [-]."""
+
+    mask = hland_masks.Complete()
+
+
+class CFAct(hland_sequences.Factor1DSequence):
+    """Actual degree day factor for snow (on glaciers or not) [mm/°C/T]."""
+
+    mask = hland_masks.Land()
+
+
+class SWE(hland_sequences.Factor2DSequence):
+    """Snow water equivalent [mm]."""
+
+    mask = hland_masks.Land()
+
+
+class GAct(hland_sequences.Factor1DSequence):
+    """Actual degree day factor for glacier ice [mm/°C/T]."""
+
+    mask = hland_masks.Glacier()
+
+
+class ContriArea(sequencetools.FactorSequence):
+    """Fraction of the "soil area" contributing to runoff generation [-]."""
+
+    NDIM = 0

hydpy/models/hland/hland_fixed.py

@@ -0,0 +1,42 @@
+# pylint: disable=missing-module-docstring
+
+# import...
+# ...from HydPy
+from hydpy.core import parametertools
+
+
+class Pi(parametertools.FixedParameter):
+    """π [-]."""
+
+    NDIM, TYPE, TIME, SPAN = 0, float, None, (0.0, None)
+    INIT = 3.141592653589793
+
+
+class FSG(parametertools.FixedParameter):
+    """Fraction between the spatial extents of the first-order and the second-order
+    slow response groundwater reservoir [-]."""
+
+    NDIM, TYPE, TIME, SPAN = 0, float, None, (0.0, None)
+    INIT = 8.0 / 9.0
+
+
+class K1L(parametertools.FixedParameter):
+    r"""Lowest possible lower boundary value for the parameters |K1|, |K2|, and |K3|
+    [-].
+
+    To prevent |SUZ| from taking on negative values, we must ensure that
+    :math:`\left( 1 - e^{-1/K0} \right) + \left( 1 - e^{-1/K1} \right) < 1` holds.
+    Also, we need to follow the restriction :math:`K0 \leq K1 \leq K2 \leq K3`.
+    |K1L| defines the lowest value meeting both constraints:
+
+    >>> from hydpy.models.hland import *
+    >>> simulationstep("1h")
+    >>> parameterstep("1d")
+    >>> from numpy import exp
+    >>> from hydpy import round_
+    >>> round_(2.0 * (1.0 - exp(-1.0/fixed.k1l)))
+    1.0
+    """
+
+    NDIM, TYPE, TIME, SPAN = 0, float, None, (0.0, None)
+    INIT = 1.4426950408889632

hydpy/models/hland/hland_fluxes.py

@@ -0,0 +1,279 @@
+# pylint: disable=missing-module-docstring
+
+# import...
+# ...from HydPy
+from hydpy.core import sequencetools
+
+# ...from hland
+from hydpy.models.hland import hland_masks
+from hydpy.models.hland import hland_sequences
+
+
+class PC(hland_sequences.Flux1DSequence):
+    """Corrected precipitation [mm/T]."""
+
+    mask = hland_masks.Complete()
+
+
+class EI(hland_sequences.Flux1DSequence):
+    """Interception evaporation [mm/T]."""
+
+    mask = hland_masks.Interception()
+
+
+class TF(hland_sequences.Flux1DSequence):
+    """Throughfall [mm/T]."""
+
+    mask = hland_masks.Interception()
+
+
+class SPL(hland_sequences.Flux1DSequence):
+    """Subbasin-internal redistribution loss of the snow's ice content [mm/T]."""
+
+    mask = hland_masks.Snow()
+
+
+class WCL(hland_sequences.Flux1DSequence):
+    """Subbasin-internal redistribution loss of the snow's water content [mm/T]."""
+
+    mask = hland_masks.Snow()
+
+
+class SPG(hland_sequences.Flux1DSequence):
+    """Subbasin-internal redistribution gain of the snow's ice content [mm/T]."""
+
+    mask = hland_masks.Snow()
+
+
+class WCG(hland_sequences.Flux1DSequence):
+    """Subbasin-internal redistribution gain of the snow's water content [mm/T]."""
+
+    mask = hland_masks.Snow()
+
+
+class GlMelt(hland_sequences.Flux1DSequence):
+    """Glacier melt [mm/T]."""
+
+    mask = hland_masks.Glacier()
+
+
+class Melt(hland_sequences.Flux2DSequence):
+    """Actual melting of frozen water stored in the snow layer [mm/T]."""
+
+    mask = hland_masks.Snow()
+
+
+class Refr(hland_sequences.Flux2DSequence):
+    """Actual (re)freezing of liquid water stored in the snow layer [mm/T]."""
+
+    mask = hland_masks.Snow()
+
+
+class In_(hland_sequences.Flux1DSequence):
+    """Snow module release/soil module inflow [mm/T]."""
+
+    mask = hland_masks.Snow()
+
+
+class R(hland_sequences.Flux1DSequence):
+    """Effective soil response [mm/T].
+
+    Note that PREVAH uses the abbreviation `DSUZ` instead of the HBV96 abbreviation `R`.
+    """
+
+    mask = hland_masks.Soil()
+
+
+class SR(hland_sequences.Flux1DSequence):
+    """Sealed surface runoff [mm/T]."""
+
+    mask = hland_masks.Sealed()
+
+
+class EA(hland_sequences.Flux1DSequence):
+    """Actual soil evaporation [mm/T]."""
+
+    mask = hland_masks.Soil()
+
+
+class CFPot(hland_sequences.Flux1DSequence):
+    """Potential capillary flow [mm/T]."""
+
+    mask = hland_masks.Soil()
+
+
+class CF(hland_sequences.Flux1DSequence):
+    """Actual capillary flow [mm/T]."""
+
+    mask = hland_masks.Soil()
+
+
+class InUZ(sequencetools.FluxSequence):
+    """Inflow to the upper zone layer [mm/T]."""
+
+    NDIM, NUMERIC = 0, False
+
+
+class Perc(sequencetools.FluxSequence):
+    """Percolation from the upper to the lower zone layer [mm/T]."""
+
+    NDIM, NUMERIC = 0, False
+
+
+class DP(hland_sequences.Flux1DSequence):
+    """Deep percolation rate [mm/T].
+
+    Note that PREVAH uses the abbreviation `Perc`, which is also the abbreviation used
+    by HBV96.  However, |Perc| is 0-dimensional while |DP| is 1-dimensional, which is
+    why we need to define separate sequence classes with different names.
+    """
+
+    mask = hland_masks.UpperZone()
+
+
+class Q0(sequencetools.FluxSequence):
+    """Outflow from the upper zone layer [mm/T]."""
+
+    NDIM, NUMERIC = 0, False
+
+
+class QVs1(hland_sequences.Flux1DSequence):
+    """Percolation from the surface flow reservoir [mm/T].
+
+    Note that COSERO uses the abbreviation `QVS1ZON` instead.
+    """
+
+    mask = hland_masks.UpperZone()
+
+
+class QAb1(hland_sequences.Flux1DSequence):
+    """Surface flow [mm/T].
+
+    Note that COSERO uses the abbreviation `QAB1ZON` instead.
+    """
+
+    mask = hland_masks.UpperZone()
+
+
+class QVs2(hland_sequences.Flux1DSequence):
+    """Percolation from the interflow reservoir [mm/T].
+
+    Note that COSERO uses the abbreviation `QVS2ZON` instead.
+    """
+
+    mask = hland_masks.UpperZone()
+
+
+class QAb2(hland_sequences.Flux1DSequence):
+    """Interflow [mm/T].
+
+    Note that COSERO uses the abbreviation `QAB2ZON` instead.
+    """
+
+    mask = hland_masks.UpperZone()
+
+
+class EL(hland_sequences.Flux1DSequence):
+    """Actual lake evaporation [mm/T]."""
+
+    mask = hland_masks.ILake()
+
+
+class Q1(sequencetools.FluxSequence):
+    """Outflow from the lower zone layer [mm/T]."""
+
+    NDIM, NUMERIC = 0, False
+
+
+class RS(hland_sequences.Flux1DSequence):
+    """Surface runoff [mm/T]."""
+
+    mask = hland_masks.UpperZone()
+
+
+class RI(hland_sequences.Flux1DSequence):
+    """Interflow [mm/T]."""
+
+    mask = hland_masks.UpperZone()
+
+
+class GR1(hland_sequences.Flux1DSequence):
+    """Recharge into the fast response groundwater reservoir [mm/T]."""
+
+    mask = hland_masks.UpperZone()
+
+
+class RG1(hland_sequences.Flux1DSequence):
+    """Discharge from the fast response groundwater reservoir [mm/T]."""
+
+    mask = hland_masks.UpperZone()
+
+
+class GR2(sequencetools.FluxSequence):
+    """Recharge into the first-order slow response groundwater reservoir [mm/T]."""
+
+    NDIM = 0
+    NUMERIC = False
+
+
+class RG2(sequencetools.FluxSequence):
+    """Discharge from the first-order slow response groundwater reservoir [mm/T]."""
+
+    NDIM = 0
+    NUMERIC = False
+
+
+class GR3(sequencetools.FluxSequence):
+    """Recharge into the second-order slow response groundwater reservoir [mm/T]."""
+
+    NDIM = 0
+    NUMERIC = False
+
+
+class RG3(sequencetools.FluxSequence):
+    """Discharge from the second-order slow response groundwater reservoir [mm/T]."""
+
+    NDIM = 0
+    NUMERIC = False
+
+
+class InRC(sequencetools.FluxSequence):
+    """Input of the runoff concentration submodel [mm/T]."""
+
+    NDIM = 0
+    NUMERIC = False
+
+
+class OutRC(sequencetools.FluxSequence):
+    """Output of the runoff concentration submodel [mm/T]."""
+
+    NDIM = 0
+    NUMERIC = False
+
+
+class RO(sequencetools.FluxSequence):
+    """Sum of all flow components [mm/T]."""
+
+    NDIM = 0
+    NUMERIC = False
+
+
+class RA(sequencetools.FluxSequence):
+    """Actual abstraction from runoff [mm/T]."""
+
+    NDIM = 0
+    NUMERIC = False
+
+
+class RT(sequencetools.FluxSequence):
+    """Total model outflow [mm/T]."""
+
+    NDIM = 0
+    NUMERIC = False
+
+
+class QT(sequencetools.FluxSequence):
+    """Total model outflow [m³/s]."""
+
+    NDIM = 0
+    NUMERIC = False

hydpy/models/hland/hland_inputs.py

@@ -0,0 +1,19 @@
+# pylint: disable=missing-module-docstring
+
+# import...
+# ...from HydPy
+from hydpy.core import sequencetools
+
+
+class P(sequencetools.InputSequence):
+    """Precipitation [mm]."""
+
+    NDIM, NUMERIC = 0, False
+    STANDARD_NAME = sequencetools.StandardInputNames.PRECIPITATION
+
+
+class T(sequencetools.InputSequence):
+    """Temperature [°C]."""
+
+    NDIM, NUMERIC = 0, False
+    STANDARD_NAME = sequencetools.StandardInputNames.AIR_TEMPERATURE

hydpy/models/hland/hland_masks.py

@@ -0,0 +1,107 @@
+# pylint: disable=missing-module-docstring
+
+# import...
+# ...from HydPy
+from hydpy.core import masktools
+
+# ...from hland
+from hydpy.models.hland.hland_constants import FIELD, FOREST, ILAKE, GLACIER, SEALED
+
+
+class HLandBaseMask(masktools.IndexMask):
+    """To be overridden."""
+
+    @staticmethod
+    def get_refindices(variable):
+        """Reference to the associated instance of |ZoneType|."""
+        return variable.subvars.vars.model.parameters.control.zonetype
+
+
+class Complete(HLandBaseMask):
+    """Mask including all types of zones."""
+
+    relevant = (FIELD, FOREST, ILAKE, GLACIER, SEALED)
+
+
+class Land(HLandBaseMask):
+    """Mask including zones of type |FIELD|, |FOREST|, |GLACIER|, and |SEALED|."""
+
+    relevant = (FIELD, FOREST, GLACIER, SEALED)
+
+
+class Interception(HLandBaseMask):
+    """Mask including zones of type |FIELD|, |FOREST|, and |SEALED|."""
+
+    relevant = (FIELD, FOREST, SEALED)
+
+
+class Snow(HLandBaseMask):
+    """Mask including zones of type |FIELD|, |FOREST|, |GLACIER|, and |SEALED|."""
+
+    relevant = (FIELD, FOREST, GLACIER, SEALED)
+
+
+class Soil(HLandBaseMask):
+    """Mask including zones of type |FIELD| and |FOREST|."""
+
+    relevant = (FIELD, FOREST)
+
+
+class UpperZone(HLandBaseMask):
+    """Mask including zones of type |FIELD|, |FOREST|, and |GLACIER|."""
+
+    relevant = (FIELD, FOREST, GLACIER)
+
+
+class Field(HLandBaseMask):
+    """Mask for zone type |FIELD|."""
+
+    relevant = (FIELD,)
+
+
+class Forest(HLandBaseMask):
+    """Mask for zone type |FOREST|."""
+
+    relevant = (FOREST,)
+
+
+class ILake(HLandBaseMask):
+    """Mask for zone type |ILAKE|."""
+
+    relevant = (ILAKE,)
+
+
+class Glacier(HLandBaseMask):
+    """Mask for zone type |GLACIER|."""
+
+    relevant = (GLACIER,)
+
+
+class Sealed(HLandBaseMask):
+    """Mask for zone type |SEALED|."""
+
+    relevant = (SEALED,)
+
+
+class NoGlacier(HLandBaseMask):
+    """Mask including zones of type |FIELD|, |FOREST|, and |ILAKE|."""
+
+    relevant = (FIELD, FOREST, ILAKE, SEALED)
+
+
+class Masks(masktools.Masks):
+    """Masks of base model |hland|."""
+
+    CLASSES = (
+        Complete,
+        Land,
+        UpperZone,
+        Snow,
+        Soil,
+        Field,
+        Forest,
+        ILake,
+        Glacier,
+        Sealed,
+        NoGlacier,
+    )