PointSourceBoundaryGetPreferredTimeStep Method

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

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(
	DateTime start,
	TimeSpan minDt,
	TimeSpan maxDt,
	double maxRelChange,
	double cutoff,
	double referenceValue
)

Parameters

start  DateTime
Start time of time step
minDt  TimeSpan
Smallest time step allowed
maxDt  TimeSpan

[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  Double
Maximum relative change
cutoff  Double
Cutoff value, for boundary 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

Implements

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

See Also