Skip to content

LID

Source-generated reference for shared LID controls, subcatchment-local usages, and LID results. See Configure specialized definitions and Collect results for workflows.

LidControl

Shared LID-control handle obtained from simulation.lidControls.

Properties

id

readonly id: string;

Canonical configured control ID.

Methods

configuration()

configuration(): Promise<LidControlConfiguration>;

Read configured layers in a healthy owner state.

Returns

Promise<LidControlConfiguration>

Detached layer records; absent layers are null. Derived fields retain their last prepared values until preparation.

configure()

Call Signature
configure(layer: "surface", patch: LidSurfacePatch): Promise<void>;

Atomically update an existing surface layer in open or ended; accepted edits return the owner to open.

Parameters
Parameter Type Description
layer "surface" Existing layer to update; this does not add absent layers.
patch LidSurfacePatch Sparse layer fields in project units; omission retains a value.
Returns

Promise<void>

Resolves after all supplied fields are accepted.

Call Signature
configure(layer: "soil", patch: LidSoilPatch): Promise<void>;

Update an existing soil layer. Same state and atomicity contract as the surface overload.

Parameters
Parameter Type Description
layer "soil" Soil selector.
patch LidSoilPatch Sparse soil declarations.
Returns

Promise<void>

Call Signature
configure(layer: "storage", patch: LidStoragePatch): Promise<void>;

Update an existing storage layer. Same state and atomicity contract as the surface overload.

Parameters
Parameter Type Description
layer "storage" Storage selector.
patch LidStoragePatch Sparse storage declarations.
Returns

Promise<void>

Call Signature
configure(layer: "pavement", patch: LidPavementPatch): Promise<void>;

Update an existing pavement layer. Same state and atomicity contract as the surface overload.

Parameters
Parameter Type Description
layer "pavement" Pavement selector.
patch LidPavementPatch Sparse pavement declarations.
Returns

Promise<void>

Call Signature
configure(layer: "drain", patch: LidDrainPatch): Promise<void>;

Update an existing underdrain. Same state and atomicity contract as the surface overload.

Parameters
Parameter Type Description
layer "drain" Drain selector.
patch LidDrainPatch Sparse drain declarations.
Returns

Promise<void>

Call Signature
configure(layer: "drainage_mat", patch: LidDrainageMatPatch): Promise<void>;

Update an existing drainage mat. Same state and atomicity contract as the surface overload.

Parameters
Parameter Type Description
layer "drainage_mat" Drainage-mat selector.
patch LidDrainageMatPatch Sparse mat declarations.
Returns

Promise<void>

Call Signature
configure(layer: LidLayerName, patch: LidLayerPatch): Promise<void>;

Update a dynamically selected existing layer. Same state and atomicity contract as the surface overload.

Parameters
Parameter Type Description
layer LidLayerName Existing layer selector.
patch LidLayerPatch Sparse declarations matching the selected layer.
Returns

Promise<void>

LidUnit

LID usage handle identified by its subcatchment and local index.

Properties

subcatchmentId

readonly subcatchmentId: string;

Canonical owning subcatchment ID.

index

readonly index: number;

Zero-based position within the owning subcatchment's LID usages.

Methods

configuration()

configuration(): Promise<LidUnitConfiguration>;

Read usage declarations in a healthy owner state.

Returns

Promise<LidUnitConfiguration>

Detached configuration in project units.

configure()

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

Atomically update this usage in open or ended; accepted edits return the owner to open.

Parameters
Parameter Type Description
patch LidUnitPatch Sparse usage declarations; null restores implicit drain routing.
Returns

Promise<void>

Resolves after all supplied fields are accepted.

snapshot()

snapshot(): Promise<LidUnitSnapshot>;

Read detached water balance and layer results in running or complete, before end().

Returns

Promise<LidUnitSnapshot>

One usage's current results; later steps do not mutate them.

LidUnitCollection

Asynchronously indexed LID units owned by one subcatchment.

Properties

subcatchmentId

readonly subcatchmentId: string;

Canonical owning subcatchment ID.

Methods

count()

count(): Promise<number>;

Read the number of configured usages; unlike model collections this queries the worker.

Returns

Promise<number>

Subcatchment-local usage count.

at()

at(index: number): Promise<LidUnit>;

Resolve one subcatchment-local usage in a healthy owner state.

Parameters
Parameter Type Description
index number Zero-based usage index, not a configured LID-control index.
Returns

Promise<LidUnit>

New handle for the selected usage.

Throws

RangeError if the index is non-integral, negative, or out of range.

LidRelationship

Detached canonical relationship identity.

Type Parameters

Type Parameter Default type
K extends LidRelationshipKind LidRelationshipKind

Properties

Property Modifier Type Description
kind readonly K Target object family.
id readonly string Canonical configured target ID.

LidUnitConfiguration

Detached declarations for one subcatchment-local LID usage.

Properties

Property Modifier Type Description
area readonly number Area per replicate in ft² or m², not acres or hectares.
fullWidth readonly number Full surface width in ft or m.
bottomWidth readonly number Read-only prepared bottom width in ft or m.
initialSaturation readonly number Initial saturation percentage, 0–100.
imperviousRunoffTreated readonly number Percentage of impervious runoff treated, 0–100.
perviousRunoffTreated readonly number Percentage of pervious runoff treated, 0–100.
control readonly LidControlRelationship Configured LID-control identity.
count readonly number Number of replicate units.
routesToPervious readonly boolean Whether surface outflow is routed to the subcatchment's pervious area.
drainDestination readonly LidDrainDestination | null Explicit drain destination, or null for implicit outlet routing.

LidSurfaceConfiguration

Surface-layer declarations and prepared read-only values.

Properties

Property Modifier Type Description
thickness readonly number Storage depth in in or mm.
vegetationVolumeFraction readonly number Vegetation volume fraction.
roughness readonly number Manning roughness coefficient.
slope readonly number Surface slope in percent.
sideSlope readonly number Side slope as a horizontal-to-vertical ratio.
alpha readonly number Derived surface runoff coefficient in project units.
immediateOverflow readonly boolean Whether ponded surface water overflows without delay.

LidSoilConfiguration

Soil-layer declarations.

Properties

Property Modifier Type Description
thickness readonly number Layer thickness in in or mm.
porosity readonly number Soil porosity fraction.
fieldCapacity readonly number Field-capacity moisture fraction.
wiltingPoint readonly number Wilting-point moisture fraction.
saturatedConductivity readonly number Saturated conductivity in in/h or mm/h.
conductivitySlope readonly number Conductivity-response slope.
suctionHead readonly number Capillary suction head in in or mm.

LidStorageConfiguration

Storage-layer declarations.

Properties

Property Modifier Type Description
thickness readonly number Layer thickness in in or mm.
voidRatio readonly number Void-to-solid volume ratio, not porosity.
saturatedConductivity readonly number Saturated conductivity in in/h or mm/h.
cloggingFactor readonly number Number of treated void volumes before clogging; zero disables clogging.

LidPavementConfiguration

Pavement-layer declarations.

Properties

Property Modifier Type Description
thickness readonly number Layer thickness in in or mm.
voidRatio readonly number Void-to-solid volume ratio, not porosity.
imperviousFraction readonly number Impervious pavement fraction.
saturatedConductivity readonly number Saturated conductivity in in/h or mm/h.
cloggingFactor readonly number Number of treated void volumes before clogging; zero disables clogging.
regenerationIntervalSeconds readonly number Time between pavement regeneration events in seconds.
regenerationFraction readonly number Fraction of permeability restored by regeneration.

LidDrainConfiguration

Underdrain declarations; the control-curve relationship is read-only here.

Properties

Property Modifier Type Description
coefficient readonly number Drain equation coefficient in project units.
exponent readonly number Drain equation head exponent.
offset readonly number Drain offset above storage bottom in in or mm.
delaySeconds readonly number Dry-weather delay before draining in seconds.
openHead readonly number Head at which the drain opens, in in or mm.
closeHead readonly number Head at which the drain closes, in in or mm.
controlCurve readonly LidCurveRelationship | null Configured control-curve identity, or null.

LidDrainageMatConfiguration

Drainage-mat declarations and prepared runoff coefficient.

Properties

Property Modifier Type Description
thickness readonly number Layer thickness in in or mm.
voidFraction readonly number Mat void-volume fraction.
roughness readonly number Manning roughness coefficient.
alpha readonly number Derived drainage-mat runoff coefficient in project units.

LidControlConfiguration

Configured optional layers for one LID control; absent layers are null.

Properties

Property Modifier Type Description
surface readonly LidSurfaceConfiguration | null Surface layer, or null when absent.
soil readonly LidSoilConfiguration | null Soil layer, or null when absent.
storage readonly LidStorageConfiguration | null Storage layer, or null when absent.
pavement readonly LidPavementConfiguration | null Pavement layer, or null when absent.
drain readonly LidDrainConfiguration | null Underdrain layer, or null when absent.
drainageMat readonly LidDrainageMatConfiguration | null Drainage mat, or null when absent.

LidSurfacePatch

Sparse surface-layer update; derived fields are not writable.

Properties

Property Type Description
thickness? number Storage depth in in or mm.
vegetationVolumeFraction? number Vegetation volume fraction.
roughness? number Manning roughness coefficient.
slope? number Surface slope in percent.
sideSlope? number Side slope as a horizontal-to-vertical ratio.

LidSoilPatch

Sparse soil-layer update.

Properties

Property Type Description
thickness? number Layer thickness in in or mm.
porosity? number Soil porosity fraction.
fieldCapacity? number Field-capacity moisture fraction.
wiltingPoint? number Wilting-point moisture fraction.
saturatedConductivity? number Saturated conductivity in in/h or mm/h.
conductivitySlope? number Conductivity-response slope.
suctionHead? number Capillary suction head in in or mm.

LidStoragePatch

Sparse storage-layer update.

Properties

Property Type Description
thickness? number Layer thickness in in or mm.
voidRatio? number Void-to-solid volume ratio, not porosity.
saturatedConductivity? number Saturated conductivity in in/h or mm/h.
cloggingFactor? number Number of treated void volumes before clogging; zero disables clogging.

LidPavementPatch

Sparse pavement-layer update.

Properties

Property Type Description
thickness? number Layer thickness in in or mm.
voidRatio? number Void-to-solid volume ratio, not porosity.
imperviousFraction? number Impervious pavement fraction.
saturatedConductivity? number Saturated conductivity in in/h or mm/h.
cloggingFactor? number Number of treated void volumes before clogging; zero disables clogging.
regenerationIntervalSeconds? number Time between pavement regeneration events in seconds.
regenerationFraction? number Fraction of permeability restored by regeneration.

LidDrainPatch

Sparse underdrain update; does not replace the control curve.

Properties

Property Type Description
coefficient? number Drain equation coefficient in project units.
exponent? number Drain equation head exponent.
offset? number Drain offset above storage bottom in in or mm.
delaySeconds? number Dry-weather delay before draining in seconds.
openHead? number Head at which the drain opens, in in or mm.
closeHead? number Head at which the drain closes, in in or mm.

LidDrainageMatPatch

Sparse drainage-mat update; the derived coefficient is not writable.

Properties

Property Type Description
thickness? number Layer thickness in in or mm.
voidFraction? number Mat void-volume fraction.
roughness? number Manning roughness coefficient.

LidUnitPatch

Sparse usage update; omitted fields retain their declarations.

Properties

Property Type Description
area? number Area per replicate in ft² or m², not acres or hectares.
fullWidth? number Full surface width in ft or m.
initialSaturation? number Initial saturation percentage, 0–100.
imperviousRunoffTreated? number Percentage of impervious runoff treated, 0–100.
perviousRunoffTreated? number Percentage of pervious runoff treated, 0–100.
control? string Canonical configured LID-control ID.
count? number Number of replicate units.
routesToPervious? boolean Whether surface outflow is routed to the subcatchment's pervious area.
drainDestination? LidDrainDestination | null Explicit destination, or null to restore implicit outlet routing.

LidUnitSnapshot

Detached LID water balance and layer state. Water-balance totals are equivalent depths, not volumes.

Properties

Property Modifier Type Description
inflow readonly number Cumulative inflow depth in in or mm.
evaporation readonly number Cumulative evaporation depth in in or mm.
infiltration readonly number Cumulative infiltration depth in in or mm.
surfaceOutflow readonly number Cumulative surface outflow depth in in or mm.
drainOutflow readonly number Cumulative drain outflow depth in in or mm.
initialVolume readonly number Initial stored water as an equivalent depth in in or mm.
finalVolume readonly number Final stored water as an equivalent depth in in or mm.
surfaceDepth readonly number Surface water depth in in or mm.
pavementDepth readonly number Pavement water depth in in or mm.
storageDepth readonly number Storage water depth in in or mm.
soilMoisture readonly number Volumetric soil moisture fraction.
dryTimeSeconds readonly number Elapsed dry time in seconds.
oldDrainFlow readonly number Previous drain flow in project flow units.
newDrainFlow readonly number Current drain flow in project flow units.
evaporationRate readonly number Evaporation rate in in/h or mm/h.
maximumNativeInfiltrationRate readonly number Maximum native-soil infiltration rate in in/h or mm/h.
surfaceInflowRate readonly number Surface inflow rate in in/h or mm/h.
surfaceInfiltrationRate readonly number Surface infiltration rate in in/h or mm/h.
surfaceEvaporationRate readonly number Surface evaporation rate in in/h or mm/h.
surfaceOutflowRate readonly number Surface outflow rate in in/h or mm/h.
pavementEvaporationRate readonly number Pavement evaporation rate in in/h or mm/h.
pavementPercolationRate readonly number Pavement percolation rate in in/h or mm/h.
soilEvaporationRate readonly number Soil evaporation rate in in/h or mm/h.
soilPercolationRate readonly number Soil percolation rate in in/h or mm/h.
storageInflowRate readonly number Storage inflow rate in in/h or mm/h.
storageExfiltrationRate readonly number Storage exfiltration rate in in/h or mm/h.
storageEvaporationRate readonly number Storage evaporation rate in in/h or mm/h.
storageDrainRate readonly number Storage drainage rate in in/h or mm/h.
surfaceFluxRate readonly number Previous surface-layer flux in ft/s or m/s, not rainfall-rate units.
soilFluxRate readonly number Previous soil-layer flux in ft/s or m/s.
storageFluxRate readonly number Previous storage-layer flux in ft/s or m/s.
pavementFluxRate readonly number Previous pavement-layer flux in ft/s or m/s.

SubcatchmentLidSnapshot

Detached aggregate LID-group results for one subcatchment.

Properties

Property Modifier Type Description
perviousArea readonly number Non-LID pervious area in ft² or m².
flowToPerviousArea readonly number Flow routed to pervious area in project flow units.
oldDrainFlow readonly number Previous aggregate drain flow in project flow units.
newDrainFlow readonly number Current aggregate drain flow in project flow units.

LidRelationshipKind

type LidRelationshipKind = "lid" | "node" | "subcatchment" | "curve";

Canonical relationship identity returned by LID configuration reads.

LidControlRelationship

type LidControlRelationship = LidRelationship<"lid">;

Reference to a configured LID control.

LidDrainDestination

type LidDrainDestination = LidRelationship<"node" | "subcatchment">;

Explicit LID drain destination.

LidCurveRelationship

type LidCurveRelationship = LidRelationship<"curve">;

Reference to a configured drain-control curve.

LidLayerName

type LidLayerName = "surface" | "soil" | "storage" | "pavement" | "drain" | "drainage_mat";

Layer selector accepted by LidControl.configure.

LidLayerPatch

type LidLayerPatch = 
  | LidSurfacePatch
  | LidSoilPatch
  | LidStoragePatch
  | LidPavementPatch
  | LidDrainPatch
  | LidDrainageMatPatch;

Sparse patch for the selected LID layer; omission retains each field.