SensitivityAnalysis

Supports Sensitivity Analysis workflow to assess the impact of input parameters on the simulation outputs

Super classes

rSharp::NetObject -> ospsuite::DotNetWrapper -> SensitivityAnalysis

Active bindings

simulation

Reference to the Simulation used to calculate or import the sensitivity analysis results (Read-Only).

numberOfSteps

Number of steps used for the variation of each parameter in one direction from the reference value. The parameter is varied in both positive and negative directions, so the total number of variations per parameter is 2 * numberOfSteps. For example, numberOfSteps = 2 with variationRange = 0.1 tests the parameter at four points: 90%, 95%, 105%, and 110% of the reference value. Default value can be retrieved with getOSPSuiteSetting("sensitivityAnalysisConfig")$numberOfSteps.

variationRange

Relative variation range applied to each parameter. This defines the total range of variation from the reference value. For example, variationRange = 0.1 means ±10% variation. Combined with numberOfSteps = 2, the parameter would be tested at 90%, 95%, 105%, and 110% of its reference value (i.e., the variation range is divided into numberOfSteps equal intervals in each direction). Default value can be retrieved with getOSPSuiteSetting("sensitivityAnalysisConfig")$variationRange.

parameterPaths

List of parameters to use for sensitivity calculation. If empty, the sensitivity will be performed automatically on all constant parameters that are really in use in the simulation. Constant parameter means all parameters with a constant value or a formula parameter with a value that was overridden by the user

Methods

Public methods

• SensitivityAnalysis$new()

• SensitivityAnalysis$addParameterPaths()

• SensitivityAnalysis$clearParameterPaths()

• SensitivityAnalysis$print()

Inherited methods

• rSharp::NetObject$.printClass()
• rSharp::NetObject$.printLine()
• rSharp::NetObject$call()
• rSharp::NetObject$get()
• rSharp::NetObject$getFields()
• rSharp::NetObject$getMemberSignature()
• rSharp::NetObject$getMethods()
• rSharp::NetObject$getProperties()
• rSharp::NetObject$getStaticFields()
• rSharp::NetObject$getStaticMethods()
• rSharp::NetObject$getStaticProperties()
• rSharp::NetObject$set()

---

Method new()

Initialize a new instance of the class

Usage

SensitivityAnalysis$new(
  simulation,
  parameterPaths = NULL,
  numberOfSteps = ospsuiteEnv$sensitivityAnalysisConfig$numberOfSteps,
  variationRange = ospsuiteEnv$sensitivityAnalysisConfig$variationRange
)

Arguments

simulation

Simulation for which a sensitivity analysis should be performed

parameterPaths

Vector of parameter paths to use for sensitivity calculation (optional). If undefined, the sensitivity will be performed automatically on all constant parameters of the simulation. Constant parameter means all parameters with a constant value or a formula parameter with a value that was overridden by the user

numberOfSteps

Number of steps used for the variation of each parameter in one direction from the reference value (optional, default specified in getOSPSuiteSetting("sensitivityAnalysisConfig")). The parameter is varied in both positive and negative directions, so the total number of variations per parameter is 2 * numberOfSteps. For example, with numberOfSteps = 2 and variationRange = 0.1, each parameter will be tested at four points: 90% (refValue * 0.9), 95% (refValue * 0.95), 105% (refValue * 1.05), and 110% (refValue * 1.1) of its reference value. The total number of simulations is 2 * numberOfSteps * number_of_parameters.

variationRange

Relative variation range applied to each parameter (optional, default specified in getOSPSuiteSetting("sensitivityAnalysisConfig")). This defines the total range of variation. For example, variationRange = 0.1 means ±10% variation. The variation range is divided into numberOfSteps equal intervals in each direction (positive and negative).

Returns

A new SensitivityAnalysis object.

---

Method addParameterPaths()

Adds the parameterPaths to the list of parameter path to vary in the sensitivity analysis

Usage

SensitivityAnalysis$addParameterPaths(parameterPaths)

Arguments

parameterPaths

Parameter paths to add (single or multiple values) If no parameters were specified during creating of a SensitivityAnalysis (all constant parameters are considered), calling addParameterPaths will make only the manually added parameters being varied.

---

Method clearParameterPaths()

Removes all parameter paths defined in the Sensitivity Analysis

Usage

SensitivityAnalysis$clearParameterPaths()

---

Method print()

Print the object to the console

Usage

SensitivityAnalysis$print(...)

Arguments

...

Rest arguments.