HydPy-Dummy-InterceptedWater (dummy model supplying main models with intercepted water states)

dummy_interceptedwater merely serves testing purposes. We use it, for example, to perform the integration tests for submodels like evap_aet_hbv96 without the need to couple them to complex main models like hland_96 for providing interception data.

Integration test

The only functionality of dummy_interceptedwater is reading input time series. Hence, configuring and testing it does not require additional explanations:

>>> from hydpy.models.dummy_interceptedwater import *
>>> parameterstep()
>>> from hydpy import Element
>>> element = Element("element")
>>> element.model = model

>>> from hydpy import IntegrationTest, pub, round_
>>> pub.timegrids = "2000-01-01", "2000-01-03", "1d"
>>> nmbzones(2)

>>> test = IntegrationTest(element)
>>> test.dateformat = "%Y-%d-%m"

>>> inputs.interceptedwater.series = [[1.0, 2.0], [3.0, 4.0]]

>>> test()
Click to see the table
|       date |      interceptedwater |
--------------------------------------
| 2000-01-01 | 1.0               2.0 |
| 2000-02-01 | 3.0               4.0 |

>>> round_(model.get_interceptedwater(1))
4.0

class hydpy.models.dummy_interceptedwater.Model

Bases: AdHocModel, IntercModel_V1

HydPy-Dummy-InterceptedWater (dummy model supplying main models with intercepted water states).

The following interface methods are available to main models using the defined model as a submodel:

• Get_InterceptedWater_V1 Get the selected zone’s current amount of intercepted water.

DOCNAME: DocName = ('Dummy-InterceptedWater', 'dummy model supplying main models with intercepted water states')

prepare_nmbzones

Set the number of zones.

>>> from hydpy.models.dummy_interceptedwater import *
>>> parameterstep()
>>> model.prepare_nmbzones(2)
>>> nmbzones
nmbzones(2)

REUSABLE_METHODS: ClassVar[tuple[type[ReusableMethod], ...]] = ()

class hydpy.models.dummy_interceptedwater.ControlParameters(master: Parameters, cls_fastaccess: type[FastAccessParameter] | None = None, cymodel: CyModelProtocol | None = None)

Bases: SubParameters

Control parameters of model dummy_interceptedwater.

The following classes are selected:

• NmbZones() The number of separately modelled zones [-].

class hydpy.models.dummy_interceptedwater.InputSequences(master: Sequences, cls_fastaccess: type[TypeFastAccess_co] | None = None, cymodel: CyModelProtocol | None = None)

Bases: InputSequences

Input sequences of model dummy_interceptedwater.

The following classes are selected:

• InterceptedWater() Intercepted water [mm].