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

NameDescriptionVersion
ADGenKineticsImplementation of generalized kinetics for modeling biochemical reaction networks
ADMSL
AES
ATplus
AdvancedNoiseA library with additional noise modules compatible to the Modelica standard library1.0.0
AixLib0.9.1
AlgebraTestSuiteNonlinear algebraic equation system benchmarks
ApproxSplineApproximation spline library1.0.1
ArduinoLibrary to simulate sketches on a virtual Arduino Uno and to connect models to real-world circuits using the Firmata protocol0.1.0
AssertionLevel
BioChem1.1.1
BondGraph
BondLibModelica library for Bond Graph modeling2.3
BrinePropMedia models for p-h-T-rho-eta properties of aqueous solutions of multiple salts and gases0.5.6
BuildSysProEDF's Modelica library for modelling buildings and energy systems3.4.0
BuildingControlLibLibrary for building control0.1.0
BuildingSystemsLibrary for building energy and plant simulation2.0.0-beta
BuildingsLibrary with models for building energy and control systems7.0.0
ChemicalPhysical Chemistry1.4.0
ClaRaSimulation of Clausius-Rankine Cycles1.6.0
ClaRa_ObsoleteClaRa obsolete models package1.6.0
ComplexComplex number with overloaded operators4.0.0
ComplexLibLibrary for steady-state analysis of AC circuits within phasor domain, version 1.0
ConPNlib
Connections
Correlationdefines correlation between two uncertainty variables
DESLib1
DataFilesFunctions for reading and writing data files (empty version)0.0.0
Distribution
DynamicSelectselect static or dynamic expressions in the annotations
ExternalObject
ModelicaModelica Standard Library - Version 4.0.04.0.0
ModelicaAdditionsCollection of Modelica libraries of DLR1.5
ModelicaServicesModelicaServices (OpenModelica implementation) - Models and functions used in the Modelica Standard Library requiring a tool specific implementation4.0.0
Modelica_DeviceDriversModelica_DeviceDrivers - A collection of drivers interfacing hardware like input devices, communication devices, shared memory, analog-digital converters and else1.7.0
Modelica_StateGraph22.0.2
Modelica_SynchronousModelica_Synchronous (version 0.92.1) - Basic synchronous input/output control blocks that are triggered by clocks0.92.1
NcDataReader2Library to read interpolated data from netCDF files and DAP servers2.5.0
OMC_ARGS
OMC_CLOCK
OMC_NO_ARGS
OMC_NO_CLOCK
ObsoleteModelica4Library that contains components from Modelica Standard Library 3.2.3 that have been removed from version 4.0.04.0.0
OpenModelicaOpenModelica internal definitions and scripting functionsOpenModelica 1.18.0~dev-269-g83ff1a1
SDFScientific Data Format (empty version)0.0.0
StateSelect
Subtask
TILMediaTILMedia-Library with thermophysical properties of Fluids and Solids1.6.0 ClaRa
Uncertainty
UserInteractionUserInteraction (empty version)0.0.0
absAbsolute value
acosInverse cosine (-1 <= u <= 1)
activeStateReturn true if instance of a state machine is active, otherwise false
actualStream
arrayConstructs an array
asinInverse sine (-1 <= u <= 1)
assertCheck an assertion condition
atanInverse tangent
atan2Four quadrant inverse tangent
backSampleFirst activation of clock is shifted in time before activation of uModelica 3.3
cardinalityNumber of connectors in connectionDeprecated
catConcatenate arrays along given dimension
ceilRound a real number towards plus infinity
changeIndicate discrete variable changing
classDirectoryNon-standard operatorDymola / MSL 2.2.1
cosCosine
coshHyperbolic cosine
crossCross product of two 3-vectors
delayDelay expression
derDerivative of the input expression
diagonalReturns a diagonal matrix
divInteger part of a division of two Real numbers
edgeIndicate rising edge
expExponential, base e
fillReturns an array with all elements equal
firstTickReturns the interval between the previous and present tick of the clock of its argument
floorRound a real number towards minus infinity
getInstanceNameModelica 3.3
holdConversion from clocked discrete-time to continuous timeModelica 3.3
homotopyModelica 3.2
identityIdentity matrix of given size
inStream
initialTrue if in initialization phase
initialStateDefine inital state of a state machine
integerReturns 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.].
intervalReturns the interval between the previous and present tick of the clock of its argument
linspaceReal vector with equally spaced elements
logNatural (base e) logarithm (u shall be > 0)
log10Base 10 logarithm (u shall be > 0)
matrixReturns the first two dimensions of an array as matrix
max
min
modInteger modulus of a division of two Real numbers
ndimsNumber of array dimensions
noClockClock of y=Clock(u) is always inferredModelica 3.3
noEventTurn off event triggering
onesReturns a one array
outerProductOuter product of two vectors
preRefer to left limit
previousAccess previous value of a clocked variableModelica 3.3
printPrints to stdout, useful for debugging.OpenModelica extension
productProduct of all array elements
promote
reinitReinitialize state variable
remInteger remainder of the division of two Real numbers
rooted
sampleReturns the interval between the previous and present tick of the clock of its argument
scalarReturns a one-element array as scalar
semiLinear
shiftSampleFirst activation of clock is shifted in timeModelica 3.3
signSign of real or integer number
sinSine
sinhHyperbolic sine
sizeReturns dimensions of an array
skewThe skew matrix associated with the vector
smoothIndicate smoothness of expression
spatialDistributionNot yet implementedModelica 3.3
sqrtSquare root
subSampleConversion from faster clock to slower clockModelica 3.3
sumSum of all array elements
superSampleConversion from slower clock to faster clockModelica 3.3
symmetricReturns a symmetric matrix
tanTangent (u shall not be -pi/2, pi/2, 3*pi/2, ...)
tanhHyperbolic tangent
terminalTrue after successful analysis
ticksInStateReturns the number of clock ticks since a transition was made to the currently active state
timeInStateReturns the time duration as Real in [s] since a transition was made to the currently active state
transitionDefine state machine transition
transposeTranspose a matrix
vectorReturns an array as vector
zerosReturns a zero array

Builtin Environment

NameDescriptionVersion
MetaModelicaMetaModelica Language Extensions

Generated at 2021-05-11T00:32:40Z by OpenModelicaOpenModelica 1.18.0~dev-269-g83ff1a1 using GenerateDoc.mos. Offline version (tar.xz) (zip).