PointSourceBoundaryGetPreferredTimeStep Method

Get preferred time step, which should not vary more than maxRelChange within the given time step.

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

Syntax

C++

Copy

public TimeSpan GetPreferredTimeStep(
	DateTime start,
	TimeSpan minDt,
	TimeSpan maxDt,
	double maxRelChange,
	double cutoff,
	double referenceValue
)

Public Function GetPreferredTimeStep ( 
	start As DateTime,
	minDt As TimeSpan,
	maxDt As TimeSpan,
	maxRelChange As Double,
	cutoff As Double,
	referenceValue As Double
) As TimeSpan

public:
virtual TimeSpan GetPreferredTimeStep(
	DateTime start, 
	TimeSpan minDt, 
	TimeSpan maxDt, 
	double maxRelChange, 
	double cutoff, 
	double referenceValue
) sealed

Parameters

start: Type: SystemDateTime
Start time of time step
minDt: Type: SystemTimeSpan
Smallest time step allowed
maxDt: Type: SystemTimeSpan
[Missing <param name="maxDt"/> documentation for "M:DHI.Mike1D.BoundaryModule.PointSourceBoundary.GetPreferredTimeStep(System.DateTime,System.TimeSpan,System.TimeSpan,System.Double,System.Double,System.Double)"]
maxRelChange: Type: SystemDouble
Maximum relative change
cutoff: Type: SystemDouble
Cutoff value, for boundary values below this value, the variation is not checked for
referenceValue: Type: SystemDouble
Reference value, used by e.g. water level boundaries (usually bottom level)

Return Value

Type: TimeSpan
Preferred time step, a value between minDt and curDt

Implements

IBoundaryAdaptiveGetPreferredTimeStep(DateTime, TimeSpan, TimeSpan, Double, Double, Double)

Reference

PointSourceBoundary Class

DHI.Mike1D.BoundaryModule Namespace

PointSourceBoundaryAddLanguageSpecificTextSet("LSTD9AEA847_0?cpp=::|nu=.");GetPreferredTimeStep Method

Parameters

Return Value

Implements

Reference

PointSourceBoundaryGetPreferredTimeStep Method