Skip to main content

SolverParams

Struct SolverParams 

Source
#[non_exhaustive]
pub struct SolverParams { pub newton_tolerance: Option<f64>, pub max_iterations: Option<u32>, pub zero_impedance_threshold: Option<f64>, pub adjust_taps: Option<bool>, pub adjust_area_interchange: Option<bool>, pub adjust_phase_shift: Option<bool>, pub adjust_dc_taps: Option<bool>, pub adjust_switched_shunt: Option<bool>, }
Expand description

Solver / solution-control metadata: the Newton tolerance and iteration cap, the zero-impedance threshold, and the per-quantity adjustment-enable flags.

Each field is optional because a source states only the ones it carries. No power flow physics, but it determines whether a downstream solver reproduces the source tool’s converged answer. Maps to the PSS/E v34+ system-wide block (GENERAL THRSHZ, NEWTON TOLN/ITMXN, SOLVER ACTAPS/AREAIN/PHSHFT/ DCTAPS/SWSHNT).

Fields (Non-exhaustive)§

This struct is marked as 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.
§newton_tolerance: Option<f64>

Newton power flow mismatch tolerance (NEWTON TOLN).

§max_iterations: Option<u32>

Newton iteration cap (NEWTON ITMXN).

§zero_impedance_threshold: Option<f64>

Branches with |x| below this are treated as zero impedance (GENERAL THRSHZ).

§adjust_taps: Option<bool>

Whether the solver adjusts transformer taps (SOLVER ACTAPS).

§adjust_area_interchange: Option<bool>

Whether the solver adjusts area interchange (SOLVER AREAIN).

§adjust_phase_shift: Option<bool>

Whether the solver adjusts phase-shift angles (SOLVER PHSHFT).

§adjust_dc_taps: Option<bool>

Whether the solver adjusts DC line taps (SOLVER DCTAPS).

§adjust_switched_shunt: Option<bool>

Whether the solver adjusts switched shunts (SOLVER SWSHNT).

Implementations§

Source§

impl SolverParams

Source

pub fn new() -> Self

Source

pub fn is_empty(&self) -> bool

True when no field is set (so readers can avoid attaching an empty record).

Trait Implementations§

Source§

impl Clone for SolverParams

Source§

fn clone(&self) -> SolverParams

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SolverParams

Source§

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

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

impl Default for SolverParams

Source§

fn default() -> SolverParams

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for SolverParams

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for SolverParams

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for SolverParams

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for SolverParams

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> 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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> 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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,