Communicator performing operations within groups defined by a GroupTopology with arbitrary-size data associated with each group. More...

#include <communication.hpp>

Classes
struct	OpData
	Data structure on which we define reduce operations. More...

Public Types
enum	Mode { byGroup, byNeighbor }
	Communication mode. More...

Public Member Functions
	GroupCommunicator (GroupTopology &gt, Mode m=byNeighbor)
	Construct a GroupCommunicator object. More...

void	Create (Array< int > &ldof_group)
	Initialize the communicator from a local-dof to group map. Finalize() is called internally. More...

Table &	GroupLDofTable ()
	Fill-in the returned Table reference to initialize the GroupCommunicator then call Finalize(). More...

void	Finalize ()
	Allocate internal buffers after the GroupLDofTable is defined. More...

void	SetLTDofTable (Array< int > &ldof_ltdof)
	Initialize the internal group_ltdof Table. More...

GroupTopology &	GetGroupTopology ()
	Get a reference to the associated GroupTopology object. More...

template<class T >
T *	CopyGroupToBuffer (const T ldata, T buf, int group, int layout) const
	Copy the entries corresponding to the group group from the local array ldata to the buffer buf. More...

template<class T >
const T *	CopyGroupFromBuffer (const T buf, T ldata, int group, int layout) const
	Copy the entries corresponding to the group group from the buffer buf to the local array ldata. More...

template<class T >
const T *	ReduceGroupFromBuffer (const T buf, T ldata, int group, int layout, void(*Op)(OpData< T >)) const
	Perform the reduction operation Op to the entries of group group using the values from the buffer buf and the values from the local array ldata, saving the result in the latter. More...

template<class T >
void	BcastBegin (T *ldata, int layout)
	Begin a broadcast within each group where the master is the root. More...

template<class T >
void	BcastEnd (T *ldata, int layout)
	Finalize a broadcast started with BcastBegin(). More...

template<class T >
void	Bcast (T *ldata, int layout)
	Broadcast within each group where the master is the root. More...

template<class T >
void	Bcast (T *ldata)
	Broadcast within each group where the master is the root. More...

template<class T >
void	Bcast (Array< T > &ldata)
	Broadcast within each group where the master is the root. More...

template<class T >
void	ReduceBegin (const T *ldata)
	Begin reduction operation within each group where the master is the root. More...

template<class T >
void	ReduceEnd (T ldata, int layout, void(Op)(OpData< T >))
	Finalize reduction operation started with ReduceBegin(). More...

template<class T >
void	Reduce (T ldata, void(Op)(OpData< T >))
	Reduce within each group where the master is the root. More...

template<class T >
void	Reduce (Array< T > &ldata, void(*Op)(OpData< T >))
	Reduce within each group where the master is the root. More...

void	PrintInfo (std::ostream &out=mfem::out) const
	Print information about the GroupCommunicator from all MPI ranks. More...

	~GroupCommunicator ()
	Destroy a GroupCommunicator object, deallocating internal data structures and buffers. More...

Static Public Member Functions
template<class T >
static void	Sum (OpData< T >)
	Reduce operation Sum, instantiated for int and double. More...

template<class T >
static void	Min (OpData< T >)
	Reduce operation Min, instantiated for int and double. More...

template<class T >
static void	Max (OpData< T >)
	Reduce operation Max, instantiated for int and double. More...

template<class T >
static void	BitOR (OpData< T >)
	Reduce operation bitwise OR, instantiated for int only. More...

Detailed Description

Communicator performing operations within groups defined by a GroupTopology with arbitrary-size data associated with each group.

Definition at line 117 of file communication.hpp.

Member Enumeration Documentation

enum mfem::GroupCommunicator::Mode

Communication mode.

Enumerator
byGroup	Communications are performed one group at a time.
byNeighbor	Communications are performed one neighbor at a time, aggregating over groups.

Definition at line 121 of file communication.hpp.

Constructor & Destructor Documentation

mfem::GroupCommunicator::GroupCommunicator	(	GroupTopology &	gt,
		Mode	m = `byNeighbor`
	)

Construct a GroupCommunicator object.

The object must be initialized before it can be used to perform any operations. To initialize the object, either

call Create() or
initialize the Table reference returned by GroupLDofTable() and then call Finalize().

Definition at line 274 of file communication.cpp.

mfem::GroupCommunicator::~GroupCommunicator ( )

Destroy a GroupCommunicator object, deallocating internal data structures and buffers.

Definition at line 1138 of file communication.cpp.

Member Function Documentation

template<class T >

void mfem::GroupCommunicator::Bcast	(	T *	ldata,
		int	layout
	)

inline

Broadcast within each group where the master is the root.

The data layout can be either 0 or 1.

For a description of layout, see CopyGroupToBuffer().

Definition at line 232 of file communication.hpp.

template<class T >

void mfem::GroupCommunicator::Bcast ( T * ldata )

inline

Broadcast within each group where the master is the root.

Definition at line 239 of file communication.hpp.

template<class T >

void mfem::GroupCommunicator::Bcast ( Array< T > & ldata )

inline

Broadcast within each group where the master is the root.

Definition at line 241 of file communication.hpp.

template<class T >

void mfem::GroupCommunicator::BcastBegin	(	T *	ldata,
		int	layout
	)

Begin a broadcast within each group where the master is the root.

For a description of layout, see CopyGroupToBuffer().

Definition at line 558 of file communication.cpp.

template<class T >

void mfem::GroupCommunicator::BcastEnd	(	T *	ldata,
		int	layout
	)

Finalize a broadcast started with BcastBegin().

The output data layout can be:

0 - ldata is an array on all ldofs; the input layout should be either 0 or 2
1 - ldata is the same array as given to BcastBegin(); the input layout should be 1.

For more details about layout, see CopyGroupToBuffer().

Definition at line 695 of file communication.cpp.

template<class T >

template void mfem::GroupCommunicator::BitOR< int > ( OpData< T > )

static

Reduce operation bitwise OR, instantiated for int only.

Definition at line 1005 of file communication.cpp.

template<class T >

const T * mfem::GroupCommunicator::CopyGroupFromBuffer	(	const T *	buf,
		T *	ldata,
		int	group,
		int	layout
	)		const

Copy the entries corresponding to the group group from the buffer buf to the local array ldata.

For a description of layout, see CopyGroupToBuffer().

Returns: The pointer buf plus the number of elements in the group.

Definition at line 485 of file communication.cpp.

template<class T >

T * mfem::GroupCommunicator::CopyGroupToBuffer	(	const T *	ldata,
		T *	buf,
		int	group,
		int	layout
	)		const

Copy the entries corresponding to the group group from the local array ldata to the buffer buf.

The layout of the local array can be:

0 - ldata is an array on all ldofs: copied indices: { J[j] : I[group] <= j < I[group+1] } where I,J=group_ldof.{I,J}
1 - ldata is an array on the shared ldofs: copied indices: { j : I[group] <= j < I[group+1] } where I,J=group_ldof.{I,J}
2 - ldata is an array on the true ldofs, ltdofs: copied indices: { J[j] : I[group] <= j < I[group+1] } where I,J=group_ltdof.{I,J}.
Returns
The pointer buf plus the number of elements in the group.

Definition at line 450 of file communication.cpp.

void mfem::GroupCommunicator::Create ( Array< int > & ldof_group )

Initialize the communicator from a local-dof to group map. Finalize() is called internally.

Definition at line 286 of file communication.cpp.

void mfem::GroupCommunicator::Finalize ( )

Allocate internal buffers after the GroupLDofTable is defined.

Definition at line 312 of file communication.cpp.

GroupTopology& mfem::GroupCommunicator::GetGroupTopology ( )

inline

Get a reference to the associated GroupTopology object.

Definition at line 170 of file communication.hpp.

Table& mfem::GroupCommunicator::GroupLDofTable ( )

inline

Fill-in the returned Table reference to initialize the GroupCommunicator then call Finalize().

Definition at line 159 of file communication.hpp.

template<class T >

template void mfem::GroupCommunicator::Max< double > ( OpData< T > )

static

Reduce operation Max, instantiated for int and double.

Definition at line 987 of file communication.cpp.

template<class T >

template void mfem::GroupCommunicator::Min< double > ( OpData< T > )

static

Reduce operation Min, instantiated for int and double.

Definition at line 969 of file communication.cpp.

void mfem::GroupCommunicator::PrintInfo ( std::ostream & out = mfem::out ) const

Print information about the GroupCommunicator from all MPI ranks.

Definition at line 1018 of file communication.cpp.

template<class T >

void mfem::GroupCommunicator::Reduce	(	T *	ldata,
		void(*)(OpData< T >)	Op
	)

inline

Reduce within each group where the master is the root.

The reduce operation is given by the second argument (see below for list of the supported operations.)

Definition at line 272 of file communication.hpp.

template<class T >

void mfem::GroupCommunicator::Reduce	(	Array< T > &	ldata,
		void(*)(OpData< T >)	Op
	)

inline

Reduce within each group where the master is the root.

Definition at line 279 of file communication.hpp.

template<class T >

void mfem::GroupCommunicator::ReduceBegin ( const T * ldata )

Begin reduction operation within each group where the master is the root.

The input data layout is an array on all ldofs, i.e. layout 0, see CopyGroupToBuffer().

The reduce operation will be specified when calling ReduceEnd(). This method is instantiated for int and double.

Definition at line 757 of file communication.cpp.

template<class T >

void mfem::GroupCommunicator::ReduceEnd	(	T *	ldata,
		int	layout,
		void(*)(OpData< T >)	Op
	)

Finalize reduction operation started with ReduceBegin().

The output data layout can be either 0 or 2, see CopyGroupToBuffer().

The reduce operation is given by the third argument (see below for list of the supported operations.) This method is instantiated for int and double.

Note: If the output data layout is 2, then the data from the ldata array passed to this call is used in the reduction operation, instead of the data from the ldata array passed to ReduceBegin(). Therefore, the data for master-groups has to be identical in both arrays.

Definition at line 876 of file communication.cpp.

template<class T >

const T * mfem::GroupCommunicator::ReduceGroupFromBuffer	(	const T *	buf,
		T *	ldata,
		int	group,
		int	layout,
		void(*)(OpData< T >)	Op
	)		const

Perform the reduction operation Op to the entries of group group using the values from the buffer buf and the values from the local array ldata, saving the result in the latter.

For a description of layout, see CopyGroupToBuffer().

Returns: The pointer buf plus the number of elements in the group.

Definition at line 519 of file communication.cpp.

void mfem::GroupCommunicator::SetLTDofTable ( Array< int > & ldof_ltdof )

Initialize the internal group_ltdof Table.

This method must be called before performing operations that use local data layout 2, see CopyGroupToBuffer() for layout descriptions.

Definition at line 421 of file communication.cpp.

template<class T >

template void mfem::GroupCommunicator::Sum< double > ( OpData< T > )

static

Reduce operation Sum, instantiated for int and double.

Definition at line 945 of file communication.cpp.

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

Classes

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation