Model definitions

Source-generated reference for definition identities, aquifers, and snowmelt parameter sets. See Configure specialized definitions for workflows, and Collections for lookup.

Definition

Read-only identity for a configured definition. Generic handles do not expose editable curve/time-series data.

Properties

id

readonly id: string;

Canonical configured definition ID.

Aquifer

Editable aquifer handle obtained from simulation.aquifers.

Extends

Definition

Properties

id

readonly id: string;

Canonical configured definition ID.

Inherited from

Definition.id

Methods

configuration()

configuration(): Promise<AquiferConfiguration>;

Read aquifer declarations in any healthy owner state.

Returns

Promise<AquiferConfiguration>

Detached aquifer configuration in project units.

configure()

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

Atomically update aquifer declarations in open or ended; accepted edits return the owner to open.

Parameters

Parameter	Type	Description
`patch`	`AquiferPatch`	Sparse field values; null clears the optional time-pattern relationship.

Returns

Promise<void>

Resolves after all fields are accepted.

SnowmeltParameterSet

Editable snowmelt parameter-set identity handle.

Extends

Definition

Properties

id

readonly id: string;

Canonical configured definition ID.

Inherited from

Definition.id

Methods

configuration()

configuration(): Promise<SnowmeltParameterSetConfiguration>;

Read all parameter-set declarations in a healthy owner state.

Returns

Promise<SnowmeltParameterSetConfiguration>

Detached parameter set with three surface records.

configure()

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

Atomically update set-level declarations in open or ended; accepted edits return the owner to open.

Parameters

Parameter	Type	Description
`patch`	`SnowmeltParameterSetPatch`	Sparse set fields; null clears the optional receiving-subcatchment relation.

Returns

Promise<void>

Resolves after the update is accepted.

surfaceConfiguration()

surfaceConfiguration(surface: SnowmeltSurfaceName): Promise<SnowmeltSurfaceConfiguration>;

Read one surface in a healthy owner state.

Parameters

Parameter	Type	Description
`surface`	`SnowmeltSurfaceName`	Plowable, impervious, or pervious surface selector.

Returns

Promise<SnowmeltSurfaceConfiguration>

Detached surface parameters.

configureSurface()

configureSurface(surface: SnowmeltSurfaceName, patch: SnowmeltSurfacePatch): Promise<void>;

Atomically update one surface in open or ended; accepted edits return the owner to open.

Parameters

Parameter	Type	Description
`surface`	`SnowmeltSurfaceName`	Surface to update.
`patch`	`SnowmeltSurfacePatch`	Sparse surface values; omitted fields retain their values.

Returns

Promise<void>

Resolves after all supplied fields are accepted.

AquiferConfiguration

Detached aquifer declarations in configured project units.

Properties

Property	Modifier	Type	Description
`porosity`	`readonly`	`number`	Soil porosity fraction.
`wiltingPoint`	`readonly`	`number`	Wilting-point moisture fraction.
`fieldCapacity`	`readonly`	`number`	Field-capacity moisture fraction.
`hydraulicConductivity`	`readonly`	`number`	Saturated hydraulic conductivity in project rainfall-rate units.
`conductivitySlope`	`readonly`	`number`	Native conductivity-response slope.
`tensionSlope`	`readonly`	`number`	Tension-response slope in project length units (ft or m).
`upperEvaporationFraction`	`readonly`	`number`	Fraction of evaporation drawn from the upper zone.
`lowerEvaporationDepth`	`readonly`	`number`	Lower-zone evaporation depth in project length units.
`lowerLossCoefficient`	`readonly`	`number`	Lower-zone loss coefficient in in/h or mm/h.
`bottomElevation`	`readonly`	`number`	Aquifer bottom elevation in ft or m.
`waterTableElevation`	`readonly`	`number`	Initial water-table elevation in ft or m.
`upperMoisture`	`readonly`	`number`	Initial upper-zone moisture fraction.
`upperEvaporationPattern`	`readonly`	`string` \| `null`	Canonical upper-evaporation time-pattern ID, or null.

AquiferPatch

Sparse aquifer update; omitted fields retain their values.

Properties

Property	Type	Description
`porosity?`	`number`	Soil porosity fraction.
`wiltingPoint?`	`number`	Wilting-point moisture fraction.
`fieldCapacity?`	`number`	Field-capacity moisture fraction.
`hydraulicConductivity?`	`number`	Saturated hydraulic conductivity in project rainfall-rate units.
`conductivitySlope?`	`number`	Native conductivity-response slope.
`tensionSlope?`	`number`	Tension-response slope in project length units (ft or m).
`upperEvaporationFraction?`	`number`	Fraction of evaporation drawn from the upper zone.
`lowerEvaporationDepth?`	`number`	Lower-zone evaporation depth in project length units.
`lowerLossCoefficient?`	`number`	Lower-zone loss coefficient in in/h or mm/h.
`bottomElevation?`	`number`	Aquifer bottom elevation in ft or m.
`waterTableElevation?`	`number`	Initial water-table elevation in ft or m.
`upperMoisture?`	`number`	Initial upper-zone moisture fraction.
`upperEvaporationPattern?`	`string` \| `null`	Clear with null; omission retains the current relationship.

SnowmeltSurfaceConfiguration

Detached snowmelt-surface declarations.

Properties

Property	Modifier	Type	Description
`minimumMeltCoefficient`	`readonly`	`number`	Minimum melt coefficient in in/(h·°F) for US projects or mm/(h·°C) for SI projects.
`maximumMeltCoefficient`	`readonly`	`number`	Maximum melt coefficient in in/(h·°F) for US projects or mm/(h·°C) for SI projects.
`baseTemperature`	`readonly`	`number`	Base melt temperature in °F for US projects or °C for SI projects.
`freeWaterFraction`	`readonly`	`number`	Free-water holding-capacity fraction.
`initialSnowDepth`	`readonly`	`number`	Initial snow water-equivalent depth in in or mm.
`initialFreeWater`	`readonly`	`number`	Initial free-water depth in in or mm.
`snowDepthForFullCoverage`	`readonly`	`number`	Snow water-equivalent depth for full coverage in in or mm.

SnowmeltSurfacePatch

Sparse snowmelt-surface update; omission retains a field.

Properties

Property	Type	Description
`minimumMeltCoefficient?`	`number`	Minimum melt coefficient in in/(h·°F) for US projects or mm/(h·°C) for SI projects.
`maximumMeltCoefficient?`	`number`	Maximum melt coefficient in in/(h·°F) for US projects or mm/(h·°C) for SI projects.
`baseTemperature?`	`number`	Base melt temperature in °F for US projects or °C for SI projects.
`freeWaterFraction?`	`number`	Free-water holding-capacity fraction.
`initialSnowDepth?`	`number`	Initial snow water-equivalent depth in in or mm.
`initialFreeWater?`	`number`	Initial free-water depth in in or mm.
`snowDepthForFullCoverage?`	`number`	Snow water-equivalent depth for full coverage in in or mm.

SnowmeltParameterSetConfiguration

Detached snowmelt parameter set with all three surface records.

Properties

Property	Modifier	Type	Description
`plowableFraction`	`readonly`	`number`	Plowable fraction of impervious area.
`plowable`	`readonly`	`SnowmeltSurfaceConfiguration`	Plowable-surface melt parameters.
`impervious`	`readonly`	`SnowmeltSurfaceConfiguration`	Impervious-surface melt parameters.
`pervious`	`readonly`	`SnowmeltSurfaceConfiguration`	Pervious-surface melt parameters.
`plowDepth`	`readonly`	`number`	Snow water-equivalent depth triggering plowing, in in or mm.
`removalFractions`	`readonly`	readonly [`number`, `number`, `number`, `number`, `number`]	Five removal fractions in native solver destination order.
`removalSubcatchment`	`readonly`	`string` \| `null`	Canonical receiving subcatchment ID, or null.

SnowmeltParameterSetPatch

Sparse parameter-set update; use configureSurface for individual surface parameters.

Properties

Property	Type	Description
`plowableFraction?`	`number`	Plowable fraction of impervious area.
`plowDepth?`	`number`	Snow water-equivalent depth triggering plowing, in in or mm.
`removalFractions?`	readonly [`number`, `number`, `number`, `number`, `number`]	Five removal fractions in native solver destination order.
`removalSubcatchment?`	`string` \| `null`	Clear with null; omission retains the current relationship.

Pollutant

type Pollutant = Definition;

Read-only pollutant identity handle.

LandUse

type LandUse = Definition;

Read-only land-use identity handle.

TimePattern

type TimePattern = Definition;

Read-only time-pattern identity handle.

Curve

type Curve = Definition;

Read-only curve identity handle.

TimeSeries

type TimeSeries = Definition;

Read-only time-series identity handle.

ControlRule

type ControlRule = Definition;

Read-only control-rule identity handle.

Transect

type Transect = Definition;

Read-only transect identity handle.

CustomShape

type CustomShape = Definition;

Read-only custom-shape identity handle.

Street

type Street = Definition;

Read-only street identity handle.

InletDesign

type InletDesign = Definition;

Read-only inlet-design identity handle.

SnowmeltSurfaceName

type SnowmeltSurfaceName = "plowable" | "impervious" | "pervious";

Snowmelt surface selector within a parameter set.