gtopt::Aperture struct

One backward-pass opening referencing a source scenario.

Maps an aperture to the scenario whose affluent values should be used when solving the backward-pass LP. The probability_factor determines the weight of this aperture's cut in the expected (probability-weighted average) Benders cut.

When probability_factor values across all apertures do not sum to 1, the solver normalises them internally.

Public static variables

static constexpr std::string_view class_name

Public functions

auto is_active() const -> constexpr auto noexcept

Public variables

OptBool active
Activation status (default: active)
OptName name
Optional human-readable label.
OptReal probability_factor
Uid source_scenario
Uid uid
Unique identifier for this aperture.

Variable documentation

OptReal gtopt::Aperture::probability_factor

Probability weight of this aperture [p.u.]. Values are normalised to sum 1 across all active apertures.

Uid gtopt::Aperture::source_scenario

UID of the scenario whose affluent data to use. If the scenario exists in the aperture_directory it is loaded from there; otherwise it is looked up in the regular forward-scenario list.