Enum BranchSusceptanceFormula 

#[non_exhaustive]
pub enum BranchSusceptanceFormula {
    ReactanceOnly,
    TapAdjustedReactance,
    SeriesSusceptance,
}

Rule for the DC branch susceptance b.

The public b follows PowerModels: it is negative for an inductive branch, the imaginary part of the series admittance the selected formula models. The positive edge weight a sparse factorization uses is its negation, calc_solver_edge_weight.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

ReactanceOnly

b = -1/x, ignoring resistance, transformer taps, and phase shifts.

The textbook DC linearization, which a paper reproducing a published result needs exactly as written.

TapAdjustedReactance

b = -1/(x tau) with phase shift injections, matching MATPOWER makeBdc up to MATPOWER’s own sign spelling.

SeriesSusceptance

b = imag(inv(r + jx)) = -x/(r² + x²) with phase shift injections.

Reads the whole series impedance, so it describes a branch with a real r/x ratio. A transformer tap does not scale it, and it reduces to -1/x when the resistance is zero. This is PowerModels’ DC branch susceptance exactly.

Implementations

impl BranchSusceptanceFormula

pub fn calc_branch_susceptance( self, resistance: f64, reactance: f64, effective_tap: f64, ) -> f64

The public branch susceptance, in PowerModels signs: the imaginary part of the series admittance the selected formula models, negative for an inductive branch. Only Self::TapAdjustedReactance reads the tap, and only Self::SeriesSusceptance reads the resistance; a value the selected formula never reads cannot reject a branch.

Non-finite in, non-finite out. The reciprocal rules need the guard because 1/±inf is a finite 0.0: a branch Y_bus rejects outright would otherwise join the DC system as a zero-weight edge with nothing to report it.

pub fn calc_solver_edge_weight( self, resistance: f64, reactance: f64, effective_tap: f64, ) -> f64

The internal positive factor weight of the same branch: the edge weight of the positive semidefinite DC Laplacian a sparse Cholesky solver factors, which is the negation of calc_branch_susceptance. Public results carry PowerModels signs; a solver path fills its factor from this weight and converts sign only while writing a caller’s output.

pub fn reads_tap(self) -> bool

Whether the selected formula reads the transformer tap, and so whether the tap can bound or reject a branch.

pub fn includes_phase_shifts(self) -> bool

Whether phase shifts contribute to the nodal injection vector.

pub fn formula_name(self) -> &'static str

The formula’s stable cross language name.

pub fn from_formula_name(name: &str) -> Option<BranchSusceptanceFormula>

The formula for one stable name, or None for an unknown name.

Trait Implementations

impl Clone for BranchSusceptanceFormula

fn clone(&self) -> BranchSusceptanceFormula

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for BranchSusceptanceFormula

impl Debug for BranchSusceptanceFormula

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

Formats the value using the given formatter.

impl Default for BranchSusceptanceFormula

fn default() -> BranchSusceptanceFormula

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for BranchSusceptanceFormula

fn deserialize<__D>( __deserializer: __D, ) -> Result<BranchSusceptanceFormula, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for BranchSusceptanceFormula

impl PartialEq for BranchSusceptanceFormula

fn eq(&self, other: &BranchSusceptanceFormula) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for BranchSusceptanceFormula

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for BranchSusceptanceFormula