pub struct McAcPfInstance { /* private fields */ }Expand description
The multiconductor AC power flow instance.
Implementations§
Source§impl McAcPfInstance
impl McAcPfInstance
Sourcepub fn from_network(network: MulticonductorNetwork) -> Result<Self, Error>
pub fn from_network(network: MulticonductorNetwork) -> Result<Self, Error>
Build the instance from the network’s stated data: every in service load contributes its prescribed per phase powers and voltage model, every voltage source its prescribed terminal complex voltage, and every stated regulator and capacitor control an active control mode.
§Errors
A network with no voltage source, or a bus island without a voltage source. This necessary connectivity check does not establish conductor energization or numerical solvability.
Sourcepub fn with_initial_point(
self,
point: OperatingPoint<MulticonductorNetwork>,
) -> Self
pub fn with_initial_point( self, point: OperatingPoint<MulticonductorNetwork>, ) -> Self
Supply an optional solver initial point.
Sourcepub fn with_network(self, network: MulticonductorNetwork) -> Result<Self, Error>
pub fn with_network(self, network: MulticonductorNetwork) -> Result<Self, Error>
Replace the network and recalculate its prescribed powers, source voltages, and active controls while preserving a compatible initial point.
Sourcepub fn network(&self) -> &MulticonductorNetwork
pub fn network(&self) -> &MulticonductorNetwork
The network this instance calculates on. Borrowed; never a copy.
Sourcepub fn loads(&self) -> &[PrescribedTerminalPower]
pub fn loads(&self) -> &[PrescribedTerminalPower]
The prescribed load terminal powers, in load table order.
Sourcepub fn sources(&self) -> &[PrescribedSourceVoltage]
pub fn sources(&self) -> &[PrescribedSourceVoltage]
Source phasor parameters in source table order. Resolve each record
against the associated network source, or use Self::source_boundary
to obtain both endpoints with the phasors.
Sourcepub fn source_boundary(
&self,
index: usize,
) -> Option<PrescribedSourceBoundary<'_>>
pub fn source_boundary( &self, index: usize, ) -> Option<PrescribedSourceBoundary<'_>>
Both voltage endpoints and their phasor differences, borrowed from this instance. No network cloning or serialization is involved.
Sourcepub fn isolated_terminals(&self) -> &[(String, String)]
pub fn isolated_terminals(&self) -> &[(String, String)]
Terminals with no equation, as (bus, terminal) pairs.
Sourcepub fn control_modes(&self) -> &[ActiveControlMode]
pub fn control_modes(&self) -> &[ActiveControlMode]
The equipment controls active for the calculation.
Sourcepub const fn initial_point(
&self,
) -> Option<&OperatingPoint<MulticonductorNetwork>>
pub const fn initial_point( &self, ) -> Option<&OperatingPoint<MulticonductorNetwork>>
The optional solver initial point.
Trait Implementations§
Source§impl Clone for McAcPfInstance
impl Clone for McAcPfInstance
Source§fn clone(&self) -> McAcPfInstance
fn clone(&self) -> McAcPfInstance
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read more