Pump Class

Inheritance Hierarchy

SystemObject
DHI.Mike1D.StructureModuleStructure
DHI.Mike1D.StructureModulePump

Namespace: DHI.Mike1D.StructureModule
Assembly: DHI.Mike1D.StructureModule (in DHI.Mike1D.StructureModule.dll) Version: 18.0.0.0 (11.1.1.1111)

Syntax

Copy

public class Pump : Structure, IPump, IStructure, 
	IDoubleProxy, IQuantityProxy, IControllable, ITimeStructure, IStructureHasPreferredTimeStep, 
	IModelStateReadWrite

The Pump type exposes the following members.

Constructors

	Name	Description
	Pump	Initializes a new instance of the Pump class

Top

Properties

	Name	Description
	AccelerationTime
	ConstantFlow
	dDischargedDownStreamWaterLevel	(Inherited from Structure.)
	dDischargedUpStreamWaterLevel	(Inherited from Structure.)
	DecelerationTime
	Discharge	(Inherited from Structure.)
	DischargeControlActive
	DownstreamWaterLevel	(Inherited from Structure.)
	ExtensionData	(Inherited from Structure.)
	FlowArea	(Inherited from Structure.)
	FlowFactor	(Inherited from Structure.)
	HQRelation
	HQRelationMinimumCapacity
	ID	(Inherited from Structure.)
	IDInUserUnit	(Inherited from Structure.)
	Implicit	(Inherited from Structure.)
	InvertLevelDownstream	(Overrides StructureInvertLevelDownstream.)
	InvertLevelUpstream	(Overrides StructureInvertLevelUpstream.)
	IsActive
	IsSideStructure	Obsolete.
	IsVariableSpeed
	Length	(Inherited from Structure.)
	Location	(Inherited from Structure.)
	MaxStartLevel
	MinStopLevel
	MinTimeOff
	MinTimeOn
	NumberOfStarts
	Offset
	OffsetMinDischarge
	OutletLevel
	PumpType
	ReservoirLevel
	RunTimeDiagnostics	(Inherited from Structure.)
	SideStructureBank	(Inherited from Structure.)
	SideStructureReservoir	(Inherited from Structure.)
	StartLevel
	StartStopLevelControlActive
	StopLevel
	StructureType	(Inherited from Structure.)
	TopoID	(Inherited from Structure.)
	TotalTimeActive
	Type	(Overrides StructureType.)
	UpstreamWaterLevel	(Inherited from Structure.)
	UseMaximumDischarge
	UseSuppressionFactor

Top

Methods

	Name	Description
	Accepts	(Inherited from Structure.)
	ApplyFlowFactor	(Inherited from Structure.)
	ControlSetDischarge
	ControlSetFlowFactor	(Inherited from Structure.)
	ControlSetStartLevel
	ControlSetStartStopLevel
	ControlSetStopLevel
	Description	(Inherited from Structure.)
	Dispose	(Inherited from Structure.)
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	ExplicitStructureSupport	(Overrides StructureExplicitStructureSupport.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetControlAction	(Overrides StructureGetControlAction(String).)
	GetCurrentValue	(Overrides StructureGetCurrentValue(String).)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	Initialize(IDiagnostics)	(Inherited from Structure.)
	Initialize(ICrossSection, ICrossSection, Boolean, IDiagnostics)	(Overrides StructureInitialize(ICrossSection, ICrossSection, Boolean, IDiagnostics).)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	Offers	(Inherited from Structure.)
	PreferredDt
	Prepare(HDParameterData, IDiagnostics)	(Overrides StructurePrepare(HDParameterData, IDiagnostics).)
	Prepare(DateTime, HDParameterData, IDiagnostics)	(Inherited from Structure.)
	PrepareTimeStep
	PumpStateFromString
	ReadState
	ResetControlledState	(Overrides StructureResetControlledState.)
	SetControlStrategyId	(Inherited from Structure.)
	SetInputWaterLevels	(Inherited from Structure.)
	SetWaterLevels(Double, Double)	(Overrides StructureSetWaterLevels(Double, Double).)
	SetWaterLevels(Double, Double, DateTime)	(Inherited from Structure.)
	SetZeroFlow	(Inherited from Structure.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	UpdatedWaterLevels	(Inherited from Structure.)
	Validate	(Overrides StructureValidate.)
	ValueGetter	(Overrides StructureValueGetter(Int32).)
	ValueSetter	(Inherited from Structure.)
	WriteState

Top

Fields

	Name	Description
	_accepts	(Inherited from Structure.)
	_controlStategyId	(Inherited from Structure.)
	_downstreamWaterLevel	(Inherited from Structure.)
	_dqdhDownstream	(Inherited from Structure.)
	_dqdhUpstream	(Inherited from Structure.)
	_flowArea	(Inherited from Structure.)
	_flowDir	(Inherited from Structure.)
	_flowFactor	(Inherited from Structure.)
	_id	(Inherited from Structure.)
	_implicit	(Inherited from Structure.)
	_location	(Inherited from Structure.)
	_offers	(Inherited from Structure.)
	_q	(Inherited from Structure.)
	_runTimeDiagnostics	(Inherited from Structure.)
	_topoID	(Inherited from Structure.)
	_upstreamWaterLevel	(Inherited from Structure.)
	MaxPumpDischargeDownstream
	MaxPumpDischargeUpstream
	PreviousDischarge
	PumpSuppressionFactorDownstream
	PumpSuppressionFactorUpstream

Top

Extension Methods

	Name	Description
	Getter	(Defined by ProxyExtensions.)
	Getters	(Defined by ProxyExtensions.)
	GettersFraction	(Defined by ProxyExtensions.)
	GetterUnboxed	(Defined by ProxyExtensions.)
	Initialize(CrossSectionData, Boolean, IDiagnostics)	Overloaded. (Defined by StructureExtensions.)
	Initialize(BoundaryData, CrossSectionData, Boolean, IDiagnostics)	Overloaded. (Defined by StructureExtensions.)
	IsPumpReversed	(Defined by StructureExtensions.)
	IsSideStructure	(Defined by StructureExtensions.)
	Setter	(Defined by ProxyExtensions.)

Top

Reference

DHI.Mike1D.StructureModule Namespace