BoundaryAdaptiveTimeValueSeriesEvaluator.GetPreferredTimeStep 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)
Syntaxpublic TimeSpan GetPreferredTimeStep(
DateTime start,
TimeSpan minDt,
TimeSpan curDt,
double maxRelChange,
double cutoff,
double referenceValue
)
Public Function GetPreferredTimeStep (
start As DateTime,
minDt As TimeSpan,
curDt As TimeSpan,
maxRelChange As Double,
cutoff As Double,
referenceValue As Double
) As TimeSpan
public:
virtual TimeSpan GetPreferredTimeStep(
DateTime start,
TimeSpan minDt,
TimeSpan curDt,
double maxRelChange,
double cutoff,
double referenceValue
) sealed
Parameters
- start
- Type: System.DateTime
Start time of time step - minDt
- Type: System.TimeSpan
Smallest time step allowed - curDt
- Type: System.TimeSpan
Current time step size - maxRelChange
- Type: System.Double
Maximum relative change - cutoff
- Type: System.Double
Cutoff value, for boundary values below this value, the variation is not checked for - referenceValue
- Type: System.Double
Reference value, used by e.g. water level boundaries (usually bottom level)
Return Value
Type:
TimeSpanPreferred time step, a value between
minDt and
curDtImplements
IBoundaryAdaptive.GetPreferredTimeStep(DateTime, TimeSpan, TimeSpan, Double, Double, Double)
See Also