HydPy-Dummy (base model)

The Dummy model is a placeholder model. Its inputs are directly handed to the output sequence and therefore can be used to (temporarily) delete a model component while maintaining the network structure.

Method Features

class hydpy.models.dummy.dummy_model.Model[source]

Bases: AdHocModel

HydPy-Dummy (base model).

The following “inlet update methods” are called in the given sequence at the beginning of each simulation step:

  • Pick_Q_V1 Query the current inflow from all inlet nodes.

The following “outlet update methods” are called in the given sequence at the end of each simulation step:
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.

  • Get_SoilWater_V1 Get the selected zone’s current soil water amount.

  • Get_SnowCover_V1 Get the selected zone’s current snow cover fraction.

  • Get_SnowyCanopy_V1 Get the selected zone’s current snow cover degree in the canopies of tree-like vegetation (or nan if the zone’s vegetation is not tree-like).

  • Get_SnowAlbedo_V1 Get the selected zone’s current snow albedo.

DOCNAME: DocName = ('Dummy', 'base model')
OBSERVER_METHODS: ClassVar[tuple[type[Method], ...]] = ()
REUSABLE_METHODS: ClassVar[tuple[type[ReusableMethod], ...]] = ()
class hydpy.models.dummy.dummy_model.Pick_Q_V1[source]

Bases: Method

Query the current inflow from all inlet nodes.

Requires the inlet sequence:

Q

Calculates the flux sequence:

Q

Basic equation:

\(Q_{fluxes} = \sum Q_{inputs}\)

Example:

>>> from hydpy.models.dummy import *
>>> parameterstep()
>>> inlets.q.shape = 2
>>> inlets.q = 2.0, 4.0
>>> model.pick_q_v1()
>>> fluxes.q
q(6.0)
class hydpy.models.dummy.dummy_model.Pass_Q_V1[source]

Bases: Method

Update the outlet link sequence.

Requires the flux sequence:

Q

Calculates the outlet sequence:

Q

Basic equation:

\(Q_{outlets} = Q_{fluxes}\)

Example:

>>> from hydpy.models.dummy import *
>>> parameterstep()
>>> fluxes.q = 2.0
>>> model.pass_q_v1()
>>> outlets.q
q(2.0)
class hydpy.models.dummy.dummy_model.Get_InterceptedWater_V1[source]

Bases: Method

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

Requires the input sequence:

InterceptedWater

Example:

>>> from hydpy.models.dummy import *
>>> parameterstep()
>>> inputs.interceptedwater.shape = 2
>>> inputs.interceptedwater = 2.0, 4.0
>>> from hydpy import round_
>>> round_(model.get_interceptedwater_v1(0))
2.0
>>> round_(model.get_interceptedwater_v1(1))
4.0
class hydpy.models.dummy.dummy_model.Get_SoilWater_V1[source]

Bases: Method

Get the selected zone’s current soil water amount.

Requires the input sequence:

SoilWater

Example:

>>> from hydpy.models.dummy import *
>>> parameterstep()
>>> inputs.soilwater.shape = 2
>>> inputs.soilwater = 2.0, 4.0
>>> from hydpy import round_
>>> round_(model.get_soilwater_v1(0))
2.0
>>> round_(model.get_soilwater_v1(1))
4.0
class hydpy.models.dummy.dummy_model.Get_SnowCover_V1[source]

Bases: Method

Get the selected zone’s current snow cover fraction.

Requires the input sequence:

SnowCover

Example:

>>> from hydpy.models.dummy import *
>>> parameterstep()
>>> inputs.snowcover.shape = 2
>>> inputs.snowcover = 2.0, 4.0
>>> from hydpy import round_
>>> round_(model.get_snowcover_v1(0))
2.0
>>> round_(model.get_snowcover_v1(1))
4.0
class hydpy.models.dummy.dummy_model.Get_SnowyCanopy_V1[source]

Bases: Method

Get the selected zone’s current snow cover degree in the canopies of tree-like vegetation (or nan if the zone’s vegetation is not tree-like).

Requires the input sequence:

SnowyCanopy

Example:

>>> from hydpy.models.dummy import *
>>> parameterstep()
>>> inputs.snowycanopy.shape = 2
>>> inputs.snowycanopy = 2.0, 4.0
>>> from hydpy import round_
>>> round_(model.get_snowycanopy_v1(0))
2.0
>>> round_(model.get_snowycanopy_v1(1))
4.0
class hydpy.models.dummy.dummy_model.Get_SnowAlbedo_V1[source]

Bases: Method

Get the selected zone’s current snow albedo.

Requires the input sequence:

SnowAlbedo

Example:

>>> from hydpy.models.dummy import *
>>> parameterstep()
>>> inputs.snowalbedo.shape = 2
>>> inputs.snowalbedo = 2.0, 4.0
>>> from hydpy import round_
>>> round_(model.get_snowalbedo_v1(0))
2.0
>>> round_(model.get_snowalbedo_v1(1))
4.0

Sequence Features

Input sequences

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

Bases: InputSequences

Input sequences of model dummy.

The following classes are selected:
class hydpy.models.dummy.dummy_inputs.InterceptedWater(subvars: ModelIOSequences[ModelIOSequence, FastAccessIOSequence])[source]

Bases: InputSequence

Intercepted water [mm].

Required by the method:

Get_InterceptedWater_V1

NDIM: int = 1
NUMERIC: bool = False
SPAN: tuple[int | float | bool | None, int | float | bool | None] = (0.0, None)
STANDARD_NAME: ClassVar[StandardInputNames] = 'intercepted_water_hru'
name: str = 'interceptedwater'

Name of the variable in lowercase letters.

unit: str = 'mm'

Unit of the variable.

class hydpy.models.dummy.dummy_inputs.SoilWater(subvars: ModelIOSequences[ModelIOSequence, FastAccessIOSequence])[source]

Bases: InputSequence

Soil water content [mm].

Required by the method:

Get_SoilWater_V1

NDIM: int = 1
NUMERIC: bool = False
SPAN: tuple[int | float | bool | None, int | float | bool | None] = (0.0, None)
STANDARD_NAME: ClassVar[StandardInputNames] = 'soil_water_hru'
name: str = 'soilwater'

Name of the variable in lowercase letters.

unit: str = 'mm'

Unit of the variable.

class hydpy.models.dummy.dummy_inputs.SnowCover(subvars: ModelIOSequences[ModelIOSequence, FastAccessIOSequence])[source]

Bases: InputSequence

Snow cover degree [-].

Required by the method:

Get_SnowCover_V1

NDIM: int = 1
NUMERIC: bool = False
SPAN: tuple[int | float | bool | None, int | float | bool | None] = (0.0, None)
STANDARD_NAME: ClassVar[StandardInputNames] = 'snow_cover_degree_hru'
name: str = 'snowcover'

Name of the variable in lowercase letters.

unit: str = '-'

Unit of the variable.

class hydpy.models.dummy.dummy_inputs.SnowyCanopy(subvars: ModelIOSequences[ModelIOSequence, FastAccessIOSequence])[source]

Bases: InputSequence

Snow cover degree in the canopies of tree-like vegetation (is nan for non-tree-like vegetation) [-].

Required by the method:

Get_SnowyCanopy_V1

NDIM: int = 1
NUMERIC: bool = False
SPAN: tuple[int | float | bool | None, int | float | bool | None] = (0.0, None)
STANDARD_NAME: ClassVar[StandardInputNames] = 'snow_cover_degree_canopy_hru'
name: str = 'snowycanopy'

Name of the variable in lowercase letters.

unit: str = '-'

Unit of the variable.

class hydpy.models.dummy.dummy_inputs.SnowAlbedo(subvars: ModelIOSequences[ModelIOSequence, FastAccessIOSequence])[source]

Bases: InputSequence

Snow albedo [-].

Required by the method:

Get_SnowAlbedo_V1

NDIM: int = 1
NUMERIC: bool = False
SPAN: tuple[int | float | bool | None, int | float | bool | None] = (0.0, 1.0)
STANDARD_NAME: ClassVar[StandardInputNames] = 'albedo_hru'
name: str = 'snowalbedo'

Name of the variable in lowercase letters.

unit: str = '-'

Unit of the variable.

Flux sequences

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

Bases: FluxSequences

Flux sequences of model dummy.

The following classes are selected:

  • Q() Abfluss [m³/s].

class hydpy.models.dummy.dummy_fluxes.Q(subvars: ModelIOSequences[ModelIOSequence, FastAccessIOSequence])[source]

Bases: FluxSequence

Abfluss [m³/s].

Calculated by the method:

Pick_Q_V1

Required by the method:

Pass_Q_V1

NDIM: int = 0
NUMERIC: bool = False
SPAN: tuple[int | float | bool | None, int | float | bool | None] = (0.0, None)
name: str = 'q'

Name of the variable in lowercase letters.

unit: str = 'm³/s'

Unit of the variable.

Inlet sequences

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

Bases: InletSequences

Inlet sequences of model dummy.

The following classes are selected:

  • Q() Abfluss (runoff) [m³/s].

class hydpy.models.dummy.dummy_inlets.Q(subvars: ModelIOSequences[ModelIOSequence, FastAccessIOSequence])[source]

Bases: InletSequence

Abfluss (runoff) [m³/s].

Required by the method:

Pick_Q_V1

NDIM: int = 1
NUMERIC: bool = False
name: str = 'q'

Name of the variable in lowercase letters.

unit: str = 'm³/s'

Unit of the variable.

Outlet sequences

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

Bases: OutletSequences

Outlet sequences of model dummy.

The following classes are selected:

  • Q() Abfluss (runoff) [m³/s].

class hydpy.models.dummy.dummy_outlets.Q(subvars: ModelIOSequences[ModelIOSequence, FastAccessIOSequence])[source]

Bases: OutletSequence

Abfluss (runoff) [m³/s].

Calculated by the method:

Pass_Q_V1

NDIM: int = 0
NUMERIC: bool = False
name: str = 'q'

Name of the variable in lowercase letters.

unit: str = 'm³/s'

Unit of the variable.

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

Bases: FluxSequences

Flux sequences of model dummy.

The following classes are selected:

  • Q() Abfluss [m³/s].

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

Bases: InletSequences

Inlet sequences of model dummy.

The following classes are selected:

  • Q() Abfluss (runoff) [m³/s].

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

Bases: InputSequences

Input sequences of model dummy.

The following classes are selected:
class hydpy.models.dummy.OutletSequences(master: Sequences, cls_fastaccess: type[TypeFastAccess_co] | None = None, cymodel: CyModelProtocol | None = None)

Bases: OutletSequences

Outlet sequences of model dummy.

The following classes are selected:

  • Q() Abfluss (runoff) [m³/s].