Struct gmt_dos_clients_fem::DiscreteStateSpace

pub struct DiscreteStateSpace<'a, T: Solver + Default> {
    pub facesheet_nodes: Option<HashMap<u8, Vec<f64>>>,
    /* private fields */
}

This structure is the state space model builder based on a builder pattern design

Fields

facesheet_nodes: Option<HashMap<u8, Vec<f64>>>

Implementations

impl<'a, T: Solver + Default> DiscreteStateSpace<'a, T>

pub fn set_facesheet_nodes(self) -> Result<Self, StateSpaceError>

pub fn fem_info(&self) -> &Self

Prints information about the FEM

pub fn sampling(self, sampling: f64) -> Self

Set the sampling rate on Hz of the discrete state space model

pub fn proportional_damping(self, zeta: f64) -> Self

Set the same proportional damping coefficients to all the modes

pub fn use_static_gain_compensation(self) -> Self

pub fn eigen_frequencies(self, eigen_frequencies: Vec<(usize, f64)>) -> Self

Overwrites some eigen frequencies

The overwritten frequencies are specified as (index,value) where index is the corresponding eigen mode index and value is the new eigen frequency in Hz

pub fn max_eigen_frequency(self, max_eigen_frequency: f64) -> Self

Truncates the eigen frequencies to and including max_eigen_frequency

The number of modes is set accordingly

pub fn truncate_hankel_singular_values( self, hankel_singular_values_threshold: f64 ) -> Self

Truncates the hankel singular values

pub fn hankel_frequency_lower_bound( self, hankel_frequency_lower_bound: f64 ) -> Self

Frequency lower bound for Hankel singular value truncation (default: 0Hz)

pub fn dump_eigen_frequencies<P: AsRef<Path>>(self, path: P) -> Self

Saves the eigen frequencies to a pickle data file

pub fn ins<U>(self) -> Self

where Vec<Option<Inputs>>: FemIo<U>, U: 'static + UniqueIdentifier + Send + Sync,

Sets the model input based on the input type

pub fn ins_with<U>(self, transform: DMatrixView<'a, f64>) -> Self

where Vec<Option<Inputs>>: FemIo<U>, U: 'static + UniqueIdentifier + Send + Sync,

pub fn ins_by_name<S: Into<String>>( self, names: Vec<S> ) -> Result<Self, StateSpaceError>

Sets the model inputs based on the FEM inputs nomenclature

pub fn ins_with_by_name<S: Into<String>>( self, names: Vec<S>, transforms: Vec<DMatrixView<'a, f64>> ) -> Result<Self, StateSpaceError>

pub fn outs<U>(self) -> Self

where Vec<Option<Outputs>>: FemIo<U>, U: 'static + UniqueIdentifier + Send + Sync,

Sets the model output based on the output type

pub fn outs_with<U>(self, transform: DMatrixView<'a, f64>) -> Self

where Vec<Option<Outputs>>: FemIo<U>, U: 'static + UniqueIdentifier + Send + Sync,

pub fn outs_by_name<S: Into<String>>( self, names: Vec<S> ) -> Result<Self, StateSpaceError>

Sets the model outputs based on the FEM outputs nomenclature

pub fn outs_with_by_name<S: Into<String>>( self, names: Vec<S>, transforms: Vec<DMatrixView<'a, f64>> ) -> Result<Self, StateSpaceError>

pub fn including_m1( self, sids: Option<Vec<u8>> ) -> Result<Self, StateSpaceError>

pub fn including_asms( self, sids: Option<Vec<u8>>, ins_transforms: Option<Vec<DMatrixView<'a, f64>>>, outs_transforms: Option<Vec<DMatrixView<'a, f64>>> ) -> Result<Self, StateSpaceError>

pub fn hankel_singular_value(w: f64, z: f64, b: &[f64], c: &[f64]) -> f64

Returns the Hankel singular value for a given eigen mode

pub fn hankel_singular_values(&self) -> Result<Vec<f64>, StateSpaceError>

Computes the Hankel singular values

pub fn reduced_hankel_singular_values( &mut self ) -> Result<Vec<f64>, StateSpaceError>

Computes the Hankel singular values for the FEM reduced to some inputs and some outputs

pub fn static_gain(&self) -> Option<DMatrix<f64>>

Returns the FEM static gain

pub fn build(self) -> Result<DiscreteModalSolver<T>, StateSpaceError>

Trait Implementations

impl<'a, T: Default + Solver + Default> Default for DiscreteStateSpace<'a, T>

fn default() -> DiscreteStateSpace<'a, T>

Returns the “default value” for a type.

impl<'a, T: Solver + Default> From<FEM> for DiscreteStateSpace<'a, T>

fn from(fem: FEM) -> Self

Creates a state space model builder from a FEM structure

impl<'a, S: Solver + Default> TryFrom<DiscreteStateSpace<'a, S>> for DiscreteModalSolver<S>

type Error = StateSpaceError

The type returned in the event of a conversion error.

fn try_from(dss: DiscreteStateSpace<'a, S>) -> Result<Self, Self::Error>

Performs the conversion.