EngineNet Methods

Methods

AnyPostIterationEvent Is there a PostIterationEvent
BuildSearchMaps Build search maps. Whenever the list of reaches and nodes are updated, this method must be called to rebuild search maps.
CreateRuntimeDiagnostics Create a runtime Diagnostics instance. This is called from Mike1DController.Prepare()
EqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
FinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
FindAllReaches Finds all the reach that uses the specified name. If none of the reaches contains the location null is returned.
FindNode Find EngineNode based on location.
FindReach(ILocation) Finds the reach that contains the specified location. If none of the reaches contains the location null is returned. If location is exactly on a node, the location can exist on more than one reaches, the first in the list is returned.
FindReach(String) Finds the reach that contains the specified location. If none of the reaches contains the location null is returned. If more than span exist with the same reachId, the first found is returned.
FindReach(ILocation, Double) Finds the reach that contains the specified location. If none of the reaches contains the location null is returned. If location is exactly on a node, the location can exist on more than one reaches, the first in the list is returned.
Finish Finish the simulation
GetComponentConcentration Get an array of all concentrations for all components at the given grid point
GetComponentSourcePoint(EngineNode) Get a source point for component sources.

If no components are included in simulation, or if node is not part of component simulation, null is returned.

GetComponentSourcePoint(EngineReach, Int32) Get a source point for component sources.

The gridPointIndex must match a grid point with volume, i.e. an HGridPoint.

If no components are included in simulation, or if node is not part of component simulation, null is returned.

GetHashCodeServes as the default hash function.
(Inherited from Object)
GetNumberOfThreads Get the number of threads, taking the smallest of: input argument, the "OMP_NUM_THREADS" environment variable and the number of cores on the computer.

If the number of threads is smaller than the number of cores on the computer, and "OMP_NUM_THREADS" is not set, then "OMP_NUM_THREADS" is set to this value.

GetNumberOfThreadsEnvironment Number of threads as defined by the environment variables.
GetSourcePointSurfaceInflow Get a source point for surface inflow for the specified node. The NodeMaxInflowReservoir class collects all inflow from surface and applies a max inflow limit to how much is forwarded to the node. The remainder of the inflow is stored in a reservoir "on top of" the node. When no limit is specified (MaxInflowFromSurface is big), all inflow is added directly to the node.
GetTypeGets the Type of the current instance.
(Inherited from Object)
Initialize In the initialization step, the network is layed out and the engine component is prepared for exchange item inspection.
InitializeModules(HDParameterData, CrossSectionData, TimeStepping, DateTime, DateTime, ADComponentData, Boolean, STData, Boolean, EcoLabData, Boolean, BoundaryData, Int32, StopwatchCollection, StopwatchCollection) Initialize the modules. Called in general initialize step
InitializeModules(HDParameterData, CrossSectionData, TimeStepping, DateTime, DateTime, ADComponentData, Boolean, STData, Boolean, EcoLabData, Boolean, AirParameterData, Boolean, BoundaryData, Int32, StopwatchCollection, StopwatchCollection) Initialize the modules. Called in general initialize step
InitializeThreadPool For threaded domain decomposition, setup thread pool.
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
PerformTimeStep Perform a time step. In case of failure, an exception is thrown, usually through the RuntimeDiagnostics.

In case of adaptive time stepping, this method will redo the time step until the requirements are met or the minimum time step length is used.

Prepare Prepares the engine for timestepping. - Creates and prepares resultDataAccess components - Initialize the engine by either reading initial conditions, reading hotstart information, by calculating steady solution or by some combination of these three Prepare() does not have to be called before OpenMI configuration phase.
ReAssignBoundarySource Reassign an open bounadry to a node.
ReleaseLicense Call this to release all licenses after simulation is done.
ResetStopSimulation Calling this function will end the simulation after the current timestep has been completed
RunUntil Performs time steps until the specified time is reached
StopSimulation Calling this function will end the simulation after the current timestep has been completed
ToStringReturns a string that represents the current object.
(Inherited from Object)
TriggerApplyExternalSourcesEvent 
TriggerPostTimeStepEvent Internal trigger method. Do not use!
TriggerSimulationDoneEvent Internal code, do not use

Trigger simulation-done event.

TriggerSpecialEvent Trigger a special event, with the provided id
TryFindReach Finds the reach that contains the specified location. If none of the reaches contains the location null is returned.
Validate Validate whether the EngineNet is in a valid state.

Extension Methods

AddTimer Add timer to simulation
(Defined by EngineExtensions)
FindReachWithStructure For a given structure, find the reach where it is located. Or null if it is not found.
(Defined by EngineExtensions)
GetClosestDownstreamGridpoint Find the specified type of gridpoint which is closest to the given location downstream.

It is assumed that the EngineReach max and min chainages are containing the given chainage, otherwise null is returned.


(Defined by EngineFindExtensions)
GetClosestUpstreamGridpoint Find the specified type of gridpoint which is closest to the given location upstream.

It is assumed that the EngineReach max and min chainages are containing the given chainage, otherwise null is returned.


(Defined by EngineFindExtensions)

See Also