SST  12.0.1
StructuralSimulationToolkit
SST::Config Class Reference

Class to contain SST Simulation Configuration variables. More...

#include <config.h>

Inheritance diagram for SST::Config:
SST::Core::Serialization::serializable

Public Member Functions

 ~Config ()
 Create a new Config object. More...
 
uint32_t verbose () const
 Level of verbosity to use in the core prints using Output.verbose or Output.debug.
 
uint32_t num_threads () const
 Number of threads requested.
 
uint32_t num_ranks () const
 Number of ranks in the simulation.
 
const std::string & configFile () const
 Name of the SDL file to use to genearte the simulation.
 
const std::string & model_options () const
 Model options to pass to the SDL file.
 
bool print_timing () const
 Print SST timing information after the run.
 
const std::string & stop_at () const
 Simulated cycle to stop the simulation at.
 
uint32_t exit_after () const
 Wall clock time (approximiate) in seconds to stop the simulation at.
 
const std::string & partitioner () const
 Partitioner to use for parallel simualations.
 
const std::string & heartbeatPeriod () const
 Simulation period at which to print out a "heartbeat" message.
 
const std::string & output_directory () const
 The directory to be used for writting output files.
 
const std::string output_core_prefix () const
 Prefix to use for the default SST::Output object in core.
 
const std::string & output_config_graph () const
 File to output python formatted config graph to (empty string means no output)
 
const std::string & output_json () const
 File to output json formatted config graph to (empty string means no output)
 
bool parallel_output () const
 If true, and a config graph output option is specified, write each ranks graph separately.
 
const std::string & output_dot () const
 File to output dot formatted config graph to (empty string means no output). More...
 
uint32_t dot_verbosity () const
 Level of verbosity to use for the dot output.
 
const std::string & component_partition_file () const
 File to output component partition info to (empty string means no output)
 
bool output_partition () const
 Controls whether partition info is output as part of configuration output.
 
const std::string & timeBase () const
 Core timebase to use as the atomic time unit for the simulation. More...
 
bool parallel_load () const
 Controls whether graph constuction will be done in parallel. More...
 
bool parallel_load_mode_multi () const
 If graph constuction will be done in parallel, will use a file per rank if true, and the same file for each rank if false.
 
const std::string & timeVortex () const
 TimeVortex implementation to use.
 
bool interthread_links () const
 Use links that connect directly to ActivityQueue in receiving thread.
 
const std::string & debugFile () const
 File to which core debug information should be written.
 
const std::string & libpath () const
 Library path to use for finding element libraries (will replace the libpath in the sstsimulator.conf file)
 
const std::string & addLibPath () const
 Paths to add to library search (adds to libpath found in sstsimulator.conf file)
 
Simulation::Mode_t runMode () const
 Run mode to use (Init, Both, Run-only). More...
 
bool rank_seq_startup () const
 Run simulation initialization stages one rank at a time for debug purposes.
 
bool print_env () const
 Controls whether the environment variables that SST sees are printed out.
 
bool enable_sig_handling () const
 Controls whether signal handlers are enable or not. More...
 
bool no_env_config () const
 
void print ()
 Print to stdout the current configuration.
 
void serialize_order (SST::Core::Serialization::serializer &ser) override
 
- Public Member Functions inherited from SST::Core::Serialization::serializable
virtual const char * cls_name () const =0
 
virtual uint32_t cls_id () const =0
 
virtual std::string serialization_name () const =0
 

Friends

class ConfigHelper
 
class SSTModelDescription
 

Additional Inherited Members

- Static Public Attributes inherited from SST::Core::Serialization::serializable
static constexpr uint32_t NullClsId = std::numeric_limits<uint32_t>::max()
 
- Protected Types inherited from SST::Core::Serialization::serializable
enum  cxn_flag_t { ConstructorFlag }
 
- Static Protected Member Functions inherited from SST::Core::Serialization::serializable
static void serializable_abort (uint32_t line, const char *file, const char *func, const char *obj)
 

Detailed Description

Class to contain SST Simulation Configuration variables.

Constructor & Destructor Documentation

SST::Config::~Config ( )
inline

Create a new Config object.

Parameters
world_size- number of parallel ranks in the simulation

Member Function Documentation

bool SST::Config::enable_sig_handling ( ) const
inline

Controls whether signal handlers are enable or not.

NOTE: the sense of this variable is opposite of the command line option (–disable-signal-handlers)

const std::string& SST::Config::output_dot ( ) const
inline

File to output dot formatted config graph to (empty string means no output).

Note, this is not a format that can be used as input for simulation

bool SST::Config::parallel_load ( ) const
inline

Controls whether graph constuction will be done in parallel.

If it is, then the SDL file name is modified to add the rank number to the file name right before the file extension, if parallel_load_mode_multi is true.

Simulation::Mode_t SST::Config::runMode ( ) const
inline

Run mode to use (Init, Both, Run-only).

Note that Run-only is not currently supported because there is not component level checkpointing.

const std::string& SST::Config::timeBase ( ) const
inline

Core timebase to use as the atomic time unit for the simulation.

It is usually best to just leave this at the default (1ps)


The documentation for this class was generated from the following files: