gmx::DomainPairComm Class Reference

#include <gromacs/domdec/domainpaircomm.h>

Description

Setup for communication between pairs of domains, both backward and forward along the DD grid.

This object is a holder a DomainCommBackward and DomainCommForward object. Both objects communicate along the same DD-grid displacement vector but with opposite direction.

Public Member Functions
	DomainPairComm (int backwardRank, int forwardRank, int zone, const IVec &domainShift, PbcType pbcType, bool commOverPbc, IVec pbcCoordinateShift, MPI_Comm mpiCommAll)
	Constructor. More...
DomainCommBackward &	backward ()
	Returns the object for communicating backward along the DD grid.
const DomainCommBackward &	backward () const
	Returns the object for communicating backward along the DD grid.
DomainCommForward &	forward ()
	Returns the object for communicating forward along the DD grid.
const DomainCommForward &	forward () const
	Returns the object for communicating forward along the DD grid.

Constructor & Destructor Documentation

gmx::DomainPairComm::DomainPairComm	(	int	backwardRank,
		int	forwardRank,
		int	zone,
		const IVec &	domainShift,
		PbcType	pbcType,
		bool	commOverPbc,
		IVec	pbcCoordinateShift,
		MPI_Comm	mpiCommAll
	)

Constructor.

Parameters

[in]	backwardRank	The MPI rank we communicate with in backward direction
[in]	forwardRank	The MPI rank we communicate with in forward direction
[in]	zone	The domain decomposition zone this pair of domains belongs to
[in]	domainShift	The shift >=0 in domain indices between the two domains
[in]	pbcType	The type of PBC
[in]	commOverPbc	Whether we are communicating backward over a periodic boundary
[in]	pbcCoordinateShift	The PBC coordinate shift, 0 or 1 for each dimension
[in]	mpiCommAll	MPI communicator for all PP ranks

---

The documentation for this class was generated from the following files:

• src/gromacs/domdec/domainpaircomm.h
• src/gromacs/domdec/domainpaircomm.cpp