Flow Model

class morl4water.core.models.flow.Flow(name: str, sources: list[Facility | ControlledFacility], destinations: Facility | ControlledFacility | dict[Facility | ControlledFacility, float], max_capacity: float, evaporation_rate: float = 0.0, delay: int = 0, default_outflow: float | None = None)

Bases: object

determine_info() → dict

determine_source_outflow() → float

determine_source_outflow_by_destination(destination_index: int, destination_inflow_ratio: float) → float

is_truncated() → bool

reset() → None

set_destination_inflow() → None

step() → tuple[ObsType | None, float, bool, bool, dict]

class morl4water.core.models.flow.Inflow(name: str, destinations: Facility | ControlledFacility | dict[Facility | ControlledFacility, float], max_capacity: float, all_inflow: list[float], evaporation_rate: float = 0.0, delay: int = 0, default_outflow: float | None = None)

Bases: Flow

determine_source_outflow() → float

determine_source_outflow_by_destination(destination_index: int, destination_inflow_ratio: float) → float

is_truncated() → bool

class morl4water.core.models.flow.Outflow(name: str, sources: list[Facility | ControlledFacility], max_capacity: float)

Bases: Flow

set_destination_inflow() → None