Functions
const eckit::mpi::Comm &	world ()
	Default communicator with all MPI tasks (ie MPI_COMM_WORLD) More...

const eckit::mpi::Comm &	myself ()
	Default communicator with each MPI task by itself. More...

void	gather (const eckit::mpi::Comm &comm, const std::vector< double > &send, std::vector< double > &recv, const size_t root)

void	allGather (const eckit::mpi::Comm &comm, const Eigen::VectorXd &sendbuf, Eigen::MatrixXd &recvbuf)

void	allGatherv (const eckit::mpi::Comm &comm, std::vector< util::DateTime > &x)
	Perform the MPI all gather operation on a vector of DateTime objects. More...

void	allGatherv (const eckit::mpi::Comm &comm, std::vector< std::string > &x)
	Perform the MPI all gather operation on a vector of DateTime objects. More...

void	exclusiveScan (const eckit::mpi::Comm &comm, size_t &x)
	Perform the exclusive scan operation. More...

template<typename SERIALIZABLE >
void	send (const eckit::mpi::Comm &comm, const SERIALIZABLE &sendobj, const int dest, const int tag)
	Extend eckit Comm for Serializable oops objects. More...

template<typename SERIALIZABLE >
void	receive (const eckit::mpi::Comm &comm, SERIALIZABLE &recvobj, const int source, const int tag)

template<typename SERIALIZABLE >
void	gather (const eckit::mpi::Comm &comm, const std::vector< SERIALIZABLE > &send, std::vector< SERIALIZABLE > &recv, const size_t root)

template<typename CIter , typename Iter >
void	allGathervUsingSerialize (const eckit::mpi::Comm &comm, CIter first, CIter last, Iter recvbuf)
	A wrapper around the MPI all gather operation for serializable types. More...

template<typename T >
void	allGatherv (const eckit::mpi::Comm &comm, std::vector< T > &x)
	Perform the MPI all gather operation on a vector of "plain old data". More...

Function Documentation

◆ allGather()

void oops::mpi::allGather	(	const eckit::mpi::Comm &	comm,
		const Eigen::VectorXd &	sendbuf,
		Eigen::MatrixXd &	recvbuf
	)

Definition at line 120 of file oops/mpi/mpi.cc.

Here is the caller graph for this function:

◆ allGatherv() [1/3]

void oops::mpi::allGatherv	(	const eckit::mpi::Comm &	comm,
		std::vector< std::string > &	x
	)

Perform the MPI all gather operation on a vector of DateTime objects.

This operation gathers data from all tasks and delivers the combined data to all tasks.

Parameters

[in]	comm	Communicator.
[in,out]	x	On input, data owned by this task that need to be delivered to all other tasks. On output, combined data received from all tasks (concatenated in the order of increasing task ranks).

Definition at line 158 of file oops/mpi/mpi.cc.

Here is the call graph for this function:

◆ allGatherv() [2/3]

template<typename T >

void oops::mpi::allGatherv	(	const eckit::mpi::Comm &	comm,
		std::vector< T > &	x
	)

Perform the MPI all gather operation on a vector of "plain old data".

This operation gathers data from all tasks and delivers the combined data to all tasks.

Template Parameters

T	must be a type for which there exists a specialization of eckit::mpi::Data::Type.

Parameters

[in]	comm	Communicator.
[in,out]	x	On input, data owned by this task that need to be delivered to all other tasks. On output, combined data received from all tasks (concatenated in the order of increasing task ranks).

Definition at line 152 of file oops/mpi/mpi.h.

◆ allGatherv() [3/3]

void oops::mpi::allGatherv	(	const eckit::mpi::Comm &	comm,
		std::vector< util::DateTime > &	x
	)

Perform the MPI all gather operation on a vector of DateTime objects.

This operation gathers data from all tasks and delivers the combined data to all tasks.

Parameters

[in]	comm	Communicator.
[in,out]	x	On input, data owned by this task that need to be delivered to all other tasks. On output, combined data received from all tasks (concatenated in the order of increasing task ranks).

Definition at line 148 of file oops/mpi/mpi.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ allGathervUsingSerialize()

template<typename CIter , typename Iter >

void oops::mpi::allGathervUsingSerialize	(	const eckit::mpi::Comm &	comm,
		CIter	first,
		CIter	last,
		Iter	recvbuf
	)

A wrapper around the MPI all gather operation for serializable types.

The all gather operation gathers data from all tasks and delivers the combined data to all tasks. This wrapper performs that operation for collections of non-primitive types that nevertheless support the OOPS serialization interface, i.e. provide the functions

void serialize(std::vector<double> &vect) const;
void deserialize(const std::vector<double> &vect, size_t &current);

An example of such a type is util::DateTime.

Parameters

comm	Communicator.
first,last	Range of values to be delivered from this task to all other tasks.
recvbuf	Output iterator to the beginning of the range to receive the combined data from all tasks.

Definition at line 119 of file oops/mpi/mpi.h.

Here is the caller graph for this function:

◆ exclusiveScan()

void oops::mpi::exclusiveScan	(	const eckit::mpi::Comm &	comm,
		size_t &	x
	)

Perform the exclusive scan operation.

On output, x is set to the sum of the values of x passed to this function on all ranks lower than the calling rank (and to 0 on rank 0).

Definition at line 177 of file oops/mpi/mpi.cc.

Here is the caller graph for this function:

◆ gather() [1/2]

void oops::mpi::gather	(	const eckit::mpi::Comm &	comm,
		const std::vector< double > &	send,
		std::vector< double > &	recv,
		const size_t	root
	)

Definition at line 96 of file oops/mpi/mpi.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ gather() [2/2]

template<typename SERIALIZABLE >

void oops::mpi::gather	(	const eckit::mpi::Comm &	comm,
		const std::vector< SERIALIZABLE > &	send,
		std::vector< SERIALIZABLE > &	recv,
		const size_t	root
	)

Definition at line 74 of file oops/mpi/mpi.h.

Here is the call graph for this function:

◆ myself()

const eckit::mpi::Comm & oops::mpi::myself ( )

Default communicator with each MPI task by itself.

Definition at line 90 of file oops/mpi/mpi.cc.

Here is the caller graph for this function:

◆ receive()

template<typename SERIALIZABLE >

void oops::mpi::receive	(	const eckit::mpi::Comm &	comm,
		SERIALIZABLE &	recvobj,
		const int	source,
		const int	tag
	)

Definition at line 55 of file oops/mpi/mpi.h.

Here is the caller graph for this function:

◆ send()

template<typename SERIALIZABLE >

void oops::mpi::send	(	const eckit::mpi::Comm &	comm,
		const SERIALIZABLE &	sendobj,
		const int	dest,
		const int	tag
	)

Extend eckit Comm for Serializable oops objects.

Definition at line 44 of file oops/mpi/mpi.h.

Here is the caller graph for this function:

◆ world()

const eckit::mpi::Comm & oops::mpi::world ( )

Default communicator with all MPI tasks (ie MPI_COMM_WORLD)

Definition at line 84 of file oops/mpi/mpi.cc.

Here is the caller graph for this function:

Functions

Function Documentation

◆ allGather()

◆ allGatherv() [1/3]

◆ allGatherv() [2/3]

◆ allGatherv() [3/3]

◆ allGathervUsingSerialize()

◆ exclusiveScan()

◆ gather() [1/2]

◆ gather() [2/2]

◆ myself()

◆ receive()

◆ send()

◆ world()