hydromodpy.physics.flow.boundary_condition_registry#

Flow boundary-condition registry and runtime bundle helpers.

The normalized [flow.bc] payload stores user-facing boundary definitions. This module keeps the process-level inventory explicit: which identifiers are canonical, which family they belong to, and which backend slices currently know how to translate them.

Module attributes

SIDE_DIRICHLET_BC_IDS_ORDERED

Stable side-boundary order used by config, runtime, and solver adapters.

FLOW_BOUNDARY_DEFINITIONS

Canonical boundary-condition definitions supported by the flow process.

SUPPORTED_FLOW_BOUNDARY_IDS

All canonical flow boundary ids accepted by flow.active_bc.

Functions

active_side_dirichlet_boundary_ids(flow)

Return active side Dirichlet ids for one Flow-like object.

boundary_condition_bundle_from_flow(flow)

Return the current boundary-condition bundle for a Flow-like object.

boundary_conditions_mapping_from_flow(flow)

Return configured boundary conditions from a Flow-like object.

boundary_definition(bc_id)

Return the canonical definition for one boundary id, when known.

canonical_dirichlet_boundary_ids()

Return all canonical Dirichlet ids in a stable order.

is_boundary_condition_active(flow, bc_id)

Return whether one boundary id is active on a Flow-like object.

side_dirichlet_boundary_ids()

Return side Dirichlet ids in a stable solver-facing order.

supported_boundary_ids_for_backend(backend)

Return canonical active boundary ids supported by one backend slice.

Classes

BoundaryConditionBundle(conditions, active_ids)

Runtime view grouping configured and active flow boundary conditions.

FlowBoundaryDefinition(id, family, ...[, ...])

One canonical flow boundary-condition definition.