scinim / fmu.nim

create your own multiplatform FMU (Functional Mock-up Interface) models with Nim

scinim

The core types and functions of the SciNim ecosystem

fmu.nim's Issues

replace `ptr fmi2EventInfo` with something safer

Fully create `modelDescription.xml`

The file modelDescription.xml:

<?xml version="1.0" encoding="UTF-8" ?>
<fmiModelDescription guid="{8c4e810f-3df3-4a00-8276-176fa3c9f008}" 
                     numberOfEventIndicators="0" 
                     modelName="inc" 
                     fmiVersion="2.0">
  <ModelExchange modelIdentifier="inc">
    <SourceFiles>
      <File name="inc.c" />
    </SourceFiles>
  </ModelExchange>
  <LogCategories>
    <Category name="logAll" />
    <Category name="logError" />
    <Category name="logFmiCall" />
    <Category name="logEvent" />
  </LogCategories>
  <ModelVariables>
    <ScalarVariable variability="discrete" 
                    valueReference="0" 
                    description="counts the seconds" 
                    causality="output" 
                    initial="exact" 
                    name="counter">
      <Integer start="1" />
    </ScalarVariable>
  </ModelVariables>
  <ModelStructure>
    <Outputs>
      <Unknown index="1" />
    </Outputs>
  </ModelStructure>
</fmiModelDescription>

DISABLE_PREFIX

This is used in C compilation. For nim, we should tweak the exportc.

Split the model for calculations and for model configuration

In the code, the API instantiates comp.

A similar instance is created at start here. This one is used in order to create the XML. This is a bit misleading.

I think it is better to create the second one in an explicit manner for each model.

Provide documentation for the creation of the FMU

Currently it is hardcoded the reference to index.html.

Make it more flexible.

Support co-simulation

Co-simulation is not yet supported

Create XML file

Create the XML file using Nim.

Create folder structure

Create the folder structure using Nim rather than resusing the structure created by fmusdk

FMU build process in Nim

Create the build process in Nim, instead of depending on the build.sh file

Compile with zig

It would be great being able to create multiplatform FMU's using zig for compilation.

Provide an icon/symbol for the model

The symbol is hardcoded here.

.fmu file not working with OpenModelica

Using OMEdityou can import the model. Later you can instantiate it in a new model. The simulation raises:

Fallo en el proceso
[INFO][inc] [logFmiCall][FMU status:OK] fmi2Instantiate: GUID={8c4e810f-3df3-4a00-8276-176fa3c9f008} SIGSEGV: Illegal storage access. (Attempt to read from nil?) 
Fallo en el proceso Simulation process failed. Exited with code 11.

Remove the includes

Convert the includes into imports, in order to make it behave more like a library.

componentEnvironment not being propagated

When the model is instantiated, componentEnvironment is passed by the simulation environment ħere as we can see in the this type declaration: fmi2CallbackFunctions.

The issue is clear when tested by fmuChecked.linux64:

[ERROR][FMUCHK] FMU logger callback does not propagate component environment to the application

The issue is that, for some reason, functions.componentEnvironment == nil in fmi2Instantiate.

Solve the FIXME notes across the source code

Convert into a library - move inc.nim into examples

Provide source code

The reference to the source code is hard coded. It should be optional.

[ERROR][FMUCHK] FMU logger callback does not propagate component environment to the application

This error is reported by fmuCheck.linux64. The issue seems to be here.