JModelica.org
User Guide

Version 1.12

2014-01-17


Acknowledgements

This document is produced with DocBook 5 using XMLMind XML Editor for authoring, Norman Walsh's XSL stylesheets and a GNOME xsltproc + Apache fop toolchain. Math contents is converted from LaTeX using the TeX/LaTeX to MathML Online Translator by the Ontario Research Centre for Computer Algebra and processed by JEuclid.

Table of Contents

1. Introduction
1. About JModelica.org
2. Mission Statement
3. Technology
4. Architecture
5. Extensibility
2. Installation
1. Supported platforms
2. Installation on Windows
2.1. Dependencies
2.2. Installation
2.3. Verifying the installation
2.4. Compilation from sources
3. Installation on Linux systems
3.1. Prerequisites
3.1.1. Installing pre-compiled packages
3.1.2. Compiling Ipopt
3.2. Compiling
3.3. Testing JModelica.org
3. Getting started
1. The JModelica.org Python packages
2. Starting a Python session
2.1. Windows
2.2. Linux or Mac OS
3. Run an example
4. Check your installation
5. Redefining the JModelica.org environment
5.1. Example redefining IPOPT_HOME
6. The JModelica.org user forum
4. Working with Models
1. Introduction to models
1.1. The different model objects in JModelica.org
2. Compilation
2.1. Simple FMU-ME compilation example
2.2. Simple FMU-CS compilation example
2.3. Simple JMU compilation example
2.4. Simple FMUX compilation example
2.5. Compiling from libraries
2.6. Compiler settings
2.6.1. compile_fmu parameters
2.6.2. Compiler options
2.7. Compile in separate process
2.8. Compilation in more detail
2.8.1. Create a compiler
2.8.2. Source tree generation and flattening
2.8.3. Code generation
3. Loading models
3.1. The FMU
3.2. The JMU
3.3. The FMUX
3.4. Loading an FMU
3.5. Loading a JMU
3.6. Loading an FMUX
4. Changing model parameters
4.1. Setting and getting parameters
5. Debugging models
5.1. Compiler logging
5.2. Runtime logging
5.2.1. Setting log level
5.2.2. Interpreting logs from JModelica.org
5.3. Getting HTML diagnostics
5. Simulation of FMUs
1. Introduction
2. A first example
3. Simulation of Models
3.1. Convenience method, load_fmu
3.2. Arguments
3.2.1. Input
3.2.2. Options for FMUModelME1 and FMUModelME2
3.2.3. Options for FMUModelCS1 and FMUModelCS2
3.3. Return argument
4. Examples
4.1. Simulation of a high-index model
4.2. Simulation and parameter sweeps
4.3. Simulation using the native FMI interface
4.3.1. Implementation
4.4. Simulation of Co-Simulation FMUs
6. Initialization and simulation of JMUs
1. Introduction
2. Initialization of JMUs
2.1. Solving DAE initialization problems
2.2. How JModelica.org creates the initialization system of equations
2.3. Initialization algorithms
2.3.1. Initialization using IPOPT
2.3.2. Initialization using KInitSolveAlg
3. Simulation of JMUs
3.1. The simulate function
3.1.1. Input
3.1.2. Options for JMUModel
3.1.3. Return argument
3.2. Examples
3.2.1. Simulation with inputs
3.2.2. Simulation of a discontinuous system
3.2.3. Simulation with sensitivities
7. Optimization
1. Introduction
2. A first example
3. Solving optimization problems
4. Scaling
5. Dynamic optimization of DAEs using direct collocation with JMUs
5.1. Examples
5.1.1. Optimal control
5.1.2. Minimum time problems
5.1.3. Parameter optimization
6. Dynamic optimization of DAEs using direct collocation with CasADi
6.1. Algorithm overview
6.2. Examples
6.2.1. Optimal control
7. Optimization of ODEs using Pseduo-Spectral methods
7.1. Options
7.2. Examples
7.2.1. Van der Pol oscillator
7.2.2. Hohmann Transfer
7.3. Limitations
8. Derivative-Free Model Calibration of FMUs
8. Graphical User Interface for Visualization of Results
1. Plot GUI
1.1. Introduction
1.2. Edit Options
1.3. View Options
1.4. Example
9. Hand Guided Tearing
1. Options Flags
2. Identification of Equations
2.1. Syntax
2.2. Example
3. Specification of Hand Guided Tearing
3.1. Paired Tearing
3.1.1. Specify Tearing Pairs on Component Level
3.1.2. Specify Tearing Pairs on System Level
3.2. Unpaired Tearing
3.2.1. Specify an Equation as Unpaired Residual Equation
3.2.2. Specify a Variable as Unpaired Iteration Variable
10. Optimica
1. A new specialized class: optimization
2. Attributes for the built in class Real
3. A Function for accessing instant values of a variable
4. Class attributes
5. Constraints
11. Abstract syntax tree access
1. Tutorial on Abstract Syntax Trees (ASTs)
1.1. About Abstract Syntax Trees
1.2. Load the Modelica standard library
1.3. Count the number of classes in the Modelica standard library
1.4. Dump the instance AST
1.5. Flattening of the filter model
12. Limitations
A. Release notes
1. Release notes for JModelica.org version 1.12
1.1. Highlights
1.2. Compilers
1.3. Simulation
1.4. Contributors
1.4.1. Previous contributors
2. Release notes for JModelica.org version 1.11
2.1. Highlights
2.2. Compilers
2.3. Simulation
2.3.1. Runtime logging
2.3.2. Support for ModelicaError and assert
2.4. Contributors
2.4.1. Previous contributors
3. Release notes for JModelica.org version 1.10
3.1. Highlights
3.2. Compilers
3.2.1. Export of FMUs for Co-Simulation
3.3. Python
3.3.1. Improved result data access
3.3.2. Improved error handling
3.3.3. Parsing of FMU log files
3.4. Simulation
3.4.1. Support for FMU version 2.0b4
3.4.2. Result filter
3.4.3. Improved solver support
3.5. Optimization
3.5.1. Improved variable scaling
3.5.2. Improved handling of measurement data
3.6. Contributors
3.6.1. Previous contributors
4. Release notes for JModelica.org version 1.9.1
5. Release notes for JModelica.org version 1.9
5.1. Highlights
5.2. Compilers
5.2.1. Improved Modelica compliance
5.2.2. Support for MSL CombiTables
5.2.3. Support for hand guided tearing
5.2.4. Improved function inlining
5.2.5. Memory and execution time improvements in the compiler
5.3. Python
5.3.1. Compile in separate process
5.4. Simulation
5.4.1. Simulation of co-simulation FMUs
5.5. Optimization
5.5.1. Improvements to CasADi-based collocation algorithm
5.6. Contributors
5.6.1. Previous contributors
6. Release notes for JModelica.org version 1.8.1
7. Release notes for JModelica.org version 1.8
7.1. Highlights
7.2. Compilers
7.2.1. Improved Modelica compliance
7.2.2. Function inlining
7.2.3. New state selection algorithm
7.3. Python
7.3.1. Simplified compiling with libraries
7.4. Optimization
7.4.1. Improvements to CasADi-based collocation algorithm
7.5. Contributors
7.5.1. Previous contributors
8. Release notes for JModelica.org version 1.7
8.1. Highlights
8.2. Compilers
8.2.1. Support for mixed systems of equations
8.2.2. Support for tearing
8.2.3. Improved Modelica compliance
8.2.4. Function inlining
8.3. Python
8.3.1. New package structure
8.3.2. Support for shared libraries in FMUs
8.4. Simulation
8.4.1. Simulation of hybrid systems
8.5. Optimization
8.5.1. A novel CasADi-based collocation algorithm
8.6. Contributors
8.6.1. Previous contributors
9. Release notes for JModelica.org version 1.6
9.1. Highlights
9.2. Compilers
9.2.1. Index reduction
9.2.2. Modelica compliance
9.3. Python
9.3.1. Graphical user interface for visualization of simulation and optimization results
9.3.2. Simulation with function inputs
9.3.3. Compilation of XML models
9.3.4. Python version upgrade
9.4. Optimization
9.4.1. Derivative- free optimization of FMUs
9.4.2. Pseudo spectral methods for dynamic optimization
9.5. Eclipse Modelica plugin
9.6. Contributors
9.6.1. Previous contributors
10. Release notes for JModelica.org version 1.5
10.1. Highlights
10.2. Compilers
10.2.1. When clauses
10.2.2. Equation sorting
10.2.3. Connections
10.2.4. Eclipse IDE
10.2.5. Miscellaneous
10.3. Simulation
10.3.1. FMU export
10.3.2. Simulation of ODEs
10.3.3. Simulation of hybrid and sampled systems
10.4. Initialization of DAEs
10.5. Optimization
10.6. Contributors
10.6.1. Previous contributors
11. Release notes for JModelica.org version 1.4
11.1. Highlights
11.2. Compilers
11.2.1. Enumerations
11.2.2. Miscellaneous
11.2.3. Improved reporting of structural singularities
11.2.4. Automatic addition of initial equations
11.3. Python interface
11.3.1. Models
11.3.2. Compiling
11.3.3. initialize, simulate and optimize
11.3.4. Result object
11.4. Simulation
11.4.1. Input trajectories
11.4.2. Sensitivity calculations
11.4.3. Write scaled simulation result to file
11.5. Contributors
11.5.1. Previous contributors
12. Release notes for JModelica.org version 1.3
12.1. Highlights
12.2. Compilers
12.2.1. The Modelica compiler
12.2.2. The Optimica compiler
12.3. JModelica.org Model Interface (JMI)
12.3.1. The collocation optimization algorithm
12.4. Assimulo
12.5. FMI compliance
12.6. XML model export
12.6.1. noEvent operator
12.6.2. static attribute
12.7. Python integration
12.7.1. High-level functions
12.7.2. File I/O
12.8. Contributors
12.8.1. Previous contributors
13. Release notes for JModelica.org version 1.2
13.1. Highlights
13.2. Compilers
13.2.1. The Modelica compiler
13.2.2. The Optimica Compiler
13.3. The JModelica.org Model Interface (JMI)
13.3.1. General
13.4. The collocation optimization algorithm
13.4.1. Piecewise constant control signals
13.4.2. Free initial conditions allowed
13.4.3. Dens output of optimization result
13.5. New simulation package: Assimulo
13.6. FMI compliance
13.7. XML model export
13.8. Python integration
13.8.1. New high-level functions for optimization and simulation
13.9. Contributors
13.9.1. Previous contributors
Bibliography

List of Figures

1.1. JModelica.org platform architecture.
2.1. Selecting Python packages in the Choose components window.
5.1. Simulation result of the Van der Pol oscillator.
5.2. Modelica.Mechanics.Rotational.First connection diagram
5.3. Simulation result for Modelica.Mechanics.Rotational.Examples.First
5.4. Simulation result-phase plane
5.5. Simulation result
5.6. Simulation result
6.1. A schematic picture of the quadruple tank process.
6.2. Tank levels
6.3. Input trajectories
6.4. Electric Circuit
6.5. Simulation result
6.6. Sensitivity results.
7.1. Optimal profiles for the VDP oscillator
7.2. Optimal profiles for the CSTR problem.
7.3. Optimal control profiles and simulated trajectories corresponding to the optimal control input.
7.4. Minimum time profiles for the Van der Pol Oscillator.
7.5. A schematic picture of the quadruple tank process.
7.6. Measured state profiles.
7.7. Control inputs used in the identification experiment.
7.8. Simulation result for the nominal model.
7.9. State profiles corresponding to estimated values of a1 and a2.
7.10. State profiles corresponding to estimated values of a1, a2, a3 and a4.
7.11. Handling of discontinuities.
7.12. The Van der Pol oscillator optimized using Gauss PseudoSpectral method.
7.13. Hohmann Transfer
7.14. The Furuta pendulum.
7.15. Measurements of Measurements of and for the Furuta pendulum. and Measurements of and for the Furuta pendulum. for the Furuta pendulum.
7.16. Measurements and model simulation result for Measurements and model simulation result for and when using nominal parameter values in the Furuta pendulum model. and Measurements and model simulation result for and when using nominal parameter values in the Furuta pendulum model. when using nominal parameter values in the Furuta pendulum model.
7.17. Measurements and model simulation results for Measurements and model simulation results for and with nominal and optimal parameters in the model of the Furuta pendulum. and Measurements and model simulation results for and with nominal and optimal parameters in the model of the Furuta pendulum. with nominal and optimal parameters in the model of the Furuta pendulum.
8.1. Overview of JModelica.org Plot GUI
8.2. A result file has been loaded.
8.3. Plotting a trajectory.
8.4. Figure Options.
8.5. Figure Axis and Labels Options.
8.6. Figure Lines and Legends options.
8.7. An additional plot has been added.
8.8. Moving Plot Figure.
8.9. GUI after moving the plot window.
8.10. Complex Figure Layout.
8.11. Figure View Options.
8.12. Multiple figure example.
10.1. Optimization result

List of Tables

2.1. Package versions for Ubuntu
4.1. Compiler options
5.1. General options for AssimuloFMIAlg.
5.2. Selection of solver arguments for CVode
5.3. General options for FMICSAlg.
5.4. Result Object
6.1. Options for the collocation-based optimization algorithm
6.2. Options for KInitSolveAlg
6.3. Options for KINSOL contained in the KINSOL_options dictionary
6.4. Values allowed in the constraints array
6.5. Verbosity levels in KINSOL
6.6. General options for AssimuloAlg.
6.7. Selection of solver arguments for CVode
6.8. Selection of solver arguments for IDA
6.9. Result Object
7.1. Options for the JMU and collocation-based optimization algorithm
7.2. Parameters for the quadruple tank process.
7.3. Options for the CasADi and collocation-based optimization algorithm
7.4. Options for the Pseudospectral optimization algorithms.