Struct SimDrive 

#[non_exhaustive]
pub struct SimDrive {
    pub veh: Vehicle,
    pub cyc: Cycle,
    pub sim_params: SimParams,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

veh: Vehicle

cyc: Cycle

sim_params: SimParams

Implementations

impl SimDrive

pub fn new(veh: Vehicle, cyc: Cycle, sim_params: Option<SimParams>) -> Self

pub fn walk(&mut self) -> Result<()>

Run vehicle simulation, and, if applicable, apply powertrain-specific corrections:

• for HEV, set initial SOC to mean of min and max SOC, and then iterate walk until SOC balance is achieved – i.e. initial and final SOC are nearly identical
• for PHEV, set initial SOC to max SOC, and then simulate once
• for BEV, set initial SOC to max SOC, and then simulate once
• for Conv, simulate once

Important Considerations

If you need to run a ReversibleEnergyStorage-equipped vehicle for only one iteration without modifying the initial SOC, then run the Self::walk_once method directly

pub fn walk_once(&mut self) -> Result<()>

Run vehicle simulation once

pub fn calc_dvdd(&self, speed_m_per_s: f64, grade: f64) -> Result<f64>

Calculates the derivative dv/dd (change in speed by change in distance)

• speed_m_per_s: the speed at which to evaluate dv/dd (m/s)
• grade: the road grade as a decimal fraction

RETURN: number, the dv/dd for these conditions

pub fn solve_step(&mut self) -> Result<()>

Solves current time step

pub fn set_pwr_prop_for_speed( &mut self, speed: Velocity, speed_prev: Velocity, dt: Time, ) -> Result<()>

Sets power required for given prescribed speed

Arguments

• speed: prescribed or achieved speed
• dt: simulation time step size

pub fn set_ach_speed(&mut self, cyc_speed: Velocity, dt: Time) -> Result<()>

Sets achieved speed based on known current max power

Arguments

• cyc_speed: prescribed speed
• dt: simulation time step size

pub fn to_fastsim2(&self) -> Result<RustSimDrive>

pub fn clear(&mut self)

Trait Implementations

impl Clone for SimDrive

fn clone(&self) -> SimDrive

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SimDrive

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SimDrive

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Init for SimDrive

fn init(&mut self) -> Result<(), Error>

Specialized code to execute upon initialization. For any struct with fields that implement Init, this should propagate down the hierarchy.

impl PartialEq for SimDrive

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

fn save_state<F: Fn() -> String>(&mut self, loc: F) -> Result<()>

Implementation for objects without save_interval

impl SerdeAPI for SimDrive

const ACCEPTED_BYTE_FORMATS: &'static [&'static str] = _

const ACCEPTED_STR_FORMATS: &'static [&'static str] = _

const RESOURCES_DIR: &'static Dir<'_> = _

const RESOURCES_SUBDIR: &'static str = ""

fn from_resource<P: AsRef<Path>>( filepath: P, skip_init: bool, ) -> Result<Self, Error>

Read (deserialize) an object from a resource file packaged with the fastsim-core crate

fn list_resources() -> Result<Vec<PathBuf>, Error>

List the available resources in the resources directory

fn to_file<P: AsRef<Path>>(&self, filepath: P) -> Result<(), Error>

Write (serialize) an object to a file. Supported file extensions are listed in ACCEPTED_BYTE_FORMATS. Creates a new file if it does not already exist, otherwise truncates the existing file.

fn from_file<P: AsRef<Path>>( filepath: P, skip_init: bool, ) -> Result<Self, Error>

Read (deserialize) an object from a file. Supported file extensions are listed in ACCEPTED_BYTE_FORMATS.

fn to_writer<W: Write>(&self, wtr: W, format: &str) -> Result<(), Error>

Write (serialize) an object into anything that implements std::io::Write

fn from_reader<R: Read>( rdr: &mut R, format: &str, skip_init: bool, ) -> Result<Self, Error>

Deserialize an object from anything that implements std::io::Read

fn to_str(&self, format: &str) -> Result<String>

Write (serialize) an object into a string

fn from_str<S: AsRef<str>>( contents: S, format: &str, skip_init: bool, ) -> Result<Self>

Read (deserialize) an object from a string

fn to_json(&self) -> Result<String>

Write (serialize) an object to a JSON string

fn from_json<S: AsRef<str>>(json_str: S, skip_init: bool) -> Result<Self>

Read (deserialize) an object from a JSON string

fn to_msg_pack(&self) -> Result<Vec<u8>>

Write (serialize) an object to a message pack

fn from_msg_pack(msg_pack: &[u8], skip_init: bool) -> Result<Self>

Read (deserialize) an object from a message pack

fn to_toml(&self) -> Result<String>

Write (serialize) an object to a TOML string

fn from_toml<S: AsRef<str>>(toml_str: S, skip_init: bool) -> Result<Self>

Read (deserialize) an object from a TOML string

fn to_yaml(&self) -> Result<String>

Write (serialize) an object to a YAML string

fn from_yaml<S: AsRef<str>>(yaml_str: S, skip_init: bool) -> Result<Self>

Read (deserialize) an object from a YAML string

impl Serialize for SimDrive

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl SetCumulative for SimDrive

fn set_cumulative<F: Fn() -> String>(&mut self, dt: Time, loc: F) -> Result<()>

Sets cumulative values based on rate values

fn reset_cumulative<F: Fn() -> String>(&mut self, loc: F) -> Result<()>

Resets cumulative and corresponding rate values to zero

impl Step for SimDrive

fn step<F: Fn() -> String>(&mut self, loc: F) -> Result<()>

Increments i field of this and all contained structs, recursively

fn reset_step<F: Fn() -> String>(&mut self, loc: F) -> Result<()>

Resets i field of this and all contained structs, recursively

impl TrackedStateMethods for SimDrive

fn check_and_reset<F: Fn() -> String>(&mut self, loc: F) -> Result<()>

Ensure [State::Fresh] and reset to [State::Stale]

fn mark_fresh<F: Fn() -> String>(&mut self, loc: F) -> Result<()>

Mark states as [State::Fresh]

impl StateMethods for SimDrive

impl StructuralPartialEq for SimDrive