Struct DcOpfSolution 

pub struct DcOpfSolution { /* private fields */ }

The DC optimal power flow solution: the DC power flow results plus the optimized generator active dispatch, the objective value, and the optional economic outputs an optimizing producer can attach.

Implementations

impl DcOpfSolution

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

Assemble the results: the DC power flow columns, the optimized per generator active dispatch (MW, generator table order), and the objective value.

Errors

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

pub fn instance(&self) -> &DcOpfInstance

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

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

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

Record the producer identity.

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

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 with_bus_active_power_marginals( self, marginals: Vec<f64>, ) -> Result<Self, Error>

Attach the derivative of the optimal objective with respect to added active demand at each bus, in objective units per MW and bus table order. A network generator cost objective gives the usual active power locational marginal price; a different objective does not imply money.

Errors

A column whose length disagrees with the instance’s bus table.

pub fn with_branch_thermal_limit_multipliers( self, from: Vec<f64>, to: Vec<f64>, ) -> Result<Self, Error>

Attach the two nonnegative KKT multipliers for every branch thermal bound, in objective units per MW and branch table order. from is the multiplier on flow <= rating; to is the multiplier on -flow <= rating. Increasing one symmetric rating by one MW changes the local optimal objective by the negative sum of the two values. A branch absent from the DC calculation carries zero in both columns.

Errors

A column whose length disagrees with the instance’s branch table.

pub const fn objective(&self) -> f64

The optimized objective value.

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

Optimized active power of one generator, MW, by stable identity.

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

Optimal objective derivative per added MW of active demand at one bus.

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

From-side thermal bound multiplier by stable branch identity.

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

To-side thermal bound multiplier by stable branch identity.

pub fn bus_active_power_marginals(&self) -> Option<&[f64]>

All active demand marginals in bus table order, when attached.

pub fn branch_from_limit_multipliers(&self) -> Option<&[f64]>

All from-side thermal bound multipliers in branch table order.

pub fn branch_to_limit_multipliers(&self) -> Option<&[f64]>

All to-side thermal bound multipliers in branch table order.

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.

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.

Trait Implementations

impl Clone for DcOpfSolution

fn clone(&self) -> DcOpfSolution

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DcOpfSolution

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

Formats the value using the given formatter.