Struct BusMergeRule 

#[non_exhaustive]
pub struct BusMergeRule {
    pub closed_switches: bool,
    pub zero_impedance: Option<ZeroImpedanceRule>,
    pub charging: MergedCharging,
    pub survivor: MergeSurvivor,
}

What BalancedNetwork::merge_buses merges.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

closed_switches: bool

Merge the two buses of every closed switch.

zero_impedance: Option<ZeroImpedanceRule>

Merge the two buses of every branch this rule selects; None merges no branch.

charging: MergedCharging

What happens to the charging of a removed branch.

survivor: MergeSurvivor

Which bus of each merged group survives.

Implementations

impl BusMergeRule

pub const fn new( closed_switches: bool, zero_impedance: Option<ZeroImpedanceRule>, ) -> Self

A rule from its two parts, folding removed branches’ charging onto the survivors.

pub const fn with_charging(self, charging: MergedCharging) -> Self

The same rule with charging for the removed branches’ charging.

pub const fn with_survivor(self, survivor: MergeSurvivor) -> Self

The same rule with survivor choosing each group’s surviving bus.

pub const fn exact() -> Self

Closed switches and exact zero impedance branches: the connections that impose equal terminal voltages with no tolerance.

pub const fn closed_switches() -> Self

Closed switches only.

pub fn psse(network: &BalancedNetwork) -> Result<Self>

PSS/E semantics for network: closed switches plus ZeroImpedanceRule::PsseThreshold at the zero impedance threshold the case states (GENERAL THRSHZ, carried in SolverParams::zero_impedance_threshold).

Read it from the network as parsed: normalization does not carry the solver parameters, so a normalized network states no threshold.

Errors

Error::BusMergeRule when the case states no threshold. Name one with ZeroImpedanceRule::PsseThreshold, for example PSSE_DEFAULT_ZERO_IMPEDANCE_THRESHOLD.

Trait Implementations

impl Clone for BusMergeRule

fn clone(&self) -> BusMergeRule

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for BusMergeRule

impl Debug for BusMergeRule

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

Formats the value using the given formatter.

impl Display for BusMergeRule

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

Formats the value using the given formatter.

impl PartialEq for BusMergeRule

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for BusMergeRule