submit

fun submit(request: RunRequest.SingleRun, scope: CoroutineScope = CoroutineScope(SimulationDispatcher.default + SupervisorJob()), preRunWarnings: List<RunWarningType> = emptyList()): RunHandle(source)

Submits request for asynchronous execution and returns a RunHandle immediately.

The simulation runs on SimulationDispatcher.default in a coroutine launched within scope. If scope is cancelled externally (e.g. application shutdown), the simulation coroutine is also cancelled and RunEvent.RunCancelled is emitted.

Return

a RunHandle for observing progress and obtaining the result

Parameters

request

the RunRequest.SingleRun to execute

scope

the coroutine scope that owns the simulation coroutine; defaults to a new SupervisorJob-backed scope on SimulationDispatcher.default