Phases

AbstractDynamicFunction

Supertype for (scalar-valued) dynamic functions.

That is, expressions that contain a phase parameter $t^{(i)}$. Each dynamic function must be defined on one (and only one) phase.

PhaseIndex(value::Int64)

Represent the phase parameter $t^{(i)}$ in an expression.

It is a subtype of AbstractDynamicFunction. To allow for deletion, index values need not be consecutive.

phase_index(dyn_fun::AbstractDynamicFunction)::PhaseIndex

Return the PhaseIndex $t^{(i)}$ of a dynamic function dyn_fun.

NonUniquePhaseError(message::String)

A dynamic function was not defined on one (and only one) phase.

supports_phases(model::MOI.ModelLike)::Bool

Indicate whether model supports phases.

UnsupportedPhasesError(message::String)

The model does not support phases, that is, supports_phases returns false.

add_phase(model::MOI.ModelLike)::PhaseIndex

Add a phase to model, returning a PhaseIndex.

An AddPhaseNotAllowedError is thrown if a phase cannot be added to the model in its current state.

AddPhaseNotAllowedError(message::String)

Phases cannot be added to the model in its current state.

MOI.is_valid(model::MOI.ModelLike, phase::PhaseIndex)::Bool

Indicate whether phase refers to a valid PhaseIndex in model.

InvalidPhaseError(phase::PhaseIndex)

The phase phase is not valid in the model.

AbstractPhaseAttribute

Supertype for phase attributes.

MOI.supports(
    model::MOI.ModelLike,
    attr::AbstractPhaseAttribute,
)::Bool

Indicate whether model supports the phase attribute attr.

MOI.set(
    model::MOI.ModelLike,
    attr::AbstractPhaseAttribute,
    phase::PhaseIndex,
    value::Any,
)

Assign value to the attribute attr of phase phase in model model.

MOI.get(
    model::MOI.ModelLike,
    attr::AbstractPhaseAttribute,
    phase::PhaseIndex,
)

Return the value of the attribute attr set to phase phase in model.

If the attribute attr is not supported by model then an error should be thrown. If the attribute is supported but has not been set, nothing is returned.

PhaseName

A phase attribute for a String identifying a phase.

PhaseInitialStart

A phase attribute for the start value of the initial phase boundary.

PhaseFinalStart

A phase attribute for the start value of the final phase boundary.

PhaseInitialSolution

A phase attribute for the solution of the initial phase boundary.

PhaseFinalSolution

A phase attribute for the solution of the final phase boundary.