Simulator Control Box

During runtime, you can utilize several simulation related functions and settings using the Simulator Control Box (Figure 1).

Simulator Control Box

simulator control box

The Simulator Control Box appears automatically when runtime is started (Menu Bar  Runtime  Start). On the left side of the panel you will find buttons to control simulation related functions such as simulaton speed, save and load sessions and scenario recording.

All buttons, tick boxes and their functionality are further described below.

Simulation control

Overview of the simulation control panel. (1) Play and pause; (2) Speed control; (3) Initialize and session write; (4) Load and save session; (5) Record and replay; (6) Conditional Breakpoints; (7) Logging and Debug Console.

simulator control box highlighted

circle 1 Play and pause

Button

Active state

Functionality

run simulation

run simulation active

Start simulation. The button turns green when the simulation is running.

pause

pause active

Pause simulation. The button turns orange when the simulation is paused.

single step

-

Increment simulation time by 1 scan time (usually 0.1 seconds). This button only works when the simulation is paused.

sim time

-

Shows running time of current session

reset sim time

reset sim time active

Reset simulation time. The tick symbol will disappear shortly after the simulation time has been reset.

circle 2 Speed control

Button

Functionality

increment speed

Increment simulation speed by 1, 10 or 100, respectively.

decrement speed

Decrement simulation speed by 1, 10 or 100, respectively.

sim speed

Shows current simulation speed.

circle 3 Initialize and session write

Init is short for Initial state (or default). A simulation always starts in its initial state. You can create an initial state using specific buttons on the Simulator Control Box.

Button

Functionality

session write init

Write current values and configuration to Initial state. In other words, you will create a new initial state based on your current simulation state. Be aware that your current initial configuration will be overwritten (and thus lost).

init

Reset the simulation to its initial state and run from that point onwards.

You have to restart your simulation after setting new init values in order for these changes to take effect.

circle 4 Load and save sessions

A session (or snapshot) is a saved copy of the state (or configuration) of your simulation at a specific point in time. You can use it to restore your simulation to that particular state at a later moment.

Button

Functionality

save session

Save the current state/configuration of the simulation into a session file. Sessions will be saved in the RT_Sessions folder located in the same directory as where your project file is stored.

load session

Restore the simulation to a specific state/configuration using a previously saved session file. on file.

Avoid using spaces, commas and dots when naming session files. It will cause the simulation to crash when you restore that session file. Example:
cross icon 01 feedwater system running
tick icon 01_feedwater_system_running

circle 5 Record and replay

You can record a sequence of operator actions using the recording function. Recording operator actions allows you to perform identical actions at a later time.

Button

Active state

Functionality

record sim

record sim active

Start recording. The button turns red when recording is active.

stop rec replay

stop rec replay active

Stop recording. The button turns green when the recording has stopped.

replay sim

replay sim active

Replay recording

While recording, navigate to the SIM_RECORDING tab on the right side of the Simulator Control Box. Here you will find a list of all actions that will be stored in your recording file (Figure 3).

List of recorded operator actions

sim recording

The files containing your recording will be saved in the same directory as where your project file is stored. Each recording will have its own folder named RECORDSIM_1, RECORDSIM_2, etc. (Figure 4)

Recording files will be saved in the same directory as where your project file is stored

record sim folder

circle 6 Conditional Breakpoints

Sometimes you may want to pause your simulation only when certain conditions are true. To achieve this you can use Conditional Breakpoints. If the condition is true, then your simulation breaks (or pauses) at the breakpoint. If the condition is false, then the simulation continues.

Tick box

Active state

Functionality

pause list active

pause list active active

Pause simulation when certain criteria are met.

To enable Conditional Breakpoints, tick the box in front of Pause list active. All conditional breakpoints will appear in the list under the SIM_Pause_ tab on the right side of the Simulator Control Box (Figure 5).

Define conditional breakpoints in the SIM_Pause tab on the right side of the Simulator Control Box

conditional breakpoints

There are two ways to add ID tags to this list:

  • Hover your mouse over a symbol with the ID tag you want to create a conditional breakpoint for and press F10.

  • Manually add ID tags to the list

You can set new or edit existing conditions by changing the compare function and value.

circle 7 Logging and Debug Console

The Logging and Debug Console enables you to view output and error messages. When errors occur during simulation, checking these error logs is the first step for determining the nature of the problem.

Tick box

Active state

Functionality

show extra messages

show extra messages active

When enabled, the Logging and Debug Console will show additional messages (e.g., commands, cycle time).