hydromodpy.physics.base.forcing#
Canonical forcing payload for flow boundaries and sinks/sources.
Historically HydroModPy carried near-duplicate config classes for each
forcing consumer (FlowBoundaryForcingConstantConfig,
FlowBoundaryForcingCsvConfig, FlowWellForcingConstantConfig,
FlowWellForcingCsvConfig, etc.). The architecture spec
(architecture_cible/02_config_pydantic.md §1.2) factorises these into a
single discriminated union keyed on kind:
ConstantForcing- one scalar value held over the whole simulation;CsvForcing- a time series loaded from a CSV file;SyntheticForcing- an amplitude/period synthetic signal.
Consumers can accept the union directly (via the Forcing alias) and
branch on kind for dispatch.
Module attributes
|
Discriminated union of flow-forcing payloads. |