Record Summary

A summary record is a component allowing to collect chosen parameters, variables, discretes or constants from selected model components. It helps user to quickly access and filter the data of interest.

Example

A summary record will be created including one parameter and one variable from a chosen model shown as an example.

1. Duplicate Modelica.Fluid.Examples.PumpingSystem to your workspace.

2. Create a new record type class and call it summary.

Note

The summary record is opened automatically.

3. Go to the summary details panel and add a new parameter by button.

4. Call the parameter reservoir_height, choose the Variability = parameter, Type = Height (m) and tooltip Description = "Reservoir geometry height".

5. Similarly, create a new variable called pump_mass_flow, Variability = Variable, Type = MassFlowRate (kg/s), Description = "Pump mass flow rate".

Tip

Start typing the Type name to the drop down list and it will keep filtering available units options for you.

6. Open PumpingSystem in your workspace and add summary

Tip

You can open the model in the new browser tab, to keep both summary record and model opened at the same time.

7. Adjust summary > General > reservoir_height: reservoir.height.

8. The summary > Variables > pump_mass_flow cannot be adjusted from the UI, so let's open the code editor as show below.

9. Adjust line 17 by defining pump_mass_flow = pumps.m_flow to the summary definition, as shown below. (summary(reservoir_height = reservoir.height,pump_mass_flow = pumps.m_flow)

10. Run the model.

11. Once the simulation finishes, go to CALCULATED VALUES and type: "summary". This filters down the summary specified parameter and variable.

12. Create plot showing both the variables.