#include <SimConfig.h>

Public Attributes
int	thermo_cache_mode = 0
	0 = reuse cached steam tables (default), 2 = force reload every sequence (–no-thermo-cache). Passed to ThermalHydraulicSolver::setThermoCacheMode More...

bool	memory_restart = false
	In-memory restart. parseOptions() sets it to !–no-memory-restart, so it is TRUE in every run unless –no-memory-restart is given; false only in a struct parseOptions() has not filled. More...

long	memory_limit_mb = 0
	–memory-limit [MB]: 0 = unlimited; >0 = keep a restart buffer in memory only while process RSS is below this, otherwise write it to a file. Rejected together with –no-memory-restart More...

bool	compress_queue = false
	–compress-queue (default off): LZ4-compress RELAP restart buffers held and sent between MPI ranks More...

bool	aggregate_pe_output = false

std::string	shm_prefix
	Path prefix for memory-restart files: "/dev/shm/adsidac_<pid>_" when /dev/shm exists, else "<system temp dir>/adsidac_<pid>_"; empty when memory_restart is false. More...

std::string	solver_url
	REST solver URL (empty = use RELAP5). –solver=mock gives "http://localhost:<--solver-port, default 9090>" unless –solver-url is set. More...

std::string	checkpoint_dir
	–checkpoint-dir as an absolute path, created at startup (empty = disabled) More...

int	checkpoint_interval = 0
	–checkpoint-interval: checkpoint every N completed sequences (0 = disabled); requires checkpoint_dir More...

bool	checkpoint_stop = false
	–checkpoint-stop: exit after the first checkpoint written; requires checkpoint_interval > 0 More...

std::string	resume_file
	–resume checkpoint file as an absolute path (empty = fresh start) More...

bool	resume_has_end_states = false
	True if the BranchRecord restored by a serial resume held end states (checkpoint written by a serial run) More...

int	is_mpi_environment = 0
	1 if OMPI_COMM_WORLD_SIZE or PMI_SIZE is set in the environment, 0 for serial More...

bool	viz_output_events = false
	Stream PE events to viz server (–viz-outputs=events or all) More...

bool	viz_output_end_states = false
	Stream end states to viz server (–viz-outputs=es or all) More...

double	truncation_time_override = 0
	CLI –truncation-time override [s] (0 = use ZCtrlPar.txt value). Not stored in checkpoints. More...

std::string	occupancy_log
	–occupancy-log path: CSV of server queue/worker occupancy (empty = disabled, MPI only). Stored as given; the server opens it after changing into `<project>/rank_0`, so a relative path lands there More...

int	merge_mode = 0

bool	merge_only = false

int	merge_threads = 0
	–merge-threads for –merge-only, threads over rank dirs (0 or less = min(8, hardware threads)) More...

bool	rm_cycle_enabled = false
	–enable-rm-cycle: ReasonMachine snapshot/restore/serialize/tbi machinery (see docs/developer/internals/reason-machine-status.md) More...

Detailed Description

Definition at line 18 of file SimConfig.h.

Member Data Documentation

◆ aggregate_pe_output

bool SimConfig::aggregate_pe_output = false

–aggregate-pe (default off): write PE nodes as records in one file per rank instead of one file per node. Opt-in because it changes the on-disk layout the gold baselines read.

Definition at line 23 of file SimConfig.h.

Referenced by main(), Server::merge_outputs(), Scheduler::parseOptions(), and run_merge_only().

◆ checkpoint_dir

std::string SimConfig::checkpoint_dir

–checkpoint-dir as an absolute path, created at startup (empty = disabled)

Definition at line 28 of file SimConfig.h.

Referenced by main(), Scheduler::parseOptions(), Server::Simulation(), and Server::write_checkpoint().

◆ checkpoint_interval

int SimConfig::checkpoint_interval = 0

–checkpoint-interval: checkpoint every N completed sequences (0 = disabled); requires checkpoint_dir

Definition at line 29 of file SimConfig.h.

Referenced by main(), Scheduler::parseOptions(), and Server::Simulation().

◆ checkpoint_stop

bool SimConfig::checkpoint_stop = false

–checkpoint-stop: exit after the first checkpoint written; requires checkpoint_interval > 0

Definition at line 30 of file SimConfig.h.

Referenced by main(), Scheduler::parseOptions(), and Server::Simulation().

◆ compress_queue

bool SimConfig::compress_queue = false

–compress-queue (default off): LZ4-compress RELAP restart buffers held and sent between MPI ranks

Definition at line 22 of file SimConfig.h.

Referenced by Server::dispatch_resume_tasks(), main(), AdsidacCallback::onBranchingPoint(), Scheduler::parseOptions(), Client::restore_relap_state(), and Server::write_checkpoint().

◆ is_mpi_environment

int SimConfig::is_mpi_environment = 0

1 if OMPI_COMM_WORLD_SIZE or PMI_SIZE is set in the environment, 0 for serial

Definition at line 33 of file SimConfig.h.

Referenced by BranchRecord::addAnEndState(), main(), and AdsidacCallback::onBranchingPoint().

◆ memory_limit_mb

long SimConfig::memory_limit_mb = 0

–memory-limit [MB]: 0 = unlimited; >0 = keep a restart buffer in memory only while process RSS is below this, otherwise write it to a file. Rejected together with –no-memory-restart

Definition at line 21 of file SimConfig.h.

Referenced by main(), Scheduler::parseOptions(), and should_use_memory_restart().

◆ memory_restart

bool SimConfig::memory_restart = false

In-memory restart. parseOptions() sets it to !–no-memory-restart, so it is TRUE in every run unless –no-memory-restart is given; false only in a struct parseOptions() has not filled.

Definition at line 20 of file SimConfig.h.

Referenced by Scheduler::initiationForSimulation(), main(), Scheduler::parseOptions(), restart_path(), and should_use_memory_restart().

◆ merge_mode

int SimConfig::merge_mode = 0

–merge, MPI output merge: 0 = now (default; rename-based, worker-parallel), 1 = serial (legacy rank-0 copy loop, escape hatch and equivalence oracle), 2 = defer (end at tree completion, leave rank dirs + MERGE_PENDING.txt for –merge-only)

Definition at line 38 of file SimConfig.h.

Referenced by Server::merge_outputs(), Scheduler::parseOptions(), and Client::Work().

◆ merge_only

bool SimConfig::merge_only = false

–merge-only: consolidate a deferred or interrupted merge and exit; never runs a simulation. Rejected with –resume or –checkpoint-interval, and under mpirun

Definition at line 42 of file SimConfig.h.

Referenced by Scheduler::parseOptions().

◆ merge_threads

int SimConfig::merge_threads = 0

–merge-threads for –merge-only, threads over rank dirs (0 or less = min(8, hardware threads))

Definition at line 45 of file SimConfig.h.

Referenced by Scheduler::parseOptions(), and run_merge_only().

◆ occupancy_log

std::string SimConfig::occupancy_log

–occupancy-log path: CSV of server queue/worker occupancy (empty = disabled, MPI only). Stored as given; the server opens it after changing into <project>/rank_0, so a relative path lands there

Definition at line 37 of file SimConfig.h.

Referenced by Scheduler::parseOptions(), and Server::Simulation().

◆ resume_file

std::string SimConfig::resume_file

–resume checkpoint file as an absolute path (empty = fresh start)

Definition at line 31 of file SimConfig.h.

Referenced by Server::dispatch_resume_tasks(), BranchRecord::endSimulation(), main(), Scheduler::parseOptions(), and Server::Simulation().

◆ resume_has_end_states

bool SimConfig::resume_has_end_states = false

True if the BranchRecord restored by a serial resume held end states (checkpoint written by a serial run)

Definition at line 32 of file SimConfig.h.

Referenced by BranchRecord::endSimulation(), and main().

◆ rm_cycle_enabled

bool SimConfig::rm_cycle_enabled = false

–enable-rm-cycle: ReasonMachine snapshot/restore/serialize/tbi machinery (see docs/developer/internals/reason-machine-status.md)

Definition at line 46 of file SimConfig.h.

Referenced by Operator::copyOperatorFromRestartInfo(), Operator::copyOperatorFromRestartInfoMultiProcessor(), Operator::copyOperatorToRestartInfo(), OperatorDM::infoChunking(), and Scheduler::parseOptions().

◆ shm_prefix

std::string SimConfig::shm_prefix

Path prefix for memory-restart files: "/dev/shm/adsidac_<pid>_" when /dev/shm exists, else "<system temp dir>/adsidac_<pid>_"; empty when memory_restart is false.

Definition at line 26 of file SimConfig.h.

Referenced by Scheduler::initiationForSimulation(), AdsidacCallback::onBranchingPoint(), Scheduler::parseOptions(), and restart_path().

◆ solver_url

std::string SimConfig::solver_url

REST solver URL (empty = use RELAP5). –solver=mock gives "http://localhost:<--solver-port, default 9090>" unless –solver-url is set.

Definition at line 27 of file SimConfig.h.

Referenced by Client::Client(), main(), and Scheduler::parseOptions().

◆ thermo_cache_mode

int SimConfig::thermo_cache_mode = 0

0 = reuse cached steam tables (default), 2 = force reload every sequence (–no-thermo-cache). Passed to ThermalHydraulicSolver::setThermoCacheMode

Definition at line 19 of file SimConfig.h.

Referenced by Client::execute_relap(), main(), and Scheduler::parseOptions().

◆ truncation_time_override

double SimConfig::truncation_time_override = 0

CLI –truncation-time override [s] (0 = use ZCtrlPar.txt value). Not stored in checkpoints.

Definition at line 36 of file SimConfig.h.

Referenced by Scheduler::parseOptions().

◆ viz_output_end_states

bool SimConfig::viz_output_end_states = false

Stream end states to viz server (–viz-outputs=es or all)

Definition at line 35 of file SimConfig.h.

Referenced by extract_sequence_outputs(), Scheduler::parseOptions(), and viz_outputs_any().

◆ viz_output_events

bool SimConfig::viz_output_events = false

Stream PE events to viz server (–viz-outputs=events or all)

Definition at line 34 of file SimConfig.h.