Modelica Documentation

This is a listing of builtin Modelica functions, miscellaneous Modelica libraries stored in a git repository. There is also documentation for OpenModelica-specific scripting.

Note that not all libraries are supported or have been tested. Feel free to add bug reports either to OpenModelica (for compiler bugs) or to the GitHub projects for enhancements or bugs in the libraries. Older libraries may contain broken links and images (only libraries with modelica:// links produce good documentation). The Modelica Standard Library is the best supported package in OpenModelica.

Libraries

Name Description Version
 ADGenKinetics Implementation of generalized kinetics for modeling biochemical reaction networks
 ADMSL
 AES
ATplus
 AdvancedNoise A library with additional noise modules compatible to the Modelica standard library 1.2.0
 AixLib 2.1.1
 AlgebraTestSuite Nonlinear algebraic equation system benchmarks
 Annex60 Library with models for building energy and control systems 1.0.0
 ApproxSpline Approximation spline library 1.0.1
 Arduino Library to simulate sketches on a virtual Arduino Uno and to connect models to real-world circuits using the Firmata protocol 0.3.0
AssertionLevel
 BLDC Brushless DC drives 1.9.0
 BidiDCDC Bidirectional DC/DC converter 1.0.0
 BikeTrailer Modeling an electrically driven bike trailer 1.3.0
 BioChem 1.1.2
 BondGraph
 BondLib Modelica library for Bond Graph modeling 2.3
 BoundaryInitBlocks 1.0.0
 BuildSysPro EDF's Modelica library for modelling buildings and energy systems 3.6.0
 BuildingControlLib Library for building control 0.1.0
 BuildingSystems Library for building energy and plant simulation 2.0.0-beta
 Buildings Library with models for building energy and control systems 12.1.0
 BusinessSimulation Dynamic modeling for business, economics, and ecology 2.2.0
 CRML
 CRMLtoModelica
 ChaoticCircuits 2.4.0
 Chemical Chemical pathways 2.0.0
 ClaRa Simulation of Clausius-Rankine Cycles 1.9.0
 ClaRa_Obsolete ClaRa obsolete models package 1.9.0
Clock
 Complex Complex number with overloaded operators 4.1.0
 ComplexLib Library for steady-state analysis of AC circuits within phasor domain, version 1.0
 ConPNlib
Connections
Correlation defines correlation between two uncertainty variables
 Credibility Credibility Library 0.3.0
 DESLib 1
 DataFiles Functions for reading and writing data files (empty version) 0.0.0
 DeltaRobot Library for modelling of Delta Robots 1.0.2
 DeployStructLib
 Design Design (empty version) 0.0.0
 DisHeatLib 1.2
Distribution
 DriveControl Library to demonstrate control of electrical drives 4.1.0
 DrivingCycles Driving cycles of vehicles 0.1.0
 DroneLibrary Modelica libray to model drones(UAVs) 1.0.0
 DymolaCommands DymolaCommands (empty version) 0.0.0
DynamicSelect select static or dynamic expressions in the annotations
 Dynawo Dynawo models library 1.7.0
 EHPTexamples Package containing basic EV models
 EHPTlib Electric and Hybrid Power train library Rev Jan 2023 3.0.0
 EMOTH Electric Mobility OTH 1.9.0
 ElectricBraking Electric braking using electric machines 1.0.0
 ElectricalEnergyStorage Library for electric energy storages 3.2.2
 ElectroMechanicalDrives Library for the simulation of electro mechanical drives and vehicles 3.0.0
 ExtendedPetriNets Library to model timed, stochastic Petri nets and state transition diagrams, extended version.
 ExternData Library for data I/O of CSV, INI, JSON, MATLAB MAT, SSV, TIR, Excel XLS/XLSX or XML files 3.2.0
 ExternalLibrary
 ExternalMedia 4.0.0
 ExternalMemoryLib
ExternalObject
 ExtremumSeeking 0.9.0
 FCSys Modelica fuel cell library 0.2.6
 FCSysTest Library to test components of FCSys
 FMITest Library of models to test connected FMUs in a Modelica tool
 FailureModes A collection of examples of failure modes for Modelica models 2.0.0
 FastBuildings Low order building simulation models 0.0
 FaultTriggering Library for Fault Triggering 0.6.6
 FeedDriveLibrary
 Flight
 FluxTubesExtension Extension of the Magnetic.FluxTubes package 1.2.0
 FractionalOrder
 FreeFluids FreeFluids.mo by Carlos Trujillo This file is part of the Free Fluids application Copyright (C) 2008-2024 Carlos Trujillo Gonzalez This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License version 3 as published by the Free Software Foundation This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. 4.7.2
FuelCellLib
FuzzyControl
 GNU_ScientificLibrary 1.1.2
 Greenhouses The Greenhouses Modelica Library 1
 HanserModelica Educational open source library on <html><a href="https://www.hanser-fachbuch.de/buch/Modelica+Objektorientierte+Modellbildung+von+Drehfeldmaschinen/9783446455511">Modelica, electrical engineering and polyphase electrical machines</a></html> 2.0.1
 HelmholtzMedia Data and models of real pure fluids (liquid, two-phase and gas) 2.1.0
 IBPSA Library with models for building energy and control systems 3.0.0
 IDEAS Integrated District Energy Assessment Simulation 3.0.0
 Icons Icons
 IdealizedContact idealized contact models for simple surfaces 0.1.0
 IndustrialControlSystems Modelica Industrial Control Systems Library 2.0.0
 KeyWordIO Read and write data files with key words 0.12.1
 LEPSE
 LargeTestSuite Library for testing of very large models 2.2.0
 LibRAS
 LinearMPC Modelica predictive control library (by the Institute of Automatic Control, RWTH Aachen University) 1
 MEV Models of the Multiple Emergency Ventilator 1.1.1
 MVEMLib 1.0.1
 MagLev MagneticLevitation 2.3.0
 ManualTracking Modelica manual tracking library
 MessagePack MessagePack is an efficient binary serialization format for multiple languages. 0.1.1
 ModPowerSystems
 ModelManagement ModelManagement (empty version) 0.0.0
 Modelica Modelica Standard Library 4.1.0
 ModelicaADS Library for socket communication in Modelica using the ADS protocol (infosys.beckhoff.com)
ModelicaAdditions Collection of Modelica libraries of DLR 1.5
 ModelicaByExample 0.5.0
 ModelicaCompliance A semantics compliance suite for the Modelica language 3.2
 ModelicaDEVS Discrete Event Systems Library 1
 ModelicaReference Modelica Reference 4.1.0
 ModelicaServices ModelicaServices (OpenModelica implementation) - Models and functions used in the Modelica Standard Library requiring a tool specific implementation 4.1.0
 ModelicaTableAdditions Extension of the CombiTable blocks of the Modelica Standard Library to additionally support reading CSV, EPW (EnergyPlus Weather) and JSON files 3.2.1
 ModelicaTest Library to test components of package Modelica 4.1.0
 ModelicaTestOverdetermined 4.1.0
 Modelica_DeviceDrivers Modelica_DeviceDrivers - A collection of drivers interfacing hardware like input devices, communication devices, shared memory, analog-digital converters and else 2.2.0
 Modelica_LinearSystems2 Modelica_LinearSystems2 (version 3.0.1) - Analysis, Synthesis and Modeling of Continuous and Discrete Linear Systems 3.0.1
 Modelica_Noise Modelica_Noise version 1.0-Beta.1 (Library for random numbers and noise signals; now included in the Modelica Standard Library 3.2.2) 1.0 Beta.1
 Modelica_Requirements Modelica_Requirements (Version 0.6) - Defining requirements formally and checking them when simulating 0.7
 Modelica_StateGraph2 Modelica_StateGraph2 (Version 2.1.1) - Modeling of continuous-time state machines 2.1.1
 Modelica_Synchronous Modelica_Synchronous (version 0.93.0) - Basic synchronous input/output control blocks that are triggered by clocks 0.93.0
 MultiPhaseMixture 1.0.0
 NcDataReader2 Library to read interpolated data from netCDF files and DAP servers 2.5.0
 NeuralNetwork 2.1.0
 Noise An open Library for the Generation of Stochastic Signals in Modelica 0.2
 Nuclear nuclear reactor simulations
OMC_ARGS
OMC_CLOCK
OMC_NO_ARGS
OMC_NO_CLOCK
 ObjectStab ObjectStab - A Modelica Library for Power System Stability Studies 2.0.0
 ObsoleteModelica3 Library that contains components from Modelica Standard Library 2.2.2 that have been removed from version 3.0 3.2.3
 ObsoleteModelica4 Library that contains components from Modelica Standard Library 3.2.3 that have been removed from version 4.0.0 4.1.0
 OpenBLDC Simulation base package
 OpenFDM
 OpenHPL Open-source hydropower library 3.0.1
 OpenHydraulics A free Modelica library that can be used to model hydraulic components and circuits. 2.0.0
 OpenIMDML Open Instance Multi-Domain Machine Library using Modelica 1
 OpenIPSL Open-Instance Power System Library 3.1.0
OpenModelica OpenModelica internal definitions and scripting functions OpenModelica 1.26.3
 OpenModelica_Microgrids
 Optimisers Model-based optimisation library 0.1
 PDE
 PJLoeslib
 PJlib
 PLL Phase Locked Loops for inverter applications 1.0.1
 PNlib 3.0.0
 PVSystems A Modelica library for photovoltaic system and power converter design 0.6.2
PVlib Photovoltaics library 0.4
 Pharmacolibrary Modelica library for Pharmacokinetics, Pharmacodynamics and Pharmacogenomics (v25.09) 25.09
 PhotoVoltaics 2.1.0
 PhotoVoltaics_TGM 2.1.0
 Physiolibrary System biology, integrative physiology and pathophysiology modelling library 3.0.0
 Physiomodel Mammalian physiology model 1.0.0
 PlanarMechanics Library to model 2-dimensional, planar mechanical systems 1.6.0
 PowerGrids 1.0.3
 PowerSysPro 2.1.3
 PowerSystems Library for electrical power systems 2.0.0
 PraxisSimulationstechnik Library of example and solution models from Peter Junglas' book "Praxis der Simulationstechnik"
 PropulsionSystem
 QCalc Modelica units based on quantity calculus
 QCalcTests Tests for QCalc
QSSFluidFlow Library for modeling of quasi-steady-state fluid flow with constant fluid density.
 RealTimeCoordinationLibrary Components for defining clocks, time constraints, and invariants. 1.0.2
 RotorAeroLib
 SDF Scientific Data Format (empty version) 0.0.0
 SMArtIInt 0.1.1
 SMArtInt 0.3.1
 SMPS Building blocks for modeling of switched - mode power converters.
 SOFCPoliMi
 ScalableTestGrids 1.2.0
 ScalableTestSuite A library of scalable Modelica test models 2.2.0
 Servomechanisms Servomechanism
 SiemensPower SiemensPower 2.2
 SolarTherm 0.2
 Soltermica Solar thermal systems Modelica library
 Spot Power-systems SPOT 0.706.1
 SpotExamples Spot examples 0.706.1
StateSelect
 StewartPlatform Library for modelling of Stewart Platforms 1.0.2
 StreamConnectors A simple library to learn the basics of stream connectors
Subtask
 SystemDynamics System Dynamics Library 2.1.2
 TAeZoSysPro
 TAeZoSysPro_testsuite
 TILMedia TILMedia-Library with thermophysical properties of Fluids and Solids 1.9.0 ClaRa
 TILMedia_AddOn_Tests Library to test components of package TILMedia ClaRa 1.9.0 ClaRa
 TRANSFORM TRANSFORM - TRANsient Simulation Framework Of Reconfigurable Models 1.0
 ThermalSeparation Thermal Separation Library 0.2
 ThermoCycle A library for the simulation of thermal systems
 ThermoPower Open library for thermal power plant simulation 3.1
 ThermoSysPro 4.1
 ThermofluidStream Library for the modeling of thermofluid streams 1.2.0
 TransiEnt Library for transient simulation of integrated energy networks with a high share of renewable energies 2.0.2
 URDFModelica 0.3.4
Uncertainty
 UserInteraction UserInteraction (empty version) 0.0.0
 VVDRlib
 VehicleInterfaces VehicleInterfaces Library (Version 2.0.2) - Interface definitions and architectures for vehicle system modeling 2.0.2
 WasteWater Modelica WasteWater Library 2.1.0
 WaterHub Water-Energy Nexus library
 Wavelet Modelica Wavelet Library
 WindPowerPlants Library of wind power plants 2.0.0
 XogenyTest Stand-alone library to facilitate assertion-based testing of Modelica code 1.1
abs Absolute value
acos Inverse cosine (-1 <= u <= 1)
activeState Return true if instance of a state machine is active, otherwise false
actualStream
array Constructs an array
asin Inverse sine (-1 <= u <= 1)
assert Check an assertion condition
atan Inverse tangent
atan2 Four quadrant inverse tangent
backSample First activation of clock is shifted in time before activation of u Modelica 3.3
cardinality Number of connectors in connection Deprecated
cat Concatenate arrays along given dimension
ceil Round a real number towards plus infinity
change Indicate discrete variable changing
classDirectory Non-standard operator Dymola / MSL 2.2.1
cos Cosine
cosh Hyperbolic cosine
cross Cross product of two 3-vectors
delay Delay expression
der Derivative of the input expression
 dhcSim Extension library of Modelica Buildings Library for district heating and cooling components 1
diagonal Returns a diagonal matrix
div Integer part of a division of two Real numbers
edge Indicate rising edge
exp Exponential, base e
fill Returns an array with all elements equal
firstTick Returns the interval between the previous and present tick of the clock of its argument
floor Round a real number towards minus infinity
getInstanceName Modelica 3.3
hold Conversion from clocked discrete-time to continuous time Modelica 3.3
homotopy Homotopy operator actual*lambda + simplified*(1-lambda) Modelica 3.2
 iPSL iTesla Power System Library 1.1.0
identity Identity matrix of given size
inStream
initial True if in initialization phase
initialState Define inital state of a state machine
integer Returns the largest integer not greater than x. The argument shall have type Real. The result has type Integer. [Note, outside of a when-clause state events are triggered when the return value changes discontinuously.].
interval Returns the interval between the previous and present tick of the clock of its argument
linspace Real vector with equally spaced elements
log Natural (base e) logarithm (u shall be > 0)
log10 Base 10 logarithm (u shall be > 0)
matrix Returns the first two dimensions of an array as matrix
max
min
mod Integer modulus of a division of two Real numbers
ndims Number of array dimensions
noClock Clock of y=Clock(u) is always inferred Modelica 3.3
noEvent Turn off event triggering
ones Returns a one array
outerProduct Outer product of two vectors
pre Refer to left limit
previous Access previous value of a clocked variable Modelica 3.3
print Prints to stdout, useful for debugging. OpenModelica extension
product Product of all array elements
promote
pure Modelica 3.4
reinit Reinitialize state variable
rem Integer remainder of the division of two Real numbers
rooted
sample Returns the interval between the previous and present tick of the clock of its argument
scalar Returns a one-element array as scalar
semiLinear
shiftSample First activation of clock is shifted in time Modelica 3.3
sign Sign of real or integer number
sin Sine
sinh Hyperbolic sine
size Returns dimensions of an array
skew The skew matrix associated with the vector
smooth Indicate smoothness of expression
spatialDistribution Approximation of variable-speed transport of properties Modelica 3.3
sqrt Square root
subSample Conversion from faster clock to slower clock Modelica 3.3
sum Sum of all array elements
superSample Conversion from slower clock to faster clock Modelica 3.3
symmetric Returns a symmetric matrix
tan Tangent (u shall not be -pi/2, pi/2, 3*pi/2, ...)
tanh Hyperbolic tangent
terminal True after successful analysis
ticksInState Returns the number of clock ticks since a transition was made to the currently active state
timeInState Returns the time duration as Real in [s] since a transition was made to the currently active state
transition Define state machine transition
transpose Transpose a matrix
vector Returns an array as vector
zeros Returns a zero array

Builtin Environment

Name Description Version
MetaModelica MetaModelica Language Extensions

Generated at 2026-03-31T18:29:59Z by OpenModelicaOpenModelica 1.26.3 using GenerateDoc.mos. Offline version (tar.xz) (zip).