Struct SimParams 

#[non_exhaustive]
pub struct SimParams {
    pub ach_speed_max_iter: u32,
    pub ach_speed_tol: Ratio,
    pub ach_speed_solver_gain: f64,
    pub trace_miss_tol: TraceMissTolerance,
    pub trace_miss_opts: TraceMissOptions,
    pub trace_miss_correct_max_steps: u32,
    pub f2_const_air_density: bool,
    pub ambient_thermal_soak: bool,
}

Solver parameters

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.

ach_speed_max_iter: u32

max number of iterations allowed in setting achieved speed when trace cannot be achieved

ach_speed_tol: Ratio

tolerance in change in speed guess in setting achieved speed when trace cannot be achieved

ach_speed_solver_gain: f64

Newton method gain for setting achieved speed

trace_miss_tol: TraceMissTolerance

When implemented, this will set the tolerance on how much trace miss is allowed

trace_miss_opts: TraceMissOptions

trace_miss_correct_max_steps: u32

the maximum number of steps in which to re-rendezvous with reference trace after a trace miss. Note: this field only applies when trace_miss_opts is set to TraceMissOptions::Correct. Note: must be 2 or greater. Defaults to 6.

f2_const_air_density: bool

whether to use FASTSim-2 style air density

ambient_thermal_soak: bool

if true, vehicle is totally inactive except for thermal models

Trait Implementations

impl Clone for SimParams

fn clone(&self) -> SimParams

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SimParams

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

Formats the value using the given formatter.

impl Default for SimParams

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SimParams

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Init for SimParams

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 SimParams

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

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 SimParams

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for SimParams