Skip to main content

InitialStateError

Enum InitialStateError 

Source
pub enum InitialStateError {
    Evaluation(EvaluationError),
    ConflictingConditions {
        element: String,
        implied: f64,
        declared: f64,
    },
    InconsistentWithCircuit {
        constraint: String,
        residual: f64,
    },
}
Expand description

Why a netlist’s declared ic= values could not be turned into a starting state vector.

Variants§

§

Evaluation(EvaluationError)

A component value, or an ic= value itself, could not be evaluated numerically.

§

ConflictingConditions

Two or more ic= values on capacitors contradict each other, independently of the rest of the circuit: they form a loop whose declared voltages do not sum to zero, so no assignment of node voltages satisfies all of them at once.

Fields

§element: String

The element whose condition closed the contradictory loop.

§implied: f64

The voltage the other conditions in the loop already imply across it, in the orientation the loop was walked in — which may be the reverse of the card’s own node order, so compare it with declared rather than reading a polarity out of it.

§declared: f64

The voltage this element declares, in that same orientation.

§

InconsistentWithCircuit

An assignment violates one of the circuit’s own algebraic constraints — every unknown in that constraint is fixed by an ic=, and the values they are fixed to do not satisfy it.

The two textbook cases: an ic on a capacitor wired directly across an ideal voltage source (the source’s branch equation already fixes that voltage), and two series inductors whose ic values declare different currents (the shared node’s KCL row already fixes them equal).

Fields

§constraint: String

The unknown whose equation is violated. A node voltage V(n) names that node’s KCL equation; a branch current I(name) names that device’s own branch equation.

§residual: f64

The constraint’s residual at the assigned state — how far from satisfied it is, in the equation’s own units.

Trait Implementations§

Source§

impl Clone for InitialStateError

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 InitialStateError

Source§

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

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

impl Display for InitialStateError

Source§

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

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

impl Error for InitialStateError

1.30.0 · Source§

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any. Read more
1.0.0 · Source§

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

1.0.0 · Source§

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

Source§

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)
Provides type-based access to context intended for error reports. Read more
Source§

impl From<EvaluationError> for InitialStateError

Source§

fn from(error: EvaluationError) -> Self

Converts to this type from the input type.
Source§

impl PartialEq for InitialStateError

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 InitialStateError

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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. 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.