EngineNet Methods

Is there a PostIterationEvent

Build search maps. Whenever the list of reaches and nodes are updated, this method must be called to rebuild search maps.

Create a runtime Diagnostics instance. This is called from Mike1DController.Prepare()

Determines whether the specified object is equal to the current object.

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.

Finds all the reach that uses the specified name. If none of the reaches contains the location null is returned.

Find EngineNode based on location.

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.

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.

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 the simulation

Get an array of all concentrations for all components at the given grid point

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.

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.

Serves as the default hash function.

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.

Number of threads as defined by the environment variables.

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.

Gets the Type of the current instance.

In the initialization step, the network is layed out and the engine component is prepared for exchange item inspection.

Initialize the modules. Called in general initialize step

For threaded domain decomposition, setup thread pool.

Creates a shallow copy of the current Object.

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.

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.

Reassign an open bounadry to a node.

Call this to release all licenses after simulation is done.

Calling this function will end the simulation after the current timestep has been completed

Performs time steps until the specified time is reached

Calling this function will end the simulation after the current timestep has been completed

Returns a string that represents the current object.

Internal trigger method. Do not use!

Internal code, do not use

Trigger simulation-done event.

Trigger a special event, with the provided id

Finds the reach that contains the specified location. If none of the reaches contains the location null is returned.

Validate whether the EngineNet is in a valid state.

Disable dispersion for AD on the enode

For a given structure, find the reach where it is located. Or null if it is not found.

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.

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.