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:
Pass_Q_V1
Update the outlet link sequence.
- 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 (ornan
if the zone’s vegetation is not tree-like).Get_SnowAlbedo_V1
Get the selected zone’s current snow albedo.
- 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.
- class hydpy.models.dummy.dummy_model.Pass_Q_V1[source]¶
Bases:
Method
Update the outlet link sequence.
- 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:
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:
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:
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:
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:
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:
InterceptedWater()
Intercepted water [mm].SoilWater()
Soil water content [mm].SnowCover()
Snow cover degree [-].SnowyCanopy()
Snow cover degree in the canopies of tree-like vegetation (isnan
for non-tree-like vegetation) [-].SnowAlbedo()
Snow albedo [-].
- class hydpy.models.dummy.dummy_inputs.InterceptedWater(subvars: ModelSequences[ModelSequence, FastAccess])[source]¶
Bases:
InputSequence
Intercepted water [mm].
- Required by the method:
- STANDARD_NAME: ClassVar[StandardInputNames] = 'intercepted_water_hru'¶
- class hydpy.models.dummy.dummy_inputs.SoilWater(subvars: ModelSequences[ModelSequence, FastAccess])[source]¶
Bases:
InputSequence
Soil water content [mm].
- Required by the method:
- STANDARD_NAME: ClassVar[StandardInputNames] = 'soil_water_hru'¶
- class hydpy.models.dummy.dummy_inputs.SnowCover(subvars: ModelSequences[ModelSequence, FastAccess])[source]¶
Bases:
InputSequence
Snow cover degree [-].
- Required by the method:
- STANDARD_NAME: ClassVar[StandardInputNames] = 'snow_cover_degree_hru'¶
- class hydpy.models.dummy.dummy_inputs.SnowyCanopy(subvars: ModelSequences[ModelSequence, FastAccess])[source]¶
Bases:
InputSequence
Snow cover degree in the canopies of tree-like vegetation (is
nan
for non-tree-like vegetation) [-].- Required by the method:
- STANDARD_NAME: ClassVar[StandardInputNames] = 'snow_cover_degree_canopy_hru'¶
- class hydpy.models.dummy.dummy_inputs.SnowAlbedo(subvars: ModelSequences[ModelSequence, FastAccess])[source]¶
Bases:
InputSequence
Snow albedo [-].
- Required by the method:
- STANDARD_NAME: ClassVar[StandardInputNames] = 'albedo_hru'¶
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: ModelSequences[ModelSequence, FastAccess])[source]¶
Bases:
FluxSequence
Abfluss [m³/s].
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: ModelSequences[ModelSequence, FastAccess])[source]¶
Bases:
InletSequence
Abfluss (runoff) [m³/s].
- Required by the method:
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: ModelSequences[ModelSequence, FastAccess])[source]¶
Bases:
OutletSequence
Abfluss (runoff) [m³/s].
- Calculated by the method:
- 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:
InterceptedWater()
Intercepted water [mm].SoilWater()
Soil water content [mm].SnowCover()
Snow cover degree [-].SnowyCanopy()
Snow cover degree in the canopies of tree-like vegetation (isnan
for non-tree-like vegetation) [-].SnowAlbedo()
Snow albedo [-].
- 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].