sensitivity_calculation

(function from pyomo.contrib.sensitivity_toolbox.sens)

pyomo.contrib.sensitivity_toolbox.sens.sensitivity_calculation(method, instance, paramList, perturbList, cloneModel=True, tee=False, keepfiles=False, solver_options=None)

This function accepts a Pyomo ConcreteModel, a list of parameters, and their corresponding perturbation list. The model is then augmented with dummy constraints required to call sipopt or k_aug to get an approximation of the perturbed solution.

Parameters:

• method (string) – ‘sipopt’ or ‘k_aug’

• instance (Block) – pyomo block or model object

• paramSubList (list) – list of mutable parameters or fixed variables

• perturbList (list) – list of perturbed parameter values

• cloneModel (bool, optional) – indicator to clone the model. If set to False, the original model will be altered

• tee (bool, optional) – indicator to stream solver log

• keepfiles (bool, optional) – preserve solver interface files

• solver_options (dict, optional) – Provides options to the solver (also the name of an attribute)

Return type:

The model that was manipulated by the sensitivity interface