RDII

Source-generated reference for AMM models, RTK unit hydrographs, and their assignments. Assignment operations are on Simulation. See Configure specialized definitions for workflows.

AmmModel

Editable AMM definition from simulation.ammModels; node assignments are managed on the simulation.

Properties

id

readonly id: string;

Canonical configured model ID.

Methods

configuration()

configuration(): Promise<AmmModelConfiguration>;

Read the definition in any healthy owner state.

Returns

Promise<AmmModelConfiguration>

Detached complete AMM configuration.

configure()

configure(patch: AmmModelPatch): Promise<void>;

Atomically update an AMM definition in open or ended; accepted edits return the owner to open.

Parameters

Parameter	Type	Description
`patch`	`AmmModelPatch`	Sparse fields; supplying components replaces the complete array.

Returns

Promise<void>

Resolves after all fields are accepted.

UnitHydrograph

Editable RTK definition from simulation.unitHydrographs; node assignments are separate.

Properties

id

readonly id: string;

Canonical configured hydrograph ID.

Methods

configuration()

configuration(): Promise<UnitHydrographConfiguration>;

Read the definition in any healthy owner state.

Returns

Promise<UnitHydrographConfiguration>

Detached rain-gage identity and complete twelve-month response matrix.

configure()

configure(patch: UnitHydrographPatch): Promise<void>;

Atomically update an RTK definition in open or ended; accepted edits return the owner to open.

Parameters

Parameter	Type	Description
`patch`	`UnitHydrographPatch`	Sparse fields; a monthly array replaces all twelve months.

Returns

Promise<void>

Resolves after the complete patch is accepted.

AmmStandardComponent

Detached standard AMM component. kind is exactly "standard".

Properties

Property	Modifier	Type	Description
`kind`	`readonly`	`"standard"`	Standard response discriminator.
`id`	`readonly`	`string`	Component identity within this model.
`dryCapture`	`readonly`	`number`	Dry-weather capture parameter in the model's native capture units.
`precipitationWindowHours`	`readonly`	`number`	Precipitation averaging window in hours.
`hydrographHalfLifeHours`	`readonly`	`number`	Response hydrograph half-life in hours.
`initialWetCapture`	`readonly`	`number`	Initial wet capture parameter in native capture units.
`moistureHalfLifeHours`	`readonly`	`number`	Antecedent moisture half-life in hours.
`temperatureWindowHours`	`readonly`	`number`	Temperature averaging window in hours.
`springColdShcf`	`readonly`	`number`	Spring cold seasonal hydrograph capture factor.
`hotShcf`	`readonly`	`number`	Hot seasonal hydrograph capture factor.
`fallColdShcf`	`readonly`	`number`	Fall cold seasonal hydrograph capture factor.

AmmBaseflowComponent

Detached baseflow AMM component. kind is exactly "baseflow".

Properties

Property	Modifier	Type	Description
`kind`	`readonly`	`"baseflow"`	Seasonal baseflow discriminator.
`id`	`readonly`	`string`	Component identity within this model.
`precipitationWindowHours`	`readonly`	`number`	Precipitation averaging window in hours.
`hydrographHalfLifeHours`	`readonly`	`number`	Response hydrograph half-life in hours.
`temperatureWindowHours`	`readonly`	`number`	Temperature averaging window in hours.
`springColdCapture`	`readonly`	`number`	Spring cold capture parameter in native capture units.
`hotCapture`	`readonly`	`number`	Hot capture parameter in native capture units.
`fallColdCapture`	`readonly`	`number`	Fall cold capture parameter in native capture units.

AmmModelConfiguration

Complete AMM model configuration in native project units.

Properties

Property	Modifier	Type	Description
`rainGage`	`readonly`	`string`	Canonical rain-gage ID.
`coldTemperature`	`readonly`	`number`	Cold reference temperature in the model's configured temperature units.
`hotTemperature`	`readonly`	`number`	Hot reference temperature in the model's configured temperature units.
`components`	`readonly`	readonly `AmmComponent`[]	Complete ordered standard/baseflow component list.

AmmModelPatch

Sparse AMM model update. Omitted fields retain their current values.

Properties

Property	Type	Description
`rainGage?`	`string`	Canonical rain-gage ID.
`coldTemperature?`	`number`	Cold reference temperature in the model's configured temperature units.
`hotTemperature?`	`number`	Hot reference temperature in the model's configured temperature units.
`components?`	readonly `AmmComponent`[]	Replacement complete component array; omission retains it.

AmmAssignment

Detached AMM node assignment in native project units. IDs are canonical.

Properties

Property	Modifier	Type	Description
`node`	`readonly`	`string`	Canonical receiving node ID.
`model`	`readonly`	`string`	Canonical AMM-model ID.
`area`	`readonly`	`number`	Assigned land area in acres (US) or hectares (SI).

UnitHydrographResponse

One detached RTK short-, medium-, or long-response parameter set.

Properties

Property	Modifier	Type	Description
`rainfallFraction`	`readonly`	`number`	Fraction of rainfall converted to RDII.
`timeToPeakHours`	`readonly`	`number`	Time to peak in hours.
`recessionRatio`	`readonly`	`number`	Recession-to-time-to-peak ratio.
`maximumInitialAbstraction`	`readonly`	`number`	Maximum initial abstraction depth in inches or millimetres.
`initialAbstractionRecoveryRate`	`readonly`	`number`	Initial abstraction recovery rate in rainfall-depth units per day.
`initialAbstractionAtStart`	`readonly`	`number`	Initial abstraction depth at start in inches or millimetres.

UnitHydrographMonth

One calendar month's named RTK responses.

Properties

Property	Modifier	Type	Description
`short`	`readonly`	`UnitHydrographResponse`	Short-response parameters.
`medium`	`readonly`	`UnitHydrographResponse`	Medium-response parameters.
`long`	`readonly`	`UnitHydrographResponse`	Long-response parameters.

UnitHydrographConfiguration

Complete January-through-December RTK response matrix.

Properties

Property	Modifier	Type	Description
`rainGage`	`readonly`	`string`	Canonical rain-gage ID.
`monthlyResponses`	`readonly`	readonly `UnitHydrographMonth`[]	Exactly twelve monthly records, January through December.

UnitHydrographPatch

Sparse RTK update. Omitted fields retain their current values.

Properties

Property	Type	Description
`rainGage?`	`string`	Replacement rain-gage ID.
`monthlyResponses?`	readonly `UnitHydrographMonth`[]	Replacement complete January-through-December array, exactly twelve entries.

RdiiAssignment

Detached RTK RDII node assignment in native project units. IDs are canonical.

Properties

Property	Modifier	Type	Description
`node`	`readonly`	`string`	Canonical receiving node ID.
`unitHydrograph`	`readonly`	`string`	Canonical RTK unit-hydrograph ID.
`area`	`readonly`	`number`	Assigned land area in acres (US) or hectares (SI).

AmmComponentKind

type AmmComponentKind = "standard" | "baseflow";

Standard runoff-response or seasonal baseflow AMM component.

AmmComponent

type AmmComponent = 
  | AmmStandardComponent
  | AmmBaseflowComponent;

AMM component discriminated by kind; component arrays are replaced as a whole.