stateinterfaces¶
This module defines submodel interfaces for sharing (model) states.
Module stateinterfaces
implements the following members:
IntercModel_V1
Pure getter interface for using main models as sub-submodels or simple dummy models as submodels for querying the amount of intercepted water.
SoilWaterModel_V1
Pure getter interface for using main models as sub-submodels or simple dummy models as submodels for querying the soil water content.
SnowCoverModel_V1
Pure getter interface for using main models as sub-submodels or simple dummy models as submodels for querying the snow cover degree.
SnowyCanopyModel_V1
Pure getter interface for using main models as sub-submodels or simple dummy models as submodels for querying the snow cover degree in the canopies of tree-like vegetation.
SnowAlbedoModel_V1
Pure getter interface for using main models as sub-submodels or simple dummy models as submodels for querying the current snow albedo.
WaterLevelModel_V1
Pure getter interface for querying the current water level.
- class hydpy.interfaces.stateinterfaces.IntercModel_V1[source]¶
Bases:
SubmodelInterface
Pure getter interface for using main models as sub-submodels or simple dummy models as submodels for querying the amount of intercepted water.
- typeid: ClassVar[Literal[1]] = 1¶
Type identifier for
IntercModel_V1
submodels.
- class hydpy.interfaces.stateinterfaces.SoilWaterModel_V1[source]¶
Bases:
SubmodelInterface
Pure getter interface for using main models as sub-submodels or simple dummy models as submodels for querying the soil water content.
- typeid: ClassVar[Literal[1]] = 1¶
Type identifier for
SoilWaterModel_V1
submodels.
- class hydpy.interfaces.stateinterfaces.SnowCoverModel_V1[source]¶
Bases:
SubmodelInterface
Pure getter interface for using main models as sub-submodels or simple dummy models as submodels for querying the snow cover degree.
- typeid: ClassVar[Literal[1]] = 1¶
Type identifier for
SnowCoverModel_V1
submodels.
- class hydpy.interfaces.stateinterfaces.SnowyCanopyModel_V1[source]¶
Bases:
SubmodelInterface
Pure getter interface for using main models as sub-submodels or simple dummy models as submodels for querying the snow cover degree in the canopies of tree-like vegetation.
- typeid: ClassVar[Literal[1]] = 1¶
Type identifier for
SnowyCanopyModel_V1
submodels.
- class hydpy.interfaces.stateinterfaces.SnowAlbedoModel_V1[source]¶
Bases:
SubmodelInterface
Pure getter interface for using main models as sub-submodels or simple dummy models as submodels for querying the current snow albedo.
- typeid: ClassVar[Literal[1]] = 1¶
Type identifier for
SnowAlbedoModel_V1
submodels.
- prepare_nmbzones(nmbzones: int) None [source]¶
Set the number of zones in which the actual calculations take place.
- get_snowalbedo(k: int) float [source]¶
Get the selected zone’s snow albedo as a fraction.
For snow-free zones,
get_snowalbedo()
should returnnan
.
- class hydpy.interfaces.stateinterfaces.WaterLevelModel_V1[source]¶
Bases:
SubmodelInterface
Pure getter interface for querying the current water level.
- typeid: ClassVar[Literal[1]] = 1¶
Type identifier for
WaterLevelModel_V1
submodels.