CommSerial.h

Go to the documentation of this file.

///////////////////////////////////////////////////////////////////////////////
//
// File: CommSerial.h
//
// For more information, please see: http://www.nektar.info
//
// The MIT License
//
// Copyright (c) 2006 Division of Applied Mathematics, Brown University (USA),
// Department of Aeronautics, Imperial College London (UK), and Scientific
// Computing and Imaging Institute, University of Utah (USA).
//
// Permission is hereby granted, free of charge, to any person obtaining a
// copy of this software and associated documentation files (the "Software"),
// to deal in the Software without restriction, including without limitation
// the rights to use, copy, modify, merge, publish, distribute, sublicense,
// and/or sell copies of the Software, and to permit persons to whom the
// Software is furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included
// in all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
// THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
// DEALINGS IN THE SOFTWARE.
//
// Description: CommSerial header
//
///////////////////////////////////////////////////////////////////////////////
#ifndef NEKTAR_LIB_UTILITIES_COMMSERIAL_H
#define NEKTAR_LIB_UTILITIES_COMMSERIAL_H
 
#include <string>
 
#include <LibUtilities/Communication/Comm.h>
#include <LibUtilities/LibUtilitiesDeclspec.h>
#include <LibUtilities/Memory/NekMemoryManager.hpp>
 
namespace Nektar::LibUtilities
{
// Forward declarations
class CommSerial;
 
/// Pointer to a Communicator object.
typedef std::shared_ptr<CommSerial> CommSerialSharedPtr;
 
/// A global linear system.
class CommSerial : public Comm
{
public:
    /// Creates an instance of this class
    LIB_UTILITIES_EXPORT static CommSharedPtr create(int narg, char *arg[])
    {
        return MemoryManager<CommSerial>::AllocateSharedPtr(narg, arg);
    }
 
    /// Name of class
    LIB_UTILITIES_EXPORT static std::string className;
 
    LIB_UTILITIES_EXPORT CommSerial(int argc, char *argv[]);
    LIB_UTILITIES_EXPORT ~CommSerial() override;
 
protected:
    LIB_UTILITIES_EXPORT void v_Finalise() final;
    LIB_UTILITIES_EXPORT int v_GetRank() override;
    LIB_UTILITIES_EXPORT bool v_TreatAsRankZero() override;
    LIB_UTILITIES_EXPORT bool v_IsSerial() override;
    LIB_UTILITIES_EXPORT std::tuple<int, int, int> v_GetVersion() final;
    LIB_UTILITIES_EXPORT void v_Block() final;
    LIB_UTILITIES_EXPORT NekDouble v_Wtime() final;
 
    LIB_UTILITIES_EXPORT void v_Send(const void *buf, int count,
                                     CommDataType dt, int dest) final;
    LIB_UTILITIES_EXPORT void v_Recv(void *buf, int count, CommDataType dt,
                                     int source) final;
    LIB_UTILITIES_EXPORT void v_SendRecv(const void *sendbuf, int sendcount,
                                         CommDataType sendtype, int dest,
                                         void *recvbuf, int recvcount,
                                         CommDataType recvtype,
                                         int source) final;
 
    LIB_UTILITIES_EXPORT void v_AllReduce(void *buf, int count, CommDataType dt,
                                          enum ReduceOperator pOp) final;
 
    LIB_UTILITIES_EXPORT void v_AlltoAll(const void *sendbuf, int sendcount,
                                         CommDataType sendtype, void *recvbuf,
                                         int recvcount,
                                         CommDataType recvtype) final;
    LIB_UTILITIES_EXPORT void v_AlltoAllv(
        const void *sendbuf, const int *sendcounts, const int *senddispls,
        CommDataType sendtype, void *recvbuf, const int *recvcounts,
        const int *recvdispls, CommDataType recvtype) final;
 
    LIB_UTILITIES_EXPORT void v_AllGather(const void *sendbuf, int sendcount,
                                          CommDataType sendtype, void *recvbuf,
                                          int recvcount,
                                          CommDataType recvtype) final;
    LIB_UTILITIES_EXPORT void v_AllGatherv(const void *sendbuf, int sendcount,
                                           CommDataType sendtype, void *recvbuf,
                                           const int *recvcounts,
                                           const int *recvdispls,
                                           CommDataType recvtype) final;
    LIB_UTILITIES_EXPORT void v_AllGatherv(void *recvbuf, const int *recvcounts,
                                           const int *recvdispls,
                                           CommDataType recvtype) final;
 
    LIB_UTILITIES_EXPORT void v_Bcast(void *buffer, int count, CommDataType dt,
                                      int root) final;
    LIB_UTILITIES_EXPORT void v_Gather(const void *sendbuf, int sendcount,
                                       CommDataType sendtype, void *recvbuf,
                                       int recvcount, CommDataType recvtype,
                                       int root) final;
    LIB_UTILITIES_EXPORT void v_Scatter(const void *sendbuf, int sendcount,
                                        CommDataType sendtype, void *recvbuf,
                                        int recvcount, CommDataType recvtype,
                                        int root) final;
 
    LIB_UTILITIES_EXPORT void v_DistGraphCreateAdjacent(
        int indegree, const int *sources, const int *sourceweights,
        int reorder) final;
    LIB_UTILITIES_EXPORT void v_NeighborAlltoAllv(
        const void *sendbuf, const int *sendcounts, const int *senddispls,
        CommDataType sendtype, void *recvbuf, const int *recvcounts,
        const int *recvdispls, CommDataType recvtype) final;
 
    LIB_UTILITIES_EXPORT void v_Irsend(const void *buf, int count,
                                       CommDataType dt, int dest,
                                       CommRequestSharedPtr request,
                                       int loc) final;
    LIB_UTILITIES_EXPORT void v_Isend(const void *buf, int count,
                                      CommDataType dt, int dest,
                                      CommRequestSharedPtr request,
                                      int loc) final;
    LIB_UTILITIES_EXPORT void v_SendInit(const void *buf, int count,
                                         CommDataType dt, int dest,
                                         CommRequestSharedPtr request,
                                         int loc) final;
    LIB_UTILITIES_EXPORT void v_Irecv(void *buf, int count, CommDataType dt,
                                      int source, CommRequestSharedPtr request,
                                      int loc) final;
    LIB_UTILITIES_EXPORT void v_RecvInit(void *buf, int count, CommDataType dt,
                                         int source,
                                         CommRequestSharedPtr request,
                                         int loc) final;
 
    LIB_UTILITIES_EXPORT void v_StartAll(CommRequestSharedPtr request) final;
    LIB_UTILITIES_EXPORT void v_WaitAll(CommRequestSharedPtr request) final;
 
    LIB_UTILITIES_EXPORT CommRequestSharedPtr v_CreateRequest(int num) final;
    LIB_UTILITIES_EXPORT void v_SplitComm(int pRows, int pColumns,
                                          int pTime) override;
    LIB_UTILITIES_EXPORT CommSharedPtr v_CommCreateIf(int flag) final;
};
} // namespace Nektar::LibUtilities
 
#endif