ProcessSpatial#

class hydromodpy.physics.ProcessSpatial[source]#

Bases: ABC, Generic[TInitialConditions]

Abstract base class for HydroModPy spatial processes.

Containers: - parameters: process parameters (not limited to FieldParam objects). - initial_conditions: one process-specific typed structure. - boundary_conditions: boundary conditions (BoundaryCondition). - sinks_sources: sinks/sources (domain objects or compatible payloads).

set_parameters_from_config(parameters=None, *, parameter_ids=None, context_label='parameters')[source]#

Build and replace self.parameters from a configuration payload.

Parameters:

parameters (Mapping[str, object] | None)
parameter_ids (Iterable[str] | None)
context_label (str)

Return type:

None

add_parameter(parameter_id, parameter)[source]#

Add or replace one single process parameter entry.

Parameters:

parameter_id (str)
parameter (object)

Return type:

None

set_initial_conditions(initial_conditions)[source]#

Build and store one process-specific initial-condition structure.

Parameters:: initial_conditions (object | None)
Return type:: None

abstract build_initial_conditions(initial_conditions)[source]#

Convert raw payload to one typed process-specific structure.

Parameters:: initial_conditions (object | None)
Return type:: Optional[TypeVar(TInitialConditions)]

abstract set_boundary_conditions(boundary_conditions)[source]#

Define or update boundary conditions.

Parameters:: boundary_conditions (dict)

add_boundary_condition(boundary_condition)[source]#

Add one boundary condition object.

Parameters:: boundary_condition (BoundaryCondition)

abstract set_sinks_sources(sinks_sources)[source]#

Define or update sinks/sources.

Parameters:: sinks_sources (dict)

add_sink_source(sink_source)[source]#

Add one sink/source object.

Parameters:: sink_source (SinkSource)