Struct McAcOpfInstance 

pub struct McAcOpfInstance { /* private fields */ }

The multiconductor AC optimal power flow instance: the shared network, the typed per phase objective, and the active terminal voltage, conductor, and per phase generator constraint selections.

Implementations

impl McAcOpfInstance

pub fn from_network(network: MulticonductorNetwork) -> Result<Self, Error>

Build the instance with the default per phase objective and every stated limit active.

Errors

A network with no voltage source.

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

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

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

Append one objective term, consuming the instance.

pub fn with_constraints( self, constraints: MulticonductorActiveConstraints, ) -> Self

Replace the active constraint selections, consuming the instance.

pub fn with_initial_point( self, point: OperatingPoint<MulticonductorNetwork>, ) -> Self

Supply an optional solver initial point.

pub fn with_network(self, network: MulticonductorNetwork) -> Result<Self, Error>

Replace the network while preserving this instance’s objective, constraint selections, and a compatible initial point.

pub fn network(&self) -> &MulticonductorNetwork

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

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

The typed objective.

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

The active constraint selections.

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

The optional solver initial point.

pub fn to_mc_ac_pf(&self) -> Result<(McAcPfInstance, Vec<Diagnostic>), Error>

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

Errors

As McAcPfInstance::from_network.

Trait Implementations

impl Clone for McAcOpfInstance

fn clone(&self) -> McAcOpfInstance

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for McAcOpfInstance

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

Formats the value using the given formatter.