mpiInfo.hpp

Go to the documentation of this file.

// -------------------------------------------------------//
//
// SHAMROCK code for hydrodynamics
// Copyright (c) 2021-2026 Timothée David--Cléris <tim.shamrock@proton.me>
// SPDX-License-Identifier: CeCILL Free Software License Agreement v2.1
// Shamrock is licensed under the CeCILL 2.1 License, see LICENSE for more information
//
// -------------------------------------------------------//
 
#pragma once
 
#include <optional>
#include <string>
namespace shamcomm {
 
    enum StateMPI_Aware {
        Unknown,
        Yes,
        No,
        ForcedYes,
        ForcedNo
    };
 
    inline bool is_direct_comm_aware(const StateMPI_Aware &v) {
        return (v == Yes || v == ForcedYes);
    }
 
    StateMPI_Aware get_mpi_cuda_aware_status();
 
    StateMPI_Aware get_mpi_rocm_aware_status();
 
    std::optional<StateMPI_Aware> should_force_dgpu_state();
 
    void fetch_mpi_capabilities(std::optional<StateMPI_Aware> forced_state);
 
    void print_mpi_capabilities();
 
    void print_mpi_comm_info();
 
    std::string get_process_name();
 
} // namespace shamcomm