Enum JacobianBackend 

pub enum JacobianBackend {
    Scalar,
    Block,
    KluNative,
}

Selects which sparse-LU backend newton_raphson_with_backend uses to solve the Jacobian system each iteration.

The default is KluNative: the KLU algorithm power systems are usually solved with, in Rust, with no build requirement. It solves the power-flow Jacobians gridoxide is benchmarked on about six times faster than Scalar (case9241pegase: 15 ms against 87), within 15% of SuiteSparse’s own KLU.

Variants

Scalar

Scalar sparse triplets solved via faer (sparse::RealSparseSystem). The default until KLU’s native port caught up with SuiteSparse’s.

Block

Experimental, opt-in: groups each bus’s own (angle, magnitude) unknowns into one 2×2 block, mirroring power-grid-model’s block-per-bus matrix structure (block_sparse::BlockLu). Every non-slack bus gets a block — including PV buses, which have no real Q-mismatch equation. Rather than varying block size per bus (which block_sparse::BlockLu doesn’t support), a PV bus’s second row is replaced with a dummy ΔVmag_i = 0 equation (coefficients [0, 1], target 0) that pins its voltage-magnitude update to zero every iteration — mathematically equivalent to the scalar backend’s actual dimension reduction, since that row is fully decoupled from every other unknown. See build_jacobian_blocks.

KluNative

The default: the same scalar Jacobian as Scalar, solved via a from-scratch Rust port of the same KLU algorithm Klu links over FFI — no C toolchain needed, always compiled (unlike Klu, no feature gate). See klu_native’s module doc comment for scope: BTF, AMD, row scaling, partial pivoting, Eisenstat-Liu pruning and refactor are faithful translations.

Implementations

impl JacobianBackend

pub fn lu_backend(self) -> LuBackend

The sparse LU this backend factors with. Block has no general sparse LU of its own, so wherever a Jacobian is not power flow’s block-per-bus shape it falls back to faer, as Scalar does.

Trait Implementations

impl Clone for JacobianBackend

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for JacobianBackend

impl Debug for JacobianBackend

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

Formats the value using the given formatter.

impl Default for JacobianBackend

fn default() -> Self

Returns the “default value” for a type.

impl Eq for JacobianBackend

impl PartialEq for JacobianBackend

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for JacobianBackend