Catchment Methods

The Catchment type exposes the following members.

Methods

	Name	Description
	Accepts
	AddToOffers
	ApplyBoundary(ICatchmentSourceBoundary)	Apply a boundary to this catchment
	ApplyBoundary(CatchmentSourceBoundaryTypes, IBoundarySource)	Apply a boundary to this catchment
	ApplyBoundary(GlobalSourceBoundaryTypes, GlobalGeoLocatedSource)	Apply a boundary to this catchment
	ApplyBoundaryLIDs(GlobalGeoLocatedSource)	Apply boundary to LID's in catchment
	ApplyBoundaryLIDs(ICatchmentSourceBoundary)	Apply boundary to LID's in catchment
	ApplyBoundaryLIDs(CatchmentSourceBoundaryTypes, IBoundarySource)	Apply boundary to LID's in catchment
	ApplyBoundaryLIDs(GlobalSourceBoundaryTypes, GlobalGeoLocatedSource)	Apply boundary to LID's in catchment
	BoundaryTypeIsAdditive	Return true if boundaries of the specified type are additive; the contributions of two discharge boundaries add up, while two temperature boundaries do not.
	CalculateStatistics	Calculate statistics on catchment.
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Destructor (Overrides ObjectFinalize.)
	FinalizeTimeStep	Finalizes the time step for the catchment.
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetRequiredTypes	Get the type of boundary required by this catchment
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GetYearlyStat	Get or create a RRYearlyStat object for the specified year.
	Initialize	Initialize Rainfall Runoff model. Sets up static data.
	InitializePlugins	Initializes the cathcment plugins.
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	Offers	List of data types that is offered and can be used in GetValue
	PerformTimeStep	This procedure forwards the calculation with one time step.
	Prepare	Prepare Rainfall Runoff model. Sets up dynamic data so that the model is ready for first time step.
	PrepareForTimeStep	Prepares the catchment for the time step.
	PreparePlugins	Prepares the cathcment plugins.
	PrepareSource	Prepare boundary source.
	PrepareState	Prepare state, especially time
	ReadPluginStates	Write current state of plugins
	Reset	Reset the catchment and set the current time.
	ResetBoundaries	Remove boundaries applied in previous runs
	StateUpdated	If state has been updated from outside, call this method to recalculate state dependent parameters.
	TakeTimeStep	This procedure is the one actually calculating the new time step.
	TimeOffers	List of data types that is offered and can be used in GetValue
	TimeOfNextUpdate	Obsolete. Return the time of next update. Used for PostTimeStepEvent event in Catchments. If a catchment uses variable timesteps, then this function must be overridden!!
	TimeValueGetter	Get value getter for the specified data quantity
	ToString	Returns a string that represents the current object. (Overrides ObjectToString.)
	TriggerPostTimeStepEvent	Trigger the PostTimeStepEvent, called at end of a time step.
	Type	The type of catchment: NAM, Urban A etc
	Update	Update internal state of catchment to time Time()
	UpdateCheckPointTime	Updates check point time.
	UpdateRouting	Updates the routing for the catchment.
	UpdateStorage	Updates the storage for the catchment.
	UpdateTime	Update time, setting _timeNew to _timeOld + _effectiveTimeStep. This method will assue that _timeNew does not go beyond _endTime, by modifying _effectiveTimeStep. Before calling UpdateTime, be sure that _effectiveTimeStep is set.
	UpdateTimeStepUsingCheckPoint	Updates the present time if it is greater than the check point time.
	Validate	Validate that the catchment is set up correctly
	ValidateLIDs	Validate all LIDs in catchment
	ValueGetter	Get value setter for the specified data quantity
	ValueSetter
	VolumeInCatchment	Volume of water stored in catchment after previous time step.
	VolumeInCatchmentAtStart	Volume of water stored in catchment after previous time step.
	WritePluginStates	Write current state of plugins

Top

Extension Methods

	Name	Description
	Getter(IQuantity)	Overloaded. From the proxy, return an FuncTResult for the specified quantity. It returns the first quantity of that type that is offered, and null if the quantity is not offered. (Defined by ProxyExtensions.)
	Getter(IQuantity, IQuantity)	Overloaded. From the proxy, return an FuncTResult for the specified quantity. It returns the first quantity of that type that is offered, and null if the quantity is not offered. (Defined by ProxyExtensions.)
	Getters	Returns a set of FuncTResult for the quantity. We can return several quantities with the same id (usually they will differ in their description). If the quantity is not offerent, an empty list is returned. (Defined by ProxyExtensions.)
	GettersFraction	Returns a set of FuncT, TResult for the quantity. We can return several quantities with the same id (usually they will differ in their description). If the quantity is not offerent, an empty list is returned. (Defined by ProxyExtensions.)
	GetterUnboxed	From the proxy, return an FuncTResult for the specified quantity. It returns the first quantity of that type that is offered, and null if the quantity is not offered. (Defined by ProxyExtensions.)
	NTSGeometry	Create an NTS geometry from the CatchmentGeometry. Depending on the coordinates, the returned IGeometry is either a NTS Polygon or NTS MultiPolygon. (Defined by RRExtensions.)
	Setter	From the proxy, return an IDoubleGetSet for the specified quantity. It returns the first quantity of that type that is accepted, and null if the quantity is not accepted. (Defined by ProxyExtensions.)
	TimeValueGetter	From the proxy, return an FuncT, TResult for the specified quantity. It returns the first quantity of that type that is offered, and null if the quantity is not offered. (Defined by ProxyExtensions.)

Top

Reference

Catchment Class

DHI.Mike1D.RainfallRunoffModule Namespace