Skip to contents

Options to be passed to the simulation engine

Super classes

rSharp::NetObject -> ospsuite::DotNetWrapper -> SimulationRunOptions

Active bindings

numberOfCores

(Maximal) number of cores to be used. This is only relevant when simulating a population simulation. Default is getOSPSuiteSetting("numberOfCores").

checkForNegativeValues

Specifies whether negative values check is on or off. Default is TRUE

showProgress

Specifies whether a progress bar should be shown during population simulations. If TRUE, a progress bar is shown in the console, indicating the number of already executed simulations from the total population size. The progress bar does not indicate the progress of a single simulation. This option only applies to population simulations and has no effect on individual simulations. Default is getOSPSuiteSetting("showProgress")

Methods

Inherited methods


Method new()

Initialize a new instance of the class

Usage

SimulationRunOptions$new(
  numberOfCores = NULL,
  checkForNegativeValues = NULL,
  showProgress = NULL
)

Arguments

numberOfCores

Number of cores to use for the simulation. Default value is getOSPSuiteSetting("numberOfCores")

checkForNegativeValues

Should the solver check for negative values. Default is TRUE

showProgress

Should a progress bar be displayed during population simulations. If TRUE, a progress bar is shown in the console, indicating the number of already executed simulations from the total population size. The progress bar does not indicate the progress of a single simulation. This option only applies to population simulations and has no effect on individual simulations. Default value is getOSPSuiteSetting("showProgress")

Returns

A new SimulationRunOptions object.


Method print()

Print the object to the console

Usage

SimulationRunOptions$print(...)

Arguments

...

Rest arguments.