Catchments Class |
Inheritance HierarchyNamespace: DHI.Mike1D.RainfallRunoffModule
Assembly: DHI.Mike1D.RainfallRunoffModule (in DHI.Mike1D.RainfallRunoffModule.dll) Version: 19.0.0.0 (11.1.1.1111)
SyntaxThe Catchments type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | Catchments | Initializes a new instance of the Catchments class |
Properties| Name | Description | |
|---|---|---|
 | CalibrationPlotOutputFolder |
Folder for calibration plots.
|
| Count |
Number of grid points
|
| CurrentTime |
Time of which all catchments has been updated to.
|
| IsReadOnly | Gets a value indicating whether the ICollectionT is read-only. |
| Item |
Get a catchment via its index
|
| LastTimeStepPerformedEvent |
Gets Last Time Step Performed Event
|
| MaxTimeStep |
Maximum time step step used in RunUntil
|
| MinTime |
Minimum time specifies how far back in time the catchment caches values. Set to MinValue to not cache values.
|
| MinTimeStep |
Minimum time step step used in RunUntil
|
| PauseSimulation |
If this is true, then the simulation will pause before the next timestep
|
| RuntimeDiagnostics |
Diagnostics instance for the Catchments. Used during runtime.
|
| StopwatchPostTimeStepEvent |
Stop watch, timing post time step event
|
| TsBuffer |
The TsBuffer used by this collection of catchments
|
Methods| Name | Description | |
|---|---|---|
| Add |
Add a catchment to the collection
|
| Clear | Removes all items from the ICollectionT. |
| Contains | Determines whether the ICollectionT contains a specific value. |
| CopyTo | |
| EnableTimeBuffer |
Enable time buffering for all catchments.
Required when running adaptive time stepping HD simulations |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| Find |
Get a catchment via its model id
|
| FindAll |
Get a catchment via its name. Returns null if no catchment has this name.
|
| Finish |
Finish simulation. Calls finish on catchments requiring finalization.
|
| GetEnumerator | Returns an enumerator that iterates through the collection. |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| IndexOf |
Searches for the specified catchment and returns the zero-based index of the item, or -1 if not found
|
| Initialize(IBoundaryData, IDiagnostics) |
Initialize Rainfall Runoff models. Sets up static data.
|
| Initialize(IBoundaryData, ADComponentData, STData, RainfallRunoffData, IDiagnostics) |
Initialize Rainfall Runoff models. Sets up static data.
|
| Insert |
Insert catchment into list at specified index
|
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| PerformTimestep |
Perform time step, progressing all catchments with the CurrentTime
as their CurrentTime one time step.
Since catchments may have different time steps, it is unknown how many catchments are performing a time step every time this method is called. |
| Prepare(DateTime, RRParameters, Diagnostics) | Obsolete.
Prepare Rainfall Runoff models. Sets up dynamic data so that the model is ready for first time step.
|
| Prepare(DateTime, DateTime, RRParameters, Diagnostics, IConnection) |
Prepare Rainfall Runoff models. Sets up dynamic data so that the model is ready for first time step.
|
| Remove |
Remove catchment.
|
| RemoveAt |
Remove catchment at specified index.
|
| ResetSearchMaps |
This will clear the search maps used for finding catchment based on model id or catchment names
If doing intensive operations on the index setter, ItemInt32, it is a good idea to reset the search maps (from a performance point of view). Also, if the search maps some some reason gets out-of-sync, this is a backdoor for resetting the search map. The search maps will be rebuild whenever one of the methods requiring them is called. |
| RunUntil |
Performs time steps until the time is reached
|
| SetupCalibrationPlots | |
| Sort(IComparerICatchment) |
Sort the catchments using the specified comparer.
Remember to sort combined catchments as the last ones Sort is implemented explicitly to avoid overhead in updating the search maps when sorting methods uses the ItemInt32 directly. |
| Sort(ComparisonICatchment) |
Sort the catchments using the specified comparison.
Remember to sort combined catchments as the last ones Sort is implemented explicitly to avoid overhead in updating the search maps when sorting methods uses the ItemInt32 directly. |
| SortCombinedLast |
Sort such that combined catchment occur last in the list
|
| StopRainfallRunoffSimulation |
Set a flag that will force the simulation to stop after the current time step
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| Update | |
| Validate |
Validates the object
|
| Validate(IDiagnostics, IBoundaryData) |
Validates the object
|
Events| Name | Description | |
|---|---|---|
 | PostTimeStepEvent |
An event that is called everytime a timestep was successfully performed.
|
| PreTimeStepEvent |
An event that is called everytime a timestep is to be performed.
|
Extension Methods| Name | Description | |
|---|---|---|
 | BinarySearchICatchment(ICatchment) | Overloaded.
Searches the entire sorted IListT for an element
and returns the zero-based index of the element.
(Defined by GenericExtensions.)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. list[interval-1] < key < list[interval] |
 | BinarySearchICatchment(FuncICatchment, Int32) | Overloaded.
Searches the entire sorted IListT for an element using the provided
comparer and returns the zero-based index of the element.
(Defined by GenericExtensions.)This differs from the "ordinary" binary search in allowing a comparer delegate that defines whether an item is found (returning 0), whether the item in the list is before (<0) or after (>0) 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. Examples
If having a list of doubles, to find 4.5 in the list, use:
int index = list.BinarySearch(d => d.CompareTo(4.5)) |
| BinarySearchICatchment(ICatchment, IComparerICatchment) | Overloaded.
Searches the entire sorted IListT for an element using the provided
comparer and returns the zero-based index of the element.
(Defined by GenericExtensions.)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. list[interval-1] < key < list[interval] |
| BinarySearchICatchment, TKey(FuncICatchment, TKey, TKey) | Overloaded.
Searches the entire sorted IListT for an element
and returns the zero-based index of the element.
(Defined by GenericExtensions.)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. list[interval-1] < key < list[interval]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. |
| BinarySearchICatchment, TKey(FuncICatchment, TKey, TKey, IComparerTKey) | Overloaded.
Searches the entire sorted IListT for an element using the provided
comparer and returns the zero-based index of the element.
(Defined by GenericExtensions.)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. list[interval-1] < key < list[interval]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. |
| FindAll |
Find all catchments with the specified name, and providing the specified quantity
(Defined by RRExtensions.) |
| FindIndexICatchment(PredicateICatchment) | Overloaded. 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 list. (Defined by GenericExtensions.) |
| FindIndexICatchment(Int32, PredicateICatchment) | Overloaded. 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. (Defined by GenericExtensions.) |
| SortICatchment | Overloaded.
Sorts the elements in the entire List{T} using the default comparer.
(Defined by GenericExtensions.)A quick sort algorithm is used. Quick sort is a un-stable sort algorithm i.e. if two elements are equal their order may not be preserved. If the provided IList is either an array or a list, the build in sorting method is used (also quick sort). |
| SortICatchment(IComparerICatchment) | Overloaded.
Sorts the elements in the entire List{T} using the provided comparer.
(Defined by GenericExtensions.)A quick sort algorithm is used. Quick sort is a un-stable sort algorithm i.e. if two elements are equal their order may not be preserved. If the provided IList is either an array or a list, the build in sorting method is used (also quick sort). |
| SortStableICatchment | Overloaded. (Defined by GenericExtensions.) |
| SortStableICatchment(IComparerICatchment) | Overloaded.
Sorts the elements in the entire List{T} using the provided comparer.
(Defined by GenericExtensions.)A merge sort algorithm is used. merge sort is a stable sort algorithm i.e. if two elements are equal their order are preserved. |
| SortStableICatchment(ComparisonICatchment) | Overloaded.
Sorts the elements in the entire List{T} using the provided comparer.
(Defined by GenericExtensions.)A merge sort algorithm is used. merge sort is a stable sort algorithm i.e. if two elements are equal their order are preserved. |
See Also