Skip to content

ADS-IDAC Directory and File Structure ​

Overview ​

An ADS-IDAC run involves two locations: the executable directory (build/bin/, which must contain the steam table files) and a project directory holding one case's inputs and outputs. The project directory can live anywhere; it is passed at run time:

bash
cd build/bin
./adsidac --project-dir=<project> --input-deck=<project>/<deck>.i

Legacy layout

Older manuals describe an ADSSource/ + TestCases/ tree with ADSConsole2.exe and a ZiniADS.txt co-located with the executable. That layout is retired: the executable is build/bin/adsidac, paths are given on the command line, and ZiniADS.txt is an optional defaults file (see ZiniADS.txt).


Executable Directory (build/bin/) ​

FileDescription
adsidacThe ADS-IDAC executable
tpfh2o, tpfh2onew, tpfd2oRELAP5 steam table files — copied here at CMake configure time; the executable must be run from a directory containing them

The 80-character RELAP5 path limit applies to the input-deck path: keep project directories reasonably shallow.


Project Directory ​

EntryDescription
<case>.iRELAP5 plant model input deck (conventionally at the project root, e.g. tests/BV4/BV4.i)
ZiniADS.txtOptional option=value defaults for the CLI (machine-specific; excluded from the checkpoint configuration fingerprint)
Input/All ADS-IDAC input files (fingerprinted for checkpoint/resume)
Output/Simulation results (created/overwritten by runs)

Runtime artifacts ​

Runs also create entries in the project directory that are not inputs:

EntryCreated byNotes
rank_<N>/MPI runsOne working directory per rank, deleted and recreated at the start of every MPI run. After a merge it holds only logs and scratch files and can be removed. Under --merge=defer it is the only copy of the run's outputs until --merge-only consolidates it, which Output/MERGE_PENDING.txt records
checkpoint/CheckpointingDefault location of checkpoint_seq_<n>.dat when no --checkpoint-dir is given at the Ctrl+C menu
restart_base.binADS_RESTART_TRIM=1The part of a restart image shared by the whole run. Created only if absent and not deleted by the engine: remove it when the input deck or plant model changes, keep it with a checkpoint that will be resumed
err messages.txt, indeck.i, restart.r, logsSerial runs, in the launch directoryWorking files

None of these is part of the checkpoint configuration fingerprint.

Reference cases in the repository ​

PathPurpose
tests/BV4/Three-loop PWR reference case used by the test suite. Expected counts are in Reference Baselines
tests/BV3/Reference-only predecessor of BV4; its inputs use formats the current parsers do not accept
studies/sgtr-10k/Full-branching steam generator tube rupture study deck (mission time 10,000 s). A study, not a test fixture: it has no expected counts. See its README.md
studies/sgtr-tree/Designed-tree variant of the same deck, run with the branch floor. See its README.md
scripts/hazel/Cluster job scripts for these studies. See Running on a Cluster

Input/ Directory ​

Input/Crew/ActionTaker/ ​

Knowledge base and behavioral parameters for the Action Taker operator model (reactor operator role):

FileDescription
ActionTaker.txtStatic behavior factors (action time multiplier, scan queue limit, skip thresholds, communication time, goal/strategy tendencies)
KB_OAT_Bias_Factors.txtFailed or biased control panel instrumentation definitions
KB_OAT_Diagnosis_Actions.txtMaps diagnostic events to candidate operator actions
KB_OAT_Event_Matrix.txtFuzzy logic diagnostic event matrix (symptom-to-event mapping)
KB_OAT_HardWired_Diagnosis.txtMental beliefs, activation criteria, associated mental procedures, and branch probabilities
KB_OAT_Maneuver_Actions.txtKnowledge-based maneuver action definitions
KB_OAT_Safety_Parameters.txtCritical safety function parameters and thresholds
KB_OAT_Scanned_Parameters.txtControl panel parameters included in the operator's periodic scan queue
KB_OAT_System_Decomposition.txtSystem functional decomposition for knowledge-based diagnosis
KB_OAT_Time_Constrained_Input.txtTime-constrained action parameters
RM/ReasonMachine knowledge inputs. Only the Decision Maker constructs a ReasonMachine, so the ActionTaker copy is present but unread; the DecisionMaker RM/ is read at initialization (the RM snapshot/restore cycle itself is a developer feature behind --enable-rm-cycle)

Input/Crew/DecisionMaker/ ​

Same structure as ActionTaker/, with files prefixed KB_ODM_ plus DecisionMaker.txt. The Decision Maker models the Senior Reactor Operator role, directing the Action Taker and selecting high-level goals and problem-solving strategies.

Input/Crew/Consultant/ ​

Holds Consultant.txt. The Consultant role is defined in the architecture but no Consultant operator is instantiated in current simulations — the file is not read at runtime. Keep the directory for forward compatibility.

Input/Crew/Procedures/ ​

Procedure definitions and branching parameters (one directory for all procedures; BV4 ships ~460 step files):

FileDescription
Procedures.txtMaster list of all procedures; defines procedure names, types, and entry condition cross-references
ZProcedure_[name]_[step].txtIndividual procedure step input files (one file per step); defines actions, expectations, non-response actions, skip probabilities, and step type
ZProcedure_MPBG_[name]_[step].txtMental procedure step input files (activated by mental belief states)
MentalProcedureActivationTimeBranches.txtWeibull parameters for branching on mental procedure activation time
ProcedureActionTimeBranches.txtWeibull parameters for branching on procedure step action timing
ProcedureControlValueBranches.txtDiscrete control value options and probabilities for control value branching

Input/Crew/ (top level) ​

FileDescription
Calculation_Aid.txtPolynomial calculation-aid definitions available to the crew model
StaticPIF.txtStatic performance influence factors

Input/HardwareReliability/ ​

FileDescription
SystemReliability.txtHardware reliability branching parameters (Beta distribution α and β for failures and recoveries)

Input/Indicators/ ​

FileDescription
ControlPanel.txtDefines all control panel indicators, alarms, and interactive controls visible to the ADS-IDAC operator model
SPDS_input.txtSafety Parameter Display System inputs — legacy, not read by the current code (the control-panel SPDS module is disabled; the active safety-parameter inputs are the per-operator KB_*_Safety_Parameters.txt files)

Input/Scheduler/ ​

FileDescription
ZCtrlPar.txtSimulation control parameters: sequence truncation time and probability cutoff (details)

Input/SupportSystemsReliability/ ​

FileDescription
*.ftaSupport system fault tree definitions, one file per support system, e.g. Diesel Generator.fta, Emergency AC Buses.fta (format). Not quantified in the shipped builds, and the shipped examples are placeholders.

Input/System/ ​

FileDescription
Initiating_Event.txtDefines initiating events (equipment failures or disturbances activating at simulation start)
RELAP5_channels.txtCross-references ADS-IDAC interactive control variables to RELAP5 interactive variable card numbers (800–999)

Output/ Directory ​

Outputs are grouped under three subdirectories, each containing numbered folders (*Folder_0, *Folder_1, …) that hold at most 1000 files each:

Output/
  ES/ESFolder_n/    ZESNode_*.txt, plus ES_summary.txt and analysis logs in ES/
  KPS/KPSFolder_n/  ZKPS_*.txt, ZDIA_*.txt, ZPIF_*.txt
  PE/PEFolder_n/    ZPENode_*.txt        (or ZPENodes_agg.txt with --aggregate-pe)

With --aggregate-pe the pivotal-event nodes are written as records in a single ZPENodes_agg.txt per rank rather than one ZPENode_<id>.txt per node. The content is identical; only the layout differs. Because PE nodes are ~94% of all output files, this is what keeps a long-mission study inside a shared filesystem's file-count quota — see Output layout options.

See Output Files for the content of each file type, MPI merge behavior, and the BV4 reference counts.


Complete Input Files Checklist ​

Verify against the shipped reference case tests/BV4/:

  • Input/Crew/ActionTaker/ — ActionTaker.txt + the ten KB_OAT_* files (+ RM/)
  • Input/Crew/DecisionMaker/ — DecisionMaker.txt + the ten KB_ODM_* files (+ RM/)
  • Input/Crew/Consultant/ — Consultant.txt
  • Input/Crew/Procedures/ — Procedures.txt, ZProcedure_* step files, three *Branches.txt parameter files
  • Input/Crew/ — Calculation_Aid.txt, StaticPIF.txt
  • Input/HardwareReliability/ — SystemReliability.txt
  • Input/Indicators/ — ControlPanel.txt, SPDS_input.txt
  • Input/Scheduler/ — ZCtrlPar.txt
  • Input/SupportSystemsReliability/ — one .fta per modeled support system
  • Input/System/ — Initiating_Event.txt, RELAP5_channels.txt
  • Project root — the RELAP5 .i deck

ADS-IDAC Engine Documentation