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

#![doc=include_str!( "../README.md")]
//! ## Feature flags
#![doc = document_features::document_features!()]
#![deny(unsafe_code)]
#![deny(clippy::all)]

use arrow::array::RecordBatch;
use fmi::schema::{MajorVersion, traits::FmiModelDescription};
use sim::SimStats;

pub mod options;
pub mod sim;

/// Sim error
#[derive(Debug, thiserror::Error)]
pub enum Error {
    #[error(transparent)]
    FmiError(#[from] fmi::Error),

    #[error(transparent)]
    SolverError(#[from] sim::solver::SolverError),

    #[error(transparent)]
    ArrowError(#[from] arrow::error::ArrowError),

    #[error(transparent)]
    Other(#[from] anyhow::Error),
}

/// Simulate an FMI model parameterized by the given top-level options.
///
/// # Returns
/// A tuple of the record batch of the simulation results and the statistics of the simulation.
pub fn simulate(options: &options::FmiSimOptions) -> Result<(RecordBatch, SimStats), Error> {
    let mini_descr = fmi::import::peek_descr_path(&options.model)?;
    let version = mini_descr.major_version().map_err(fmi::Error::from)?;

    log::debug!("Loaded {mini_descr:?}");

    // Read optional input data
    let input_data = options
        .input_file
        .as_ref()
        .inspect(|p| log::debug!("Reading input data from {}", p.display()))
        .map(sim::util::read_csv_file)
        .transpose()?;

    match version {
        MajorVersion::FMI1 => Err(fmi::Error::UnsupportedFmiVersion(version).into()),

        #[cfg(feature = "fmi2")]
        MajorVersion::FMI2 => {
            let import: fmi::fmi2::import::Fmi2Import = fmi::import::from_path(&options.model)?;
            sim::simulate_with(input_data, &options.interface, import)
        }

        #[cfg(feature = "fmi3")]
        MajorVersion::FMI3 => {
            let import: fmi::fmi3::import::Fmi3Import = fmi::import::from_path(&options.model)?;
            sim::simulate_with(input_data, &options.interface, import)
        }
    }
}