Enum BranchSusceptanceFormula
#[non_exhaustive]pub enum BranchSusceptanceFormula {
ReactanceOnly,
TapAdjustedReactance,
SeriesSusceptance,
TapAdjustedSeriesSusceptance,
SeriesSusceptanceNoPhaseShift,
}Expand description
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)§
This enum is marked as non-exhaustive
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. The coefficient matches PowerModels DCP; its phase-shift
treatment does not. Use SeriesSusceptanceNoPhaseShift for DCP.
TapAdjustedSeriesSusceptance
b = -x/((r² + x²) tau) with phase shift injections (ignore conductance).
SeriesSusceptanceNoPhaseShift
Series susceptance, ignoring taps and phase shifts, matching PowerModels DCP on the same branch orientation and impedance reference side. PowerModels may reverse antiparallel transformers during parsing, scaling their impedance by the original tap squared; this tap-ignoring coefficient then changes. The two tap-adjusted conventions are invariant under that complete reversal transformation.
Implementations§
§impl BranchSusceptanceFormula
impl BranchSusceptanceFormula
pub fn calc_branch_susceptance(
self,
resistance: f64,
reactance: f64,
effective_tap: f64,
) -> f64
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. The dependency helpers state which input values can 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
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 calc_susceptance_sensitivity_to_series_susceptance(
self,
resistance: f64,
reactance: f64,
effective_tap: f64,
) -> f64
pub fn calc_susceptance_sensitivity_to_series_susceptance( self, resistance: f64, reactance: f64, effective_tap: f64, ) -> f64
The derivative of calc_branch_susceptance
with respect to the branch’s series susceptance b_s = -x/(r² + x²),
holding the series conductance g = r/(r² + x²) and the tap fixed.
The series formulas are linear in b_s: 1 and, tap adjusted,
1/tap. The reciprocal reactance formulas read x = -b_s/(g² + b_s²),
so d(-1/x)/db_s = 1 - (g/b_s)² = 1 - (r/x)², divided by the tap for
Self::TapAdjustedReactance. A sensitivity that perturbs a branch’s
series susceptance multiplies by this factor to move the DC weight the
formula assembles.
Non-finite in, non-finite out, as the susceptance itself.
pub fn calc_phase_shift_radians(self, shift: f64, normalized: bool) -> f64
pub fn calc_phase_shift_radians(self, shift: f64, normalized: bool) -> f64
The phase shift a DC column under this formula carries, radians: the
branch’s stated shift (degrees, or radians in a normalized network)
when the formula carries phase shift injections, else zero. The one
phase shift rule every DC builder reads.
pub fn calc_dc_column(
self,
branch: &Branch,
row: usize,
normalized: bool,
) -> Result<Option<DcBranchColumn>, Error>
pub fn calc_dc_column( self, branch: &Branch, row: usize, normalized: bool, ) -> Result<Option<DcBranchColumn>, Error>
The DC column of one branch under this formula: its positive factor
weight (calc_solver_edge_weight) and
its phase shift (calc_phase_shift_radians).
The one place a branch becomes a DC column; every DC builder (the
incidence factor, the DC operators, the DC OPF preparation) reads it
and keeps only its own skip-or-refuse policy and error wording.
Ok(None) for a degenerate impedance: the denominator the formula
divides by is under [MIN_DIVISIBLE_MAGNITUDE], hypot(r, x) for a
formula that reads the resistance and |x| otherwise, so a value the
formula never reads cannot reject a branch (#324). A formally nonzero
impedance below the bound would give a finite weight big enough to
annihilate every real branch sharing a bus with it.
§Errors
Error::DegenerateTap when the formula
divides by a tap it cannot divide by, and
Error::NonFiniteSusceptance
when the weight is not finite (a NaN reactance slips past the bound
and would poison the whole Laplacian). row only labels the error.
pub fn reads_tap(self) -> bool
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 reads_resistance(self) -> bool
pub fn reads_resistance(self) -> bool
Whether resistance participates in the series impedance coefficient.
pub fn includes_phase_shifts(self) -> bool
pub fn includes_phase_shifts(self) -> bool
Whether phase shifts contribute to the nodal injection vector.
pub fn formula_name(self) -> &'static str
pub fn formula_name(self) -> &'static str
The formula’s stable cross language name.
pub fn from_formula_name(name: &str) -> Option<BranchSusceptanceFormula>
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
impl Clone for BranchSusceptanceFormula
§fn clone(&self) -> BranchSusceptanceFormula
fn clone(&self) -> BranchSusceptanceFormula
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreimpl Copy for BranchSusceptanceFormula
§impl Debug for BranchSusceptanceFormula
impl Debug for BranchSusceptanceFormula
§impl Default for BranchSusceptanceFormula
impl Default for BranchSusceptanceFormula
§fn default() -> BranchSusceptanceFormula
fn default() -> BranchSusceptanceFormula
§impl<'de> Deserialize<'de> for BranchSusceptanceFormula
impl<'de> Deserialize<'de> for BranchSusceptanceFormula
§fn deserialize<__D>(
__deserializer: __D,
) -> Result<BranchSusceptanceFormula, <__D as Deserializer<'de>>::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(
__deserializer: __D,
) -> Result<BranchSusceptanceFormula, <__D as Deserializer<'de>>::Error>where
__D: Deserializer<'de>,
impl Eq for BranchSusceptanceFormula
§impl PartialEq for BranchSusceptanceFormula
impl PartialEq for BranchSusceptanceFormula
§impl Serialize for BranchSusceptanceFormula
impl Serialize for BranchSusceptanceFormula
§fn serialize<__S>(
&self,
__serializer: __S,
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where
__S: Serializer,
fn serialize<__S>(
&self,
__serializer: __S,
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where
__S: Serializer,
impl StructuralPartialEq for BranchSusceptanceFormula
Auto Trait Implementations§
impl Freeze for BranchSusceptanceFormula
impl RefUnwindSafe for BranchSusceptanceFormula
impl Send for BranchSusceptanceFormula
impl Sync for BranchSusceptanceFormula
impl Unpin for BranchSusceptanceFormula
impl UnsafeUnpin for BranchSusceptanceFormula
impl UnwindSafe for BranchSusceptanceFormula
Blanket Implementations§
impl<T> Allocation for T
impl<T> Boilerplate for T
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> DeserializeOwned for Twhere
T: for<'de> Deserialize<'de>,
§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key and return true if they are equal.