ControlPanel.txt
Purpose
The ControlPanel.txt input file, in conjunction with RELAP5_channels.txt, describes the main control panel interface between the RELAP5 thermal hydraulic reactor plant model and the operator behavior model. All plant status information perceived by the operations crew must be displayed on the ADS-IDAC control panel, and all control manipulations must be performed through this interface.
ControlPanel.txt provides a central link between most of the program modules within ADS-IDAC. Indicators, controls, and alarms referenced in other input files must use exactly the same item names defined in this file.
Four categories of information can be displayed on the ADS-IDAC control panel:
- Thermal hydraulic parameters (e.g., temperature, pressure, flow rate) — can display both the current value and the rate of change (trend). Adding the prefix
RATE_to aparameter_nameenables trend display. - Component operating state (e.g., on, off, open, closed)
- Support system operational state — driven by the support-system reliability module rather than a RELAP5 channel
- Alarms — based on parameter values, component state, or the difference between two parameters
Two types of controllers are available:
- Fine adjustment controls (
Control_Panel_Fine_Adjust) — for components with a continuous range of input values such as throttle valves and setpoint controllers. - Binary state controllers (
Control_Panel_Controller) — for components with discrete states such as pumps and control switches.
INFO
The required_time and failure_value fields throughout this file are deprecated dummy fields. The time required to perform control panel activities is now set in the ZProcedure_ series of input files. Instrument failures should be modeled using the KB_OAT(ODM)_Bias_Factors.txt input file. Dummy values must still be provided for these fields.
Input File Format
Each entry is written on one line, all fields separated by spaces or tabs (this matches the shipped reference file tests/BV4/Input/Indicators/ControlPanel.txt):
Control_Panel_Parameter number_of_parameters
Number_of_Data_Points_for_Rate_Calculation number_of_rate_data_points
parameter_name_1 channel indicator_type required_time failure_value
.
parameter_name_n channel indicator_type required_time failure_value
Indicator_Heat_Structure_value number_of_heat_structure_parameters
heat_structure_name_1 heat_channel indicator_type required_time failure_value heat_mesh_point
Control_Panel_Component_State number_of_components
component_name_1 trip_channel indicator_type required_time failure_state threshold_type threshold_trip_value
Control_Panel_Support_System_State number_of_support_system_displays
support_system_name_1 failure_state
Controls_Panel_Fine_Adjust number_of_fine_adjust_controls
control_name_1 interactive_channel required_time open/on_value closed/off_value neutral_value control_failure_value
Control_Panel_Controller number_of_controllers
control_name_1 interactive_channel required_time open/on_state closed/off_state neutral_state control_failure_state
Alarm_for_Parameter_State number_of_parameter_alarms
alarm_name_1 alarm_parameter alarm_weight required_time logic setpoint
Alarm_for_Component_State number_of_component_alarms
alarm_name_1 alarm_component alarm_weight required_time state_setpoint
Alarm_for_Difference_Between_two_Values number_of_difference_alarms
alarm_name_1 first_parameter alarm_weight required_time second_parameter diff_setpointToken-based parsing — order and counts are what matter
The parser reads the file as a whitespace-separated token stream: line breaks, tabs, and spaces are interchangeable, and the section header words are read into placeholders without being checked — the section order and the counts are what drive parsing. Keep the headers anyway (the file is unreadable without them), use the names shown above (from the BV4 reference file), and make every count exactly match the number of entries that follow: a wrong count silently shifts all subsequent sections.
Section 1 — Control_Panel_Parameter
Defines control panel indicators for thermal hydraulic parameters. Heat structure indicators are listed separately in Section 2.
| Parameter | Type | Description | Example Value |
|---|---|---|---|
number_of_parameters | Integer, > 0 | Count of parameter indicators. Must exactly match the number listed. | 14 |
number_of_rate_data_points | Integer, > 1 | Number of data points stored for parameter trend calculation (linear regression). At the default 0.5 s timestep, 120 points covers the preceding 60 seconds. | 120 |
parameter_name | String | Descriptive name for the indicator. No spaces; use _. Prefix with RATE_ to obtain rate-of-change (trend) of another parameter. | PZR_Pressure |
channel | String | RELAP5 channel reference from RELAP5_channels.txt. Channel prefix determines available indicator_type values: HV_ (hydraulic volume), HJ_ (hydraulic junction), CV_ (control variable). | HV_340 |
indicator_type | String | Physical quantity extracted from the channel. See valid types table below. For CV_ channels, enter Value as a dummy. | Pressure |
required_time | Double, > 0.0 | Deprecated dummy field. A value must be supplied. | 20.0 |
failure_value | Double | Deprecated dummy field. A value must be supplied. | 0.0 |
Valid Indicator Types by Channel Prefix
| Channel Prefix | Channel Type | Valid indicator_type Values | Notes |
|---|---|---|---|
HV_xxx | Hydraulic Volume | Pressure, Liquid_Temperature, Vapor_Temperature, Saturation_Temperature, Boron_Denisty, Equilibrium_Quality, Flow_Regime_Number, Mass_Flow_Rate, Liquid_Velocity, Vapor_Velocity | Units depend on R5PAR_mp_SI_UNIT setting |
HJ_xxx | Hydraulic Junction | Any valid string | Units depend on R5PAR_mp_SI_UNIT setting |
CV_xxx | Control Variable | Any valid string (use Value) | Units set by RELAP5 control variable definition |
HS_xxxnn | Heat Structure | Any valid string (use Temperature) | Only temperature may be obtained from a heat structure channel |
VT_xxx or LT_xxx | Component State | Any valid string (use Trip_Time) | Channel returns time the trip was last set TRUE, or -1 if FALSE |
Section 2 — Indicator_Heat_Structure_value
Links heat structure channels to control panel temperature indicators.
| Parameter | Type | Description | Example Value |
|---|---|---|---|
number_of_heat_structure_parameters | Integer, > 0 | Count of heat structure indicators. Must exactly match the number listed. | 1 |
heat_structure_name | String | Descriptive name for the heat structure indicator. No spaces; use _. | THS_57001 |
heat_channel | String | Must refer to a valid heat structure channel (HS_xxxnn) in RELAP5_channels.txt. | HS_57001 |
indicator_type | String | Dummy field for heat structures. Use Temperature for readability. | Temperature |
required_time | Double | Deprecated dummy field. A value must be supplied. | 20.0 |
failure_value | Double | Deprecated dummy field. A value must be supplied. | 0.0 |
heat_mesh_point | Integer, > 0 | Specifies the heat structure mesh point within the channel. | 1 |
Section 3 — Control_Panel_Component_State
Defines component state indicators based on RELAP5 Boolean variable or logical trip channels.
| Parameter | Type | Description | Example Value |
|---|---|---|---|
number_of_components | Integer, > 0 | Count of component state indicators. Must exactly match the number listed. | 3 |
component_name | String | Descriptive name for the component state indicator. No spaces; use _. | Reactor_Trip |
trip_channel | String | Must refer to a variable or logical trip channel (VT_xxx or LT_xxx) in RELAP5_channels.txt. | LT_1698 |
indicator_type | String | Dummy field. Use Trip_Time for readability. | Trip_Time |
required_time | Double | Deprecated dummy field. A value must be supplied. | 20.0 |
failure_state | String | Deprecated dummy field. Valid strings: ON, OFF, OPEN, CLOSE, TRIP. A value must be supplied. | OFF |
threshold_type | String | Defines the mapping between the RELAP5 trip channel TRUE/FALSE state and the component state displayed on the panel. See table below. | GREATER_THEN_ON |
threshold_trip_value | Double, > 0.0 | Time delay (seconds) between an actual change in component operating state and the indication of the state change on the panel. | 1.0E-5 |
Threshold Type Options
| Threshold Type | Component State Required for Trip TRUE in RELAP | Component State when Trip is FALSE | Component State when Trip is TRUE |
|---|---|---|---|
GREATER_THEN_ON or SMALLER_THEN_OFF | ON | OFF | ON when elapsed time since trip last set TRUE > threshold value |
GREATER_THEN_OFF or SMALLER_THEN_ON | OFF | ON | OFF when elapsed time since trip last set TRUE > threshold value |
GREATER_THEN_OPEN or SMALLER_THEN_CLOSE | OPEN | CLOSE | OPEN when elapsed time since trip last set TRUE > threshold value |
GREATER_THEN_CLOSE or SMALLER_THEN_OPEN | CLOSE | OPEN | CLOSE when elapsed time since trip last set TRUE > threshold value |
INFO
There are only four unique threshold_type categories; companion options (e.g., SMALLER_THEN_OFF vs. GREATER_THEN_ON) provide equivalent behavior. For readability, using GREATER_THEN_ON or GREATER_THEN_OPEN is recommended. Components whose states are of type _ON/_OFF use integer codes VON = 3022 / VOFF = 3023; components of type _OPEN/_CLOSE use VOPEN = 3098 / VCLOSE = 3099.
Section 4 — Control_Panel_Support_System_State
Defines display elements showing support-system operational state. Unlike the other display sections, these are not tied to a RELAP5 channel — their state is driven by the support-system reliability module, which quantifies a fault tree per display from Input/SupportSystemsReliability/. The display name must match the tree's top node; see Support system fault trees for the .fta format and for authoring rules. The section must be present even when empty (BV4 uses a count of 0).
These displays never change state in the shipped builds
The fault-tree solver is compiled out (ENABLE_HCL=OFF), so a declared support system stays at its healthy state for the whole run and generates no branch. A procedure step that checks one still runs and simply always sees "healthy".
| Parameter | Type | Description | Example Value |
|---|---|---|---|
number_of_support_system_displays | Integer, ≥ 0 | Count of support system state displays. | 0 |
support_system_name | String | Name of the support system as used by the support-system reliability module. No spaces; use _. | Emergency_AC_Buses |
failure_state | String | State displayed when the support system fails: ON, OFF, OPEN, or CLOSE. The healthy display state is the complement (e.g., OFF on failure → ON when healthy). | OFF |
Section 5 — Controls_Panel_Fine_Adjust
Defines continuous controllers with fine adjustment capability (throttle valves, setpoint controllers).
| Parameter | Type | Description | Example Value |
|---|---|---|---|
number_of_fine_adjust_controls | Integer, > 0 | Count of fine adjustment controls. Must exactly match the number listed. | 3 |
control_name | String | Descriptive name for the control element. No spaces; use _. | X_PZR_Spray_Valve |
interactive_channel | String | Must refer to a valid interactive control channel in RELAP5_channels.txt. | IC_804 |
required_time | Double | Deprecated dummy field. A value must be supplied. | 1.0 |
open/on_value | Double | Upper control limit for the fine adjustment controller. | 1.0 |
closed/off_value | Double | Lower control limit for the fine adjustment controller. | 0.0 |
neutral_value | Double | Neutral (default) control setting. | 0.0 |
control_failure_value | Double | Control value applied upon failure activation from SystemReliability.txt. | -1.0 |
Section 6 — Control_Panel_Controller
Defines binary-state controllers (pumps, control switches).
| Parameter | Type | Description | Example Value |
|---|---|---|---|
number_of_controllers | Integer, > 0 | Count of binary state controllers. Must exactly match the number listed. | 2 |
control_name | String | Descriptive name for the control element. No spaces; use _. | X_RCP_A |
interactive_channel | String | Must refer to a valid interactive control channel in RELAP5_channels.txt. | IC_821 |
required_time | Double | Deprecated dummy field. A value must be supplied. | 1.0 |
open/on_state | Integer | Integer code representing the open or on state. | 1 |
closed/off_state | Integer | Integer code representing the closed or off state. | 0 |
neutral_state | Integer | Integer code for the neutral control state. | -1 |
control_failure_state | String | Failure state for the controller. Valid values: ON, OFF, OPEN, CLOSE, NONE. NONE maps to neutral_state. | NONE |
Controller Failure State Mapping
control_failure_state | Failure Control Value |
|---|---|
OPEN or ON | open/on_state |
CLOSE or OFF | closed/off_state |
NONE | neutral_state |
Section 7 — Alarm Sections
Alarm_for_Parameter_State
Activates when a thermal hydraulic parameter crosses a threshold.
| Parameter | Type | Description | Example Value |
|---|---|---|---|
number_of_parameter_alarms | Integer, > 0 | Count of parameter-based alarms. Must exactly match the number listed. | 5 |
alarm_name | String | Descriptive name for the alarm. No spaces; use _. Prefix A_ recommended. Prefix A_ENDSEQ_ terminates the simulation sequence upon alarm activation. | A_SG_A_Lo_Level |
alarm_parameter | String | Must match a parameter_name or heat structure indicator in ControlPanel.txt. | SG_A_NR_Level |
alarm_weight | Double | Alarm importance weighting factor. Not fully implemented — enter a dummy value. | 0.5 |
required_time | Double | Deprecated dummy field. A value must be supplied. | 20.0 |
logic | String | Comparison operator: GT, GE, EQ, LE, LT. Alarm activates when alarm_parameter logic setpoint is true. No quotes. | LT |
setpoint | Double | Alarm threshold value. | 0.25 |
WARNING
Any alarm whose name begins with A_ENDSEQ_ will cause the accident sequence simulation to terminate when that alarm is activated. This prefix should only be used intentionally to define end-of-sequence termination conditions.
Alarm_for_Component_State
Activates when a component enters a specified operating state.
| Parameter | Type | Description | Example Value |
|---|---|---|---|
number_of_component_alarms | Integer, > 0 | Count of component state alarms. Must exactly match the number listed. | 3 |
alarm_name | String | Alarm name. Prefix A_ recommended. A_ENDSEQ_ terminates the sequence. | A_Reactor_Trip |
alarm_component | String | Must match a component_name in ControlPanel.txt. | Reactor_Trip |
alarm_weight | Double | Dummy importance weighting value. | 0.0 |
required_time | Double | Deprecated dummy field. | 20.0 |
state_setpoint | String | Component state that activates the alarm. Valid values: ON, OFF, OPEN, CLOSE. No quotes. | ON |
Alarm_for_Parameter_Difference (Alarm_Parameter_Difference)
Activates when the difference between two parameters exceeds a threshold. The alarm is only activated by a one-sided deviation: first_parameter − second_parameter > diff_setpoint. To detect two-sided deviations, define two complementary difference alarms with the parameters reversed.
| Parameter | Type | Description | Example Value |
|---|---|---|---|
number_of_difference_alarms | Integer, > 0 | Count of parameter difference alarms. Must exactly match the number listed. | 2 |
alarm_name | String | Alarm name. Prefix A_ recommended. A_ENDSEQ_ terminates the sequence. | A_SG_A_MF_Flow_Lo |
first_parameter | String | Must match a parameter_name or heat structure indicator in ControlPanel.txt. | SG_A_MS_Flow |
alarm_weight | Double | Dummy importance weighting value. | 0.5 |
required_time | Double | Deprecated dummy field. | 20.0 |
second_parameter | String | Must match a parameter_name or heat structure indicator in ControlPanel.txt. | SG_A_FW_Flow |
diff_setpoint | Double | Alarm activates when first_parameter − second_parameter > diff_setpoint. | 350.0 |
Sample Input
The sample below demonstrates 14 parameters, 1 heat structure, 3 components, no support system displays, 3 fine adjustment controls, 2 binary controllers, and 5 alarms (across parameter, component, and difference alarm types).
Control_Panel_Parameter 14
Number_of_Data_Points_for_Rate_Calculation 120
Time CV_002 Value 20.0 0.0
Core_Power CV_100 Value 20.0 0.0
SUR CV_491 Value 20.0 1.0
Loop_A_Tcold HV_216 Liquid_Temperature 20.0 0.0
Loop_A_Tave CV_101 Value 20.0 0.0
Loop_A_Thot HV_204 Liquid_Temperature 20.0 0.0
PZR_Pressure HV_340 Pressure 20.0 0.0
RATE_PZR_Pressure HV_340 Pressure 20.0 0.0
PZR_Level CV_202 Value 20.0 0.0
RATE_PZR_Level CV_202 Value 20.0 0.0
SG_A_NR_Level CV_502 Value 20.0 0.0
SG_A_FW_Flow HJ_527 Mass_Flow_Rate 20.0 0.0
SG_A_MS_Flow HJ_282 Mass_Flow_Rate 20.0 0.0
PZR_Level_Setpoint CV_188 Value 20.0 0.0
Indicator_Heat_Structure_value 1
THS_57001 HS_57001 Temperature 20.0 0.0 1
Control_Panel_Component_State 3
Reactor_Trip LT_1698 Trip_Time 20.0 OFF GREATER_THEN_ON 1.0E-5
Safety_Injection LT_1669 Trip_Time 20.0 ON GREATER_THEN_ON 1.0E-5
Turbine_Trip LT_1602 Trip_Time 20.0 ON GREATER_THEN_ON 1.0E-5
Control_Panel_Support_System_State 0
Controls_Panel_Fine_Adjust 3
X_PZR_Spray_Valve IC_804 1.0 1.0 0.0 0.0 -1.0
X_PZR_PORV IC_805 1.0 0.33 0.0 0.0 -1.0
X_SG_A_Atmos_PORV IC_806 1.0 1.0 0.0 0.0 -1.0
Control_Panel_Controller 2
X_RCP_A IC_821 1.0 1 0 -1 NONE
X_ACC_A_Outlet_Valve IC_850 1.0 1 -1 0 NONE
Alarm_for_Parameter_State 5
A_SG_A_Lo_Level SG_A_NR_Level 0.5 20.0 LT 0.25
A_SG_A_LoLo_Level SG_A_NR_Level 0.5 20.0 LT 0.12
A_SG_A_Hi_Level SG_A_NR_Level 0.5 20.0 GT 0.5
A_PZR_Lo_Pressure PZR_Pressure 0.5 20.0 LT 2100.0
A_ENDSEQ_Parameter Core_Power 0.5 20.0 LT 0.001
Alarm_for_Component_State 3
A_Reactor_Trip Reactor_Trip 0.0 20.0 ON
A_Safety_Injection Safety_Injection 0.0 20.0 ON
A_Turbine_Trip Turbine_Trip 0.0 20.0 ON
Alarm_for_Difference_Between_two_Values 2
A_SG_A_MF_Flow_Lo SG_A_MS_Flow 0.5 20.0 SG_A_FW_Flow 350.0
A_PZR_Level_Hi_Dev PZR_Level 0.5 20.0 PZR_Level_Setpoint 0.05Sample Notes
RATE_PZR_PressureandRATE_PZR_Levelboth reference channelHV_340andCV_202respectively, demonstrating theRATE_prefix for trend indication.- The
A_ENDSEQ_Parameteralarm onCore_Powerwill terminate the simulation sequence if core power drops below 0.001. - The difference alarms
A_SG_A_MF_Flow_LoandA_PZR_Level_Hi_Deveach detect one-sided deviations between paired parameters.