Cabana_Grid_Halo.hpp File Reference

Multi-node grid scatter/gather. More...

#include <Cabana_Grid_Array.hpp>
#include <Cabana_Grid_IndexSpace.hpp>
#include <Cabana_ParameterPack.hpp>
#include <Kokkos_Core.hpp>
#include <Kokkos_Profiling_ScopedRegion.hpp>
#include <mpi.h>
#include <algorithm>
#include <array>
#include <cmath>
#include <type_traits>
#include <vector>

Include dependency graph for Cabana_Grid_Halo.hpp:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	Cabana::Grid::HaloPattern< NumSpaceDim >
	Base halo exchange pattern class. More...
class	Cabana::Grid::NodeHaloPattern< 3 >
class	Cabana::Grid::NodeHaloPattern< 2 >
class	Cabana::Grid::FaceHaloPattern< 3 >
class	Cabana::Grid::FaceHaloPattern< 2 >
struct	Cabana::Grid::ScatterReduce::Sum
	Sum values from neighboring ranks into this rank's data. More...
struct	Cabana::Grid::ScatterReduce::Min
struct	Cabana::Grid::ScatterReduce::Max
struct	Cabana::Grid::ScatterReduce::Replace
class	Cabana::Grid::Halo< MemorySpace >
struct	Cabana::Grid::ArrayPackMemorySpace< ArrayT, Types >
	Infer array memory space. More...

Namespaces
namespace	Cabana
	Core: particle data structures and algorithms.

Functions
template<class Pattern, class... ArrayTypes>
auto	Cabana::Grid::createHalo (const Pattern &pattern, const int width, const ArrayTypes &... arrays)
	Halo creation function.

Detailed Description

Multi-node grid scatter/gather.

Function Documentation

createHalo()

template<class Pattern, class... ArrayTypes>

auto Cabana::Grid::createHalo	(	const Pattern &	pattern,
		const int	width,
		const ArrayTypes &...	arrays )

Halo creation function.

Parameters

pattern	The pattern to build the halo from.
width	Must be less than or equal to the width of the array halo.
arrays	The arrays over which to build the halo.

Returns

Shared pointer to a Halo.