Class AMPManagerProperties is a class that contains the various startup options for AMP. More...

#include <AMPManager.h>

Public Member Functions
	AMPManagerProperties ()
	Empty constructor. This creates the default startup parameters.

Public Attributes
bool	bind_process_to_accelerator = true
	Associate each accelerator with a single MPI rank (default is true)

bool	catch_exit = true
	Catch early exit.

bool	catch_HDF5 = true
	Set error handlers for HDF5 routines.

bool	catch_MPI = true
	Set error handlers for MPI routines.

bool	catch_PETSc = true
	Set error handlers for PETSc routines.

bool	catch_SAMRAI = true
	Set error handlers for SAMRAI routines.

std::set< int >	catch_signals
	The set of unhandled signals to set (will be initialized to a default set)

AMP_MPI::Comm	COMM_WORLD

int	default_Kokkos_threads = 0

int	default_OpenMP_threads = 0

std::function< void(StackTrace::abort_error &)>	error_handler = nullptr
	Set a user-provided function for handling all errors.

bool	initialize_device = true
	Initialize CUDA/HIP device (default is true)

int	print_memory = -1
	Print memory statistics (default is only if leaks detected)

bool	print_startup = false
	Print version information upon startup (default is false)

bool	print_times = false
	Print the time required to initialize or shutdown each package. Default is false.

int	profile_MPI_level = 2
	The default level for the MPI timers. Default is 2.

int	stack_trace_type = 3

bool	use_MPI_Abort = true

Friends
class	AMPManager

Detailed Description

Class AMPManagerProperties is a class that contains the various startup options for AMP.

Definition at line 25 of file AMPManager.h.

Constructor & Destructor Documentation

◆ AMPManagerProperties()

AMP::AMPManagerProperties::AMPManagerProperties ( )

Empty constructor. This creates the default startup parameters.

Friends And Related Symbol Documentation

◆ AMPManager

friend class AMPManager

friend

Definition at line 119 of file AMPManager.h.

Member Data Documentation

◆ bind_process_to_accelerator

bool AMP::AMPManagerProperties::bind_process_to_accelerator = true

Associate each accelerator with a single MPI rank (default is true)

Definition at line 53 of file AMPManager.h.

◆ catch_exit

bool AMP::AMPManagerProperties::catch_exit = true

Catch early exit.

Definition at line 83 of file AMPManager.h.

◆ catch_HDF5

bool AMP::AMPManagerProperties::catch_HDF5 = true

Set error handlers for HDF5 routines.

Definition at line 80 of file AMPManager.h.

◆ catch_MPI

bool AMP::AMPManagerProperties::catch_MPI = true

Set error handlers for MPI routines.

Definition at line 71 of file AMPManager.h.

◆ catch_PETSc

bool AMP::AMPManagerProperties::catch_PETSc = true

Set error handlers for PETSc routines.

Definition at line 74 of file AMPManager.h.

◆ catch_SAMRAI

bool AMP::AMPManagerProperties::catch_SAMRAI = true

Set error handlers for SAMRAI routines.

Definition at line 77 of file AMPManager.h.

◆ catch_signals

std::set<int> AMP::AMPManagerProperties::catch_signals

The set of unhandled signals to set (will be initialized to a default set)

Definition at line 68 of file AMPManager.h.

◆ COMM_WORLD

AMP_MPI::Comm AMP::AMPManagerProperties::COMM_WORLD

MPI communicator to use for AMP_COMM_WORLD. By default this should be set to AMP_COMM_WORLD if MPI is not initialized. If MPI is initialized, this can be set to AMP_COMM_WORLD, MPI_COMM_WORLD, or any valid MPI communicator. If it is set to AMP_COMM_WORLD then is will default internally to MPI_COMM_WORLD. Note: Currently AMP_COMM_WORLD cannot be changed once AMPManager::startup has been called.

Definition at line 96 of file AMPManager.h.

◆ default_Kokkos_threads

int AMP::AMPManagerProperties::default_Kokkos_threads = 0

Default number of Kokkos threads to use Kokkos OpenMP backend will be initialized according to the following: command line arguments: "--threads", "--kokkos-threads", "--kokkos-num-thread" OMP_NUM_THREADS environmental value (if set) default_Kokkos_threads (if not equal to 0) default_OpenMP_threads (if not equal to 0) 1 thread if none of the above apply

Definition at line 107 of file AMPManager.h.

◆ default_OpenMP_threads

int AMP::AMPManagerProperties::default_OpenMP_threads = 0

Default number of OpenMP threads to use OpenMP will be initialized according to the following: Kokkos (may override OpenMP) default_OpenMP_threads (if not equal to 0) 1 thread if none of the above apply

Definition at line 116 of file AMPManager.h.

◆ error_handler

std::function<void( StackTrace::abort_error & )> AMP::AMPManagerProperties::error_handler = nullptr

Set a user-provided function for handling all errors.

Definition at line 86 of file AMPManager.h.

◆ initialize_device

bool AMP::AMPManagerProperties::initialize_device = true

Initialize CUDA/HIP device (default is true)

Definition at line 50 of file AMPManager.h.

◆ print_memory

int AMP::AMPManagerProperties::print_memory = -1

Print memory statistics (default is only if leaks detected)

Definition at line 47 of file AMPManager.h.

◆ print_startup

bool AMP::AMPManagerProperties::print_startup = false

Print version information upon startup (default is false)

Definition at line 44 of file AMPManager.h.

◆ print_times

bool AMP::AMPManagerProperties::print_times = false

Print the time required to initialize or shutdown each package. Default is false.

Definition at line 41 of file AMPManager.h.

◆ profile_MPI_level

int AMP::AMPManagerProperties::profile_MPI_level = 2

The default level for the MPI timers. Default is 2.

Definition at line 56 of file AMPManager.h.

◆ stack_trace_type

int AMP::AMPManagerProperties::stack_trace_type = 3

Stack trace to print on error: 0 - Don't print the call stack 1 - Current process/thread 2 - Current process, all threads 3 - Global call stack

Definition at line 65 of file AMPManager.h.

◆ use_MPI_Abort

bool AMP::AMPManagerProperties::use_MPI_Abort = true

Use MPI_Abort. This determines if we want to use MPI_Abort (default) or throw an exception when we abort. Note that using MPI_Abort will safely terminate all processes, but is incompatible with try, catch. A standard exception can be caught, but can easily lead to errors where different processors get stuck when a single process encounters an error. It is strongly recommended to use MPI_Abort.

Definition at line 38 of file AMPManager.h.

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

src/utils/AMPManager.h

Public Member Functions

Public Attributes

Friends