BaseLib::MPI Namespace Reference

Classes
struct	Mpi
struct	Setup

Functions
template<typename T >
constexpr MPI_Datatype	mpiType ()
template<typename T >
static std::vector< T >	allgather (T const &value, Mpi const &mpi)
template<typename T >
static std::vector< T >	allgather (std::vector< T > const &vector, Mpi const &mpi)
template<typename T >
static T	allreduce (T const &value, MPI_Op const &mpi_op, Mpi const &mpi)
template<typename T >
static std::vector< T >	allreduce (std::vector< T > const &vector, MPI_Op const &mpi_op, Mpi const &mpi)
template<typename T >
static void	allreduceInplace (std::vector< T > &vector, MPI_Op const &mpi_op, Mpi const &mpi)
template<typename T >
static std::vector< int >	allgatherv (std::span< T > const send_buffer, std::vector< std::remove_const_t< T > > &receive_buffer, Mpi const &mpi)
static bool	anyOf (bool const val, Mpi const &mpi=Mpi{OGS_COMM_WORLD})

Variables
MPI_Comm	OGS_COMM_WORLD = MPI_COMM_WORLD

Function Documentation

allgather() [1/2]

template<typename T >

static std::vector< T > BaseLib::MPI::allgather ( std::vector< T > const & vector, Mpi const & mpi )

static

Definition at line 115 of file MPI.h.

{
    std::size_t const size = vector.size();
    // Flat in memory over all ranks;
    std::vector<T> result(mpi.size * size);
 
    MPI_Allgather(vector.data(), size, mpiType<T>(), result.data(), size,
                  mpiType<T>(), mpi.communicator);
 
    return result;
}

References BaseLib::MPI::Mpi::communicator, mpiType(), and BaseLib::MPI::Mpi::size.

allgather() [2/2]

template<typename T >

static std::vector< T > BaseLib::MPI::allgather ( T const & value, Mpi const & mpi )

static

Definition at line 104 of file MPI.h.

{
    std::vector<T> result(mpi.size);
 
    MPI_Allgather(&value, 1, mpiType<T>(), result.data(), 1, mpiType<T>(),
                  mpi.communicator);
 
    return result;
}

References BaseLib::MPI::Mpi::communicator, mpiType(), and BaseLib::MPI::Mpi::size.

Referenced by allgatherv(), MeshLib::computeNumberOfRegularBaseNodesAtRank(), MeshLib::computeNumberOfRegularHigherOrderNodesAtRank(), MeshLib::computeRegularBaseNodeGlobalNodeIDsOfSubDomainPartition(), MeshLib::IO::getPartitionInfo(), MeshLib::IO::getTopologyType(), and MeshLib::IO::NodePartitionedMeshReader::newMesh().

allgatherv()

template<typename T >

static std::vector< int > BaseLib::MPI::allgatherv ( std::span< T > const send_buffer, std::vector< std::remove_const_t< T > > & receive_buffer, Mpi const & mpi )

static

Allgather for variable data. Returns offsets in the receive buffer. The receive buffer is resized to accommodate the gathered data.

Definition at line 164 of file MPI.h.

{
    // Determine the number of elements to send
    int const size = static_cast<int>(send_buffer.size());
 
    // Gather sizes from all ranks
    std::vector<int> const sizes = allgather(size, mpi);
 
    // Compute offsets based on counts
    std::vector<int> const offsets = BaseLib::sizesToOffsets(sizes);
 
    // Resize receive buffer to hold all gathered data
    receive_buffer.resize(offsets.back());
 
    MPI_Allgatherv(send_buffer.data(), size, mpiType<T>(),
                   receive_buffer.data(), sizes.data(), offsets.data(),
                   mpiType<T>(), mpi.communicator);
 
    return offsets;
}

References allgather(), BaseLib::MPI::Mpi::communicator, mpiType(), and BaseLib::sizesToOffsets().

Referenced by MeshLib::computeGhostBaseNodeGlobalNodeIDsOfSubDomainPartition(), and MathLib::PETScVector::getGlobalVector().

allreduce() [1/2]

template<typename T >

static std::vector< T > BaseLib::MPI::allreduce ( std::vector< T > const & vector, MPI_Op const & mpi_op, Mpi const & mpi )

static

Definition at line 137 of file MPI.h.

{
    std::size_t const size = vector.size();
    std::vector<T> result(vector.size());
 
    MPI_Allreduce(vector.data(), result.data(), size, mpiType<T>(), mpi_op,
                  mpi.communicator);
    return result;
}

References BaseLib::MPI::Mpi::communicator, and mpiType().

allreduce() [2/2]

template<typename T >

static T BaseLib::MPI::allreduce ( T const & value, MPI_Op const & mpi_op, Mpi const & mpi )

static

Definition at line 128 of file MPI.h.

{
    T result{};
 
    MPI_Allreduce(&value, &result, 1, mpiType<T>(), mpi_op, mpi.communicator);
    return result;
}

References BaseLib::MPI::Mpi::communicator, and mpiType().

Referenced by MeshGeoToolsLib::BoundaryElementsAtPoint::BoundaryElementsAtPoint(), MeshLib::getNumberOfGlobalNodes(), NumLib::anonymous_namespace{DOFTableUtil.cpp}::norm1(), NumLib::anonymous_namespace{DOFTableUtil.cpp}::norm2(), NumLib::anonymous_namespace{DOFTableUtil.cpp}::normInfinity(), ProcessLib::PhaseField::PhaseFieldProcess< DisplacementDim >::postNonLinearSolverConcreteProcess(), ProcessLib::PhaseField::PhaseFieldProcess< DisplacementDim >::postTimestepConcreteProcess(), and MeshLib::IO::NodePartitionedMeshReader::readProperties().

allreduceInplace()

template<typename T >

static void BaseLib::MPI::allreduceInplace ( std::vector< T > & vector, MPI_Op const & mpi_op, Mpi const & mpi )

static

Definition at line 149 of file MPI.h.

{
    MPI_Allreduce(MPI_IN_PLACE,
                  vector.data(),
                  vector.size(),
                  mpiType<T>(),
                  mpi_op,
                  mpi.communicator);
}

References BaseLib::MPI::Mpi::communicator, and mpiType().

Referenced by MeshLib::computeGhostBaseNodeGlobalNodeIDsOfSubDomainPartition().

anyOf()

static bool BaseLib::MPI::anyOf ( bool const val, Mpi const & mpi = Mpi{OGS_COMM_WORLD} )

inlinestatic

The reduction is implemented transparently for with and without MPI. In the latter case the input value is returned.

Definition at line 191 of file MPI.h.

                                             {OGS_COMM_WORLD}
#endif
)
{
#ifdef USE_PETSC
    return allreduce(val, MPI_LOR, mpi);
#else
    return val;
#endif
}

References OGS_COMM_WORLD.

Referenced by ProcessLib::AssemblyMixin< Process >::assembleWithJacobian(), and NumLib::NonlinearSolver< NonlinearSolverTag::Newton >::solve().

mpiType()

template<typename T >

MPI_Datatype BaseLib::MPI::mpiType ( )

constexpr

Definition at line 70 of file MPI.h.

{
    using U = std::remove_const_t<T>;
    if constexpr (std::is_same_v<U, bool>)
    {
        return MPI_C_BOOL;
    }
    if constexpr (std::is_same_v<U, char>)
    {
        return MPI_CHAR;
    }
    if constexpr (std::is_same_v<U, double>)
    {
        return MPI_DOUBLE;
    }
    if constexpr (std::is_same_v<U, float>)
    {
        return MPI_FLOAT;
    }
    if constexpr (std::is_same_v<U, int>)
    {
        return MPI_INT;
    }
    if constexpr (std::is_same_v<U, std::size_t>)
    {
        return MPI_UNSIGNED_LONG;
    }
    if constexpr (std::is_same_v<U, unsigned int>)
    {
        return MPI_UNSIGNED;
    }
}

Referenced by allgather(), allgather(), allgatherv(), allreduce(), allreduce(), and allreduceInplace().

Variable Documentation

OGS_COMM_WORLD

MPI_Comm BaseLib::MPI::OGS_COMM_WORLD = MPI_COMM_WORLD

Definition at line 15 of file MPI.cpp.

Referenced by ApplicationsLib::LinearSolverLibrarySetup::LinearSolverLibrarySetup(), MeshLib::IO::PVDFile::addVTUFile(), anyOf(), MeshLib::IO::getCommunicator(), initializeLogger(), BaseLib::initOGSLogger(), MeshLib::IO::isFileManager(), ChemistryLib::PhreeqcIOData::specifyFileName(), and MeshLib::IO::VtuInterface::writeVTU().