precipinterfaces

This module defines submodel interfaces for providing precipitation.

Module precipinterfaces implements the following members:

• PrecipModel_V1 Pure getter interface for using main models as sub-submodels.

• PrecipModel_V2 Simple interface for determining precipitation in one step.

---

class hydpy.interfaces.precipinterfaces.PrecipModel_V1

Bases: SubmodelInterface

Pure getter interface for using main models as sub-submodels.

typeid: ClassVar[Literal[1]] = 1

Type identifier for PrecipModel_V1 submodels.

get_precipitation(k: int) → float

Get the selected zone’s precipitation value in mm/T.

class hydpy.interfaces.precipinterfaces.PrecipModel_V2

Bases: SubmodelInterface

Simple interface for determining precipitation in one step.

typeid: ClassVar[Literal[2]] = 2

Type identifier for PrecipModel_V2 submodels.

prepare_nmbzones(nmbzones: int) → None

Set the number of zones in which the actual calculations take place.

prepare_subareas(subareas: Sequence[float]) → None

Set the areas of the individual zones in km².

determine_precipitation() → None

Determine precipitation.

get_precipitation(k: int) → float

Get the selected zone’s precipitation value in mm/T.

get_meanprecipitation() → float

Get the previously calculated average precipitation in mm/T.