SAMRAI::tbox::SAMRAIManager Struct Reference

Class SAMRAIManager is a utility for managing startup and shutdown for SAMRAI applications and for changing the maximum number of patch data components supported by SAMRAI patches. All applications should call SAMRAIManager::startup() (or SAMRAIManager::startup()) at the beginning of the program. Startup should be called after initializing MPI but before any SAMRAI objects are used. SAMRAIManager::shutdown() (or SAMRAIManager:shutdown()) should be called near the end of the program, but before shutting down MPI and calling exit(0). Note that the shutdown function does not exit the program; it merely shuts down certain packages and deallocates memory (mostly objects with static members).

#include <tbox/SAMRAIManager.h>

Static Public Member Functions
static void	startup ()
static void	shutdown ()
static int	getMaxNumberPatchDataEntries ()
static void	setMaxNumberPatchDataEntries (int maxnum)

Static Private Attributes
static int	s_max_patch_data_entries
static bool	s_max_patch_data_entries_accessed

Member Function Documentation

startup()

static void SAMRAI::tbox::SAMRAIManager::startup ( )

static

Initialize the SAMRAI package. Depending on the architecture and compile flags, this routine sets up MPI, initializes IEEE exception handlers, and other architecture-specific details.

shutdown()

static void SAMRAI::tbox::SAMRAIManager::shutdown ( )

static

Shutdown the SAMRAI package. Depending on the compile flags set at compile-time, this routine shuts down MPI and calls registered shutdown handlers.

getMaxNumberPatchDataEntries()

static int SAMRAI::tbox::SAMRAIManager::getMaxNumberPatchDataEntries ( )

static

Return maximum number of patch data entries supported by SAMRAI. The value is either the default value (256) or the value set by calling the setMaxNumberPatchDataEntries() function.

setMaxNumberPatchDataEntries()

static void SAMRAI::tbox::SAMRAIManager::setMaxNumberPatchDataEntries ( int  maxnum )

static

Set maximum number of patch data entries supported by SAMRAI to the maximum of the current value and the argument value.

Note that this routine cannot be called anytime after the max patch data entries value has been accessed via the getMaxNumberPatchDataEntries() function, either by the user or internally within SAMRAI. Typically, the first internal access of this value occurs whenever any objects related to the patch hierarchy or variables are created.

Member Data Documentation

s_max_patch_data_entries

int SAMRAI::tbox::SAMRAIManager::s_max_patch_data_entries

staticprivate

s_max_patch_data_entries_accessed

bool SAMRAI::tbox::SAMRAIManager::s_max_patch_data_entries_accessed

staticprivate

---

The documentation for this struct was generated from the following file:

• /samrai/include/tbox/SAMRAIManager.h