Clean up, test FMI 2 container, add nSteps

Author: t-sommer

native/container-fmu/container-fmu/src/fmi3.rs

@@ -883,7 +883,7 @@ pub extern "C" fn fmi3DoStep(
         *eventHandlingNeeded = false;
         *terminateSimulation = container.terminated;
         *earlyReturn = false;
-        *lastSuccessfulTime = container.time
+        *lastSuccessfulTime = container.time();
     };
 
     status

native/container-fmu/container-fmu/src/lib.rs

@@ -5,7 +5,7 @@ pub mod fmi2;
 pub mod fmi3;
 
 use crate::conf::*;
-use approx::relative_ne;
+use approx::{relative_eq, relative_ne};
 use fmi::fmi2::types::*;
 use fmi::fmi2::*;
 use fmi::fmi3::types::*;
@@ -33,10 +33,10 @@ enum FMUInstance {
 }
 
 struct Container {
-    time: f64,
     tolerance: Option<f64>,
     startTime: f64,
     stopTime: Option<f64>,
+    nSteps: u64,
     terminated: bool,
     instances: Vec<FMUInstance>,
     system: System,
@@ -244,10 +244,10 @@ impl Container {
         let stringValues = Vec::new();
 
         let container = Container {
-            time: 0.0,
             tolerance: None,
             startTime: 0.0,
             stopTime: None,
+            nSteps: 0,
             terminated: false,
             instances,
             system,
@@ -420,6 +420,10 @@ impl Container {
         self.call_all(|fmu| fmu.terminate(), |fmu| fmu.terminate())
     }
 
+    fn time(&self) -> f64 {
+        self.startTime + self.nSteps as f64 * self.system.fixedStepSize
+    }
+
     fn getVariable(
         &self,
         valueReference: fmi3ValueReference,
@@ -464,7 +468,7 @@ impl Container {
 
         for valueReference in valueReferences {
             if *valueReference == 0 {
-                values[0] = self.time;
+                values[0] = self.time();
                 values = &mut values[1..];
             } else {
                 let variable = match self.getVariable(*valueReference, VariableType::Float64) {
@@ -1174,7 +1178,7 @@ impl Container {
         // thread safety constraints (FMU callbacks are not Sync).
         // The FMU doStep calls must be executed sequentially.
 
-        let currentCommunicationPoint = self.time;
+        let currentCommunicationPoint = self.time();
         let communicationStepSize = self.system.fixedStepSize;
 
         let do_step = |instance: &FMUInstance| match instance {
@@ -1226,7 +1230,7 @@ impl Container {
 
         return_on_error!(status, self.updateConnections());
 
-        self.time += communicationStepSize;
+        self.nSteps += 1;
 
         status
     }
@@ -1238,18 +1242,29 @@ impl Container {
     ) -> fmiStatus {
         let mut status = fmiOK;
 
-        if relative_ne!(currentCommunicationPoint, self.time) {
+        if relative_ne!(currentCommunicationPoint, self.time()) {
             let message = format!(
                 "Expected currentCommunicationPoint={} but was {}",
-                self.time, currentCommunicationPoint
+                self.time(),
+                currentCommunicationPoint
             );
             self.logError(&message);
             return fmiError;
         }
 
-        let next_time = currentCommunicationPoint + communicationStepSize;
+        let n_steps_float = communicationStepSize / self.system.fixedStepSize;
+        let n_steps = n_steps_float.round() as u64;
+
+        if n_steps == 0 || !relative_eq!(n_steps as f64, n_steps_float) {
+            let message = format!(
+                "The communicationStepSize={} must be an even multiple of the fixedStepSize={}.",
+                self.system.fixedStepSize, communicationStepSize
+            );
+            self.logError(&message);
+            return fmiError;
+        }
 
-        while self.time < next_time && relative_ne!(self.time, next_time) {
+        for _ in 0..n_steps {
             return_on_error!(status, self.doFixedStep());
         }
 

native/container-fmu/container-fmu/tests/common.rs

@@ -201,12 +201,11 @@ pub fn create_fmi2_container() -> FMU2 {
     }
 
     let log_message = move |status: &fmi2Status, category: &str, message: &str| {
-        println!("[{status:?}] [{category}] {message}")
+        println!(" [{status:?}] [{category}] {message}")
     };
 
-    let log_fmi_call = move |_status: &fmi2Status, _message: &str| {
-        // println!("[{_status:?}] {_message}")
-    };
+    let log_fmi_call =
+        move |_status: &fmi2Status, _message: &str| println!(">[{_status:?}] {_message}");
 
     FMU2::new(
         &unzipdir,

src/fmpy/container_fmu/__init__.py

@@ -1,66 +1,13 @@
-from typing import Sequence
-
 import json
-from datetime import datetime, timezone
 from pathlib import Path
 import numpy as np
-
-import jinja2
 from fmpy import read_model_description
 from fmpy.container_fmu.config import Configuration
 from fmpy.model_description import ModelVariable
 
-
 __version__ = "0.1.0"
 
 
-def write_model_description_from_configuration(configuration: Configuration, filename: Path):
-    template_dir = Path(__file__).parent / "template"
-
-    loader = jinja2.FileSystemLoader(searchpath=template_dir)
-    environment = jinja2.Environment(loader=loader, trim_blocks=True)
-    template = environment.get_template("FMI3.xml")
-
-    def xml_encode(s):
-        """Escape non-ASCII characters"""
-
-        if s is None:
-            return s
-
-        s = s.replace("&", "&")
-        s = s.replace("<", "&lt;")
-        s = s.replace(">", "&gt;")
-        s = s.replace('"', "&quot;")
-
-        for c in s:
-            if ord(c) > 127:
-                s = s.replace(c, "&#x" + format(ord(c), "x") + ";")
-
-        return s
-
-    def to_literal(value):
-        if isinstance(value, bool):
-            return "true" if value else "false"
-        else:
-            return str(value)
-
-    template.globals.update(
-        {
-            "xml_encode": xml_encode,
-            "to_literal": to_literal,
-        }
-    )
-
-    xml = template.render(
-        container_fmu_version=__version__,
-        generationDateAndTime=datetime.now(timezone.utc).isoformat(),
-        system=configuration,
-    )
-
-    with open(filename, "w") as f:
-        f.write(xml)
-
-
 def write_configuration(configuration: Configuration, filename: Path):
 
     data = {

src/fmpy/container_fmu/template/FMI3.xml

@@ -9,30 +9,35 @@
     printLogMessage,
 )
 from fmpy.model_description import BaseUnit, DisplayUnit, ModelDescription, SimpleType, Item, DefaultExperiment, \
-    ModelVariable, Unit, CoSimulation
+    ModelVariable, Unit, CoSimulation, VariableType
 
 
-@pytest.mark.skipif(platform_tuple == "aarch64-darwin", reason="FMI 2.0 does not support aarch64-darwin")
-def test_feedthrough(work_dir, reference_fmus_dist_dir, resources_dir):
+@pytest.mark.parametrize("fmi_version", ["2.0", "3.0"])
+def test_feedthrough(work_dir, reference_fmus_dist_dir, resources_dir, fmi_version):
+
+    if platform_tuple == "aarch64-darwin":
+        pytest.skip("FMI 2.0 does not support aarch64-darwin")
+
+    variable_type: VariableType = "Real" if fmi_version == "2.0" else "Float64"
 
     container_input = ModelVariable(
-        type="Real",
+        type=variable_type,
         variability="continuous",
         causality="input",
         name="Float64_continuous_input",
         start="1.1",
     )
 
     container_output = ModelVariable(
-        type="Real",
+        type=variable_type,
         initial="calculated",
         variability="continuous",
         causality="output",
         name="Float64_continuous_output",
     )
 
     model_description = ModelDescription(
-        fmiVersion="2.0",
+        fmiVersion=fmi_version,
         modelName="Feedthrough",
         instantiationToken="",
         unitDefinitions=[
@@ -43,7 +48,7 @@ def test_feedthrough(work_dir, reference_fmus_dist_dir, resources_dir):
             ),
         ],
         typeDefinitions=[
-            SimpleType(name='AngularVelocity', type="Real", quantity='AngularVelocity', unit='rad/s',
+            SimpleType(name='AngularVelocity', type=variable_type, quantity='AngularVelocity', unit='rad/s',
                        displayUnit='rpm'),
             SimpleType(name='Option', type='Enumeration', items=[
                 Item(name='Option 1', value="1", description="First option"),
@@ -58,7 +63,7 @@ def test_feedthrough(work_dir, reference_fmus_dist_dir, resources_dir):
         ),
         modelVariables=[
             ModelVariable(
-                type="Real",
+                type=variable_type,
                 variability="continuous",
                 causality="independent",
                 name="time",
@@ -107,7 +112,7 @@ def test_feedthrough(work_dir, reference_fmus_dist_dir, resources_dir):
 
     unzipdir = work_dir
 
-    filename = unzipdir / "Container.fmu"
+    filename = unzipdir / f"Container_fmi{fmi_version[0]}.fmu"
 
     create_container_fmu(configuration, unzipdir, filename)
 
@@ -126,7 +131,7 @@ def test_feedthrough(work_dir, reference_fmus_dist_dir, resources_dir):
         filename,
         debug_logging=True,
         fmi_call_logger=print,
-        logger=printLogMessage,
+        # logger=printLogMessage,
         output_interval=0.5,
         stop_time=1,
         # start_values={"Float64_continuous_input": 1.5},