Modelica Performance Analyzer

A common problem when simulating models in an equation-based language like Modelica is that the model may contain non-linear equation systems. These are solved in each time-step by extrapolating an initial guess and running a non-linear system solver. If the simulation takes too long to simulate, it is useful to run the performance analysis tool. The tool has around 5~25% overhead, which is very low compared to instruction-level profilers (30x-100x overhead). Due to being based on a single simulation run, the report may contain spikes in the charts.

When running a simulation for performance analysis, execution times of user-defined functions as well as linear, non-linear and mixed equation systems are recorded.

To start a simulation in this mode, turn on profiling with the following command line flag >>> setCommandLineOptions("--profiling=all")

The generated report is in HTML format (with images in the SVG format), stored in a file modelname_prof.html, but the XML database and measured times that generated the report and graphs are also available if you want to customize the report for comparison with other tools.

Below we use the performance profiler on the simple model A:

model ProfilingTest
  function f
    input Real r;
    output Real o = sin(r);
  end f;
  String s = "abc";
  Real x = f(x) "This is x";
  Real y(start=1);
  Real z1 = cos(z2);
  Real z2 = sin(z1);
equation
  der(y) = time;
end ProfilingTest;

We simulate as usual, after setting the profiling flag:

>>> setCommandLineOptions("--profiling=blocks+html")
true
>>> simulate(ProfilingTest)
record SimulationResult
    resultFile = "«DOCHOME»/ProfilingTest_res.mat",
    simulationOptions = "startTime = 0.0, stopTime = 1.0, numberOfIntervals = 500, tolerance = 1e-6, method = 'dassl', fileNamePrefix = 'ProfilingTest', options = '', outputFormat = 'mat', variableFilter = '.*', cflags = '', simflags = ''",
    messages = "LOG_SUCCESS       | info    | The initialization finished successfully without homotopy method.
LOG_SUCCESS       | info    | The simulation finished successfully.
Warning: empty y range [3:3], adjusting to [2.97:3.03]
Warning: empty y range [3:3], adjusting to [2.97:3.03]
Warning: empty y range [2:2], adjusting to [1.98:2.02]
Warning: empty y range [2:2], adjusting to [1.98:2.02]
Warning: empty y range [3:3], adjusting to [2.97:3.03]
Warning: empty y range [3:3], adjusting to [2.97:3.03]
LOG_STDOUT        | info    | Time measurements are stored in ProfilingTest_prof.html (human-readable) and ProfilingTest_prof.xml (for XSL transforms or more details)
",
    timeFrontend = 0.001880701,
    timeBackend = 0.017765236,
    timeSimCode = 0.0026296310000000003,
    timeTemplates = 0.005098842,
    timeCompile = 0.57878309,
    timeSimulation = 0.042343175000000004,
    timeTotal = 0.648631235
end SimulationResult;
"Warning: There are nonlinear iteration variables with default zero start attribute found in NLSJac0. For more information set -d=initialization. In OMEdit Tools->Options->Simulation->Show additional information from the initialization process, in OMNotebook call setCommandLineOptions(\"-d=initialization\").
Warning: The initial conditions are not fully specified. For more information set -d=initialization. In OMEdit Tools->Options->Simulation->Show additional information from the initialization process, in OMNotebook call setCommandLineOptions(\"-d=initialization\").
"

Profiling information for ProfilingTest

Information

All times are measured using a real-time wall clock. This means context switching produces bad worst-case execution times (max times) for blocks. If you want better results, use a CPU-time clock or run the command using real-time priviliges (avoiding context switches).

Note that for blocks where the individual execution time is close to the accuracy of the real-time clock, the maximum measured time may deviate a lot from the average.

For more details, see ProfilingTest_prof.xml.

Settings

Name

Value

Integration method

dassl

Output format

mat

Output name

ProfilingTest_res.mat

Output size

24.0 kB

Profiling data

ProfilingTest_prof.data

Profiling size

0 B

Summary

Task

Time

Fraction

Pre-Initialization

0.000153

7.20%

Initialization

0.000144

6.78%

Event-handling

0.000001

0.05%

Creating output file

0.000149

7.01%

Linearization

NaN%

Time steps

0.001354

63.72%

Overhead

0.000132

6.21%

Unknown

NaN

NaN%

Total simulation time

0.002125

100.00%

Global Steps

Steps

Total Time

F raction

Average Time

Max Time

De viation

|Graph th umbnail 999|

499

0 .001354

63.72%

2.7134 2685370 741e-06

0.00 0059940

21.09x

Measured Function Calls

Name

Calls

Time

F raction

Max Time

De viation

|Graph th umbnail f unction fun0|

|Graph

th umbnail count f unction fun0|

` Profili ngTest. f <#lin e=0>`__

1512

0.00 0016950

0.80%

0.00 0000340

29.33x

Measured Blocks

Name

Calls

Time

F raction

Max Time

De viation

|Graph th umbnail eq0|

|Graph

th umbnail count eq0|

` <# eq0>`__

8

0.00 0078800

3.71%

0.00 0078940

7.01x

|Graph th umbnail eq11|

|Graph

th umbnail count eq11|

` <#e q11>`__

4

0.00 0001560

0.07%

0.00 0001620

3.15x

|Graph th umbnail eq19|

|Graph

th umbnail count eq19|

` <#e q19>`__

1006

0.00 0467950

22.02%

0.00 0017640

36.92x

|Graph th umbnail eq21|

|Graph

th umbnail count eq21|

` <#e q21>`__

1508

0.00 0495470

23.32%

0.00 0015320

45.63x

Equations

Name

Variables

eq0

eq1

y

eq2

s

eq3

z1

eq4

eq5

` <#var0>`__

eq6

` <#var0>`__

eq7

` <#var0>`__

eq8

` <#var0>`__

eq9

z2

eq10

eq11

x

eq12

eq13

z2

eq14

eq15

` <#var0>`__

eq16

` <#var0>`__

eq17

` <#var0>`__

eq18

` <#var0>`__

eq19

z1

eq20

eq21

x

eq22

der(y)

eq23

Variables

Name

Comment

y

der(y)

x

This is x

z1

z2

s

This report was generated by OpenModelica on 2024-07-03 19:46:57.

Genenerated JSON for the Example

Listing 9 ProfilingTest_prof.json
{
"name":"ProfilingTest",
"prefix":"ProfilingTest",
"date":"2024-07-03 19:46:57",
"method":"dassl",
"outputFormat":"mat",
"outputFilename":"ProfilingTest_res.mat",
"outputFilesize":24581,
"overheadTime":0.00013248,
"preinitTime":0.00015319,
"initTime":0.0001444,
"eventTime":1.14e-06,
"outputTime":0.00014893,
"jacobianTime":5.32e-06,
"totalTime":0.00212515,
"totalStepsTime":2.48e-06,
"totalTimeProfileBlocks":0.00104378,
"numStep":499,
"maxTime":5.994e-05,
"functions":[
{"name":"ProfilingTest.f","ncall":1512,"time":0.000016950,"maxTime":0.000000340}
],
"profileBlocks":[
{"id":0,"ncall":8,"time":0.000078800,"maxTime":0.000078940},
{"id":11,"ncall":4,"time":0.000001560,"maxTime":0.000001620},
{"id":19,"ncall":1006,"time":0.000467950,"maxTime":0.000017640},
{"id":21,"ncall":1508,"time":0.000495470,"maxTime":0.000015320}
]
}

Using the Profiler from OMEdit

When running a simulation from OMEdit, it is possible to enable profiling information, which can be combined with the transformations browser.

Profiling setup

Figure 137 Setting up the profiler from OMEdit.

When profiling the DoublePendulum example from MSL, the following output in Figure 138 is a typical result. This information clearly shows which system takes longest to simulate (a linear system, where most of the time overhead probably comes from initializing LAPACK over and over).

Profiling results

Figure 138 Profiling results of the Modelica standard library DoublePendulum example, sorted by execution time.