Skip to main content

CurrentFunctional

Struct CurrentFunctional 

Source
pub struct CurrentFunctional {
    pub at: usize,
    pub coefficients: Vec<(usize, Complex<f64>)>,
}
Expand description

A terminal current as a sparse linear functional of the complex bus voltages, plus the bus whose voltage turns it into a power.

Fields§

§at: usize

The bus whose voltage forms the power S = V_at · conj(I).

§coefficients: Vec<(usize, Complex<f64>)>

I = Σ c_k·V_k, as (bus, c).

Duplicate buses are allowed and sum, which is what makes gridoxide’s half-open branch — represented as a self-loop, so from == to — come out right, and what lets a node injection concatenate its Y-bus row with its source and shunt terms instead of merging them.

Implementations§

Source§

impl CurrentFunctional

Source

pub fn current(&self, v: &[Complex<f64>]) -> Complex<f64>

I = Σ c_k·V_k.

Source

pub fn power(&self, v: &[Complex<f64>]) -> Complex<f64>

S = V_at · conj(I), i.e. (P, Q) as one complex number.

Source

pub fn power_partials(&self, v: &[Complex<f64>], out: &mut Vec<Partial>)

Partials of S with respect to every bus it depends on, appended to out in coefficient order.

∂S/∂θ_k    = −j·V_at·conj(c_k·V_k)      + [k = at]·j·S
∂S/∂|V_k|  =    V_at·conj(c_k·e^{jθ_k}) + [k = at]·S/|V_at|

Every coefficient produces an entry, including one whose value is numerically zero. H’s sparsity pattern has to depend on the topology alone and not on the state — dropping a zero would shrink the row at a flat start, where many sin(θ_i − θ_k) vanish exactly, and grow it again next iteration, invalidating the cached symbolic factorization.

An empty functional produces nothing at all rather than a lone at entry. Its quantity is identically zero with no dependence on anything, and a row of structural zeros would defeat mask_untouched, which is what pins a genuinely disconnected bus.

Source

pub fn local_current(&self, v: &[Complex<f64>]) -> Complex<f64>

I_local = S/|V_at| — see local_current_partials_of.

Source

pub fn current_partials(&self, v: &[Complex<f64>], out: &mut Vec<Partial>)

Source

pub fn local_current_partials(&self, v: &[Complex<f64>], out: &mut Vec<Partial>)

Trait Implementations§

Source§

impl Clone for CurrentFunctional

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for CurrentFunctional

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for CurrentFunctional

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for CurrentFunctional

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> ByRef<T> for T

Source§

fn by_ref(&self) -> &T

Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DistributionExt for T
where T: ?Sized,

Source§

fn rand<T>(&self, rng: &mut (impl Rng + ?Sized)) -> T
where Self: Distribution<T>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Imply<T> for U
where T: ?Sized, U: ?Sized,

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V