Nektar::LibUtilities::CommSerial Class Reference

A global linear system. More...

#include <CommSerial.h>

Inheritance diagram for Nektar::LibUtilities::CommSerial:

Public Member Functions
	CommSerial (int argc, char *argv[])
	~CommSerial () override
Public Member Functions inherited from Nektar::LibUtilities::Comm
	Comm (int narg, char *arg[])
virtual	~Comm ()
void	Finalise ()
int	GetSize () const
	Returns number of processes. More...
int	GetRank ()
const std::string &	GetType () const
bool	TreatAsRankZero ()
bool	IsSerial ()
bool	IsParallelInTime ()
std::tuple< int, int, int >	GetVersion ()
void	Block ()
	Block execution until all processes reach this point. More...
NekDouble	Wtime ()
	Return the time in seconds. More...
template<class T >
void	Send (int pProc, T &pData)
template<class T >
void	Recv (int pProc, T &pData)
template<class T >
void	SendRecv (int pSendProc, T &pSendData, int pRecvProc, T &pRecvData)
template<class T >
void	AllReduce (T &pData, enum ReduceOperator pOp)
template<class T >
void	AlltoAll (T &pSendData, T &pRecvData)
template<class T1 , class T2 >
void	AlltoAllv (T1 &pSendData, T2 &pSendDataSizeMap, T2 &pSendDataOffsetMap, T1 &pRecvData, T2 &pRecvDataSizeMap, T2 &pRecvDataOffsetMap)
template<class T >
void	AllGather (T &pSendData, T &pRecvData)
template<class T >
void	AllGatherv (T &pSendData, T &pRecvData, Array< OneD, int > &pRecvDataSizeMap, Array< OneD, int > &pRecvDataOffsetMap)
template<class T >
void	AllGatherv (T &pRecvData, Array< OneD, int > &pRecvDataSizeMap, Array< OneD, int > &pRecvDataOffsetMap)
template<class T >
void	Bcast (T &pData, int pRoot)
template<class T >
T	Gather (int rootProc, T &val)
template<class T >
T	Scatter (int rootProc, T &pData)
template<class T >
void	DistGraphCreateAdjacent (T &sources, T &sourceweights, int reorder)
template<class T1 , class T2 >
void	NeighborAlltoAllv (T1 &pSendData, T2 &pSendDataSizeMap, T2 &pSendDataOffsetMap, T1 &pRecvData, T2 &pRecvDataSizeMap, T2 &pRecvDataOffsetMap)
template<class T >
void	Irsend (int pProc, T &pData, int count, const CommRequestSharedPtr &request, int loc)
template<class T >
void	Isend (int pProc, T &pData, int count, const CommRequestSharedPtr &request, int loc)
template<class T >
void	SendInit (int pProc, T &pData, int count, const CommRequestSharedPtr &request, int loc)
template<class T >
void	Irecv (int pProc, T &pData, int count, const CommRequestSharedPtr &request, int loc)
template<class T >
void	RecvInit (int pProc, T &pData, int count, const CommRequestSharedPtr &request, int loc)
void	StartAll (const CommRequestSharedPtr &request)
void	WaitAll (const CommRequestSharedPtr &request)
CommRequestSharedPtr	CreateRequest (int num)
CommSharedPtr	CommCreateIf (int flag)
	If the flag is non-zero create a new communicator. More...
void	SplitComm (int pRows, int pColumns, int pTime=1)
	Splits this communicator into a grid of size pRows*pColumns and creates row and column communicators. By default the communicator is a single row. More...
CommSharedPtr	GetRowComm ()
	Retrieve the row communicator to which this process belongs. More...
CommSharedPtr	GetColumnComm ()
	Retrieve the column communicator to which this process belongs. More...
CommSharedPtr	GetTimeComm ()
	Retrieve the time communicator to which this process belongs. More...
CommSharedPtr	GetSpaceComm ()
	Retrieve the space communicator to which this process belongs. More...
bool	RemoveExistingFiles ()
std::pair< CommSharedPtr, CommSharedPtr >	SplitCommNode ()

Static Public Member Functions
static CommSharedPtr	create (int narg, char *arg[])
	Creates an instance of this class. More...

Static Public Attributes
static std::string	className
	Name of class. More...

Protected Member Functions
void	v_Finalise () final
int	v_GetRank () override
bool	v_TreatAsRankZero () override
bool	v_IsSerial () override
std::tuple< int, int, int >	v_GetVersion () final
void	v_Block () final
NekDouble	v_Wtime () final
void	v_Send (void *buf, int count, CommDataType dt, int dest) final
void	v_Recv (void *buf, int count, CommDataType dt, int source) final
void	v_SendRecv (void *sendbuf, int sendcount, CommDataType sendtype, int dest, void *recvbuf, int recvcount, CommDataType recvtype, int source) final
void	v_AllReduce (void *buf, int count, CommDataType dt, enum ReduceOperator pOp) final
void	v_AlltoAll (void *sendbuf, int sendcount, CommDataType sendtype, void *recvbuf, int recvcount, CommDataType recvtype) final
void	v_AlltoAllv (void *sendbuf, int sendcounts[], int sensdispls[], CommDataType sendtype, void *recvbuf, int recvcounts[], int rdispls[], CommDataType recvtype) final
void	v_AllGather (void *sendbuf, int sendcount, CommDataType sendtype, void *recvbuf, int recvcount, CommDataType recvtype) final
void	v_AllGatherv (void *sendbuf, int sendcount, CommDataType sendtype, void *recvbuf, int recvcounts[], int rdispls[], CommDataType recvtype) final
void	v_AllGatherv (void *recvbuf, int recvcounts[], int rdispls[], CommDataType recvtype) final
void	v_Bcast (void *buffer, int count, CommDataType dt, int root) final
void	v_Gather (void *sendbuf, int sendcount, CommDataType sendtype, void *recvbuf, int recvcount, CommDataType recvtype, int root) final
void	v_Scatter (void *sendbuf, int sendcount, CommDataType sendtype, void *recvbuf, int recvcount, CommDataType recvtype, int root) final
void	v_DistGraphCreateAdjacent (int indegree, const int sources[], const int sourceweights[], int reorder) final
void	v_NeighborAlltoAllv (void *sendbuf, int sendcounts[], int sdispls[], CommDataType sendtype, void *recvbuf, int recvcounts[], int rdispls[], CommDataType recvtype) final
void	v_Irsend (void *buf, int count, CommDataType dt, int dest, CommRequestSharedPtr request, int loc) final
void	v_Isend (void *buf, int count, CommDataType dt, int dest, CommRequestSharedPtr request, int loc) final
void	v_SendInit (void *buf, int count, CommDataType dt, int dest, CommRequestSharedPtr request, int loc) final
void	v_Irecv (void *buf, int count, CommDataType dt, int source, CommRequestSharedPtr request, int loc) final
void	v_RecvInit (void *buf, int count, CommDataType dt, int source, CommRequestSharedPtr request, int loc) final
void	v_StartAll (CommRequestSharedPtr request) final
void	v_WaitAll (CommRequestSharedPtr request) final
CommRequestSharedPtr	v_CreateRequest (int num) final
void	v_SplitComm (int pRows, int pColumns, int pTime) override
CommSharedPtr	v_CommCreateIf (int flag) final
Protected Member Functions inherited from Nektar::LibUtilities::Comm
	Comm ()
virtual void	v_Finalise ()=0
virtual int	v_GetRank ()=0
virtual bool	v_TreatAsRankZero ()=0
virtual bool	v_IsSerial ()=0
virtual std::tuple< int, int, int >	v_GetVersion ()=0
virtual void	v_Block ()=0
virtual NekDouble	v_Wtime ()=0
virtual void	v_Send (void *buf, int count, CommDataType dt, int dest)=0
virtual void	v_Recv (void *buf, int count, CommDataType dt, int source)=0
virtual void	v_SendRecv (void *sendbuf, int sendcount, CommDataType sendtype, int dest, void *recvbuf, int recvcount, CommDataType recvtype, int source)=0
virtual void	v_AllReduce (void *buf, int count, CommDataType dt, enum ReduceOperator pOp)=0
virtual void	v_AlltoAll (void *sendbuf, int sendcount, CommDataType sendtype, void *recvbuf, int recvcount, CommDataType recvtype)=0
virtual void	v_AlltoAllv (void *sendbuf, int sendcounts[], int sensdispls[], CommDataType sendtype, void *recvbuf, int recvcounts[], int rdispls[], CommDataType recvtype)=0
virtual void	v_AllGather (void *sendbuf, int sendcount, CommDataType sendtype, void *recvbuf, int recvcount, CommDataType recvtype)=0
virtual void	v_AllGatherv (void *sendbuf, int sendcount, CommDataType sendtype, void *recvbuf, int recvcounts[], int rdispls[], CommDataType recvtype)=0
virtual void	v_AllGatherv (void *recvbuf, int recvcounts[], int rdispls[], CommDataType recvtype)=0
virtual void	v_Bcast (void *buffer, int count, CommDataType dt, int root)=0
virtual void	v_Gather (void *sendbuf, int sendcount, CommDataType sendtype, void *recvbuf, int recvcount, CommDataType recvtype, int root)=0
virtual void	v_Scatter (void *sendbuf, int sendcount, CommDataType sendtype, void *recvbuf, int recvcount, CommDataType recvtype, int root)=0
virtual void	v_DistGraphCreateAdjacent (int indegree, const int sources[], const int sourceweights[], int reorder)=0
virtual void	v_NeighborAlltoAllv (void *sendbuf, int sendcounts[], int sdispls[], CommDataType sendtype, void *recvbuf, int recvcounts[], int rdispls[], CommDataType recvtype)=0
virtual void	v_Irsend (void *buf, int count, CommDataType dt, int dest, CommRequestSharedPtr request, int loc)=0
virtual void	v_Isend (void *buf, int count, CommDataType dt, int dest, CommRequestSharedPtr request, int loc)=0
virtual void	v_SendInit (void *buf, int count, CommDataType dt, int dest, CommRequestSharedPtr request, int loc)=0
virtual void	v_Irecv (void *buf, int count, CommDataType dt, int source, CommRequestSharedPtr request, int loc)=0
virtual void	v_RecvInit (void *buf, int count, CommDataType dt, int source, CommRequestSharedPtr request, int loc)=0
virtual void	v_StartAll (CommRequestSharedPtr request)=0
virtual void	v_WaitAll (CommRequestSharedPtr request)=0
virtual CommRequestSharedPtr	v_CreateRequest (int num)=0
virtual void	v_SplitComm (int pRows, int pColumns, int pTime)=0
virtual CommSharedPtr	v_CommCreateIf (int flag)=0
virtual std::pair< CommSharedPtr, CommSharedPtr >	v_SplitCommNode ()

Additional Inherited Members
Protected Attributes inherited from Nektar::LibUtilities::Comm
int	m_size
	Number of processes. More...
std::string	m_type
	Type of communication. More...
CommSharedPtr	m_commRow
	Row communicator. More...
CommSharedPtr	m_commColumn
	Column communicator. More...
CommSharedPtr	m_commTime
CommSharedPtr	m_commSpace

Detailed Description

A global linear system.

Definition at line 52 of file CommSerial.h.

Constructor & Destructor Documentation

CommSerial()

Nektar::LibUtilities::CommSerial::CommSerial	(	int	argc,
		char *	argv[]
	)

Definition at line 46 of file CommSerial.cpp.

                                             : Comm(argc, argv)
{
#ifdef NEKTAR_USING_PETSC
    PetscInitializeNoArguments();
#endif
    m_size = 1;
    m_type = "Serial";
}

References Nektar::LibUtilities::Comm::m_size, and Nektar::LibUtilities::Comm::m_type.

~CommSerial()

Nektar::LibUtilities::CommSerial::~CommSerial ( )

overridedefault

Member Function Documentation

create()

static CommSharedPtr Nektar::LibUtilities::CommSerial::create ( int  narg, char *  arg[]  )

inlinestatic

Creates an instance of this class.

Definition at line 56 of file CommSerial.h.

    {
        return MemoryManager<CommSerial>::AllocateSharedPtr(narg, arg);
    }

References Nektar::MemoryManager< DataType >::AllocateSharedPtr().

v_AllGather()

void Nektar::LibUtilities::CommSerial::v_AllGather ( void *  sendbuf, int  sendcount, CommDataType  sendtype, void *  recvbuf, int  recvcount, CommDataType  recvtype  )

finalprotectedvirtual

Implements Nektar::LibUtilities::Comm.

Definition at line 179 of file CommSerial.cpp.

{
}

v_AllGatherv() [1/2]

void Nektar::LibUtilities::CommSerial::v_AllGatherv ( void *  recvbuf, int  recvcounts[], int  rdispls[], CommDataType  recvtype  )

finalprotectedvirtual

Implements Nektar::LibUtilities::Comm.

Definition at line 204 of file CommSerial.cpp.

{
}

v_AllGatherv() [2/2]

void Nektar::LibUtilities::CommSerial::v_AllGatherv ( void *  sendbuf, int  sendcount, CommDataType  sendtype, void *  recvbuf, int  recvcounts[], int  rdispls[], CommDataType  recvtype  )

finalprotectedvirtual

Implements Nektar::LibUtilities::Comm.

Definition at line 191 of file CommSerial.cpp.

{
}

v_AllReduce()

void Nektar::LibUtilities::CommSerial::v_AllReduce ( void *  buf, int  count, CommDataType  dt, enum ReduceOperator  pOp  )

finalprotectedvirtual

Implements Nektar::LibUtilities::Comm.

Definition at line 146 of file CommSerial.cpp.

{
}

v_AlltoAll()

void Nektar::LibUtilities::CommSerial::v_AlltoAll ( void *  sendbuf, int  sendcount, CommDataType  sendtype, void *  recvbuf, int  recvcount, CommDataType  recvtype  )

finalprotectedvirtual

Implements Nektar::LibUtilities::Comm.

Definition at line 156 of file CommSerial.cpp.

{
}

v_AlltoAllv()

void Nektar::LibUtilities::CommSerial::v_AlltoAllv ( void *  sendbuf, int  sendcounts[], int  sensdispls[], CommDataType  sendtype, void *  recvbuf, int  recvcounts[], int  rdispls[], CommDataType  recvtype  )

finalprotectedvirtual

Implements Nektar::LibUtilities::Comm.

Definition at line 168 of file CommSerial.cpp.

{
}

v_Bcast()

void Nektar::LibUtilities::CommSerial::v_Bcast ( void *  buffer, int  count, CommDataType  dt, int  root  )

finalprotectedvirtual

Implements Nektar::LibUtilities::Comm.

Definition at line 214 of file CommSerial.cpp.

{
}

v_Block()

void Nektar::LibUtilities::CommSerial::v_Block ( )

finalprotectedvirtual

Implements Nektar::LibUtilities::Comm.

Definition at line 102 of file CommSerial.cpp.

{
}

v_CommCreateIf()

CommSharedPtr Nektar::LibUtilities::CommSerial::v_CommCreateIf ( int  flag )

finalprotectedvirtual

Implements Nektar::LibUtilities::Comm.

Definition at line 356 of file CommSerial.cpp.

{
    if (flag == 0)
    {
        // flag == 0 => get back MPI_COMM_NULL, return a null ptr instead.
        return std::shared_ptr<Comm>();
    }
    else
    {
        // Return a real communicator
        return shared_from_this();
    }
}

v_CreateRequest()

CommRequestSharedPtr Nektar::LibUtilities::CommSerial::v_CreateRequest ( int  num )

finalprotectedvirtual

Implements Nektar::LibUtilities::Comm.

Definition at line 338 of file CommSerial.cpp.

{
    return std::shared_ptr<CommRequest>(new CommRequest);
}

v_DistGraphCreateAdjacent()

void Nektar::LibUtilities::CommSerial::v_DistGraphCreateAdjacent ( int  indegree, const int  sources[], const int  sourceweights[], int  reorder  )

finalprotectedvirtual

Implements Nektar::LibUtilities::Comm.

Definition at line 246 of file CommSerial.cpp.

{
}

v_Finalise()

void Nektar::LibUtilities::CommSerial::v_Finalise ( )

finalprotectedvirtual

Implements Nektar::LibUtilities::Comm.

Definition at line 60 of file CommSerial.cpp.

{
#ifdef NEKTAR_USING_PETSC
    PetscFinalize();
#endif
}

v_Gather()

void Nektar::LibUtilities::CommSerial::v_Gather ( void *  sendbuf, int  sendcount, CommDataType  sendtype, void *  recvbuf, int  recvcount, CommDataType  recvtype, int  root  )

finalprotectedvirtual

Implements Nektar::LibUtilities::Comm.

Definition at line 224 of file CommSerial.cpp.

{
    std::memcpy(recvbuf, sendbuf, sendcount * CommDataTypeGetSize(sendtype));
}

References Nektar::LibUtilities::CommDataTypeGetSize().

v_GetRank()

int Nektar::LibUtilities::CommSerial::v_GetRank ( void  )

overrideprotectedvirtual

Implements Nektar::LibUtilities::Comm.

Reimplemented in Nektar::FieldUtils::FieldConvertComm.

Definition at line 70 of file CommSerial.cpp.

{
    return 0;
}

v_GetVersion()

std::tuple< int, int, int > Nektar::LibUtilities::CommSerial::v_GetVersion ( )

finalprotectedvirtual

Implements Nektar::LibUtilities::Comm.

Definition at line 94 of file CommSerial.cpp.

{
    return std::make_tuple(0, 0, 0);
}

v_Irecv()

void Nektar::LibUtilities::CommSerial::v_Irecv ( void *  buf, int  count, CommDataType  dt, int  source, CommRequestSharedPtr  request, int  loc  )

finalprotectedvirtual

Implements Nektar::LibUtilities::Comm.

Definition at line 301 of file CommSerial.cpp.

{
}

v_Irsend()

void Nektar::LibUtilities::CommSerial::v_Irsend ( void *  buf, int  count, CommDataType  dt, int  dest, CommRequestSharedPtr  request, int  loc  )

finalprotectedvirtual

Implements Nektar::LibUtilities::Comm.

Definition at line 266 of file CommSerial.cpp.

{
}

v_Isend()

void Nektar::LibUtilities::CommSerial::v_Isend ( void *  buf, int  count, CommDataType  dt, int  dest, CommRequestSharedPtr  request, int  loc  )

finalprotectedvirtual

Implements Nektar::LibUtilities::Comm.

Definition at line 278 of file CommSerial.cpp.

{
}

v_IsSerial()

bool Nektar::LibUtilities::CommSerial::v_IsSerial ( void  )

overrideprotectedvirtual

Implements Nektar::LibUtilities::Comm.

Reimplemented in Nektar::FieldUtils::FieldConvertComm.

Definition at line 86 of file CommSerial.cpp.

{
    return true;
}

v_NeighborAlltoAllv()

void Nektar::LibUtilities::CommSerial::v_NeighborAlltoAllv ( void *  sendbuf, int  sendcounts[], int  sdispls[], CommDataType  sendtype, void *  recvbuf, int  recvcounts[], int  rdispls[], CommDataType  recvtype  )

finalprotectedvirtual

Implements Nektar::LibUtilities::Comm.

Definition at line 255 of file CommSerial.cpp.

{
}

v_Recv()

void Nektar::LibUtilities::CommSerial::v_Recv ( void *  buf, int  count, CommDataType  dt, int  source  )

finalprotectedvirtual

Implements Nektar::LibUtilities::Comm.

Definition at line 126 of file CommSerial.cpp.

{
}

v_RecvInit()

void Nektar::LibUtilities::CommSerial::v_RecvInit ( void *  buf, int  count, CommDataType  dt, int  source, CommRequestSharedPtr  request, int  loc  )

finalprotectedvirtual

Implements Nektar::LibUtilities::Comm.

Definition at line 312 of file CommSerial.cpp.

{
}

v_Scatter()

void Nektar::LibUtilities::CommSerial::v_Scatter ( void *  sendbuf, int  sendcount, CommDataType  sendtype, void *  recvbuf, int  recvcount, CommDataType  recvtype, int  root  )

finalprotectedvirtual

Implements Nektar::LibUtilities::Comm.

Definition at line 235 of file CommSerial.cpp.

{
    std::memcpy(recvbuf, sendbuf, sendcount * CommDataTypeGetSize(sendtype));
}

References Nektar::LibUtilities::CommDataTypeGetSize().

v_Send()

void Nektar::LibUtilities::CommSerial::v_Send ( void *  buf, int  count, CommDataType  dt, int  dest  )

finalprotectedvirtual

Implements Nektar::LibUtilities::Comm.

Definition at line 117 of file CommSerial.cpp.

{
}

v_SendInit()

void Nektar::LibUtilities::CommSerial::v_SendInit ( void *  buf, int  count, CommDataType  dt, int  dest, CommRequestSharedPtr  request, int  loc  )

finalprotectedvirtual

Implements Nektar::LibUtilities::Comm.

Definition at line 289 of file CommSerial.cpp.

{
}

v_SendRecv()

void Nektar::LibUtilities::CommSerial::v_SendRecv ( void *  sendbuf, int  sendcount, CommDataType  sendtype, int  dest, void *  recvbuf, int  recvcount, CommDataType  recvtype, int  source  )

finalprotectedvirtual

Implements Nektar::LibUtilities::Comm.

Definition at line 135 of file CommSerial.cpp.

{
}

v_SplitComm()

void Nektar::LibUtilities::CommSerial::v_SplitComm ( int  pRows, int  pColumns, int  pTime  )

overrideprotectedvirtual

Implements Nektar::LibUtilities::Comm.

Reimplemented in Nektar::FieldUtils::FieldConvertComm.

Definition at line 346 of file CommSerial.cpp.

{
    ASSERTL0(false, "Cannot split a serial process.");
}

References ASSERTL0.

v_StartAll()

void Nektar::LibUtilities::CommSerial::v_StartAll ( CommRequestSharedPtr  request )

finalprotectedvirtual

Implements Nektar::LibUtilities::Comm.

Definition at line 324 of file CommSerial.cpp.

{
}

v_TreatAsRankZero()

bool Nektar::LibUtilities::CommSerial::v_TreatAsRankZero ( void  )

overrideprotectedvirtual

Implements Nektar::LibUtilities::Comm.

Reimplemented in Nektar::FieldUtils::FieldConvertComm.

Definition at line 78 of file CommSerial.cpp.

{
    return true;
}

v_WaitAll()

void Nektar::LibUtilities::CommSerial::v_WaitAll ( CommRequestSharedPtr  request )

finalprotectedvirtual

Implements Nektar::LibUtilities::Comm.

Definition at line 331 of file CommSerial.cpp.

{
}

v_Wtime()

NekDouble Nektar::LibUtilities::CommSerial::v_Wtime ( )

finalprotectedvirtual

Implements Nektar::LibUtilities::Comm.

Definition at line 109 of file CommSerial.cpp.

{
    return 0;
}

Member Data Documentation

className

std::string Nektar::LibUtilities::CommSerial::className

static

Initial value:

= GetCommFactory().RegisterCreatorFunction(
    "Serial", CommSerial::create, "Single-process serial communication.")

Name of class.

Definition at line 62 of file CommSerial.h.