fmi-sim 0.5.0

A pure Rust FMI simulator
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64

use fmi::schema::traits::DefaultExperiment;

use crate::options::CommonOptions;

#[derive(Debug, Clone)]
pub struct SimParams {
    /// Start time of the simulation
    pub start_time: f64,
    /// Stop time of the simulation
    pub stop_time: f64,
    /// Output interval
    pub output_interval: f64,
    /// Tolerance
    pub tolerance: Option<f64>,
    /// Use event mode
    pub event_mode_used: bool,
    /// Support early-return in Co-Simulation.
    pub early_return_allowed: bool,
}

impl SimParams {
    /// Create a new `SimParams` from the given `SimOptions` and `DefaultExperiment`.
    ///
    /// Values from `SimOptions` take precedence over values from `DefaultExperiment`.
    pub fn new_from_options<DE>(
        options: &CommonOptions,
        default_experiment: &DE,
        event_mode_used: bool,
        early_return_allowed: bool,
    ) -> Self
    where
        DE: DefaultExperiment,
    {
        let start_time = options
            .start_time
            .or(default_experiment.start_time())
            .unwrap_or(0.0);

        let stop_time = options
            .stop_time
            .or(default_experiment.stop_time())
            .unwrap_or(1.0);

        let output_interval = options
            .output_interval
            .or(default_experiment.step_size())
            .unwrap_or_else(|| (stop_time - start_time) / 500.0);

        if output_interval <= 0.0 {
            panic!("`output_interval` must be positive.");
        }

        let tolerance = options.tolerance.or(default_experiment.tolerance());

        Self {
            start_time,
            stop_time,
            output_interval,
            tolerance,
            event_mode_used,
            early_return_allowed,
        }
    }
}