Enum DcConvention 

#[non_exhaustive]
pub enum DcConvention {
    ReactanceOnly,
    Matpower,
    SeriesImpedance,
}

Rule for the DC branch susceptance b.

b is positive for an inductive branch, the DC model convention MATPOWER makeBdc uses. It is the edge weight of the bus susceptance matrix and the coefficient in f = b (theta_from - theta_to). The AC series susceptance Im(1/(r + jx)) is its negation.

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.

Matpower

b = 1/(x tau) with phase shift injections, matching MATPOWER makeBdc.

SeriesImpedance

b = 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. PowerModels’ DC formulation uses the same quantity.

Implementations

impl DcConvention

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

The branch susceptance from resistance, reactance, and effective tap. Only Self::Matpower reads the tap, and only Self::SeriesImpedance reads the resistance.

pub fn includes_phase_shifts(self) -> bool

Whether phase shifts contribute to the nodal injection vector.

Trait Implementations

impl Clone for DcConvention

fn clone(&self) -> DcConvention

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DcConvention

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

Formats the value using the given formatter.

impl Default for DcConvention

fn default() -> DcConvention

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for DcConvention

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for DcConvention

fn eq(&self, other: &DcConvention) -> 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 DcConvention

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for DcConvention

impl Eq for DcConvention

impl StructuralPartialEq for DcConvention