General

📄️ setProgramOption

Sets the specified program option for the simulation. These mirror the options available on the sst command line. Parameters set in the python file will be overwritten by options set on the command line. Use sst –help to get a list of available options.

📄️ setProgramOptions

Sets multiple program options for the simulation. These mirror the options available on the sst command line. Parameters set in the python file will be overwritten by options set on the command line. Use sst –help to get a list of available options.

📄️ getProgramOptions

Returns a dictionary with the current values of the program options. This will include all program options, not just those set in the python file.

📄️ getMPIRankCount

Returns the number of physical MPI ranks in the simulation

📄️ getMyMPIRank

Returns the MPI rank that the script is running on.

📄️ getThreadCount

Returns the threads per rank specified for the simulation.

📄️ setThreadCount

Sets the number of threads per rank for the simulation. These values can be overwritten by using \-n on the command line.

📄️ pushNamePrefix

Pushes a name prefix onto the name stack. This prefix will be added on the names of all Components and Links. The names in the stack are separated by a period. Example, if pushNamePrefix(“base”) and pushNamePrefix(“next”) were called in that order, the prefixed name would be “base.next”. Prefixes can be popped from the stack using popNamePrefix().

📄️ popNamePrefix

Pops a prefix from the name stack. See pushNamePrefix for how name stacks are used.

📄️ exit

Causes the simulation to exit.

📄️ findComponentByName

In many cases, Components and SubComponents will be created using library functions and the user will not have direct access to their handles. In some instances, the provided python modules will have accessor functions that can provide handles to these elements. If this is not provided by the library, the user can call the findComponentByName() function to get a handle to the desired element. The function can find handles for both Components and SubComponents. The use of this function presupposes a knowledge of the naming convention of the elements in the build functions of the library.

📄️ addGlobalParam

"GlobalParam" has been renamed to "SharedParam" in SST 15.0 to better reflect the shared rather than strictly global nature of these parameter sets. See addSharedParam instead.

📄️ addGlobalParams

"GlobalParam" has been renamed to "SharedParam" in SST 15.0 to better reflect the shared rather than strictly global nature of these parameter sets. See addSharedParams instead.

📄️ addSharedParam

It is common for multiple components or subcomponents in a simulation to share a common subset of parameters. Shared parameter sets can be used to reduce memory usage during simulation construction for such cases. This is particularly helpful for very large simulations where the total state of the simulation graph before it is distributed may exceed the available memory on rank 0. To use shared parameters, register parameters to named sets using addSharedParam() and/or addSharedParams(). Then, subscribe components and subcomponents to the named parameter set(s) using addSharedParamSet(). In case of conflicts, parameters set directly on components take precedence over those provided in shared parameter sets.