Click or drag to resize

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.

Namespace:  DHI.Mike1D.BoundaryModule
Assembly:  DHI.Mike1D.BoundaryModule (in DHI.Mike1D.BoundaryModule.dll) Version: 19.0.0.0 (11.1.1.1111)
Syntax
Copy
public static TimeSpan GetBoundaryPreferredTimeStep(
	IBoundarySource boundary,
	DateTime start,
	TimeSpan minDt,
	TimeSpan maxDt,
	double maxRelChange,
	double cutoff,
	double referenceValue
)

Parameters

boundary
Type: DHI.Mike1D.BoundaryModuleIBoundarySource

[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
Type: SystemDateTime

[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
Type: SystemTimeSpan

[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
Type: SystemTimeSpan

[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
Type: SystemDouble

[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
Type: SystemDouble

[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
Type: SystemDouble

[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

Type: 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