Snapshots and statistics

Source-generated reference for snapshot shapes, system totals, and diagnostics. See Collect results for sampling workflows.

Family-specific result, quality, and statistics records are documented with Node, Link, Subcatchment, Rain gage, and LID.

Binary output reader

The standalone reader has its own Binary output reference and Read binary output guide.

RoutingTotals

Cumulative routing volumes in project volume units; continuity error is percent.

Properties

Property	Modifier	Type	Description
`dryWeatherInflow`	`readonly`	`number`	Dry-weather inflow volume.
`wetWeatherInflow`	`readonly`	`number`	Wet-weather inflow volume.
`groundwaterInflow`	`readonly`	`number`	Groundwater inflow volume.
`rdiiInflow`	`readonly`	`number`	RDII inflow volume.
`externalInflow`	`readonly`	`number`	External inflow volume.
`flooding`	`readonly`	`number`	Flooding volume.
`outflow`	`readonly`	`number`	Outfall discharge volume.
`evaporationLoss`	`readonly`	`number`	Evaporation loss volume.
`seepageLoss`	`readonly`	`number`	Seepage loss volume.
`reactionLoss`	`readonly`	`number`	Reaction loss in the native routing balance.
`initialStorage`	`readonly`	`number`	Initial system storage volume.
`finalStorage`	`readonly`	`number`	Final system storage volume.
`continuityError`	`readonly`	`number`	Routing continuity error in percent.

RunoffTotals

Cumulative runoff water-balance depths in inches or millimetres, except percent continuity error.

Properties

Property	Modifier	Type	Description
`rainfall`	`readonly`	`number`	Rainfall depth.
`evaporationLoss`	`readonly`	`number`	Evaporation loss depth.
`infiltrationLoss`	`readonly`	`number`	Infiltration loss depth.
`runoff`	`readonly`	`number`	Runoff depth.
`lidDrainage`	`readonly`	`number`	LID drainage depth.
`outfallRunon`	`readonly`	`number`	Outfall runon depth.
`initialSurfaceStorage`	`readonly`	`number`	Initial surface-storage depth.
`finalSurfaceStorage`	`readonly`	`number`	Final surface-storage depth.
`initialSnowCover`	`readonly`	`number`	Initial snow-cover depth.
`finalSnowCover`	`readonly`	`number`	Final snow-cover depth.
`snowRemoved`	`readonly`	`number`	Removed snow depth.
`continuityError`	`readonly`	`number`	Runoff continuity error in percent.

RoutingDiagnostics

Detached time-step and convergence diagnostics for the current run.

Properties

Property	Modifier	Type	Description
`averageTimeStepSeconds`	`readonly`	`number`	Average routing step in seconds.
`minimumTimeStepSeconds`	`readonly`	`number`	Minimum routing step in seconds.
`maximumTimeStepSeconds`	`readonly`	`number`	Maximum routing step in seconds.
`stepCount`	`readonly`	`number`	Number of routing steps.
`nonconvergedStepCount`	`readonly`	`number`	Number of nonconverged steps.
`nonconvergedStepPercentage`	`readonly`	`number`	Nonconverged steps as a percentage of all steps.
`averageIterations`	`readonly`	`number`	Average trial iterations per routing step.

SimulationStatistics

Cumulative system records from simulation.statistics() in running or complete, before ending.

Properties

Property	Modifier	Type	Description
`routingTotals`	`readonly`	`RoutingTotals`	Routing-volume continuity balance.
`runoffTotals`	`readonly`	`RunoffTotals`	Runoff-depth continuity balance.
`groundwaterContinuityError`	`readonly`	`number`	Groundwater continuity error in percent.
`qualityContinuityError`	`readonly`	`number`	System quality continuity error in percent.
`routingDiagnostics`	`readonly`	`RoutingDiagnostics`	Routing time-step and convergence data.
`qualityBalances`	`readonly`	`Readonly`<`Record`<`string`, { `continuityError`: `number`; `seepageLoss`: `number`; }>>	Pollutant-ID balances; seepage follows native report units, including safe log10 units for counts.

Snapshot

type Snapshot<T> = object & { readonly [K in keyof T]: readonly T[K][] };

Detached, timestamp-free columns with one value per canonical object ID. Requested selection order is preserved; an empty selection yields empty columns.

Type Declaration

objectIds

readonly objectIds: readonly string[];

Canonical object IDs defining every column's order.

Type Parameters

Type Parameter	Description
`T`	Per-object result record defining each column's values and units.

NodeSnapshot

type NodeSnapshot = Snapshot<NodeResults>;

Aligned node hydraulic columns; keep the observation time separately.

LinkSnapshot

type LinkSnapshot = Snapshot<LinkResults>;

Aligned link hydraulic columns; keep the observation time separately.

SubcatchmentSnapshot

type SubcatchmentSnapshot = Snapshot<SubcatchmentResults>;

Aligned subcatchment runoff columns; keep the observation time separately.