OMSimulator’s documentation

Version: v3.0.0.post203-gc218ca5

Contents

• 1. Introduction
• 2. OMSimulator
  • 2.1. OMSimulator Flags
  • 2.2. Examples
    • 2.2.1. Running a Python script
    • 2.2.2. Running an SSP file
    • 2.2.3. Running an FMU
• 3. OMSimulatorLib
  • 3.1. RunFile
  • 3.2. activateVariant
  • 3.3. addBus
  • 3.4. addConnection
  • 3.5. addConnector
  • 3.6. addConnectorToBus
  • 3.7. addResources
  • 3.8. addSignalsToResults
  • 3.9. addSubModel
  • 3.10. addSystem
  • 3.11. compareSimulationResults
  • 3.12. copySystem
  • 3.13. delete
  • 3.14. deleteConnection
  • 3.15. deleteConnectorFromBus
  • 3.16. deleteResources
  • 3.17. doStep
  • 3.18. duplicateVariant
  • 3.19. export
  • 3.20. exportDependencyGraphs
  • 3.21. exportSSMTemplate
  • 3.22. exportSSVTemplate
  • 3.23. exportSnapshot
  • 3.24. freeMemory
  • 3.25. getBoolean
  • 3.26. getBus
  • 3.27. getComponentType
  • 3.28. getConnections
  • 3.29. getConnector
  • 3.30. getDirectionalDerivative
  • 3.31. getElement
  • 3.32. getElements
  • 3.33. getFMUInfo
  • 3.34. getFixedStepSize
  • 3.35. getInteger
  • 3.36. getModelState
  • 3.37. getReal
  • 3.38. getResultFile
  • 3.39. getSolver
  • 3.40. getStartTime
  • 3.41. getStopTime
  • 3.42. getString
  • 3.43. getSubModelPath
  • 3.44. getSystemType
  • 3.45. getTime
  • 3.46. getTolerance
  • 3.47. getVariableStepSize
  • 3.48. getVersion
  • 3.49. importFile
  • 3.50. importSnapshot
  • 3.51. initialize
  • 3.52. instantiate
  • 3.53. list
  • 3.54. listUnconnectedConnectors
  • 3.55. listVariants
  • 3.56. loadSnapshot
  • 3.57. newModel
  • 3.58. newResources
  • 3.59. referenceResources
  • 3.60. removeSignalsFromResults
  • 3.61. rename
  • 3.62. replaceSubModel
  • 3.63. reset
  • 3.64. setActivationRatio
  • 3.65. setBoolean
  • 3.66. setBusGeometry
  • 3.67. setCommandLineOption
  • 3.68. setConnectionGeometry
  • 3.69. setConnectorGeometry
  • 3.70. setElementGeometry
  • 3.71. setFixedStepSize
  • 3.72. setInteger
  • 3.73. setLogFile
  • 3.74. setLoggingCallback
  • 3.75. setLoggingInterval
  • 3.76. setLoggingLevel
  • 3.77. setMaxLogFileSize
  • 3.78. setReal
  • 3.79. setRealInputDerivative
  • 3.80. setResultFile
  • 3.81. setSolver
  • 3.82. setStartTime
  • 3.83. setStopTime
  • 3.84. setString
  • 3.85. setTempDirectory
  • 3.86. setTolerance
  • 3.87. setUnit
  • 3.88. setVariableStepSize
  • 3.89. setWorkingDirectory
  • 3.90. simulate
  • 3.91. simulate_realtime
  • 3.92. stepUntil
  • 3.93. terminate
• 4. OMSimulatorPython3
  • 4.1. Core Capabilities
  • 4.2. Command Line Interface
    • 4.2.1. Examples
  • 4.3. Quick start Example
  • 4.4. SSP
  • 4.5. SSD
  • 4.6. SSV
  • 4.7. SSM
  • 4.8. FMU
  • 4.9. Component
  • 4.10. addSystem
  • 4.11. addConnector
  • 4.12. addConnection
  • 4.13. addResource
  • 4.14. addComponent
  • 4.15. addSSVReference
  • 4.16. removeSSVReference
  • 4.17. swapSSVReference
  • 4.18. listSSVReference
  • 4.19. exportSSVTemplate
  • 4.20. exportSSVTemplate
  • 4.21. setValue
  • 4.22. getValue
  • 4.23. mapParameter
  • 4.24. duplicate and activate Variant
  • 4.25. getVariant
  • 4.26. listResource
  • 4.27. deleteResource
  • 4.28. delete
  • 4.29. instantiate
  • 4.30. setResultFile
  • 4.31. initialize
  • 4.32. Solver
    • 4.32.1. Available Solvers
    • 4.32.2. Solver Settings
    • 4.32.3. Solver Assignment
  • 4.33. simulate
  • 4.34. terminate and delete
• 5. OpenModelicaScripting
  • 5.1. Examples
  • 5.2. OpenModelica Scripting Commands
  • 5.3. addBus
  • 5.4. addConnection
  • 5.5. addConnector
  • 5.6. addConnectorToBus
  • 5.7. addSignalsToResults
  • 5.8. addSubModel
  • 5.9. addSystem
  • 5.10. compareSimulationResults
  • 5.11. copySystem
  • 5.12. delete
  • 5.13. deleteConnection
  • 5.14. deleteConnectorFromBus
  • 5.15. export
  • 5.16. exportDependencyGraphs
  • 5.17. exportSnapshot
  • 5.18. freeMemory
  • 5.19. getBoolean
  • 5.20. getFixedStepSize
  • 5.21. getInteger
  • 5.22. getModelState
  • 5.23. getReal
  • 5.24. getSolver
  • 5.25. getStartTime
  • 5.26. getStopTime
  • 5.27. getSubModelPath
  • 5.28. getSystemType
  • 5.29. getTime
  • 5.30. getTolerance
  • 5.31. getVariableStepSize
  • 5.32. getVersion
  • 5.33. importFile
  • 5.34. importSnapshot
  • 5.35. initialize
  • 5.36. instantiate
  • 5.37. list
  • 5.38. listUnconnectedConnectors
  • 5.39. loadSnapshot
  • 5.40. newModel
  • 5.41. removeSignalsFromResults
  • 5.42. rename
  • 5.43. reset
  • 5.44. setBoolean
  • 5.45. setCommandLineOption
  • 5.46. setFixedStepSize
  • 5.47. setInteger
  • 5.48. setLogFile
  • 5.49. setLoggingInterval
  • 5.50. setLoggingLevel
  • 5.51. setReal
  • 5.52. setRealInputDerivative
  • 5.53. setResultFile
  • 5.54. setSolver
  • 5.55. setStartTime
  • 5.56. setStopTime
  • 5.57. setTempDirectory
  • 5.58. setTolerance
  • 5.59. setVariableStepSize
  • 5.60. setWorkingDirectory
  • 5.61. simulate
  • 5.62. stepUntil
  • 5.63. terminate
• 6. Graphical Modelling
  • 6.1. OMEdit
    • 6.1.1. Architecture
    • 6.1.2. New SSP Model
    • 6.1.3. Open SSP Model
    • 6.1.4. Add System and Sub-Systems
    • 6.1.5. Add SubModel
    • 6.1.6. Replace SubModel
    • 6.1.7. Simulation Setup
    • 6.1.8. Simulate
    • 6.1.9. Dual Mass Oscillator Example
  • 6.2. OMSimulatorGui
    • 6.2.1. Requirements and Enabling the Build
    • 6.2.2. Installing with pip
    • 6.2.3. Launching
    • 6.2.4. Main Window
    • 6.2.5. Creating and Opening Models
    • 6.2.6. The System Tree
    • 6.2.7. The Diagram Canvas
    • 6.2.8. Element (Component) Properties
    • 6.2.9. Parameter Files (SSV/SSM)
    • 6.2.10. Resources
    • 6.2.11. Variants
    • 6.2.12. Simulation Settings
    • 6.2.13. Options (Working Directory and Command Line Options)
    • 6.2.14. Simulating and Viewing Results
    • 6.2.15. Current Limitations

Indices and tables

• Index

• Search Page