DETAILS PANEL 🔗
The details panel is located to the right in the application and is comprised of a seven (7) tabs:
Depending on which mode is active, different tabs are made available. For more info on which tabs are available in what modes, please consult the Navigation bar . A tab, which is a part of the panel serving a specific purpose, can be expanded and collapsed by clicking on its frame.
The header is found on the top of the panel and displays the name and icon of the active model or selected component, information about the model and what class the model has. If no component is selected, the header will display the active class. If the model being displayed in the header is writeable, the user can click on its name to change it. If it is replaceable, the user can use the class name drop down menu to change the class.
The information tab displays documentation associated with the active model or selected component.
The properties tab is used to configure the active model or selected component by setting parameter values in the input fields and redeclare replaceable components. The tab is structured in sub-tabs and groups according to the model definition (Modelica Dialog annotation). Furthermore it also contains values calculated during simulation. These can appear in any sub-tab/group depending on how the model is set up but can typically be found under the variables tab.
Parameters in record array components cannot be edited using the Properties tab. Click here to find out how to edit such parameters.
Components that are replaceable or have specifically been configured to do so will also appear in the Properties tab. Replaceable components can be changed to a different class by using the drop down menu and parameters of a component can be seen and modified by expanding the component using the expander icon to the right of the name as shown in the image below.
Some properties of a model are not displayed in the Properties tab:
- Protected parameters, variables and components. When something is declared as Protected it means that the model developer has actively chosen to hide the parameter/variable/component.
- Disabled parameters. The user may choose to display disabled parameters in Settings
- Final parameters. When a parameter has been set as final it means that it cannot be changed. The user may choose to display final parameters in Settings. For most users keeping the default option to hide parameters set as final is a good choice as helps to condense the parameter list highlighting only the important ones.
The user can set attributes of a parameter or variable by clicking the vertical ellipsis between the name and the value field. The content of the attributes will depend on the type of the parameter/variable. Changes done to the attributes will be indicated by a highlight of the vertical ellipsis color.
The filtering is accessed by pressing the funnel icon just below the Properties tab frame. Filtering can be done by category:
- Start values
- Modified parameters
and/or keyword. Furthermore, the user can expand the filtering type by pressing the icon just right of the keyword input field which will show available types to filter on.
The filter in Properties only applies to the current hierarchical level and not to sub-components.
The Components tab lists all components in the active model. Typically, this list corresponds closely to what is shown in the diagram but might include components that are not shown graphically in the diagram. The list is displayed in order of declaration but the user may choose to sort by alphabetical order to quickly find a component of interest. Selecting a component in the list will display its header and properties and the corresponding component will be selected in the diagram.
Double-clicking on a component in the component list is a shortcut to performing the 'Inspect component' function, which opens its content in the context of the instance within the model in the canvas.
The Experiment tab contains everything related to an experiment. In the upper part of the tab there is a list of available experiments. Experiments can be added by pressing the + New experiment link. Experiments are saved automatically as soon as they are modified.
Sometimes it can be useful to apply an experiments parameter modifications and analysis settings to a model, meaning that the content of the experiment is saved in the Modelica model. This can be done by right-clicking an experiment in the list and selecting Apply to model or Apply to new model. Note that the only analysis settings that can be applied to the model are dynamic solver, start time, stop time and interval.
Experiments in the list can be activated or deactivated by clicking on them and it is also possible to create, duplicate, rename and delete experiments using the context menu. When an experiment is active, the Experimentation button is shown with a blue icon and the name of the experiment. This means that if a simulation is executed the simulation will be used (regardless of what mode is active). Only one experiment can be active at a given time.
There are three sub-tabs where different aspects of the experiment can be configured.
In the Analysis tab the user can decide what kind of analysis that is to be used for execution and any related settings. The available analyses are outlined below. Analysis settings not shown below the respective analyses can be found under the Execution settings.
The Modifications tab shows all parameter modifications in the experiment. Any modification can be removed by clicking the X to the right of the entry. The Modifications tab is read only, so to add or change a modification, the user will have to access the respective parameter shown in the list in the Properties tab or using a sticky.
To reduce the number of variables stored in a experiment result, the user can consult the Output tab and add filters. By default all variables except protected variables are included. To limit the stored variables, the user can click + New filter and select a type of filter and depending on the type define it:
- Text: Enter the filter string according to the glob format (https://en.wikipedia.org/wiki/Glob_(programming), e.g. *summary* to keep all variables containing the string 'summary'.
- View: Select an existing view or the current view where the latter means all stickies and plots currently displayed on the canvas (meaning it will change if the shown stickies and plots are modified). All variables displayed in stickies and plots in the chosen view will be kept in the result.
Output filters can be removed by clicking the X.
This will enable dynamic simulation where the user can set: - Start time (Default 0)
- Stop time (Default 1) - Interval (Defaults to (stop time - start time) / number of result points defined in settings) - Solver (Default CVODE)
Changes made to the Dynamic simulation settings start value, stop value, solver and interval will be saved in the model if writeable.
Steady state This will calculate the steady state solution of the model taking any PbS (Physics based Solving) annotations into account.
- Custom Available custom analyses will appear in a drop down list under the Custom button. Arguments for the chosen custom analysis, if any, will appear below the drop down.
The simulations tab list execution results of the active model including timestamps indicating when the simulation was performed. The user can select a result to inspect its content in the tabs Properties or Calculated values. If a compilation or simulation has failed, there will be an entry with an error symbol saying 'Compilation error' or 'Simulation error' depending on what went wrong. It is possible to access the simulation and compilation log from the context menu (also for failed simulations and compilations), which is accessed by clicking the ellipsis icon in a given result list entry. The user may rename a result by clicking on the pen icon next to the name or remove it by clicking the X to the right of the filter entry.
In case of multi-simulation, simulation and compilation logs can be viewed for individual cases.
The calculated values tab will display the content of a result chosen under Simulations as a tree structure corresponding to the model hierarchy. It contains the same information as the Properties tab but presented without considering tabs and groups.
Shows calculated values of parameters for the selected simulation result. The tab includes a filtering function.