Skip to contents

A domain_decomposition is the wrapper object returned by decompose_network(). It bundles a list of hy_domain() objects with the basin-level extensive network overlays and the nexus metadata that recomposition needs.

Details

The object is a plain S3 list with six slots:

domains

named list of hy_domain objects, one per sub-network.

domain_connectivity

named list of hy_leveled overlays keyed by basin id. Each overlay is the basin's extensive network — a hy_leveled view of the connecting flowlines with toids intact except at the basin outlet, which carries the reserved outlet toid value. Sub-threshold basins have no overlay.

overrides

non-dendritic inter-domain transfer table, or NULL.

catchment_domain_index

named character vector mapping each catchment id to its domain id.

nexus_registry

synthetic nexus identifiers and the domains they connect.

source_network

the original enriched input network.

Inter-domain topology is not stored as a slot; get_domain_graph() is the canonical derived accessor and rebuilds the edge list from nexus_registry on demand.

See also

decompose_network() for construction, hy_domain() for the per-domain object, validate_decomposition() for structural checks, get_domain_graph() and get_domain_for_catchment() for accessors, print.domain_decomposition() for the print method.