OMFrontend.jl

Experimental implementation of NF. That is a Modelica frontend in Julia.

For the entire suite of software components that make up this compiler see OpenModelica.jl

Notes regarding the first public release

This should be considered an alpha. This means that changes may happen quickly, and that they might be breaking.

Example use

Assuming you have the following Modelica model:

model HelloWorld
  Real x( start = 1, fixed = true );
  parameter Real a = 1;
equation
  der(x) = - a * x;
end HelloWorld;

You can use the API in the following way (Assuming the file is in the active directory):

import OMFrontend
modelFile = "HelloWorld.mo"
modelName = "HelloWorld"
p = OMFrontend.parseFile(modelFile)
scodeProgram = OMFrontend.translateToSCode(p);
(FM, cache) = OMFrontend.instantiateSCodeToFM(modelName, scodeProgram);
OMFrontend.toString(FM)

This should result in the following string representation of FlatModelica:

"class HelloWorld\n  Real x(fixed = true, start = 1.0);\n  parameter Real a = 1.0;\nequation\n  der(x) = -a * x;\nend HelloWorld;\n"

Note: In this case the flat Modelica code is almost indentical to the original model.

Representation

This particular model uses the FlatModelica datastructure. An alternative is to use the DAE datastructure defined by DAE.jl

Other API functions

There is also an API defined for using libraries, however, as of this writing the documentations for these procedures are not yet finalized and is subject to change. If you are a developer please see OMFrontend.jl/src/OMFrontend.jl for the other methods.

Issues/Questions

For any questions or ideas on how we could collaborate on something please see my LiU email at my page LiU-page