gtopt::Phase struct

Groups consecutive planning stages into a higher-level period.

When only one phase is needed (the common case) it is created automatically with default values that cover all stages.

Public static variables

static constexpr std::string_view class_name
Class name constant used for serialisation/deserialisation.

Public functions

auto is_active() const -> constexpr auto noexcept

Public variables

OptBool active
Activation status (default: active)
Array<Uid> apertures
Size count_stage
Number of stages in this phase [dimensionless].
Size first_stage
0-based index of the first stage in this phase [dimensionless]
OptName name
Optional human-readable label.
Uid uid
Unique identifier for the phase.

Variable documentation

Array<Uid> gtopt::Phase::apertures

Optional aperture UIDs to use in this phase's SDDP backward pass. When empty, all apertures from the global aperture_array are used. When non-empty, only the listed aperture UIDs participate in the backward-pass cut computation for this phase.

Size gtopt::Phase::count_stage

Number of stages in this phase [dimensionless].