ScenarioNode

(class from pyomo.contrib.parmest.utils.scenario_tree)

class pyomo.contrib.parmest.utils.scenario_tree.ScenarioNode(name, cond_prob, stage, cost_expression, scen_name_list, nonant_list, scen_model, nonant_ef_suppl_list=None, parent_name=None)[source]

Bases: object

Store a node in the scenario tree.

Note

This can only be created programmatically from a scenario creation function. (maybe that function reads data)

Parameters:

  • name (str) – name of the node; one node must be named “ROOT”

  • cond_prob (float) – conditional probability

  • stage (int) – stage number (root is 1)

  • cost_expression (pyo Expression or Var) – stage cost

  • scen_name_list (str) – OPTIONAL scenario names at the node just for debugging and reporting; not really used as of Dec 31

  • nonant_list (list of pyo Var, Vardata or slices) – the Vars that require nonanticipativity at the node (might not be a list)

  • scen_model (pyo concrete model) – the (probably not ‘a’) concrete model

  • nonant_ef_suppl_list (list of pyo Var, Vardata or slices) – vars for which nonanticipativity constraints tighten the EF (important for bundling)

  • parent_name (str) – name of the parent node

Lists:

nonant_vardata(list of vardata objects): vardatas to blend x_bar_list(list of floats): bound by index to nonant_vardata

__init__(name, cond_prob, stage, cost_expression, scen_name_list, nonant_list, scen_model, nonant_ef_suppl_list=None, parent_name=None)[source]

Initialize a ScenarioNode object. Assume most error detection is done elsewhere.

Methods

__init__(name, cond_prob, stage, ...[, ...])

Initialize a ScenarioNode object.

Member Documentation