Struct McAcOpfSolution 

pub struct McAcOpfSolution { /* private fields */ }

The multiconductor AC optimal power flow solution: the power flow results plus per phase generator dispatch and the objective value.

Implementations

impl McAcOpfSolution

pub fn new( instance: Arc<McAcOpfInstance>, termination: Termination, terminal_voltage_magnitude: Vec<f64>, terminal_voltage_angle: Vec<f64>, source_active_injection: Vec<f64>, generator_active_power: Vec<f64>, objective: f64, ) -> Result<Self, Error>

Assemble the results: the power flow columns plus the optimized per phase generator dispatch (watts, generator table order with each generator’s terminal map order) and the objective value.

Errors

A column whose length disagrees with the instance’s resolved terminals or generator conductors.

pub fn instance(&self) -> &McAcOpfInstance

The immutable instance this solution solves. Borrowed; never a copy.

pub fn shared_instance(&self) -> Arc<McAcOpfInstance>

The shared instance owner, for another solution of the same problem.

pub fn network(&self) -> &MulticonductorNetwork

The network the solved instance calculates on.

pub fn termination(&self) -> &Termination

How the producing calculation ended.

pub fn residuals(&self) -> &Residuals

The reported numerical residuals.

pub fn producer(&self) -> Option<&str>

The producer or solver identity, when recorded.

pub fn with_producer(self, producer: impl Into<String>) -> Self

Record the producer identity.

pub fn with_residuals(self, residuals: Residuals) -> Self

Record the numerical residuals.

pub fn terminal_voltage_magnitude( &self, bus: &str, terminal: &str, ) -> Option<f64>

Voltage magnitude at one bus terminal, volts.

pub fn terminal_voltage_angle(&self, bus: &str, terminal: &str) -> Option<f64>

Voltage angle at one bus terminal, radians.

pub fn terminal_current_magnitude( &self, bus: &str, terminal: &str, ) -> Option<f64>

Current into the network at one bus terminal, amperes, when the producer reported currents.

pub fn terminal_active_power(&self, bus: &str, terminal: &str) -> Option<f64>

Active power into the network at one bus terminal, watts, when the producer reported terminal powers.

pub fn with_terminal_currents(self, values: Vec<f64>) -> Result<Self, Error>

Record per terminal current magnitudes, amperes.

Errors

A column whose length disagrees with the resolved terminals.

pub fn with_terminal_powers(self, values: Vec<f64>) -> Result<Self, Error>

Record per terminal active powers, watts.

Errors

A column whose length disagrees with the resolved terminals.

pub fn source_active_injections(&self) -> &[f64]

Per source terminal active injections, watts, in source table order with each source’s terminal map order.

pub const fn objective(&self) -> f64

The optimized objective value.

pub fn generator_active_powers(&self) -> &[f64]

The optimized per phase generator dispatch, watts, generator table order with each generator’s terminal map order.

Trait Implementations

impl Clone for McAcOpfSolution

fn clone(&self) -> McAcOpfSolution

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for McAcOpfSolution

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

Formats the value using the given formatter.