public class CatchmentSurfaces : List<CatchmentSurface>,
ICatchmentSurface, ICatchmentSurfaceVariables, ICatchmentSurfaceStateVariables, ICatchmentSurfaceComputationalVariables, IModelStateReadWrite| CatchmentSurfaces | Initializes a new instance of the ListT class that is empty and has the default initial capacity. |
| CatchmentSurfaces(ListCatchmentSurface) | Initializes a new instance of the CatchmentSurfaces class |
| Capacity | Gets or sets the total number of elements the internal data structure can hold without resizing. (Inherited from ListCatchmentSurface) |
| Count | Gets the number of elements contained in the ListT. (Inherited from ListCatchmentSurface) |
| Depth | Depth of water on sub-catchment. State variable. Unit: [m] |
| DepthOld | Depth of water at the previous time step. Computational variable. Unit: [m] |
| EvaporationActual | Actual evaporation. Reporting variable. Unit: [m/s] |
| EvaporationActualOld | Evaporation of last time step. Reporting variable. Unit: [m/s] |
| EvaporationPotential | Potential evaporation. Reporting variable. Unit: [m/s] |
| InfiltrationActual | Actual infiltration. Reporting variable. Unit: [m/s] |
| InfiltrationActualOld | Infiltration of last time step Reporting variable. Unit: [m/s] |
| InfiltrationPotential | Potential infiltration. Reporting variable. Unit: [m/s] |
| InfiltrationPotentialOld | Potential infiltration of last time step Reporting variable. Unit: [m/s] |
| InfiltrationTime | Infiltration time which is relevant only for single default Linear Reservoir surface. |
| Item | Gets or sets the element at the specified index. (Inherited from ListCatchmentSurface) |
| Loss |
Loss, other than infiltration which goes into InfiltrationActual.
Additionally, the wetting loss and storage loss is not included in this loss, and these are considered a part of catchment water volume, which cannot be routed. Unit: [m/s] |
| LossOld | Loss of last time step |
| RainRate |
Rain rate, which can be modified by some processes.
For example, rain rate can be modified by snow module. Unit: [m/s] |
| RainRateOld | Rain rate of last time step. Unit: [m/s] |
| SnowStorage | Snow storage at time N+1. Unit: [m] |
| SnowStorageOld | Snow storage at previous time N. Unit: [m] |
| StorageLoss | Storage loss depth. State variable. Unit: [m] |
| StorageLossOld | Storage loss depth at the previous time step. Computational variable. Unit: [m] |
| StormwaterLIDs | |
| Temperature | Temperature from forcing. Unit: Degrees Celcius |
| TotalEffectiveAreaFraction | Sum of all effective area fractions. |
| UpdateVariablesInPerformTimeStep | Flag indicating that average variables in CatchmentSurfaces need to be updated after the time step is done. |
| WettingLoss | Wetting loss depth. State variable. Unit: [m] |
| WettingLossOld | Wetting loss depth at the previous time step. Computational variable. Unit: [m] |
| Add | Adds an object to the end of the ListT. (Inherited from ListCatchmentSurface) |
| AddRange | Adds the elements of the specified collection to the end of the ListT. (Inherited from ListCatchmentSurface) |
| AddToOffers | Adds averaged catchment surface outputs to provided lists of offers and offer delegates. |
| AsReadOnly | Returns a read-only ReadOnlyCollectionT wrapper for the current collection. (Inherited from ListCatchmentSurface) |
| AssignSurfaceIndices | Assigns index to each surface in the list |
| AssignTotalEffectiveAreaFraction | Assigns total effective area fraction. |
| BinarySearch(T) | Searches the entire sorted ListT for an element using the default comparer and returns the zero-based index of the element. (Inherited from ListCatchmentSurface) |
| BinarySearch(T, IComparerT) | Searches the entire sorted ListT for an element using the specified comparer and returns the zero-based index of the element. (Inherited from ListCatchmentSurface) |
| BinarySearch(Int32, Int32, T, IComparerT) | Searches a range of elements in the sorted ListT for an element using the specified comparer and returns the zero-based index of the element. (Inherited from ListCatchmentSurface) |
| CheckNoVolumeInLIDs | Check for zero volume condition in all LIDs |
| Clear | Removes all elements from the ListT. (Inherited from ListCatchmentSurface) |
| Contains | Determines whether an element is in the ListT. (Inherited from ListCatchmentSurface) |
| ConvertAllTOutput | Converts the elements in the current ListT to another type, and returns a list containing the converted elements. (Inherited from ListCatchmentSurface) |
| CopyTo(T) | Copies the entire ListT to a compatible one-dimensional array, starting at the beginning of the target array. (Inherited from ListCatchmentSurface) |
| CopyTo(T, Int32) | Copies the entire ListT to a compatible one-dimensional array, starting at the specified index of the target array. (Inherited from ListCatchmentSurface) |
| CopyTo(Int32, T, Int32, Int32) | Copies a range of elements from the ListT to a compatible one-dimensional array, starting at the specified index of the target array. (Inherited from ListCatchmentSurface) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
| EvaporateFromStorages | Evaporates from depth, storage loss, and wetting loss. |
| Exists | Determines whether the ListT contains elements that match the conditions defined by the specified predicate. (Inherited from ListCatchmentSurface) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object) |
| FinalizeTimeStep | Finalizes catchment surface time step. |
| Find | Searches for an element that matches the conditions defined by the specified predicate, and returns the first occurrence within the entire ListT. (Inherited from ListCatchmentSurface) |
| FindAll | Retrieves all the elements that match the conditions defined by the specified predicate. (Inherited from ListCatchmentSurface) |
| FindIndex(PredicateT) | Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the first occurrence within the entire ListT. (Inherited from ListCatchmentSurface) |
| FindIndex(Int32, PredicateT) | Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the first occurrence within the range of elements in the ListT that extends from the specified index to the last element. (Inherited from ListCatchmentSurface) |
| FindIndex(Int32, Int32, PredicateT) | Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the first occurrence within the range of elements in the ListT that starts at the specified index and contains the specified number of elements. (Inherited from ListCatchmentSurface) |
| FindLast | Searches for an element that matches the conditions defined by the specified predicate, and returns the last occurrence within the entire ListT. (Inherited from ListCatchmentSurface) |
| FindLastIndex(PredicateT) | Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the last occurrence within the entire ListT. (Inherited from ListCatchmentSurface) |
| FindLastIndex(Int32, PredicateT) | Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the last occurrence within the range of elements in the ListT that extends from the first element to the specified index. (Inherited from ListCatchmentSurface) |
| FindLastIndex(Int32, Int32, PredicateT) | Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the last occurrence within the range of elements in the ListT that contains the specified number of elements and ends at the specified index. (Inherited from ListCatchmentSurface) |
| ForEach | Performs the specified action on each element of the ListT. (Inherited from ListCatchmentSurface) |
| GetDepthInStorages |
Get total depth in catchment surfaces.
This include the sum of snow storage, wetting loss, storage loss, and depth. |
| GetDirectRunoffFromLIDs | Return current direct runoff from all LIDs |
| GetEnumerator | Returns an enumerator that iterates through the ListT. (Inherited from ListCatchmentSurface) |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetRange | Creates a shallow copy of a range of elements in the source ListT. (Inherited from ListCatchmentSurface) |
| GetTotalAreaFraction | Returns total area fraction of surfaces. |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| GetVolumeInLIDs | Return current water volume in all LIDs |
| IndexOf(T) | Searches for the specified object and returns the zero-based index of the first occurrence within the entire ListT. (Inherited from ListCatchmentSurface) |
| IndexOf(T, Int32) | Searches for the specified object and returns the zero-based index of the first occurrence within the range of elements in the ListT that extends from the specified index to the last element. (Inherited from ListCatchmentSurface) |
| IndexOf(T, Int32, Int32) | Searches for the specified object and returns the zero-based index of the first occurrence within the range of elements in the ListT that starts at the specified index and contains the specified number of elements. (Inherited from ListCatchmentSurface) |
| Initialize | Initialize catchment surface. |
| InitializeSnowModule | Initializes a simple snow module on all catchment surfaces for CatchmentAbstractUrban. |
| Insert | Inserts an element into the ListT at the specified index. (Inherited from ListCatchmentSurface) |
| InsertRange | Inserts the elements of a collection into the ListT at the specified index. (Inherited from ListCatchmentSurface) |
| LastIndexOf(T) | Searches for the specified object and returns the zero-based index of the last occurrence within the entire ListT. (Inherited from ListCatchmentSurface) |
| LastIndexOf(T, Int32) | Searches for the specified object and returns the zero-based index of the last occurrence within the range of elements in the ListT that extends from the first element to the specified index. (Inherited from ListCatchmentSurface) |
| LastIndexOf(T, Int32, Int32) | Searches for the specified object and returns the zero-based index of the last occurrence within the range of elements in the ListT that contains the specified number of elements and ends at the specified index. (Inherited from ListCatchmentSurface) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| PerformTimeStep |
Perform catchment surface time step.
The catchment surface has several processes: * Snow module * Filling of storages * Evaporation * Infiltration |
| Prepare | Prepare catchment surface for simulation. |
| PrepareForTimeStep | Prepare for catchment surface time step. |
| ReadState | Read state and apply to module. Returns true if state was successfully read. |
| Remove | Removes the first occurrence of a specific object from the ListT. (Inherited from ListCatchmentSurface) |
| RemoveAll | Removes all the elements that match the conditions defined by the specified predicate. (Inherited from ListCatchmentSurface) |
| RemoveAt | Removes the element at the specified index of the ListT. (Inherited from ListCatchmentSurface) |
| RemoveRange | Removes a range of elements from the ListT. (Inherited from ListCatchmentSurface) |
| RemoveSurfacesWithZeroAreaFraction | Removes surfaces from the list with zero area fraction. |
| ResetComputationalVariables | Resets computational variable values to zero |
| ResetStateVariables | Resets state variable values to zero |
| ResetVariables | Resets variable values to zero |
| Reverse | Reverses the order of the elements in the entire ListT. (Inherited from ListCatchmentSurface) |
| Reverse(Int32, Int32) | Reverses the order of the elements in the specified range. (Inherited from ListCatchmentSurface) |
| SetDepths | Set the depth of all surfaces to the same value |
| Sort | Sorts the elements in the entire ListT using the default comparer. (Inherited from ListCatchmentSurface) |
| Sort(ComparisonT) | Sorts the elements in the entire ListT using the specified ComparisonT. (Inherited from ListCatchmentSurface) |
| Sort(IComparerT) | Sorts the elements in the entire ListT using the specified comparer. (Inherited from ListCatchmentSurface) |
| Sort(Int32, Int32, IComparerT) | Sorts the elements in a range of elements in ListT using the specified comparer. (Inherited from ListCatchmentSurface) |
| StateUpdated | When state has been updated, this method can be called to update derived/computational variables |
| ToArray | Copies the elements of the ListT to a new array. (Inherited from ListCatchmentSurface) |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
| TransferVariablesToOld | Transfers previous time step variable values to Old variables. |
| TrimExcess | Sets the capacity to the actual number of elements in the ListT, if that number is less than a threshold value. (Inherited from ListCatchmentSurface) |
| TrueForAll | Determines whether every element in the ListT matches the conditions defined by the specified predicate. (Inherited from ListCatchmentSurface) |
| UpdateVariables | Update the average values on surface from sub-surfaces. |
| WriteState | Write current state of module |
| BinarySearchCatchmentSurface, TKey |
Searches the entire sorted IListT for an element
and returns the zero-based index of the element.
If the key is not found, a negative number is returned,
which can be intepreted as the bitwise complement
of the interval of indices that the key is in between, i.e.
This differs from the "ordinary" binary search in allowing a keySelectorcomparer that knows how to compare a class with its key. Example, if the list contains classes of type T having an id number and the class is sorted on that id, then the keySelector returns the id number for that class. (Defined by GenericExtensions) |
| BinarySearchCatchmentSurface, TKey |
Searches the entire sorted IListT for an element using the provided
comparer and returns the zero-based index of the element.
If the key is not found, a negative number is returned,
which can be intepreted as the bitwise complement
of the interval of indices that the key is in between, i.e.
This differs from the "ordinary" binary search in allowing a keySelectorcomparer that knows how to compare a class with its key. Example, if the list contains classes of type T having an id number and the class is sorted on that id, then the keySelector returns the id number for that class. (Defined by GenericExtensions) |