Click or drag to resize

BoundaryAdaptiveTimeValueSeriesEvaluatorGetPreferredTimeStep 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
Copy
public TimeSpan GetPreferredTimeStep(
	DateTime start,
	TimeSpan minDt,
	TimeSpan curDt,
	double maxRelChange,
	double cutoff,
	double referenceValue
)

Parameters

start
Type: SystemDateTime
Start time of time step
minDt
Type: SystemTimeSpan
Smallest time step allowed
curDt
Type: SystemTimeSpan
Current time step size
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)
See Also