ntnu-ihb / fmi4j Goto Github PK

FMI4j is a software package for dealing with Functional Mockup Units (FMUs) on the JVM

License: MIT License

Java 46.79% Kotlin 38.85% C++ 10.60% C 3.75%

fmi-standard fmi java co-simulation model-exchange fmu kotlin

fmi4j's Introduction

FMI4j

FMI4j is a software package for dealing with Functional Mock-up Units (FMUs) on the Java Virtual Machine (JVM), written in Kotlin.

FMI4j supports import of both FMI 1.0 and 2.0 for Co-simulation. For Model Exchange version 2.0 is supported.

Compared to other FMI libraries targeting the JVM, FMI4j is considerably faster due to the fact that we use JNI instead of JNA. Considering FMI-import, a significant speedup (2-5x) compared to other open-source FMI implementations for the JVM should be expected.

Maven artifacts are available through Central

FMI import

class Demo {
    
    void main(String[] args) {
        
        Fmu fmu = Fmu.from(new File("path/to/fmu.fmu")); //URLs are also supported
        FmuSlave slave = fmu.asCoSimulationFmu().newInstance();

        slave.simpleSetup();
        
        double t = 0;
        double stop = 10;
        double stepSize = 1.0/100;
        while(t <= stop) {
            if (!slave.doStep(t, stepSize)) {
                break;
            }
            t += stepSize;
        }
        slave.terminate(); //or close, try with resources is also supported
        fmu.close();
        
    }
    
}

Would you rather build FMUs using a JVM language? Check out FMU4j!
Or maybe build FMUs using Python? Check out PythonFMU!
Or would you rather simulate FMUs using C++? Check out FMI4cpp!
Need to distribute your FMUs? FMU-proxy to the rescue!
Need a complete co-simulation framework with SSP support? Check out Vico

fmi4j's People

Contributors

Stargazers

Watchers

Forkers

fmi-tools gitter-badger eidekrist jfulem peterjaw devotionzhu sourceindex20 sfi-mechatronics lsy234009 sacharya21 oi-93 fdzhang mfkiwl ljb-ljb foolbrid pl1024

fmi4j's Issues

The System Could Not Find The Specified Path

I was using the FMI4J toolkit on a project, but I had a problem using it. It worked fine in debug mode and threw exceptions when calling methods. I thought I was unzipping the FMU files in an asynchronous manner, was that right?

Generate FMU from kotlin script

Should investigate if it would be possible to generate an FMU from a kotlin script. This would be immensely powerful.

Support C-code FMUs

Would be a nice feature to have. Should not be to difficult when following the steps used for fmu2jar (create gradle skeleton -> copy sources -> run )

FMU export is broken. Need to revert to JAXB..

Jackson is unable to serve the same use-case as JAXB is capable of.. Supporting JDK9+ is an issue..

Bintray is shutting down -> find replacement

Avoid using reflection in fmi-export

(But keep annotation based system)

Setting start should return FmiStatus

Migrate to kotlin dsl

Replace groovy dsl with kotlin dsl for gradle scripts

Real attribute 'relativeQuantity' should be of type boolean

FMI 1.0 import crashes on linux

Feedback from users

Hi,
I would very much like to hear from you, the person reading this.
Why are you interested in this project, have you tried it?
What is unclear, what can be improved?

Note that it is also possible to chat on gitter!

ValueReference is only unique within in a base class

I thought a valueReference was a unique identifier to scalarVariable (or a list of scalarVariable that are aliases). But it seems you can have the same valueReference for a integer/real/boolean/string/enumeration.

That means the getByValueReference function is wrong, as it will return the first occurence.

Discontinue gradle plugin

Unless someone is using this feature, it is not worth the maintenance effort.

Bulk read and write

Create function for reading and writing all types at once

Generate cross-check results

Generate cross-check results and upload them to https://github.com/modelica/fmi-cross-check

Export java code as Co-Simulation FMUs

In the future it should be possible to export Co-Simulation FMUs using FMI4j

Java. IO. FileNotFoundException

Lars, I'm back.In the use of [Fmu.from (java.net.URL)] tries to use nginx build file server load Fmu file, throws Exception[Java. IO. FileNotFoundException:C:\Users\Mr.Liu\AppData\Local\Temp\fmi4j_22DAB33C64C553D3AC12677C4AEDE2365354478909019804419\modelDescription.XML], I don't know thisTry to see if this method is correct or give me a little hint about how to use it.Thank you very much!

Lack of informations about Getting Started

I'm currently trying to make FMI4j work on a sample project.

I encounter some Symbol resolution from examples provided in the Wiki.

My sample app :

import no.mechatronics.sfi.fmi4j.common.FmiStatus;
import no.mechatronics.sfi.fmi4j.modeldescription.variables.RealVariable;

import java.io.File;

/**
 * Hello world!
 *
 */
public class App 
{
    public static void main( String[] args )
    {
        Fmu fmu = Fmu.from(new File("path/to/fmu.fmu")); // Fmu class not found
        try(FmiSimulation instance = fmu.asCoSimulationFmu().newInstance()) { // FmiSimulation class not found

            RealVariable myVar = instance.getVariableByName("myVar").asRealVariable()

            //assign custom start values
            myVar.setStart(2d);

            instance.init(); //throws on error

            double myValue = myVar.read().getValue(); //read
            FmiStatus status = myVar.write(5d); //write

            double dt = 1d/100;
            while (instance.getCurrentTime() < 10) {
                instance.doStep(dt);
            }

        } //instance is termi
    }
}

My pom.xml :

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>

  <groupId>com.someone</groupId>
  <artifactId>javafmi</artifactId>
  <version>0.1</version>
  <packaging>jar</packaging>

  <name>javafmi</name>
  <url>http://maven.apache.org</url>

  <properties>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  </properties>

  <dependencies>
    <dependency>
      <groupId>no.mechatronics.sfi.fmi4j</groupId>
      <artifactId>fmi-md</artifactId>
      <version>0.5.7</version>
    </dependency>

    <dependency>
      <groupId>junit</groupId>
      <artifactId>junit</artifactId>
      <version>3.8.1</version>
      <scope>test</scope>
    </dependency>
  </dependencies>
</project>

Have you any tips on how to make it work ?

Thanks in advance !

Consider using GraalVM

GraalVM would allow faster execution than JNI can provide and exported FMUs would not require a JVM to run.

Support reset in exporter

How to use Jars

HI Lars！I generated some JAR packages using the command (./gradlew installDist), but I don't know how to use it. Could you please provide me with an example or some operation description?Thanks！

Document Gradle fmu-export plugin

Discontinue fmu2jar

Consider generate xml classes from xsd using JAXB

Add task for cleaning the temp dir for any leftover files/folders

In cases where FMI4j would crash, it is unable to delete any temp dir/files it has created.

A gradle task should be added that will check the temp dir for any leftover fles and delete them.

0.25.0 version

Souldn't build.gradle contain version = '0.25.0'?

Move JNI code into it's own subproject

Migrate to the new cpp-library plugin for compiling JNI code

Incorrect initialization sequence of FMI 1.0 slaves

The FMI 2.0 initialization flow goes like this:

fmi2Instantiate()
fmi2SetupExperiment()
fmi2EnterInitializationMode()
fmi2SetXXX()
fmi2ExitInitializationMode()

while for FMI 1.0, the flow goes like this:

fmiInstantiateSlave()
fmiSetXXX()
fmiInitializeSlave()

FMI4J's fmi-import initialization sequence is based on FMI 2.0, with separate functions [setup(), enterInitializationMode(), exitInitializationMode()] which are adapted to the FMI 1.0 intialization sequence. For FMI 1.0 slaves, in order to allow calls to setXXX() BEFORE fmiInitializeSlave() is called, the call to fmiInitializeSlave() should be moved from setup() to exitInitializationMode().

Improve cross-checker to support fmus with inputs

Currently, FMUs that require inputs to be set (*_in-csv) is left out of the cross-check.

Replace JNA with JNI

Replace JNA with JNI for performance reasons.

Strict mode

Make it possible to enable/disable strict mode.
In strict mode, a call not compliant withthe state machine defined by the standard will fail fast

v0.19.0 can't be built by jitpack

FAILURE: Build failed with an exception.

What went wrong:
Execution failed for task ':fmi-native:compileReleaseLinuxX86-64Cpp'.

No tool chain is available to build C++ for host operating system 'Linux' architecture 'x86-64':
- Tool chain 'visualCpp' (Visual Studio):
- Visual Studio is not available on this operating system.
- Tool chain 'gcc' (GNU GCC):
- Could not find C++ compiler 'g++' in system path.
- Tool chain 'clang' (Clang):
- Could not find C++ compiler 'clang++' in system path.

Make Gradle plugin for FMI export

Support JDK > 1.8

Participation in FMI Cross-Check

It would be highly beneficial if FMI4j would participate in the FMI Cross Check https://github.com/modelica/fmi-cross-check. For many tools this has significantly improved the maturity of their FMI support.

Remove ME wrapper

Create Gradle plugin for FMUs

Create a plugin which automatically generates source code for an FMU

A FMU named "ControlledTemperature.fmu" which is located in src/main/fmu" will have a class file ControlledTemperature.kt with named getters and setter for all variables.

This is similar to Fmu2Jar expect that it will be MUCH easier to use.