AMPManager.h

Go to the documentation of this file.

#ifndef included_AMP_AMPManager
#define included_AMP_AMPManager
 
#include "AMP/utils/AMP_MPI.h"
 
#include <array>
#include <functional>
#include <memory>
#include <set>
#include <string>
#include <vector>
 
 
namespace StackTrace {
class abort_error;
}
 
 
namespace AMP {
 
 
class AMPManagerProperties
{
public:
    AMPManagerProperties();
 
    bool use_MPI_Abort = true;
 
    bool print_times = false;
 
    bool print_startup = false;
 
    int print_memory = -1;
 
    bool initialize_device = true;
 
    bool bind_process_to_accelerator = true;
 
    int profile_MPI_level = 2;
 
    int stack_trace_type = 3;
 
    std::set<int> catch_signals;
 
    bool catch_MPI = true;
 
    bool catch_PETSc = true;
 
    bool catch_SAMRAI = true;
 
    bool catch_HDF5 = true;
 
    bool catch_exit = true;
 
    std::function<void( StackTrace::abort_error & )> error_handler = nullptr;
 
    AMP_MPI::Comm COMM_WORLD;
 
    int default_Kokkos_threads = 0;
 
    int default_OpenMP_threads = 0;
 
private:
    friend class AMPManager;
};
 
 
class AMPManager
{
public:
    static void startup( int &argc,
                         char *argv[],
                         const AMPManagerProperties &properties = AMPManagerProperties() );
 
    static void shutdown();
 
    static void restart();
 
    static bool isInitialized();
 
    static bool isFinalized();
 
    static std::tuple<int, const char *const *> get_args();
 
    static AMPManagerProperties getAMPManagerProperties();
 
    static void terminate_AMP( std::string message );
 
    static void setHandlers();
 
    static void clearHandlers();
 
    static void setMPIErrorHandler();
 
    static void clearMPIErrorHandler();
 
    static std::array<int, 3> revision();
 
    static std::string info();
 
    static void incrementResource( const std::string &resource );
 
    static void decrementResource( const std::string &resource );
 
    static const AMP::AMP_MPI &getCommWorld();
 
    static void setCommWorld( const AMP::AMP_MPI & );
 
    static void registerShutdown( std::function<void()> );
 
private:
    // Private constructor (we do not actually want to create an object)
    AMPManager() = delete;
 
    // Static variables
    static int d_initialized;
    static int d_argc;
    static const char *const *d_argv;
    static AMPManagerProperties d_properties;
    static std::vector<std::function<void()>> d_atShutdown;
 
    // Function to control exit behavior
    static void exitFun();
 
    // Functions to start/shutdown the various packages
    static double start_SAMRAI();
    static double start_PETSc();
    static double start_HYPRE();
    static double initDevices();
    static double bindDevices();
    static double start_OpenMP();
    static double stop_SAMRAI();
    static double stop_HYPRE();
    static double stop_PETSc();
 
    // wrapper for shutting and restarting SAMRAI
    static void restart_SAMRAI();
 
    // Functions to set error handlers for specific packages
    static void set_PETSc_error_handler();
    static void clear_PETSc_error_handler();
};
 
} // namespace AMP
 
#endif