powerio-matrix 0.7.1

Sparse matrices and graph outputs for power system case files, built on powerio.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38

//! MATPOWER-compatible FDPF `Bp` matrix.
//!
//! In fast decoupled power flow, `Bp` is the fixed approximation to the active
//! power versus voltage angle Jacobian block used for the P step.
//!
//! Per MATPOWER `makeB.m`, `Bp` is built as `-Im(Y_bus)` after modifying the
//! network data used for that one matrix:
//!
//! - bus shunts are cleared
//! - line charging is cleared
//! - tap magnitudes are set to one
//! - line resistance is cleared in the XB scheme
//! - phase shifts remain
//!
//! With zero phase shifts this has the usual weighted bus Laplacian sign
//! pattern: stored nonzero off diagonal entries are negative and diagonals are
//! nonnegative. Phase shifters change the off diagonal terms, matching MATPOWER.

use sprs::CsMat;

use crate::Result;
use crate::indexed::IndexedNetwork;

use super::ybus::{YbusFlags, build_ybus_with_flags};
use super::{BuildOptions, Scheme, negate_into};

pub fn build_bprime(case: &IndexedNetwork, opts: &BuildOptions) -> Result<CsMat<f64>> {
    let flags = YbusFlags {
        zero_resistance: matches!(opts.scheme, Scheme::Xb),
        zero_charging: true,
        unity_taps: true,
        zero_shifts: false,
        skip_bus_shunts: true,
        skip_zero_impedance: opts.skip_zero_impedance,
    };
    let parts = build_ybus_with_flags(case, flags)?;
    Ok(negate_into(parts.b))
}