EngineTime Class

NetworkEngine time.

Inheritance Hierarchy

SystemObject
DHI.Mike1D.EngineEngineTime

Namespace: DHI.Mike1D.Engine
Assembly: DHI.Mike1D.Engine (in DHI.Mike1D.Engine.dll) Version: 19.0.0.0 (11.1.1.1111)

Syntax

public class EngineTime : IDoubleFractionProxy, IDoubleProxy, 
	IQuantityProxy

Public Class EngineTime
	Implements IDoubleFractionProxy, IDoubleProxy, IQuantityProxy

public ref class EngineTime : IDoubleFractionProxy, 
	IDoubleProxy, IQuantityProxy

The EngineTime type exposes the following members.

Constructors

	Name	Description
	EngineTime	Initializes a new instance of the EngineTime class

Properties

	Name	Description
	AdaptiveTimeSteppingActivated	Indicates whether adaptive time stepping is activated. Used to decide whether the state should be stored before a time step.
	CheckPoints	Check point controller, handling check points in time that must be hit by the EngineTime. This is not used when EngineTimeStep is null (constant time step)
	DDt	Time step inverse - 1/Dt Unit: [1/sec]
	Dt	Time step Unit: [sec]. Rounded to nearest millisecond
	DtSpan	Time step Unit: [sec]. Rounded to nearest millisecond
	EngineTimeStep	The IEngineTimeStep does the actual calculation of the new time step. If null, time step is decided directly by the current value of Dt/DtSpan.
	NumberOfTimeSteps	Number of time steps performed.
	NumberOfTriedTimeSteps	Total number of time steps tried, also those failing.
	NumberOfTriesForTimeStep	Counts the number of time steps tried for the current time step
	TimeN	Time at time step n
	TimeNp1	Time at time step n+1
	TimeNph	Time at time step n + ½

Methods

	Name	Description
	Accepts	List of data types that is accepted and can be used in SetValue
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	NextTimeStep	Returns the size of the next time step. In case of adaptive time stepping this is a guess of the size of the next time step, and may not equal the actual size of the time step.
	Offers	List of data types that is offered and can be used in GetValue
	Prepare
	ResetInitialTimeStep	Resets values for EngineTimeStep and sets DtSpan to initialTimeStep.
	SetTime	Adjusts the current timestep by setting both DtSpan and TimeNp1 Unit: [sec]. Rounded to nearest millisecond
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	TryDecreaseTimeStep	Returns false if the time step should be decreased but cannot be decreased further. Throws an exception if adaptive time stepping is not enabled.
	Update	Steps time one time steps forward
	ValueFractionGetter
	ValueGetter	Get value setter for the specified data quantity
	ValueSetter	Get value setter for the specified data type

Fields

	Name	Description
	ACCEPTS_Time	quantityIndex of accepted time quantity
	ACCEPTS_TimeStep	quantityIndex of accepted timestep quantity
	OFFERS_Time	quantityIndex of offered time quantity
	OFFERS_TimeStep	quantityIndex of offered timestep quantity

Extension Methods

	Name	Description
	Getter	From the proxy, return an FuncTResult for the specified quantity. It returns the first quantity of that type that is offered, and null if the quantity is not offered. (Defined by ProxyExtensions.)
	Getters	Returns a set of FuncTResult for the quantity. We can return several quantities with the same id (usually they will differ in their description). If the quantity is not offerent, an empty list is returned. (Defined by ProxyExtensions.)
	GettersFraction	Returns a set of FuncT, TResult for the quantity. We can return several quantities with the same id (usually they will differ in their description). If the quantity is not offerent, an empty list is returned. (Defined by ProxyExtensions.)
	GetterUnboxed	From the proxy, return an FuncTResult for the specified quantity. It returns the first quantity of that type that is offered, and null if the quantity is not offered. (Defined by ProxyExtensions.)
	Setter	From the proxy, return an IDoubleGetSet for the specified quantity. It returns the first quantity of that type that is accepted, and null if the quantity is not accepted. (Defined by ProxyExtensions.)