Cabana_Grid_GlobalGrid.hpp File Reference

Global grid. More...

#include <Cabana_Grid_GlobalMesh.hpp>
#include <Cabana_Grid_Partitioner.hpp>
#include <Cabana_Grid_Types.hpp>
#include <array>
#include <memory>
#include <mpi.h>
#include <Cabana_Grid_GlobalGrid_impl.hpp>

Include dependency graph for Cabana_Grid_GlobalGrid.hpp:

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

Go to the source code of this file.

Classes
class	Cabana::Grid::GlobalGrid< MeshType >
	Global logical grid. More...

Namespaces
namespace	Cabana
	Core: particle data structures and algorithms.

Functions
template<class MeshType>
std::shared_ptr< GlobalGrid< MeshType > >	Cabana::Grid::createGlobalGrid (MPI_Comm comm, const std::shared_ptr< GlobalMesh< MeshType > > &global_mesh, const std::array< bool, MeshType::num_space_dim > &periodic, const BlockPartitioner< MeshType::num_space_dim > &partitioner)
	Create a global grid.
template<class Scalar, std::size_t NumSpaceDim>
std::shared_ptr< GlobalGrid< SparseMesh< Scalar, NumSpaceDim > > >	Cabana::Grid::createGlobalGrid (MPI_Comm comm, const std::shared_ptr< GlobalMesh< SparseMesh< Scalar, NumSpaceDim > > > &global_mesh, const std::array< bool, SparseMesh< Scalar, NumSpaceDim >::num_space_dim > &periodic, const BlockPartitioner< SparseMesh< Scalar, NumSpaceDim >::num_space_dim > &partitioner)
	Create a sparse global grid.

Detailed Description

Global grid.

Function Documentation

createGlobalGrid() [1/2]

template<class MeshType>

std::shared_ptr< GlobalGrid< MeshType > > Cabana::Grid::createGlobalGrid	(	MPI_Comm	comm,
		const std::shared_ptr< GlobalMesh< MeshType > > &	global_mesh,
		const std::array< bool, MeshType::num_space_dim > &	periodic,
		const BlockPartitioner< MeshType::num_space_dim > &	partitioner )

Create a global grid.

Parameters

comm	The communicator over which to define the grid.
global_mesh	The global mesh data.
periodic	Whether each logical dimension is periodic.
partitioner	The grid partitioner.

Returns

Shared pointer to a GlobalGrid.

createGlobalGrid() [2/2]

template<class Scalar, std::size_t NumSpaceDim>

std::shared_ptr< GlobalGrid< SparseMesh< Scalar, NumSpaceDim > > > Cabana::Grid::createGlobalGrid	(	MPI_Comm	comm,
		const std::shared_ptr< GlobalMesh< SparseMesh< Scalar, NumSpaceDim > > > &	global_mesh,
		const std::array< bool, SparseMesh< Scalar, NumSpaceDim >::num_space_dim > &	periodic,
		const BlockPartitioner< SparseMesh< Scalar, NumSpaceDim >::num_space_dim > &	partitioner )

Create a sparse global grid.

Parameters

comm	The communicator over which to define the grid.
global_mesh	The global mesh data.
periodic	Whether each logical dimension is periodic.
partitioner	The grid partitioner.

Returns

Shared pointer to a GlobalGrid.