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.

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.

NekDouble	Wtime ()
	Return the time in seconds.

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.

void	SplitComm (int pRows, int pColumns, int pTime=0)
	Splits this communicator into a grid of size pRows*pColumns and creates row and column communicators. By default the communicator is a single row.

CommSharedPtr	GetRowComm ()
	Retrieve the row communicator to which this process belongs.

CommSharedPtr	GetColumnComm ()
	Retrieve the column communicator to which this process belongs.

CommSharedPtr	GetTimeComm ()
	Retrieve the time communicator to which this process belongs.

CommSharedPtr	GetSpaceComm ()
	Retrieve the space communicator to which this process belongs.

bool	RemoveExistingFiles ()

std::pair< CommSharedPtr, CommSharedPtr >	SplitCommNode ()

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

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

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 (const void *buf, int count, CommDataType dt, int dest) final

void	v_Recv (void *buf, int count, CommDataType dt, int source) final

void	v_SendRecv (const 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 (const void sendbuf, int sendcount, CommDataType sendtype, void recvbuf, int recvcount, CommDataType recvtype) final

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

void	v_AllGather (const void sendbuf, int sendcount, CommDataType sendtype, void recvbuf, int recvcount, CommDataType recvtype) final

void	v_AllGatherv (const void sendbuf, int sendcount, CommDataType sendtype, void recvbuf, const int recvcounts, const int recvdispls, CommDataType recvtype) final

void	v_AllGatherv (void recvbuf, const int recvcounts, const int *recvdispls, CommDataType recvtype) final

void	v_Bcast (void *buffer, int count, CommDataType dt, int root) final

void	v_Gather (const void sendbuf, int sendcount, CommDataType sendtype, void recvbuf, int recvcount, CommDataType recvtype, int root) final

void	v_Scatter (const 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 (const void sendbuf, const int sendcounts, const int senddispls, CommDataType sendtype, void recvbuf, const int recvcounts, const int recvdispls, CommDataType recvtype) final

void	v_Irsend (const void *buf, int count, CommDataType dt, int dest, CommRequestSharedPtr request, int loc) final

void	v_Isend (const void *buf, int count, CommDataType dt, int dest, CommRequestSharedPtr request, int loc) final

void	v_SendInit (const 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 std::pair< CommSharedPtr, CommSharedPtr >	v_SplitCommNode ()

Additional Inherited Members
Protected Attributes inherited from Nektar::LibUtilities::Comm
int	m_size
	Number of processes.

std::string	m_type
	Type of communication.

CommSharedPtr	m_commRow
	Row communicator.

CommSharedPtr	m_commColumn
	Column communicator.

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	(	const void *	sendbuf,
		int	sendcount,
		CommDataType	sendtype,
		void *	recvbuf,
		int	recvcount,
		CommDataType	recvtype
	)

finalprotectedvirtual

Implements Nektar::LibUtilities::Comm.

Definition at line 183 of file CommSerial.cpp.

189{

190}

◆ v_AllGatherv() [1/2]

void Nektar::LibUtilities::CommSerial::v_AllGatherv	(	const void *	sendbuf,
		int	sendcount,
		CommDataType	sendtype,
		void *	recvbuf,
		const int *	recvcounts,
		const int *	recvdispls,
		CommDataType	recvtype
	)

finalprotectedvirtual

Implements Nektar::LibUtilities::Comm.

Definition at line 195 of file CommSerial.cpp.

202{

203}

◆ v_AllGatherv() [2/2]

void Nektar::LibUtilities::CommSerial::v_AllGatherv	(	void *	recvbuf,
		const int *	recvcounts,
		const int *	recvdispls,
		CommDataType	recvtype
	)

finalprotectedvirtual

Implements Nektar::LibUtilities::Comm.

Definition at line 208 of file CommSerial.cpp.

212{

213}

◆ 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 147 of file CommSerial.cpp.

151{

152}

◆ v_AlltoAll()

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

finalprotectedvirtual

Implements Nektar::LibUtilities::Comm.

Definition at line 157 of file CommSerial.cpp.

163{

164}

◆ v_AlltoAllv()

void Nektar::LibUtilities::CommSerial::v_AlltoAllv	(	const void *	sendbuf,
		const int *	sendcounts,
		const int *	senddispls,
		CommDataType	sendtype,
		void *	recvbuf,
		const int *	recvcounts,
		const int *	recvdispls,
		CommDataType	recvtype
	)

finalprotectedvirtual

Implements Nektar::LibUtilities::Comm.

Definition at line 169 of file CommSerial.cpp.

177{

178}

◆ v_Bcast()

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

finalprotectedvirtual

Implements Nektar::LibUtilities::Comm.

Definition at line 218 of file CommSerial.cpp.

222{

223}

◆ v_Block()

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

finalprotectedvirtual

Implements Nektar::LibUtilities::Comm.

Definition at line 102 of file CommSerial.cpp.

103{

104}

◆ v_CommCreateIf()

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

finalprotectedvirtual

Implements Nektar::LibUtilities::Comm.

Definition at line 366 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 348 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 252 of file CommSerial.cpp.

255{

256}

◆ 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	(	const void *	sendbuf,
		int	sendcount,
		CommDataType	sendtype,
		void *	recvbuf,
		int	recvcount,
		CommDataType	recvtype,
		int	root
	)

finalprotectedvirtual

Implements Nektar::LibUtilities::Comm.

Definition at line 228 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 311 of file CommSerial.cpp.

316{

317}

◆ v_Irsend()

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

finalprotectedvirtual

Implements Nektar::LibUtilities::Comm.

Definition at line 275 of file CommSerial.cpp.

281{

282}

◆ v_Isend()

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

finalprotectedvirtual

Implements Nektar::LibUtilities::Comm.

Definition at line 287 of file CommSerial.cpp.

293{

294}

◆ 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	(	const void *	sendbuf,
		const int *	sendcounts,
		const int *	senddispls,
		CommDataType	sendtype,
		void *	recvbuf,
		const int *	recvcounts,
		const int *	recvdispls,
		CommDataType	recvtype
	)

finalprotectedvirtual

Implements Nektar::LibUtilities::Comm.

Definition at line 261 of file CommSerial.cpp.

269{

270}

◆ v_Recv()

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

finalprotectedvirtual

Implements Nektar::LibUtilities::Comm.

Definition at line 127 of file CommSerial.cpp.

130{

131}

◆ 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 322 of file CommSerial.cpp.

328{

329}

◆ v_Scatter()

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

finalprotectedvirtual

Implements Nektar::LibUtilities::Comm.

Definition at line 240 of file CommSerial.cpp.

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

References Nektar::LibUtilities::CommDataTypeGetSize().

◆ v_Send()

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

finalprotectedvirtual

Implements Nektar::LibUtilities::Comm.

Definition at line 117 of file CommSerial.cpp.

121{

122}

◆ v_SendInit()

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

finalprotectedvirtual

Implements Nektar::LibUtilities::Comm.

Definition at line 299 of file CommSerial.cpp.

305{

306}

◆ v_SendRecv()

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

finalprotectedvirtual

Implements Nektar::LibUtilities::Comm.

Definition at line 136 of file CommSerial.cpp.

141{

142}

◆ 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 356 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 334 of file CommSerial.cpp.

335{

336}

◆ 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 341 of file CommSerial.cpp.

342{

343}

◆ 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.")

Nektar::LibUtilities::CommSerial::create

static CommSharedPtr create(int narg, char *arg[])

Creates an instance of this class.

Definition CommSerial.h:56

Nektar::LibUtilities::NekFactory::RegisterCreatorFunction

tKey RegisterCreatorFunction(tKey idKey, CreatorFunction classCreator, std::string pDesc="")

Register a class with the factory.

Definition BasicUtils/NekFactory.hpp:196

Nektar::LibUtilities::GetCommFactory

CommFactory & GetCommFactory()

Definition Communication/Comm.cpp:60

Name of class.

Definition at line 62 of file CommSerial.h.

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CommSerial()

◆ ~CommSerial()

Member Function Documentation

◆ create()

◆ v_AllGather()

◆ v_AllGatherv() [1/2]

◆ v_AllGatherv() [2/2]

◆ v_AllReduce()

◆ v_AlltoAll()

◆ v_AlltoAllv()

◆ v_Bcast()

◆ v_Block()

◆ v_CommCreateIf()

◆ v_CreateRequest()

◆ v_DistGraphCreateAdjacent()

◆ v_Finalise()

◆ v_Gather()

◆ v_GetRank()

◆ v_GetVersion()

◆ v_Irecv()

◆ v_Irsend()

◆ v_Isend()

◆ v_IsSerial()

◆ v_NeighborAlltoAllv()

◆ v_Recv()

◆ v_RecvInit()

◆ v_Scatter()

◆ v_Send()

◆ v_SendInit()

◆ v_SendRecv()

◆ v_SplitComm()

◆ v_StartAll()

◆ v_TreatAsRankZero()

◆ v_WaitAll()

◆ v_Wtime()

Member Data Documentation

◆ className