Skip to main content

StageSpec

Enum StageSpec 

Source
pub enum StageSpec {
    Static {
        id: String,
        steps: u32,
        integrator: IntegratorSpec,
        algorithm: AlgorithmSpec,
        convergence: Option<ConvergenceSpec>,
        hold_patterns_after: Vec<u32>,
    },
    Modal {
        id: String,
        modes: u32,
    },
    Reset {
        id: String,
    },
    Transient {
        id: String,
        steps: u32,
        dt: f64,
        damping: DampingSpec,
        ground_motions: Vec<GroundMotionSpec>,
        algorithm: AlgorithmSpec,
        convergence: Option<ConvergenceSpec>,
    },
}

Variants§

§

Static

Fields

§steps: u32
§integrator: IntegratorSpec
§algorithm: AlgorithmSpec
§hold_patterns_after: Vec<u32>

Indices into LoadPatternTable to freeze (via Domain::hold_pattern_constant) at this stage’s final load factor once it completes.

§

Modal

A single eigenvalue solve (core::modal_analysis) for the domain’s current state — not iterative like Static/Transient, so this stage always takes exactly one advance() step regardless of the caller’s step budget (decode.rs’s compile_stages hardcodes steps: 1 for it). modes is the number of lowest-frequency modes to compute (1..=free_dof_count).

Fields

§modes: u32
§

Reset

Reverts the model to its initial state (OpenSees reset): displacements, velocities and every element/material history return to their as-built values and time to 0. Like OpenSees, it does not undo holdPatternsAfter freezes (loadConst): a held pattern stays applied at its frozen factor, so a later stage sees that load in full from its first step; patterns that were not held ramp again from 0. Load patterns and their loads stay defined. Takes no steps and records nothing.

Fields

§

Transient

Newmark-beta time-history analysis (core::TransientAnalysis, fixed at the unconditionally-stable “average acceleration” parameters — see its own doc comment). steps fixed-size dt increments; ground_motions (zero or more) each add a uniform inertial excitation along one axis, on top of whatever LoadPattern reference loads are already active (e.g. a preceding Static stage’s frozen gravity).

Fields

§steps: u32
§dt: f64
§damping: DampingSpec
§ground_motions: Vec<GroundMotionSpec>
§algorithm: AlgorithmSpec

Omitted algorithms preserve the original linear Newmark solve.

Implementations§

Source§

impl StageSpec

Source

pub fn id(&self) -> &str

Trait Implementations§

Source§

impl Clone for StageSpec

Source§

fn clone(&self) -> StageSpec

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 StageSpec

Source§

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

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

impl<'de> Deserialize<'de> for StageSpec

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 StageSpec

Source§

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

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

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

Inequality operator !=. Read more
Source§

impl Serialize for StageSpec

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 StageSpec

Source§

impl Tsify for StageSpec

Source§

const DECL: &'static str = "export type StageSpec = { kind: \"static\"; id: string; steps: number; integrator: IntegratorSpec; algorithm: AlgorithmSpec; convergence?: ConvergenceSpec; holdPatternsAfter: number[] } | { kind: \"modal\"; id: string; modes: number } | { kind: \"reset\"; id: string } | { kind: \"transient\"; id: string; steps: number; dt: number; damping: DampingSpec; groundMotions: GroundMotionSpec[]; algorithm?: AlgorithmSpec; convergence?: ConvergenceSpec };"

Source§

const SERIALIZATION_CONFIG: SerializationConfig

Source§

type JsType = JsType

Must be a type imported through #[wasm_bindgen] extern "C" { .. }. [Ts<T>] is #[repr(transparent)] over this and passes it across the ABI as a plain JS handle, which any other representation would break.
§

fn into_js(&self) -> Result<Self::JsType, Error>
where Self: Serialize,

§

fn from_js<T>(js: T) -> Result<Self, Error>
where T: Into<JsValue>, Self: DeserializeOwned,

§

fn into_ts(&self) -> Result<Ts<Self>, Error>
where Self: Sized + Serialize,

Calls Ts::from_rust on self, returning a Result<Ts<Self>, crate::Error>. Read more

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
§

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

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.
Source§

impl<S, T> Upcast<T> for S
where T: UpcastFrom<S> + ?Sized, S: ?Sized,

Source§

fn upcast(&self) -> &T
where Self: ErasableGeneric, T: Sized + ErasableGeneric<Repr = Self::Repr>,

Perform a zero-cost type-safe upcast to a wider ref type within the Wasm bindgen generics type system. Read more
Source§

fn upcast_into(self) -> T
where Self: Sized + ErasableGeneric, T: Sized + ErasableGeneric<Repr = Self::Repr>,

Perform a zero-cost type-safe upcast to a wider type within the Wasm bindgen generics type system. Read more