Cabana::Grid::GlobalMesh< MeshType > Class Template Reference

Global mesh partial specialization for uniform mesh. More...

#include <Cabana_Grid_GlobalMesh.hpp>

Public Types
using	mesh_type = MeshType
	Mesh type.
using	scalar_type = typename mesh_type::scalar_type
	Scalar type.

Public Member Functions
	GlobalMesh (const std::array< scalar_type, num_space_dim > &global_low_corner, const std::array< scalar_type, num_space_dim > &global_high_corner, const scalar_type cell_size)
	Cell size constructor where all cell dimensions are the same.
	GlobalMesh (const std::array< scalar_type, num_space_dim > &global_low_corner, const std::array< scalar_type, num_space_dim > &global_high_corner, const std::array< scalar_type, num_space_dim > &cell_size)
	Cell size constructor - each cell dimension can be different.
	GlobalMesh (const std::array< scalar_type, num_space_dim > &global_low_corner, const std::array< scalar_type, num_space_dim > &global_high_corner, const std::array< int, num_space_dim > &global_num_cell)
	Number of global cells constructor.
scalar_type	lowCorner (const std::size_t dim) const
	Get the global low corner of the mesh.
scalar_type	highCorner (const std::size_t dim) const
	Get the global high corner of the mesh.
scalar_type	extent (const std::size_t dim) const
	Get the extent of a given dimension.
int	globalNumCell (const std::size_t dim) const
	Get the global number of cells in a given dimension.
scalar_type	cellSize (const std::size_t dim) const
	Get the uniform cell size in a given dimension.

Static Public Attributes
static constexpr std::size_t	num_space_dim = mesh_type::num_space_dim
	Spatial dimension.

Detailed Description

template<class MeshType>
class Cabana::Grid::GlobalMesh< MeshType >

Global mesh partial specialization for uniform mesh.

Uniform meshes are rectilinear meshes where every cell in the mesh is identical. A cell is described by its width in each dimension.

Template Parameters

MeshType

Mesh type: UniformMesh, SparseMesh

Member Function Documentation

cellSize()

template<class MeshType>

scalar_type Cabana::Grid::GlobalMesh< MeshType >::cellSize ( const std::size_t dim ) const

inline

Get the uniform cell size in a given dimension.

Parameters

dim	Spatial dimension.

extent()

template<class MeshType>

scalar_type Cabana::Grid::GlobalMesh< MeshType >::extent ( const std::size_t dim ) const

inline

Get the extent of a given dimension.

Parameters

dim	Spatial dimension.

globalNumCell()

template<class MeshType>

int Cabana::Grid::GlobalMesh< MeshType >::globalNumCell ( const std::size_t dim ) const

inline

Get the global number of cells in a given dimension.

Parameters

dim	Spatial dimension.

highCorner()

template<class MeshType>

scalar_type Cabana::Grid::GlobalMesh< MeshType >::highCorner ( const std::size_t dim ) const

inline

Get the global high corner of the mesh.

Parameters

dim	Spatial dimension.

lowCorner()

template<class MeshType>

scalar_type Cabana::Grid::GlobalMesh< MeshType >::lowCorner ( const std::size_t dim ) const

inline

Get the global low corner of the mesh.

Parameters

dim	Spatial dimension.

---

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

• grid/src/Cabana_Grid_GlobalMesh.hpp