pythonfmu3 0.3.2__py3-none-any.whl → 0.3.4__py3-none-any.whl

pythonfmu3/_version.py

@@ -1 +1 @@
-__version__ = "0.3.2"
+__version__ = "0.3.4"

pythonfmu3/builder.py

@@ -13,7 +13,7 @@ from typing import Iterable, Optional, Tuple, Union
 from xml.dom.minidom import parseString
 from xml.etree.ElementTree import Element, SubElement, tostring
 from .osutil import get_lib_extension, get_platform
-from .fmi3slave import FMI3_MODEL_OPTIONS, Fmi3Slave, Fmi3SlaveBase
+from .fmi3slave import FMI3_MODEL_OPTIONS_COMMON, FMI3_MODEL_OPTIONS_COSIM, FMI3_MODEL_OPTIONS_MX, Fmi3Slave, Fmi3SlaveBase
 
 FilePath = Union[str, Path]
 HERE = Path(__file__).parent
@@ -137,16 +137,20 @@ class FmuBuilder:
             dest_file = dest / f"{model_identifier}.fmu"
 
             type_node = xml.find("CoSimulation")
-            option_names = [opt.name for opt in FMI3_MODEL_OPTIONS]
-            if type_node:
+            option_names = [opt.name for opt in FMI3_MODEL_OPTIONS_COMMON]
+            cosim_option_names = option_names.copy()
+            cosim_option_names.extend(opt.name for opt in FMI3_MODEL_OPTIONS_COSIM)
+            if type_node is not None:
                 for option, value in options.items():
-                    if option in option_names:
+                    if option in cosim_option_names:
                         type_node.set(option, str(value).lower())
 
             type_node = xml.find("ModelExchange")
-            if type_node:
+            mx_option_names = option_names.copy()
+            mx_option_names.extend(opt.name for opt in FMI3_MODEL_OPTIONS_MX)
+            if type_node is not None:
                 for option, value in options.items():
-                    if option in option_names:
+                    if option in mx_option_names:
                         type_node.set(option, str(value).lower())
 
             with zipfile.ZipFile(dest_file, "w") as zip_fmu:
@@ -247,7 +251,25 @@ def create_command_parser(parser: argparse.ArgumentParser):
         default=None
     )
 
-    for option in FMI3_MODEL_OPTIONS:
+    for option in FMI3_MODEL_OPTIONS_COMMON:
+        action = "store_false" if option.value else "store_true"
+        parser.add_argument(
+            f"--{option.cli}",
+            dest=option.name,
+            help=f"If given, {option.name}={action[6:]}",
+            action=action
+        )
+
+    for option in FMI3_MODEL_OPTIONS_COSIM:
+        action = "store_false" if option.value else "store_true"
+        parser.add_argument(
+            f"--{option.cli}",
+            dest=option.name,
+            help=f"If given, {option.name}={action[6:]}",
+            action=action
+        )
+    
+    for option in FMI3_MODEL_OPTIONS_MX:
         action = "store_false" if option.value else "store_true"
         parser.add_argument(
             f"--{option.cli}",

pythonfmu3/fmi3slave.py

@@ -21,14 +21,22 @@ from .unit import Unit
 
 ModelOptions = namedtuple("ModelOptions", ["name", "value", "cli"])
 
-FMI3_MODEL_OPTIONS: List[ModelOptions] = [
+FMI3_MODEL_OPTIONS_COMMON: List[ModelOptions] = [
     ModelOptions("needsExecutionTool", True, "no-external-tool"),
-    ModelOptions("canHandleVariableCommunicationStepSize", True, "no-variable-step"),
     ModelOptions("canBeInstantiatedOnlyOncePerProcess", False, "only-one-per-process"),
     ModelOptions("canGetAndSetFMUState", False, "handle-state"),
     ModelOptions("canSerializeFMUState", False, "serialize-state")
 ]
 
+FMI3_MODEL_OPTIONS_COSIM: List[ModelOptions] = [
+    ModelOptions("canHandleVariableCommunicationStepSize", True, "no-variable-step"),
+]
+
+FMI3_MODEL_OPTIONS_MX: List[ModelOptions] = [
+    ModelOptions("needsCompletedIntegratorStep", False, "needs-completed-step"),
+]
+
+
 class Fmi3StepResult(NamedTuple):
     status: Fmi3Status = Fmi3Status.ok
     eventHandlingNeeded: bool = False
@@ -103,23 +111,26 @@ class Fmi3SlaveBase(object):
         root = Element("fmiModelDescription", attrib)
 
         options = dict()
-        for option in FMI3_MODEL_OPTIONS:
+        for option in FMI3_MODEL_OPTIONS_COMMON:
             value = model_options.get(option.name, option.value)
             options[option.name] = str(value).lower()
+        
         options["modelIdentifier"] = self.modelName
-        options["canNotUseMemoryManagementFunctions"] = "true"
+
+        options_cs = options.copy()
+        for option in FMI3_MODEL_OPTIONS_COSIM:
+            options_cs[option.name] = str(value).lower()
         
-        options_me = dict()
-        options_me["canGetAndSetFMUState"] = "true"
-        options_me["modelIdentifier"] = self.modelName
-        options_me["needsCompletedIntegratorStep"] = "false"
+        options_me = options.copy()
+        for option in FMI3_MODEL_OPTIONS_MX:
+            options_me[option.name] = str(value).lower()
 
         # check if we have cosim mixin or model exchange mixin
         if isinstance(self, ModelExchange):
             SubElement(root, "ModelExchange", attrib=options_me)
         
         if isinstance(self, CoSimulation):
-            SubElement(root, "CoSimulation", attrib=options)
+            SubElement(root, "CoSimulation", attrib=options_cs)
 
         if self.units:
             unit_defs = SubElement(root, "UnitDefinitions")
@@ -172,8 +183,7 @@ class Fmi3SlaveBase(object):
         initial_unknown = list(
             filter(lambda v: (v.causality == Fmi3Causality.output and (v.initial in allowed_variability))
                               or v.causality == Fmi3Causality.calculatedParameter
-                              or v in continuous_state_derivatives and v.initial in allowed_variability
-                              or v.variability == Fmi3Variability.continuous and v.initial in allowed_variability and v.causality != Fmi3Causality.independent, self.vars.values())
+                              or v in continuous_state_derivatives and v.initial in allowed_variability, self.vars.values())
         )
 
         for v in outputs:
@@ -271,10 +281,13 @@ class Fmi3SlaveBase(object):
         for vr in vrs:
             var = self.vars[vr]
             if isinstance(var, Int32):
-                refs.append(int(var.getter()))
+                if len(var.dimensions) == 0:
+                    refs.append(int(var.getter()))
+                else:
+                    refs.extend(map(int, var.getter()))
             else:
                 raise TypeError(
-                    f"Variable with valueReference={vr} is not of type Integer!"
+                    f"Variable with valueReference={vr} is not of type Int32!"
                 )
         return refs
     
@@ -283,7 +296,10 @@ class Fmi3SlaveBase(object):
         for vr in vrs:
             var = self.vars[vr]
             if isinstance(var, (Enumeration, Int64)):
-                refs.append(int(var.getter()))
+                if len(var.dimensions) == 0:
+                    refs.append(int(var.getter()))
+                else:
+                    refs.extend(map(int, var.getter()))
             else:
                 raise TypeError(
                     f"Variable with valueReference={vr} is not of type Int64!"
@@ -295,11 +311,14 @@ class Fmi3SlaveBase(object):
         for vr in vrs:
             var = self.vars[vr]
             if isinstance(var, UInt64):
-                val = var.getter()
-                refs.append(val if isinstance(val, ctypes.c_uint64) else ctypes.c_uint64(val))
+                if len(var.dimensions) == 0:
+                    val = var.getter()
+                    refs.append(ctypes.c_uint64(val) if not isinstance(val, ctypes.c_uint64) else val)
+                else:
+                    refs.extend(map(ctypes.c_uint64, var.getter()))
             else:
                 raise TypeError(
-                    f"Variable with valueReference={vr} is not of type UInt64!"
+                    f"Variable with valueReference={vr} is not of type Uint64!"
                 )
         return refs
 
@@ -314,7 +333,7 @@ class Fmi3SlaveBase(object):
                     refs.extend(var.getter())
             else:
                 raise TypeError(
-                    f"Variable with valueReference={vr} is not of type Real!"
+                    f"Variable with valueReference={vr} is not of type Float64!"
                 )
         return refs
 
@@ -323,7 +342,11 @@ class Fmi3SlaveBase(object):
         for vr in vrs:
             var = self.vars[vr]
             if isinstance(var, Boolean):
-                refs.append(bool(var.getter()))
+                if len(var.dimensions) == 0:
+                    refs.append(bool(var.getter()))
+                else:
+                    refs.extend(var.getter())
+            
             else:
                 raise TypeError(
                     f"Variable with valueReference={vr} is not of type Boolean!"
@@ -343,30 +366,48 @@ class Fmi3SlaveBase(object):
         return refs
 
     def set_int32(self, vrs: List[int], values: List[int]):
-        for vr, value in zip(vrs, values):
+        offset = 0
+        for vr in vrs:
             var = self.vars[vr]
             if isinstance(var, Int32):
-                var.setter(value)
+                size = var.size(self.vars)
+                if size > 1:
+                    var.setter(values[offset:offset+size])
+                else:
+                    var.setter(values[offset])
+                offset += size
             else:
                 raise TypeError(
-                    f"Variable with valueReference={vr} is not of type Integer!"
+                    f"Variable with valueReference={vr} is not of type Int32!"
                 )
                 
     def set_int64(self, vrs: List[int], values: List[int]):
-        for vr, value in zip(vrs, values):
+        offset = 0
+        for vr in vrs:
             var = self.vars[vr]
             if isinstance(var, (Enumeration, Int64)):
-                var.setter(value)
+                size = var.size(self.vars)
+                if size > 1:
+                    var.setter(values[offset:offset+size])
+                else:
+                    var.setter(values[offset])
+                offset += size
             else:
                 raise TypeError(
-                    f"Variable with valueReference={vr} is not of type Integer!"
+                    f"Variable with valueReference={vr} is not of type Int64!"
                 )
 
     def set_uint64(self, vrs: List[int], values: List[int]):
-        for vr, value in zip(vrs, values):
+        offset = 0
+        for vr in vrs:
             var = self.vars[vr]
             if isinstance(var, UInt64):
-                var.setter(value)
+                size = var.size(self.vars)
+                if size > 1:
+                    var.setter(values[offset:offset+size])
+                else:
+                    var.setter(values[offset])
+                offset += size
             else:
                 raise TypeError(
                     f"Variable with valueReference={vr} is not of type UInt64!"
@@ -385,14 +426,20 @@ class Fmi3SlaveBase(object):
                 offset += size
             else:
                 raise TypeError(
-                    f"Variable with valueReference={vr} is not of type Real!"
+                    f"Variable with valueReference={vr} is not of type Float64!"
                 )
 
     def set_boolean(self, vrs: List[int], values: List[bool]):
-        for vr, value in zip(vrs, values):
+        offset = 0
+        for vr in vrs:
             var = self.vars[vr]
             if isinstance(var, Boolean):
-                var.setter(value)
+                size = var.size(self.vars)
+                if size > 1:
+                    var.setter(values[offset:offset+size])
+                else:
+                    var.setter(values[offset])
+                offset += size
             else:
                 raise TypeError(
                     f"Variable with valueReference={vr} is not of type Boolean!"

pythonfmu3/pythonfmu-export/src/cppfmu/cppfmu_cs.cpp

@@ -66,7 +66,8 @@ void SlaveInstance::SetFloat64(
 void SlaveInstance::SetInt32(
     const FMIValueReference /*vr*/[],
     std::size_t nvr,
-    const FMIInt32 /*value*/[])
+    const FMIInt32 /*value*/[],
+    std::size_t nValues)
 {
     if (nvr != 0) {
         throw std::logic_error("Attempted to set nonexistent variable");
@@ -76,7 +77,8 @@ void SlaveInstance::SetInt32(
 void SlaveInstance::SetInt64(
     const FMIValueReference /*vr*/[],
     std::size_t nvr,
-    const FMIInt64 /*value*/[])
+    const FMIInt64 /*value*/[],
+    std::size_t nValues)
 {
     if (nvr != 0) {
         throw std::logic_error("Attempted to set nonexistent variable");
@@ -86,7 +88,8 @@ void SlaveInstance::SetInt64(
 void SlaveInstance::SetUInt64(
     const FMIValueReference /*vr*/[],
     std::size_t nvr,
-    const FMIUInt64 /*value*/[])
+    const FMIUInt64 /*value*/[],
+    std::size_t nValues)
 {
     if (nvr != 0) {
         throw std::logic_error("Attempted to set nonexistent variable");
@@ -97,7 +100,8 @@ void SlaveInstance::SetUInt64(
 void SlaveInstance::SetBoolean(
     const FMIValueReference /*vr*/[],
     std::size_t nvr,
-    const FMIBoolean /*value*/[])
+    const FMIBoolean /*value*/[],
+    std::size_t nValues)
 {
     if (nvr != 0) {
         throw std::logic_error("Attempted to set nonexistent variable");
@@ -108,7 +112,8 @@ void SlaveInstance::SetBoolean(
 void SlaveInstance::SetString(
     const FMIValueReference /*vr*/[],
     std::size_t nvr,
-    const FMIString /*value*/[])
+    const FMIString /*value*/[],
+    std::size_t nValues)
 {
     if (nvr != 0) {
         throw std::logic_error("Attempted to set nonexistent variable");
@@ -131,7 +136,8 @@ void SlaveInstance::GetFloat64(
 void SlaveInstance::GetInt32(
     const FMIValueReference /*vr*/[],
     std::size_t nvr,
-    FMIInt32 /*value*/[]) const
+    FMIInt32 /*value*/[],
+    std::size_t nValues) const
 {
     if (nvr != 0) {
         throw std::logic_error("Attempted to get nonexistent variable");
@@ -142,7 +148,8 @@ void SlaveInstance::GetInt32(
 void SlaveInstance::GetInt64(
     const FMIValueReference /*vr*/[],
     std::size_t nvr,
-    FMIInt64 /*value*/[]) const
+    FMIInt64 /*value*/[],
+    std::size_t nValues) const
 {
     if (nvr != 0) {
         throw std::logic_error("Attempted to get nonexistent variable");
@@ -153,7 +160,8 @@ void SlaveInstance::GetInt64(
 void SlaveInstance::GetUInt64(
     const FMIValueReference /*vr*/[],
     std::size_t nvr,
-    FMIUInt64 /*value*/[]) const
+    FMIUInt64 /*value*/[],
+    std::size_t nValues) const
 {
     if (nvr != 0) {
         throw std::logic_error("Attempted to get nonexistent variable");
@@ -164,7 +172,8 @@ void SlaveInstance::GetUInt64(
 void SlaveInstance::GetBoolean(
     const FMIValueReference /*vr*/[],
     std::size_t nvr,
-    FMIBoolean /*value*/[]) const
+    FMIBoolean /*value*/[],
+    std::size_t nValues) const
 {
     if (nvr != 0) {
         throw std::logic_error("Attempted to set nonexistent variable");
@@ -175,7 +184,8 @@ void SlaveInstance::GetBoolean(
 void SlaveInstance::GetString(
     const FMIValueReference /*vr*/[],
     std::size_t nvr,
-    FMIString /*value*/[]) const
+    FMIString /*value*/[],
+    std::size_t nValues) const
 {
     if (nvr != 0) {
         throw std::logic_error("Attempted to set nonexistent variable");

pythonfmu3/pythonfmu-export/src/cppfmu/cppfmu_cs.hpp

@@ -76,23 +76,28 @@ public:
     virtual void SetInt32(
         const FMIValueReference vr[],
         std::size_t nvr,
-        const FMIInt32 value[]);
+        const FMIInt32 value[],
+        std::size_t nValues);
     virtual void SetInt64(
         const FMIValueReference vr[],
         std::size_t nvr,
-        const FMIInt64 value[]);
+        const FMIInt64 value[],
+        std::size_t nValues);
     virtual void SetUInt64(
         const FMIValueReference vr[],
         std::size_t nvr,
-        const FMIUInt64 value[]);
+        const FMIUInt64 value[],
+        std::size_t nValues);
     virtual void SetBoolean(
         const FMIValueReference vr[],
         std::size_t nvr,
-        const FMIBoolean value[]);
+        const FMIBoolean value[],
+        std::size_t nValues);
     virtual void SetString(
         const FMIValueReference vr[],
         std::size_t nvr,
-        const FMIString value[]);
+        const FMIString value[],
+        std::size_t nValues);
 
     /* Called from fmi3GetXxx()/fmiGetXxx().
      * Throws std::logic_error by default.
@@ -105,23 +110,28 @@ public:
     virtual void GetInt32(
         const FMIValueReference vr[],
         std::size_t nvr,
-        FMIInt32 value[]) const;
+        FMIInt32 value[],
+        std::size_t nValues) const;
     virtual void GetInt64(
         const FMIValueReference vr[],
         std::size_t nvr,
-        FMIInt64 value[]) const;
+        FMIInt64 value[],
+        std::size_t nValues) const;
     virtual void GetUInt64(
         const FMIValueReference vr[],
         std::size_t nvr,
-        FMIUInt64 value[]) const;
+        FMIUInt64 value[],
+        std::size_t nValues) const;
     virtual void GetBoolean(
         const FMIValueReference vr[],
         std::size_t nvr,
-        FMIBoolean value[]) const;
+        FMIBoolean value[],
+        std::size_t nValues) const;
     virtual void GetString(
         const FMIValueReference vr[],
         std::size_t nvr,
-        FMIString value[]) const;
+        FMIString value[],
+        std::size_t nValues) const;
 
     // Called from fmi3DoStep()/fmiDoStep(). Must be implemented in model code.
     virtual FMIStatus DoStep(

pythonfmu3/pythonfmu-export/src/cppfmu/fmi_functions.cpp

@@ -334,7 +334,7 @@ fmi3Status fmi3GetInt32(
 {
     const auto component = reinterpret_cast<Component*>(c);
     try {
-        component->slave->GetInt32(vr, nvr, values);
+        component->slave->GetInt32(vr, nvr, values, nValues);
         return fmi3OK;
     } catch (const cppfmu::FatalError& e) {
         component->logger.Log(fmi3Fatal, "", e.what());
@@ -354,7 +354,7 @@ fmi3Status fmi3GetInt64(
 {
     const auto component = reinterpret_cast<Component*>(c);
     try {
-        component->slave->GetInt64(vr, nvr, values);
+        component->slave->GetInt64(vr, nvr, values, nValues);
         return fmi3OK;
     } catch (const cppfmu::FatalError& e) {
         component->logger.Log(fmi3Fatal, "", e.what());
@@ -374,7 +374,7 @@ fmi3Status fmi3GetUInt64(
 {
     const auto component = reinterpret_cast<Component*>(c);
     try {
-        component->slave->GetUInt64(vr, nvr, values);
+        component->slave->GetUInt64(vr, nvr, values, nValues);
         return fmi3OK;
     } catch (const cppfmu::FatalError& e) {
         component->logger.Log(fmi3Fatal, "", e.what());
@@ -394,7 +394,7 @@ fmi3Status fmi3GetBoolean(
 {
     const auto component = reinterpret_cast<Component*>(c);
     try {
-        component->slave->GetBoolean(vr, nvr, values);
+        component->slave->GetBoolean(vr, nvr, values, nValues);
         return fmi3OK;
     } catch (const cppfmu::FatalError& e) {
         component->logger.Log(fmi3Fatal, "", e.what());
@@ -414,7 +414,7 @@ fmi3Status fmi3GetString(
 {
     const auto component = reinterpret_cast<Component*>(c);
     try {
-        component->slave->GetString(vr, nvr, values);
+        component->slave->GetString(vr, nvr, values, nValues);
         return fmi3OK;
     } catch (const cppfmu::FatalError& e) {
         component->logger.Log(fmi3Fatal, "", e.what());
@@ -455,7 +455,7 @@ fmi3Status fmi3SetInt32(
 {
     const auto component = reinterpret_cast<Component*>(c);
     try {
-        component->slave->SetInt32(vr, nvr, values);
+        component->slave->SetInt32(vr, nvr, values, nValues);
         return fmi3OK;
     } catch (const cppfmu::FatalError& e) {
         component->logger.Log(fmi3Fatal, "", e.what());
@@ -475,7 +475,7 @@ fmi3Status fmi3SetInt64(
 {
     const auto component = reinterpret_cast<Component*>(c);
     try {
-        component->slave->SetInt64(vr, nvr, values);
+        component->slave->SetInt64(vr, nvr, values, nValues);
         return fmi3OK;
     } catch (const cppfmu::FatalError& e) {
         component->logger.Log(fmi3Fatal, "", e.what());
@@ -495,7 +495,7 @@ fmi3Status fmi3SetUInt64(
 {
     const auto component = reinterpret_cast<Component*>(c);
     try {
-        component->slave->SetUInt64(vr, nvr, values);
+        component->slave->SetUInt64(vr, nvr, values, nValues);
         return fmi3OK;
     } catch (const cppfmu::FatalError& e) {
         component->logger.Log(fmi3Fatal, "", e.what());
@@ -515,7 +515,7 @@ fmi3Status fmi3SetBoolean(
 {
     const auto component = reinterpret_cast<Component*>(c);
     try {
-        component->slave->SetBoolean(vr, nvr, values);
+        component->slave->SetBoolean(vr, nvr, values, nValues);
         return fmi3OK;
     } catch (const cppfmu::FatalError& e) {
         component->logger.Log(fmi3Fatal, "", e.what());
@@ -535,7 +535,7 @@ fmi3Status fmi3SetString(
 {
     const auto component = reinterpret_cast<Component*>(c);
     try {
-        component->slave->SetString(vr, nvr, values);
+        component->slave->SetString(vr, nvr, values, nValues);
         return fmi3OK;
     } catch (const cppfmu::FatalError& e) {
         component->logger.Log(fmi3Fatal, "", e.what());