HDPipeDesignOptimizationReach Class

Pipe design reach. The Control() method sets the Manning number of the _first_ XS in the underlying EngineReach. In MU setups, the cross section is shared between all points in the underlying reach, so in MU setups the Manning number of the whole reach will be controlled.

Inheritance Hierarchy

SystemObject
DHI.Mike1D.Mike1DDataAccessHDPipeDesignOptimizationReach

Namespace: DHI.Mike1D.Mike1DDataAccess
Assembly: DHI.Mike1D.Mike1DDataAccess (in DHI.Mike1D.Mike1DDataAccess.dll) Version: 19.0.0.0 (11.1.1.1111)

Syntax

C++

Copy

public class HDPipeDesignOptimizationReach

Public Class HDPipeDesignOptimizationReach

public ref class HDPipeDesignOptimizationReach

The HDPipeDesignOptimizationReach type exposes the following members.

Constructors

	Name	Description
	HDPipeDesignOptimizationReach	Initializes a new instance of the HDPipeDesignOptimizationReach class

Top

Properties

	Name	Description
	Active	If true, then the reach will control the underlying reach's Manning number.
	DesignFactor	Current value of the design factor
	Diameter	The current diameter of the underlying circular reach (the diameter of the cross section in the first h-grid point).
	InitialDesignFactor	The control of Manning number is indirect in that the control acts on a factor that is multiplied onto the Manning number (the actual Manning number is the original Manning nubmer times this factor). InitialDesignFactor controls the value of the factor at the beginning of the simulation.
	MaxManning	Maximum value of the manning number
	MinManning	Minimum value of the manning number
	OriginalDiameter	Original diameter of the reach (really of the first (upstream) cross section)
	ReachId	ID of the underlying EngineReach
	Results	List of results from previous simulations
	UpstreamNodeId	ID of the upstream node

Top

Methods

	Name	Description
	CalculateNewReachDiametersAndCopyToResults	Calculate new reach diameter from the Manning number of the cross section in the first (upstream) grid point, and save this diameter to the results list.
	Control	Setter for controllable entity. Used by the control module. Can safely be called multiple times with the same timeN.
	DeltaDiameter	Return the change in diameter from the original diameter to the newest available result
	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.)
	GetEngineReach	Find the IReach that has _reachId == EngineReach.LocationSpan.ID. If multiple reaches exist that have the same ID in locations, the first reach is returned.
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	Prepare	Prepare the Pipe Design reach.
	ResetControlledState	Reset controlled state to initial values.
	SaveOriginalDiameter	Save original diameters, to be used when rerunning the simulation
	SetDiameterFromResults	Set reach diameter from results. This is called in Initialize() which is called so before Prepare(), therefore we cannot use _xsCircular.
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	Validate	Validate reach data

Top

Reference

DHI.Mike1D.Mike1DDataAccess Namespace