Struct System3TM 

pub struct System3TM {
    pub solver_type: SolverTypes,
    pub m1: ThermalMass,
    pub m2: ThermalMass,
    pub h12: Conductance,
    pub m3: ThermalMass,
    pub h23: Conductance,
    pub t_report: Vec<f64>,
    pub state: SystemState,
    pub history: SystemStateHistoryVec,
}

System of connected components

Fields

solver_type: SolverTypes

m1: ThermalMass

m2: ThermalMass

h12: Conductance

h12 connects m1 to m2

m3: ThermalMass

h23: Conductance

t_report: Vec<f64>

state: SystemState

history: SystemStateHistoryVec

Implementations

impl System3TM

pub fn save_state(&mut self)

Saves self.state to self.history and propagtes to save_state in Self::m1, Self::m2, Self::h12, Self::m3, Self::h23

impl System3TM

pub fn walk(&mut self)

iterates through time until last value of t_report

pub fn solve_step(&mut self)

Runs solver_type specific step method that calls [Self::step] in solver-specific manner

Trait Implementations

impl BareClone for System3TM

fn bare_clone(&self) -> Self

Returns a copy

impl Clone for System3TM

fn clone(&self) -> System3TM

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for System3TM

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

Formats the value using the given formatter.

impl Default for System3TM

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for System3TM

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl HasStates for System3TM

fn states(&self) -> Vec<f64>

returns values of states

fn set_states(&mut self, val: Vec<f64>)

sets values of states

fn step_states_by_dt(&mut self, dt: &f64)

assuming set_derivs has been called, steps value of states by deriv * dt

fn step_states(&mut self, val: Vec<f64>)

assuming set_derivs has been called, steps value of states by deriv * dt

fn derivs(&self) -> Vec<f64>

returns derivatives of states

fn set_derivs(&mut self, val: &[f64])

sets values of derivatives of states

fn step_derivs(&mut self, val: Vec<f64>)

steps derivs by val

fn storages(&self) -> Vec<f64>

returns value of storage variable (e.g. thermal capacitance [J/K])

impl PartialEq for System3TM

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for System3TM

fn partial_cmp(&self, other: &System3TM) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for System3TM

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl SolverBase for System3TM

fn reset_derivs(&mut self)

reset all time derivatives to zero for start of solve_step

fn step_time(&mut self, dt: &f64)

steps dt without affecting states

fn update_derivs(&mut self)

Updates time derivatives of states. This method must be user defined in solver macro args.

fn sc(&self) -> Option<&AdaptiveSolverConfig>

Returns solver_conf, if applicable

fn sc_mut(&mut self) -> Option<&mut AdaptiveSolverConfig>

Returns mut solver_conf, if applicable

fn state(&self) -> &SystemState

Returns Self::state

impl SolverVariantMethods for System3TM

fn euler(&mut self, dt: &f64)

Steps forward by dt

fn heun(&mut self, dt: &f64)

Heun’s Method (starts out with Euler’s method but adds an extra step) See Heun’s Method (the first listed Heun’s method, not the one also known as Ralston’s Method): https://en.wikipedia.org/wiki/Heun%27s_method

fn midpoint(&mut self, dt: &f64)

Midpoint Method See: https://en.wikipedia.org/wiki/Midpoint_method

fn ralston(&mut self, dt: &f64)

Ralston’s Method See Ralston’s Method: https://en.wikipedia.org/wiki/List_of_Runge%E2%80%93Kutta_methods#Ralston.27s_method

fn rk23_bogacki_shampine(&mut self, dt_max: &f64) -> f64

solves time step with adaptive Bogacki Shampine Method (variant of RK23) and returns ‘dt’ used see: https://en.wikipedia.org/wiki/Bogacki%E2%80%93Shampine_method

fn rk23_bogacki_shampine_step(&mut self, dt: f64) -> (Vec<f64>, Vec<f64>)

fn rk4fixed(&mut self, dt: &f64)

solves time step with 4th order Runge-Kutta method. See RK4 method: https://en.wikipedia.org/wiki/Runge%E2%80%93Kutta_methods#Examples

fn rk45_cash_karp(&mut self, dt_max: &f64) -> f64

solves time step with adaptive Cash-Karp Method (variant of RK45) and returns dt used https://en.wikipedia.org/wiki/Cash%E2%80%93Karp_method

fn rk45_cash_karp_step(&mut self, dt: f64) -> (Vec<f64>, Vec<f64>)

impl StructuralPartialEq for System3TM