BoundaryExtensionsGetBoundaryPreferredTimeStep Method

For a generic boundary, estimate the preferred time step, based in some tolerances for how much the boundary can change within a 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 static TimeSpan GetBoundaryPreferredTimeStep(
	IBoundarySource boundary,
	DateTime start,
	TimeSpan minDt,
	TimeSpan maxDt,
	double maxRelChange,
	double cutoff,
	double referenceValue
)

Parameters

boundary  IBoundarySource

[Missing <param name="boundary"/> documentation for "M:DHI.Mike1D.BoundaryModule.BoundaryExtensions.GetBoundaryPreferredTimeStep(DHI.Mike1D.BoundaryModule.IBoundarySource,System.DateTime,System.TimeSpan,System.TimeSpan,System.Double,System.Double,System.Double)"]

start  DateTime

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

minDt  TimeSpan

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

maxDt  TimeSpan

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

maxRelChange  Double

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

cutoff  Double

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

referenceValue  Double

[Missing <param name="referenceValue"/> documentation for "M:DHI.Mike1D.BoundaryModule.BoundaryExtensions.GetBoundaryPreferredTimeStep(DHI.Mike1D.BoundaryModule.IBoundarySource,System.DateTime,System.TimeSpan,System.TimeSpan,System.Double,System.Double,System.Double)"]

Return Value

TimeSpan

[Missing <returns> documentation for "M:DHI.Mike1D.BoundaryModule.BoundaryExtensions.GetBoundaryPreferredTimeStep(DHI.Mike1D.BoundaryModule.IBoundarySource,System.DateTime,System.TimeSpan,System.TimeSpan,System.Double,System.Double,System.Double)"]

See Also