Click or drag to resize

NodeMaxInflowReservoir Class

A functionality to node to limit total inflow from surface. Total inflow in m3/s, from multiple sources.

The class handles two types of inflow, surface inflow and catchment runoff inflow. The procedure models that the catchment runoff inflow "runs through" the surface model before entering the node.

Inheritance Hierarchy
SystemObject
  DHI.Mike1D.EngineNodeMaxInflowReservoir

Namespace:  DHI.Mike1D.Engine
Assembly:  DHI.Mike1D.Engine (in DHI.Mike1D.Engine.dll) Version: 16.0.0.0 (11.1.1.1111)
Syntax
C#
public class NodeMaxInflowReservoir : ISourcePoint, 
	IComponentSourcePoint

The NodeMaxInflowReservoir type exposes the following members.

Properties
  NameDescription
Public propertyActualInflow
Actual total inflow to node for current time step
Public propertyActualSurfaceInflow
Actual surface inflow for current time step, different from what was set in AddSurfaceContribution when max inflow limit is in effect
Public propertyComponentMassInReservoir
Amount of component (mass) retained in reservoir
Public propertyWaterVolumeInReservoir
Amount of water retained in reservoir
Top
Methods
  NameDescription
Public methodAddSourceContribution(Double)
Add a contribution to the source.
Public methodAddSourceContribution(Int32, Double)
Add a mass contribution to the AD source for the specified component.
Public methodAddSourceContribution(Int32, Double, Double)
Add a concentration contribution to the source for the specified component.
Public methodAddSourcePerAreaContribution
Add a contribution per area unit to the source.
Public methodAddSourcePerLengthContribution
Add a contribution per length to the source.
Public methodAddSurfaceContribution(Double)
Add a surface inflow contribution

Note that only one surface connection is supported, so this should not be called twice (the second call will override the first)

Public methodAddSurfaceContribution(Double, Double)
Add a surface inflow contribution as an implicit source

Note that only one surface connection is supported, so this should not be called twice (the second call will override the first)

Public methodEmptyReservoir
Empty reservoir
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodOutflowConcentration
The outflow concentration, i.e. concentration of flow out of the node.
Public methodSetSurfaceConcentration
Set concentration of component for surface inflow.

Only used if surface inflow is positive. When negative, water flows out with concentration in node.

Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Remarks
The following rules apply: - Water from surface has "higher" priority than water from catchment i.e. water from surface enters the node first, and then water from catchment if there is room within the max-inflow limit - Only one surface connection is supported, i.e. the surface methods AddSurfaceContribution(Double) and the AD counterparts can only be called once per timestep. - Water from surface, when limited, is not added to reservoir, assuming surface model has its own reservoir. So the user must keep track of what was actually added, by quering ActualSurfaceInflow - When inflow is limited, catchment inflow is retained in a reservoir. - Water from catchment and reservoir are mixing immediately - When coupled to a surface model, you can query the properties of the reservoir and empty it, EmptyReservoir, in order to transfer reservoir content to an external surface model. - If surface inflow is negative (outflow from node), other inflows can not enter the node and hence all catchment inflow is retained in the reservoir. - AD contributions from surface must be concentrations.
See Also