BoundaryAdaptiveTimeEvaluatorGetPreferredTimeStep Method

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

Variation is measured as the difference from any value to the linearly interpolated value from start to start + curDt.

this method returns the preferred time step where variation is at most maxRelChange.

Definition

Namespace: DHI.Mike1D.BoundaryModule
Assembly: DHI.Mike1D.BoundaryModule (in DHI.Mike1D.BoundaryModule.dll) Version: 24.0.0.0 (11.1.1.1111)
C#
public TimeSpan GetPreferredTimeStep(
	IReadOnlyList<double> values,
	DateTime start,
	TimeSpan minDt,
	TimeSpan curDt,
	double maxRelChange,
	double cutoff,
	double referenceValue
)

Parameters

values  IReadOnlyListDouble
Values
start  DateTime
Start time of time step
minDt  TimeSpan
Smallest time step allowed
curDt  TimeSpan
Current time step size
maxRelChange  Double
Maximum relative change
cutoff  Double
Cutoff value, for values below this value, the variation is not checked for
referenceValue  Double
Reference value, used by e.g. water level boundaries (usually bottom level)

Return Value

TimeSpan
Preferred time step, a value between minDt and curDt

See Also