AdaptiveTSCheckSolutionConstraintsGetBoundaryPreferredTimeStep Method

Get preferred time step, such that changes in boundary time series is within some limits

Definition

Namespace: DHI.Mike1D.Engine.ModuleHD
Assembly: DHI.Mike1D.Engine (in DHI.Mike1D.Engine.dll) Version: 24.0.0.0 (11.1.1.1111)
C#
public TimeSpan GetBoundaryPreferredTimeStep(
	DateTime start,
	TimeSpan minDt,
	TimeSpan maxDt,
	double maxRelChange,
	double cutoff
)

Parameters

start  DateTime

[Missing <param name="start"/> documentation for "M:DHI.Mike1D.Engine.ModuleHD.AdaptiveTSCheckSolutionConstraints.GetBoundaryPreferredTimeStep(System.DateTime,System.TimeSpan,System.TimeSpan,System.Double,System.Double)"]

minDt  TimeSpan

[Missing <param name="minDt"/> documentation for "M:DHI.Mike1D.Engine.ModuleHD.AdaptiveTSCheckSolutionConstraints.GetBoundaryPreferredTimeStep(System.DateTime,System.TimeSpan,System.TimeSpan,System.Double,System.Double)"]

maxDt  TimeSpan

[Missing <param name="maxDt"/> documentation for "M:DHI.Mike1D.Engine.ModuleHD.AdaptiveTSCheckSolutionConstraints.GetBoundaryPreferredTimeStep(System.DateTime,System.TimeSpan,System.TimeSpan,System.Double,System.Double)"]

maxRelChange  Double

[Missing <param name="maxRelChange"/> documentation for "M:DHI.Mike1D.Engine.ModuleHD.AdaptiveTSCheckSolutionConstraints.GetBoundaryPreferredTimeStep(System.DateTime,System.TimeSpan,System.TimeSpan,System.Double,System.Double)"]

cutoff  Double

[Missing <param name="cutoff"/> documentation for "M:DHI.Mike1D.Engine.ModuleHD.AdaptiveTSCheckSolutionConstraints.GetBoundaryPreferredTimeStep(System.DateTime,System.TimeSpan,System.TimeSpan,System.Double,System.Double)"]

Return Value

TimeSpan

[Missing <returns> documentation for "M:DHI.Mike1D.Engine.ModuleHD.AdaptiveTSCheckSolutionConstraints.GetBoundaryPreferredTimeStep(System.DateTime,System.TimeSpan,System.TimeSpan,System.Double,System.Double)"]

See Also