Skip to main content

AnalysisError

Enum AnalysisError 

Source
pub enum AnalysisError {
    FailedToConverge {
        step: usize,
    },
    SingularSystem,
    InvalidConstraint,
    InvalidModeCount {
        requested: usize,
        free_dofs: usize,
    },
    InvalidOption {
        field: &'static str,
    },
    UnsupportedLoadSeries,
    ZeroLoadSensitivity,
    InitialStateNotInEquilibrium {
        measure: f64,
    },
    MissingSeedDirection,
    CutbacksExhausted {
        step: usize,
        attempts: usize,
        radius: f64,
        last_failure: ArcFailure,
    },
    ContinuationComplete,
    InvalidModel(ModelError),
}
Expand description

Real error enum, not sentinel integers. Carries the context an OpenSees-style -1..-5 return code would otherwise leave to out-of-band documentation.

Variants§

§

FailedToConverge

Fields

§step: usize
§

SingularSystem

§

InvalidConstraint

An Integrator::DisplacementControl’s controlled DOF is fixed (not part of the free-DOF system), so there’s no equation to control.

§

InvalidModeCount

modal_analysis was asked for more modes than the model has free DOFs (or zero modes) — there’s no such Krylov subspace to build.

Fields

§requested: usize
§free_dofs: usize
§

InvalidOption

A configuration value is out of range, nonfinite, or not supported in combination with the rest of the analysis. field names the option in its wire-format spelling (e.g. "integrator.minRadius").

Fields

§field: &'static str
§

UnsupportedLoadSeries

Arc-length continuation found an unfrozen LoadSeries::Path pattern (its slope isn’t valid across a load reversal or breakpoint).

§

ZeroLoadSensitivity

Arc-length continuation’s combined reference-load sensitivity is zero on every free equation: there is no load to continue.

§

InitialStateNotInEquilibrium

Arc-length continuation must start from equilibrium. measure is the force-test measure at entry (||r|| for NormUnbalance, the largest scaled component for Combined).

Fields

§measure: f64
§

MissingSeedDirection

The first arc-length tangent is singular and no seed direction was configured to orient it.

§

CutbacksExhausted

Every arc-length attempt for this step failed and the radius can’t be reduced further (or the retry budget is spent). last_failure says why the final attempt failed.

Fields

§step: usize
§attempts: usize
§radius: f64
§last_failure: ArcFailure
§

ContinuationComplete

An arc-length stop criterion was already met; the phase is over and further steps are refused without changing any state.

§

InvalidModel(ModelError)

The model failed Domain::validate (for example a nodal load on a DOF no element stiffens).

Trait Implementations§

Source§

impl Clone for AnalysisError

Source§

fn clone(&self) -> AnalysisError

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 Copy for AnalysisError

Source§

impl Debug for AnalysisError

Source§

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

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

impl PartialEq for AnalysisError

Source§

fn eq(&self, other: &AnalysisError) -> 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 AnalysisError

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
§

impl<T> Boilerplate for T
where T: Copy + Send + Sync + Debug + PartialEq + 'static,

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
§

impl<T> ByRef<T> for T

§

fn by_ref(&self) -> &T

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.

§

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

Source§

type Output = T

Should always be Self
Source§

impl<T> Scalar for T
where T: 'static + Clone + PartialEq + Debug,

§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
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.