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
to
.
this method returns the preferred time step where variation is at most maxRelChange.
Namespace:
DHI.Mike1D.BoundaryModule
Assembly:
DHI.Mike1D.BoundaryModule (in DHI.Mike1D.BoundaryModule.dll) Version: 19.0.0.0 (11.1.1.1111)
Syntax public TimeSpan GetPreferredTimeStep(
IReadOnlyList<double> values,
DateTime start,
TimeSpan minDt,
TimeSpan curDt,
double maxRelChange,
double cutoff,
double referenceValue
)
Public Function GetPreferredTimeStep (
values As IReadOnlyList(Of Double),
start As DateTime,
minDt As TimeSpan,
curDt As TimeSpan,
maxRelChange As Double,
cutoff As Double,
referenceValue As Double
) As TimeSpan
public:
TimeSpan GetPreferredTimeStep(
IReadOnlyList<double>^ values,
DateTime start,
TimeSpan minDt,
TimeSpan curDt,
double maxRelChange,
double cutoff,
double referenceValue
)
Parameters
- values
- Type: System.Collections.GenericIReadOnlyListDouble
Values - 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 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:
TimeSpanPreferred time step, a value between
minDt and
curDtSee Also