OMSimulatorLua¶

This is a shared library that provides a Lua interface for the OMSimulatorLib library.

Examples¶

oms_setTempDirectory("./temp/")
oms_newModel("model")
oms_addSystem("model.root", oms_system_sc)

-- instantiate FMUs
oms_addSubModel("model.root.system1", "FMUs/System1.fmu")
oms_addSubModel("model.root.system2", "FMUs/System2.fmu")

-- add connections
oms_addConnection("model.root.system1.y", "model.root.system2.u")
oms_addConnection("model.root.system2.y", "model.root.system1.u")

-- simulation settings
oms_setResultFile("model", "results.mat")
oms_setStopTime("model", 0.1)
oms_setFixedStepSize("model.root", 1e-4)

oms_instantiate("model")
oms_setReal("model.root.system1.x_start", 2.5)

oms_initialize("model")
oms_simulate("model")
oms_terminate("model")
oms_delete("model")

Lua Scripting Commands¶

addConnector¶

Adds a connector to a given component.

status = oms_addConnector(cref, causality, type)

getComponentType¶

Gets the type of the given component.

# not available

setFixedStepSize¶

Sets the fixed step size. Can be used for the communication step size of co-simulation systems and also for the integrator step size in model exchange systems.

status = oms_setFixedStepSize(cref, stepSize)

setSolver¶

Sets the solver method for the given system.

status = oms_setSolver(cref, solver)

solver	Type	Description
oms_solver_sc_explicit_euler	sc-system	Explicit euler with fixed step size
oms_solver_sc_cvode	sc-system	CVODE with adaptive stepsize
oms_solver_wc_ma	wc-system	default master algorithm with fixed step size
oms_solver_wc_mav	wc-system	master algorithm with adaptive stepsize

simulate_asynchronous¶

Adds a TLM bus.

status = oms_addTLMBus(cref, domain, dimensions, interpolation)

getTLMBus¶

Gets the TLM bus objects of the given TLM bus cref.

# not available

setWorkingDirectory¶

Set a new working directory.

status = oms_setWorkingDirectory(newWorkingDir)

deleteConnection¶

Deletes the connection between connectors crefA and crefB.

status = oms_deleteConnection(crefA, crefB)

The two arguments crefA and crefB get swapped automatically if necessary.

getSystemType¶

Gets the type of the given system.

# not available

reset¶

Reset the composite model after a simulation run.

The FMUs go into the same state as after instantiation.

status = oms_reset(cref)

addSignalsToResults¶

Add all variables that match the given regex to the result file.

status = oms_addSignalsToResults(cref, regex)

The second argument, i.e. regex, is considered as a regular expression (C++11). “.*” and “(.)*” can be used to hit all variables.

getBus¶

Gets the bus object.

# not available

getConnector¶

Gets the connector object of the given connector cref.

# not available

listUnconnectedConnectors¶

Lists all unconnected connectors of a given system.

Memory is allocated for contents. The caller is responsible to free it using the C-API. The Lua and Python bindings take care of the memory and the caller doesn’t need to call free.

contents, status = oms_listUnconnectedConnectors(cref)

getTolerance¶

Gets the tolerance of a given system or component.

absoluteTolerance, relativeTolerance, status = oms_getTolerance(cref)

getBoolean¶

Get boolean value of given signal.

value, status = oms_getBoolean(cref)

getElement¶

Get element information of a given component reference.

# not available

simulate_asynchronous¶

Simulates a composite model in its own thread.

# not available

deleteConnectorFromTLMBus¶

Deletes a connector from a given TLM bus.

status = oms_deleteConnectorFromTLMBus(busCref, connectorCref)

setSignalFilter¶

status = oms_setSignalFilter(cref, regex)

exportDependencyGraphs¶

Export the dependency graphs of a given model to dot files.

status = oms_exportDependencyGraphs(cref, initialization, simulation)

getStartTime¶

Get the start time from the model.

startTime, status = oms_getStartTime(cref)

RunFile¶

Simulates a single FMU or SSP model.

# not available

addConnection¶

Adds a new connection between connectors A and B. The connectors need to be specified as fully qualified component references, e.g., “model.system.component.signal”.

status = oms_addConnection(crefA, crefB)

The two arguments crefA and crefB get swapped automatically if necessary.

copySystem¶

Copies a system.

status = oms_copySystem(source, target)

delete¶

Deletes a connector, component, system, or model object.

status = oms_delete(cref)

terminate¶

Terminates a given composite model.

status = oms_terminate(cref)

setConnectionGeometry¶

# not available

getModelState¶

Gets the model state of the given model cref.

# not available

getElements¶

Get list of all sub-components of a given component reference.

# not available

setLoggingLevel¶

Enables/Disables debug logging (logDebug and logTrace).

0 default, 1 default+debug, 2 default+debug+trace

oms_setLoggingLevel(logLevel)

getStopTime¶

Get the stop time from the model.

stopTime, status = oms_getStopTime(cref)

initialize¶

Initializes a composite model.

status = oms_initialize(cref)

setBoolean¶

Set boolean value of given signal.

status = oms_setBoolean(cref, value)

setCommandLineOption¶

Sets special flags.

status = oms_setCommandLineOption(cmd)

Available flags:

info:    Usage: OMSimulator [Options|Lua script]
info:    Options:
           <filename>                  FMU or SSP file
           --clearAllOptions           Reset all flags to default values
           --fetchAllVars=<arg>        
           --help [ -h ]               Displays the help text
           --ignoreInitialUnknowns=<arg>  Ignore the initial unknowns from the modelDesction.xml
           --intervals=<arg> [ -i ]    Specifies the number of communication points (arg > 1)
           --logFile=<arg> [ -l ]      Specifies the logfile (stdout is used if no log file is specified)
           --logLevel=<arg>            0 default, 1 default+debug, 2 default+debug+trace
           --mode=<arg> [ -m ]         Forces a certain FMI mode iff the FMU provides cs and me [arg: cs (default) or me]
           --progressBar=<arg>         
           --resultFile=<arg> [ -r ]   Specifies the name of the output result file
           --setInputDerivatives=<arg>  
           --solver                    Specifies the integration method (internal, euler, cvode)
           --startTime=<arg> [ -s ]    Specifies the start time
           --stopTime=<arg> [ -t ]     Specifies the stop time
           --suppressPath=<arg>        
           --tempDir=<arg>             Specifies the temp directory
           --timeout=<arg>             Specifies the maximum allowed time in seconds for running a simulation (0 disables)
           --tolerance=<arg>           Specifies the relative tolerance
           --version [ -v ]            Displays version information
           --wallTime=<arg>            Add wall time information for to the result file
           --workingDir=<arg>          Specifies the working directory

setInteger¶

Set integer value of given signal.

status = oms_setInteger(cref, value)

getReal¶

Get real value.

value, status = oms_getReal(cref)

addExternalModel¶

Adds an external model to a TLM system.

status = oms_addExternalModel(cref, path, startscript)

extractFMIKind¶

Extracts the FMI kind of a given FMU from the file system.

# not available

setElementGeometry¶

Set geometry information to a given component.

# not available

setTLMPositionAndOrientation¶

Sets initial position and orientation for a TLM 3D interface.

status oms_setTLMPositionAndOrientation(cref, x1, x2, x3, A11, A12, A13, A21, A22, A23, A31, A32, A33)

getVersion¶

Returns the library’s version string.

version = oms_getVersion()

cancelSimulation_asynchronous¶

Cancels a running asynchronous simulation.

# not available

setMaxLogFileSize¶

Sets maximum log file size in MB. If the file exceeds this limit, the logging will continue on stdout.

oms_setMaxLogFileSize(size)

simulate¶

Simulates a composite model.

status = oms_simulate(cref)

getSubModelPath¶

Returns the path of a given component.

# not available

addBus¶

Adds a bus to a given component.

status = oms_addBus(cref)

setTempDirectory¶

Set new temp directory.

status = oms_setTempDirectory(newTempDir)

compareSimulationResults¶

This function compares a given signal of two result files within absolute and relative tolerances.

oms_compareSimulationResults(filenameA, filenameB, var, relTol, absTol)

The following table describes the input values:

Input	Type	Description
filenameA	String	Name of first result file to compare.
filenameB	String	Name of second result file to compare.
var	String	Name of signal to compare.
relTol	Number	Relative tolerance.
absTol	Number	Absolute tolerance.

The following table describes the return values:

Type	Description
Integer	1 if the signal is considered as equal, 0 otherwise

rename¶

Renames a model, system, or component.

status = oms_rename(cref, newCref)

stepUntil¶

Simulates a composite model until a given time value.

status = oms_stepUntil(cref, stopTime)

parseModelName¶

Parses the model name from a given SSD representation.

Memory is allocated for ident. The caller is responsible to free it using the C-API. The Lua and Python bindings take care of the memory and the caller doesn’t need to call free.

ident, status = oms_parseModelName(contents)

getTLMVariableTypes¶

Gets the type of an TLM variable.

# not available

setLoggingInterval¶

Set the logging interval of the simulation.

status = oms_setLoggingInterval(cref, loggingInterval)

setTLMBusGeometry¶

# not available

importString¶

Imports a composite model from a string.

cref, oms_status_enu_t oms_importString(contents)

addSystem¶

Adds a (sub-)system to a model or system.

status = oms_addSystem(cref, type)

getConnections¶

Get list of all connections from a given component.

# not available

instantiate¶

Instantiates a given composite model.

status = oms_instantiate(cref)

freeMemory¶

Free the memory allocated by some other API. Pass the object for which memory is allocated.

oms_freeMemory(obj)

addTLMConnection¶

Connects two TLM connectors.

status = oms_addTLMConnection(crefA, crefB, delay, alpha, linearimpedance, angularimpedance)

setStartTime¶

Set the start time of the simulation.

status = oms_setStartTime(cref, startTime)

simulate_realtime¶

Experimental feature for (soft) real-time simulation.

status = experimental_simulate_realtime(ident)

export¶

Exports a composite model to a SPP file.

status = oms_export(cref, filename)

setStopTime¶

Set the stop time of the simulation.

status = oms_setStopTime(cref, stopTime)

setLoggingCallback¶

Sets a callback function for the logging system.

# not available

getSolver¶

Gets the selected solver method of the given system.

solver, status = oms_getSolver(cref)

setResultFile¶

Set the result file of the simulation.

status = oms_setResultFile(cref, filename)
status = oms_setResultFile(cref, filename, bufferSize)

getInteger¶

Get integer value of given signal.

value, status = oms_getInteger(cref)

getVariableStepSize¶

Gets the step size parameters.

initialStepSize, minimumStepSize, maximumStepSize, status = oms_getVariableStepSize(cref)

deleteConnectorFromBus¶

Deletes a connector from a given bus.

status = oms_deleteConnectorFromBus(busCref, connectorCref)

setTolerance¶

Sets the tolerance for a given model, system, or component.

status = oms_setTolerance(const char* cref, double tolerance)
status = oms_setTolerance(const char* cref, double absoluteTolerance, double relativeTolerance)

setVariableStepSize¶

Sets the step size parameters for methods with stepsize control.

status = oms_getVariableStepSize(cref, initialStepSize, minimumStepSize, maximumStepSize)

setConnectorGeometry¶

Set geometry information to a given connector.

# not available

setTLMConnectionParameters¶

Simulates a composite model in its own thread.

# not available

addConnectorToTLMBus¶

Adds a connector to a TLM bus.

status = oms_addConnectorToTLMBus(busCref, connectorCref, type)

setReal¶

Set real value of given signal.

status = oms_setReal(cref, value)

getFixedStepSize¶

Gets the fixed step size. Can be used for the communication step size of co-simulation systems and also for the integrator step size in model exchange systems.

stepSize, status = oms_setFixedStepSize(cref)

addConnectorToBus¶

Adds a connector to a bus.

status = oms_addConnectorToBus(busCref, connectorCref)

setLogFile¶

Redirects logging output to file or std streams. The warning/error counters are reset.

filename=”” to redirect to std streams and proper filename to redirect to file.

status = oms_setLogFile(filename)

newModel¶

Creates a new and yet empty composite model.

status = oms_newModel(cref)

getFMUInfo¶

Returns FMU specific information.

# not available

importFile¶

Imports a composite model from a SSP file.

cref, status = oms_importFile(filename)

setActivationRatio¶

Experimental feature for setting the activation ratio of FMUs for experimenting with multi-rate master algorithms.

status = experimental_setActivationRatio(cref, k)

setBusGeometry¶

# not available

list¶

Lists the SSD representation of a given model, system, or component.

Memory is allocated for contents. The caller is responsible to free it using the C-API. The Lua and Python bindings take care of the memory and the caller doesn’t need to call free.

contents, status = oms_list(cref)

setTLMSocketData¶

Sets data for TLM socket communication.

status = oms_setTLMSocketData(cref, address, managerPort, monitorPort)

removeSignalsFromResults¶

Removes all variables that match the given regex to the result file.

status = oms_removeSignalsFromResults(cref, regex)

The second argument, i.e. regex, is considered as a regular expression (C++11). “.*” and “(.)*” can be used to hit all variables.

addSubModel¶

Adds a component to a system.

status = oms_addSubModel(cref, fmuPath)