Struct DcPfSolution 

pub struct DcPfSolution { /* 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 power flow solution: bus angles and injections and branch terminal active flows over the shared instance.

Implementations

impl DcPfSolution

pub fn new( instance: Arc<DcPfInstance>, termination: Termination, bus_voltage_angle: Vec<f64>, bus_active_injection: Vec<f64>, branch_from_active_flow: Vec<f64>, branch_to_active_flow: Vec<f64>, three_winding_transformer_terminal_active_power: Vec<ThreeWindingTransformerTerminalActivePower>, ) -> Result<DcPfSolution, Error>

Assemble the required results: per bus voltage angles (degrees) and net active injections (MW) in bus table order, and per branch terminal active flows (MW, into the branch at each terminal) in branch table order.

Errors

A column whose length disagrees with the instance’s tables.

pub fn instance(&self) -> &DcPfInstance

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

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

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

pub fn network(&self) -> &BalancedNetwork

The network the solved instance calculates on.

pub fn bus_order(&self) -> Vec<BusId>

Bus IDs in the column order every bulk accessor uses.

pub fn branch_order(&self) -> Vec<String>

Stable branch identities in bulk column order.

pub fn generator_order(&self) -> Vec<String>

Stable generator identities in bulk column order.

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>) -> DcPfSolution

Record the producer identity.

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

Record the numerical residuals.

pub fn branch_identity_order(&self) -> impl Iterator<Item = String>

The branch identities the flow columns follow, in table order.

pub fn generator_dispatch(&self) -> Option<&GeneratorDispatch>

Per generator dispatch, when the instance determines it uniquely or the source records an explicit allocation.

pub fn with_generator_dispatch( self, dispatch: GeneratorDispatch, ) -> Result<DcPfSolution, Error>

Record an explicit per generator allocation.

Errors

A dispatch whose length disagrees with the generator table.

pub fn bus_voltage_angle(&self, bus: BusId) -> Option<f64>

Voltage angle at one bus, degrees.

pub fn bus_active_injection(&self, bus: BusId) -> Option<f64>

Net active injection at one bus, MW.

pub fn branch_from_active_flow(&self, identity: &str) -> Option<f64>

Active flow into the branch at its from terminal, MW, by stable branch identity.

pub fn branch_to_active_flow(&self, identity: &str) -> Option<f64>

Active flow into the branch at its to terminal, MW.

pub fn three_winding_transformer_terminal_active_powers( &self, ) -> &[ThreeWindingTransformerTerminalActivePower]

Three winding transformer terminal active powers in transformer table order.

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

The complete bus_voltage_angle column, in bus_order.

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

The complete bus_active_injection column, in bus_order.

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

The complete branch_from_active_flow column, in branch_order.

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

The complete branch_to_active_flow column, in branch_order.

Trait Implementations

impl Clone for DcPfSolution

fn clone(&self) -> DcPfSolution

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DcPfSolution

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

Formats the value using the given formatter.

impl From<DcPfSolution> for PioValue

fn from(value: DcPfSolution) -> Self

Converts to this type from the input type.