Struct gmt_fem::FEM

pub struct FEM {
    pub model_description: String,
    pub inputs: Vec<Option<Inputs>>,
    pub outputs: Vec<Option<Outputs>>,
    pub eigen_frequencies: Vec<f64>,
    pub inputs_to_modal_forces: Vec<f64>,
    pub modal_disp_to_outputs: Vec<f64>,
    pub proportional_damping_vec: Vec<f64>,
    pub static_gain: Option<Vec<f64>>,
    pub n_io: (usize, usize),
    /* private fields */
}

GMT Finite Element Model

Fields

model_description: String

Model info

inputs: Vec<Option<Inputs>>

inputs properties

outputs: Vec<Option<Outputs>>

outputs properties

eigen_frequencies: Vec<f64>

mode shapes eigen frequencies [Hz]

inputs_to_modal_forces: Vec<f64>

inputs forces to modal forces matrix [n_modes,n_inputs] (row wise)

modal_disp_to_outputs: Vec<f64>

mode shapes to outputs nodes [n_outputs,n_modes] (row wise)

proportional_damping_vec: Vec<f64>

mode shapes damping coefficients

static_gain: Option<Vec<f64>>

n_io: (usize, usize)

number of inputs and outputs before any model reduction

Implementations

impl FEM

pub fn from_zip_archive<P: AsRef<Path>>(path: P) -> Result<FEM>

Loads a FEM model, saved in a second order form, from a zip archive file

pub fn from_env() -> Result<Self>

Loads a FEM model, saved in a second order form, from a zip archive file located in a directory given by the FEM_REPO environment variable

The name of the zip file must be "modal_state_space_model_2ndOrder.zip

pub fn n_modes(&self) -> usize

Gets the number of modes

pub fn eigen_frequencies_to_radians(&self) -> Vec<f64>

Converts FEM eigen frequencies from Hz to radians

pub fn n_inputs(&self) -> usize

Gets the number of inputs

pub fn n_outputs(&self) -> usize

Gets the number of outputs

pub fn keep_inputs(&mut self, id: &[usize]) -> &mut Self

Selects the inputs according to their natural ordering

pub fn keep_inputs_by<F>(&mut self, id: &[usize], pred: F) -> &mut Self

where F: Fn(&IOData) -> bool + Copy,

Selects the inputs according to their natural ordering and some properties matching

pub fn keep_outputs(&mut self, id: &[usize]) -> &mut Self

Selects the outputs according to their natural ordering

pub fn keep_outputs_by<F>(&mut self, id: &[usize], pred: F) -> &mut Self

where F: Fn(&IOData) -> bool + Copy,

Selects the outputs according to their natural ordering and some properties matching

pub fn filter_inputs_by<F>(&mut self, id: &[usize], pred: F) -> &mut Self

where F: Fn(&IOData) -> bool + Copy,

Filters the inputs according to some properties matching

pub fn remove_inputs_by<F>(&mut self, id: &[usize], pred: F) -> &mut Self

where F: Fn(&IOData) -> bool + Copy,

Removes the inputs which properties do not match the predicate

pub fn filter_outputs_by<F>(&mut self, id: &[usize], pred: F) -> &mut Self

where F: Fn(&IOData) -> bool + Copy,

Filters the outputs according to some properties matching

pub fn inputs2modes(&mut self) -> Vec<f64>

Returns the inputs 2 modes transformation matrix for the turned-on inputs

pub fn input2modes(&self, id: usize) -> Option<Vec<f64>>

Returns the inputs 2 modes transformation matrix for a given input

pub fn trim2input( &self, id: usize, matrix: &DMatrix<f64> ) -> Option<DMatrix<f64>>

pub fn modes2outputs(&mut self) -> Vec<f64>

Returns the modes 2 outputs transformation matrix for the turned-on outputs

pub fn modes2output(&self, id: usize) -> Option<Vec<f64>>

Returns the modes 2 outputs transformation matrix for a given output

pub fn trim2output( &self, id: usize, matrix: &DMatrix<f64> ) -> Option<DMatrix<f64>>

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

Return the static gain reduced to the turned-on inputs and outputs

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

Returns the FEM static gain for the turned-on inputs and outputs

Trait Implementations

impl Clone for FEM

fn clone(&self) -> FEM

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FEM

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

Formats the value using the given formatter.

impl Default for FEM

fn default() -> FEM

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for FEM

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for FEM

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

Formats the value using the given formatter.

impl Serialize for FEM

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

where __S: Serializer,

Serialize this value into the given Serde serializer.