Classes
struct	sierra::MPI::Loc< T >
	Template class `loc` implements the data structure for the MINLOC and MAXLOC data types. More...

struct	sierra::MPI::Datatype< T >
	Traits class `Datatype` implements a traits class containing two static member functions which return the appropriate MPI data type for the C++ data type. More...

struct	sierra::MPI::ReduceInterface
	Interface class `ReduceInterface` specifies the required virtual functions for the aggregated type and operation operator. The aggregated reduction operator allows a single MPI operation to perform many operations on many types. More...

struct	sierra::MPI::Reduce< Op, LocalIt, GlobalIt >
	Template class `Reduce` implements the ReduceInterface interface for any operator and type. The operator is a functor and the iterator specifies the access to the data and its type. More...

class	sierra::MPI::ReduceSet
	Class `ReduceSet` ... More...

struct	sierra::MPI::Sum
	Class `Sum` ... More...

struct	sierra::MPI::Prod
	Class `Prod` ... More...

struct	sierra::MPI::Min
	Class `Min` ... More...

struct	sierra::MPI::Max
	Class `Max` ... More...

struct	sierra::MPI::MinLoc
	Class `MinLoc` ... More...

struct	sierra::MPI::MaxLoc
	Class `MaxLoc` ... More...

Functions
MPI_Datatype	sierra::MPI::float_complex_type ()
	Function `float_complex_type` returns an MPI complex data type for C++. More...

MPI_Datatype	sierra::MPI::double_complex_type ()
	Function `double_complex_type` returns an MPI complex data type for C++. More...

MPI_Op	sierra::MPI::double_complex_sum_op ()
	Function `double_complex_sum_op` returns a sum operation for the C++ complex MPI data type. More...

template<class T >
MPI_Op	sierra::MPI::real_complex_sum_op ()
	Function `real_complex_sum_op` returns a sum operation for the C++ complex MPI data type. More...

MPI_Datatype	sierra::MPI::long_long_int_int_type ()
	Member function double_double_int_type ... More...

MPI_Datatype	sierra::MPI::double_double_int_type ()
	Member function double_double_int_type ... More...

template<class T >
void	sierra::MPI::AllReduce (MPI_Comm mpi_comm, MPI_Op op, T *src_dest, size_t size)
	Function `AllReduce` copies the source/destination array into a temporary vector and then executed the MPI operation using the temporary as the source. More...

template<class T >
void	sierra::MPI::AllReduce (MPI_Comm mpi_comm, MPI_Op op, std::vector< T > &dest)
	Function `AllReduce` copies the source/destination vector into a temporary vector and then executed the MPI operation using the temporary as the source. More...

template<class T >
void	sierra::MPI::AllReduce (MPI_Comm mpi_comm, MPI_Op op, std::vector< T > &source, std::vector< T > &dest)
	Function `AllReduce` copies the source/destination vector into a temporary vector and then executed the MPI operation using the temporary as the source. More...

template<class T >
void	sierra::MPI::AllGather (MPI_Comm mpi_comm, std::vector< T > &source, std::vector< T > &dest)

template<typename T >
T *	sierra::MPI::align_cast (void *p)
	Function `align_cast` returns a pointer that has been aligned to the specified alignment or double if the alignment if greater than that of double. More...

void	sierra::MPI::AllReduce (MPI_Comm comm, const ReduceSet &reduce_set)
	Member function `AllReduce` ... More...

template<typename T >
Reduce< Sum, T * > *	sierra::MPI::ReduceSum (T t, T u, size_t length)
	Member function `ReduceSum` ... More...

template<typename T >
Reduce< Prod, T * > *	sierra::MPI::ReduceProd (T t, T u, size_t length)
	Member function `ReduceProd` ... More...

template<typename T >
Reduce< Max, T * > *	sierra::MPI::ReduceMax (T t, T u, size_t length)
	Member function `ReduceMax` ... More...

template<typename T >
Reduce< Min, T * > *	sierra::MPI::ReduceMin (T t, T u, size_t length)
	Member function `ReduceMin` ... More...

template<typename T >
Reduce< Sum, T * > *	sierra::MPI::ReduceSum (T &t, T &u)
	Member function `ReduceSum` ... More...

template<typename T >
Reduce< Prod, T * > *	sierra::MPI::ReduceProd (T &t, T &u)
	Member function `ReduceProd` ... More...

template<typename T >
Reduce< Max, T * > *	sierra::MPI::ReduceMax (T &t, T &u)
	Member function `ReduceMax` ... More...

template<typename T >
Reduce< Min, T * > *	sierra::MPI::ReduceMin (T &t, T &u)
	Member function `ReduceMin` ... More...

template<class LocalIt , class GlobalIt >
Reduce< Sum, LocalIt, GlobalIt > *	sierra::MPI::ReduceSum (LocalIt local_begin, LocalIt local_end, GlobalIt global_begin, GlobalIt global_end)
	Member function `ReduceSum` ... More...

template<class LocalIt , class GlobalIt >
Reduce< Prod, LocalIt, GlobalIt > *	sierra::MPI::ReduceProd (LocalIt local_begin, LocalIt local_end, GlobalIt global_begin, GlobalIt global_end)
	Member function `ReduceProd` ... More...

template<typename T , class LocalIt , class GlobalIt >
Reduce< Min, LocalIt, GlobalIt > *	sierra::MPI::ReduceMin (LocalIt local_begin, LocalIt local_end, GlobalIt global_begin, GlobalIt global_end)
	Member function `ReduceMin` ... More...

template<typename T , class LocalIt , class GlobalIt >
Reduce< Max, LocalIt, GlobalIt > *	sierra::MPI::ReduceMax (LocalIt local_begin, LocalIt local_end, GlobalIt global_begin, GlobalIt global_end)
	Member function `ReduceMax` ... More...

template<class T , class U >
void	sierra::MPI::AllReduceCollected (MPI_Comm mpi_comm, MPI_Op op, U collector)
	Member function `AllReduceCollected` ... More...

Detailed Description

Function Documentation

◆ float_complex_type()

MPI_Datatype sierra::MPI::float_complex_type ( )

Function float_complex_type returns an MPI complex data type for C++.

Returns: a MPI_Datatype value of the C++ complex MPI data type.

Definition at line 38 of file MPI.cpp.

◆ double_complex_type()

MPI_Datatype sierra::MPI::double_complex_type ( )

Function double_complex_type returns an MPI complex data type for C++.

Returns: a MPI_Datatype value of the C++ complex MPI data type.

Definition at line 23 of file MPI.cpp.

◆ double_complex_sum_op()

MPI_Op sierra::MPI::double_complex_sum_op ( )

Function double_complex_sum_op returns a sum operation for the C++ complex MPI data type.

Returns: a MPI_Op ...

Definition at line 118 of file MPI.cpp.

◆ real_complex_sum_op()

template<class T >

MPI_Op sierra::MPI::real_complex_sum_op ( )

inline

Function real_complex_sum_op returns a sum operation for the C++ complex MPI data type.

Returns: a MPI_Op ...

Definition at line 70 of file MPI.hpp.

◆ long_long_int_int_type()

MPI_Datatype sierra::MPI::long_long_int_int_type ( )

Member function double_double_int_type ...

Returns: a MPI_Datatype ...

◆ double_double_int_type()

MPI_Datatype sierra::MPI::double_double_int_type ( )

Member function double_double_int_type ...

Returns: a MPI_Datatype ...

Definition at line 76 of file MPI.cpp.

◆ AllReduce() [1/4]

template<class T >

void sierra::MPI::AllReduce	(	MPI_Comm	mpi_comm,
		MPI_Op	op,
		T *	src_dest,
		size_t	size
	)

inline

Function AllReduce copies the source/destination array into a temporary vector and then executed the MPI operation using the temporary as the source.

Parameters

mpi_comm	a `MPI_Comm` value of the MPI communicator.
op	a `MPI_Op` value of the MPI operation.
src_dest	a `T` pointer to an array to be copied for the source and used as the destination.
size	a `size_t` value of the length of the array pointed to by src_dest

Definition at line 362 of file MPI.hpp.

◆ AllReduce() [2/4]

template<class T >

void sierra::MPI::AllReduce	(	MPI_Comm	mpi_comm,
		MPI_Op	op,
		std::vector< T > &	dest
	)

inline

Function AllReduce copies the source/destination vector into a temporary vector and then executed the MPI operation using the temporary as the source.

Parameters

mpi_comm	a `MPI_Comm` value of the MPI communicator.
op	a `MPI_Op` value of the MPI operation.
src_dest	a `std::vector<T>` reference to be copied for the source and used as the destination.
size	a `size_t` value of the length of the array pointed to by src_dest

Definition at line 387 of file MPI.hpp.

◆ AllReduce() [3/4]

template<class T >

void sierra::MPI::AllReduce	(	MPI_Comm	mpi_comm,
		MPI_Op	op,
		std::vector< T > &	source,
		std::vector< T > &	dest
	)

inline

Function AllReduce copies the source/destination vector into a temporary vector and then executed the MPI operation using the temporary as the source.

Parameters

mpi_comm	a `MPI_Comm` value of the MPI communicator.
op	a `MPI_Op` value of the MPI operation.
src	a `std::vector<T>` reference to the source data for the MPI op.
dest	a `std::vector<T>` reference to the destination data for the MPI op.
size	a `size_t` value of the length of the array pointed to by src_dest

Definition at line 415 of file MPI.hpp.

◆ align_cast()

template<typename T >

T* sierra::MPI::align_cast ( void * p )

Function align_cast returns a pointer that has been aligned to the specified alignment or double if the alignment if greater than that of double.

Parameters

p	a `void` pointer of the address to align.

Returns: a T pointer which is an alignment of p to the lesser of the type specified or double.

Definition at line 451 of file MPI.hpp.

◆ AllReduce() [4/4]

void sierra::MPI::AllReduce	(	MPI_Comm	comm,
		const ReduceSet &	reduce_set
	)

Member function AllReduce ...

Parameters

comm	a `MPI_Comm` variable ...
reduce_set	a `ReduceSet` variable ...

Definition at line 295 of file MPI.cpp.

◆ ReduceSum() [1/3]

template<typename T >

Reduce<Sum, T > sierra::MPI::ReduceSum	(	T *	t,
		T *	u,
		size_t	length
	)

Member function ReduceSum ...

Parameters

t	a `T` variable ...
u	a `T` variable ...
length	a `size_t` variable ...

Returns: a Reduce ...

Definition at line 789 of file MPI.hpp.

◆ ReduceProd() [1/3]

template<typename T >

Reduce<Prod, T > sierra::MPI::ReduceProd	(	T *	t,
		T *	u,
		size_t	length
	)

Member function ReduceProd ...

Parameters

t	a `T` variable ...
u	a `T` variable ...
length	a `size_t` variable ...

Returns: a Reduce ...

Definition at line 805 of file MPI.hpp.

◆ ReduceMax() [1/3]

template<typename T >

Reduce<Max, T > sierra::MPI::ReduceMax	(	T *	t,
		T *	u,
		size_t	length
	)

Member function ReduceMax ...

Parameters

t	a `T` variable ...
u	a `T` variable ...
length	a `size_t` variable ...

Returns: a Reduce ...

Definition at line 821 of file MPI.hpp.

◆ ReduceMin() [1/3]

template<typename T >

Reduce<Min, T > sierra::MPI::ReduceMin	(	T *	t,
		T *	u,
		size_t	length
	)

Member function ReduceMin ...

Parameters

t	a `T` variable ...
u	a `T` variable ...
length	a `size_t` variable ...

Returns: a Reduce ...

Definition at line 837 of file MPI.hpp.

◆ ReduceSum() [2/3]

template<typename T >

Reduce<Sum, T > sierra::MPI::ReduceSum	(	T &	t,
		T &	u
	)

Member function ReduceSum ...

Parameters

t	a `T` variable ...
u	a `T` variable ...

Returns: a Reduce ...

Definition at line 852 of file MPI.hpp.

◆ ReduceProd() [2/3]

template<typename T >

Reduce<Prod, T > sierra::MPI::ReduceProd	(	T &	t,
		T &	u
	)

Member function ReduceProd ...

Parameters

t	a `T` variable ...
u	a `T` variable ...

Returns: a Reduce ...

Definition at line 866 of file MPI.hpp.

◆ ReduceMax() [2/3]

template<typename T >

Reduce<Max, T > sierra::MPI::ReduceMax	(	T &	t,
		T &	u
	)

Member function ReduceMax ...

Parameters

t	a `T` variable ...
u	a `T` variable ...

Returns: a Reduce ...

Definition at line 880 of file MPI.hpp.

◆ ReduceMin() [2/3]

template<typename T >

Reduce<Min, T > sierra::MPI::ReduceMin	(	T &	t,
		T &	u
	)

Member function ReduceMin ...

Parameters

t	a `T` variable ...
u	a `T` variable ...

Returns: a Reduce ...

Definition at line 894 of file MPI.hpp.

◆ ReduceSum() [3/3]

template<class LocalIt , class GlobalIt >

Reduce<Sum, LocalIt, GlobalIt>* sierra::MPI::ReduceSum	(	LocalIt	local_begin,
		LocalIt	local_end,
		GlobalIt	global_begin,
		GlobalIt	global_end
	)

Member function ReduceSum ...

Parameters

local_begin	an `LocalIt` variable ...
local_end	an `LocalIt` variable ...
global_begin	an `GlobalIt` variable ...
global_end	an `GlobalIt` variable ...

Returns: a Reduce ...

Definition at line 913 of file MPI.hpp.

◆ ReduceProd() [3/3]

template<class LocalIt , class GlobalIt >

Reduce<Prod, LocalIt, GlobalIt>* sierra::MPI::ReduceProd	(	LocalIt	local_begin,
		LocalIt	local_end,
		GlobalIt	global_begin,
		GlobalIt	global_end
	)

Member function ReduceProd ...

Parameters

local_begin	an `LocalIt` variable ...
local_end	an `LocalIt` variable ...
global_begin	an `GlobalIt` variable ...
global_end	an `GlobalIt` variable ...

Returns: a Reduce ...

Definition at line 931 of file MPI.hpp.

◆ ReduceMin() [3/3]

template<typename T , class LocalIt , class GlobalIt >

Reduce<Min, LocalIt, GlobalIt>* sierra::MPI::ReduceMin	(	LocalIt	local_begin,
		LocalIt	local_end,
		GlobalIt	global_begin,
		GlobalIt	global_end
	)

Member function ReduceMin ...

Parameters

local_begin	an `LocalIt` variable ...
local_end	an `LocalIt` variable ...
global_begin	an `GlobalIt` variable ...
global_end	an `GlobalIt` variable ...

Returns: a Reduce ...

Definition at line 949 of file MPI.hpp.

◆ ReduceMax() [3/3]

template<typename T , class LocalIt , class GlobalIt >

Reduce<Max, LocalIt, GlobalIt>* sierra::MPI::ReduceMax	(	LocalIt	local_begin,
		LocalIt	local_end,
		GlobalIt	global_begin,
		GlobalIt	global_end
	)

Member function ReduceMax ...

Parameters

local_begin	an `LocalIt` variable ...
local_end	an `LocalIt` variable ...
global_begin	an `GlobalIt` variable ...
global_end	an `GlobalIt` variable ...

Returns: a Reduce ...

Definition at line 967 of file MPI.hpp.

◆ AllReduceCollected()

template<class T , class U >

void sierra::MPI::AllReduceCollected	(	MPI_Comm	mpi_comm,
		MPI_Op	op,
		U	collector
	)

inline

Member function AllReduceCollected ...

Parameters

mpi_comm	a `MPI_Comm` variable ...
op	a `MPI_Op` variable ...
collector	an `U` variable ...

Definition at line 983 of file MPI.hpp.

Classes

Functions

Detailed Description

Function Documentation

◆ float_complex_type()

◆ double_complex_type()

◆ double_complex_sum_op()

◆ real_complex_sum_op()

◆ long_long_int_int_type()

◆ double_double_int_type()

◆ AllReduce() [1/4]

◆ AllReduce() [2/4]

◆ AllReduce() [3/4]

◆ align_cast()

◆ AllReduce() [4/4]

◆ ReduceSum() [1/3]

◆ ReduceProd() [1/3]

◆ ReduceMax() [1/3]

◆ ReduceMin() [1/3]

◆ ReduceSum() [2/3]

◆ ReduceProd() [2/3]

◆ ReduceMax() [2/3]

◆ ReduceMin() [2/3]

◆ ReduceSum() [3/3]

◆ ReduceProd() [3/3]

◆ ReduceMin() [3/3]

◆ ReduceMax() [3/3]

◆ AllReduceCollected()