Struct DcOpfInstance 

pub struct DcOpfInstance { /* private fields */ }

The calculation types used by solver consumers. The full problem vocabulary lives in powerio_prob; these types sit at the facade root so a consumer does not need a second PowerIO dependency to name its boundary. The DC optimal power flow instance: the shared network, the typed objective, the active constraint selections, the selected DC branch susceptance formula, and the reference conditions the network states.

Implementations

impl DcOpfInstance

pub fn from_network(network: BalancedNetwork) -> Result<DcOpfInstance, Error>

Build the instance with every stated limit active. The default objective is the network’s generator cost curves when at least one dispatchable generator carries cost data. A network with no applicable cost rows becomes an explicit feasibility problem instead of inventing zero cost curves. Partially populated costs still select the network objective so preparation reports the missing row.

Errors

A network with no reference bus or no in service generator attached to a non-isolated bus.

pub fn with_objective(self, objective: Objective) -> DcOpfInstance

Replace the objective, consuming the instance. The shared network moves; no table is copied.

pub fn with_objective_term(self, term: ObjectiveTerm) -> DcOpfInstance

Append one objective term, consuming the instance.

pub fn with_constraints(self, constraints: ActiveConstraints) -> DcOpfInstance

Replace the active constraint selections, consuming the instance.

pub fn with_branch_susceptance_formula( self, formula: BranchSusceptanceFormula, ) -> DcOpfInstance

Select the branch susceptance formula, consuming the instance.

pub fn with_initial_point( self, point: OperatingPoint<BalancedNetwork>, ) -> DcOpfInstance

Supply an optional solver initial point.

pub fn with_network( self, network: BalancedNetwork, ) -> Result<DcOpfInstance, Error>

Replace the network while preserving this instance’s objective, constraint selections, branch susceptance formula, and compatible initial point. This is the checked path for a parameter edit such as a branch rating change; callers do not have to reconstruct the problem and risk dropping its semantics.

Errors

The replacement has no reference bus or dispatchable generator, or it changes an identity layout used by the initial point.

pub fn network(&self) -> &BalancedNetwork

The network this instance calculates on. Borrowed; never a copy.

pub const fn objective(&self) -> &Objective

The typed objective.

pub const fn constraints(&self) -> &ActiveConstraints

The active constraint selections.

pub const fn branch_susceptance_formula(&self) -> BranchSusceptanceFormula

The selected branch susceptance formula.

pub const fn initial_point(&self) -> Option<&OperatingPoint<BalancedNetwork>>

The optional solver initial point.

pub fn to_dc_pf(&self) -> Result<(DcPfInstance, Vec<Diagnostic>), Error>

The DC power flow instance for this problem’s network at its stated injections: the objective and the constraint selections are discarded, and the discard is recorded.

Errors

As DcPfInstance::from_network.

Trait Implementations

impl BalancedCalculationInstance for DcOpfInstance

fn network(&self) -> &BalancedNetwork

The instance’s balanced electrical network.

impl Clone for DcOpfInstance

fn clone(&self) -> DcOpfInstance

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DcOpfInstance

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl From<DcOpfInstance> for PioValue

fn from(value: DcOpfInstance) -> Self

Converts to this type from the input type.