LIDBase Methods

Methods

AddInflow Add inflow (run-on from catchment to LID)
AddToOffers Add LID offers to provided lists of offers and offer delegates.
(Inherited from LIDBaseOffers)
ApplyBoundary(CatchmentSourceBoundaryTypes, IBoundarySource) Apply a boundary to this catchment
ApplyBoundary(GlobalSourceBoundaryTypes, GlobalGeoLocatedSource) Apply a boundary to this catchment
EqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
FinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
Finish Finish simulations
GetEvapRates Computes evaporation rate from layer.
GetHashCodeServes as the default hash function.
(Inherited from Object)
GetTypeGets the Type of the current instance.
(Inherited from Object)
Initialize Initialize LID
Limit Limit val between minValue and maxValue
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
PerformTimeStep(DateTime, DateTime) Take time step and calculate the rain rate and potential evaporation rate from boundaries
PerformTimeStep(DateTime, DateTime, Double, Double) Take time step with provided rain rate and evaporation rate
Prepare Prepare LID
PrepareForNewReportFile(IDiagnostics) Check report file directory and delete existing file, if present.
PrepareForNewReportFile(IDiagnostics, FilePath, String) Check report file directory and delete existing file, if present.
PrepareForTimeStep Take time step
ReadState Read state and apply to module. Returns true if state was successfully read.
SetInputParameters Set input parameters
StateUpdated When state has been updated, this method can be called to update derived/computational variables
ToStringReturns a string that represents the current object.
(Inherited from Object)
Validate Validate LID surface
WriteState Write current state of module

Extension Methods

SetSoilMoisture Set soil/pavement moisture of lid, independent of type.

If lid does not have a soil/pavement layer, an exception is thrown


(Defined by LIDExtension)
SetStorageDepth Set storage depth of lid, independent of type.

If lid does not have a storage layer, an exception is thrown


(Defined by LIDExtension)
SetSurfaceDepth Set surface depth of lid, independent of type.

If lid does not have a surface layer, an exception is thrown


(Defined by LIDExtension)
SoilMoisture Get soil/pavement moisture of lid, independent of type.

If lid does not have a soil/pavement layer, an exception is thrown


(Defined by LIDExtension)
StorageDepth Get storage depth of lid, independent of type.

If lid does not have a storage layer, an exception is thrown


(Defined by LIDExtension)
SurfaceDepth Get surface depth of lid, independent of type.

If lid does not have a surface layer, an exception is thrown


(Defined by LIDExtension)
ValidateConnections Validate LID surface connections and total routing fraction
(Defined by LIDExtension)

See Also