Cabana::Grid::Array< Scalar, EntityType, MeshType, Params > Class Template Reference

Array of field data on the local mesh. More...

#include <Cabana_Grid_Array.hpp>

Public Types
using	value_type = Scalar
	Value type.
using	entity_type = EntityType
	Entity type.
using	mesh_type = MeshType
	Mesh type.
using	array_layout = ArrayLayout<entity_type, mesh_type>
	Array layout type.
using	view_type
	View type.
using	memory_space = typename view_type::memory_space
	Memory space.
using	execution_space = typename memory_space::execution_space
	Default execution space.
using	subview_type
	Subview type.
using	subview_layout = typename subview_type::array_layout
	Subview array layout type.
using	subview_memory_traits = typename subview_type::memory_traits
	Subview memory traits.
using	subarray_type
	Subarray type.

Public Member Functions
	Array (const std::string &label, const std::shared_ptr< array_layout > &layout)
	Create an array with the given layout. Arrays are constructed over the ghosted index space of the layout.
	Array (const std::shared_ptr< array_layout > &layout, const view_type &view)
	Create an array with the given layout and view. This view should match the array index spaces in size.
std::shared_ptr< array_layout >	layout () const
	Get the layout of the array.
view_type	view () const
	Get a view of the array data.
std::string	label () const
	Get the array label.

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

Detailed Description

template<class Scalar, class EntityType, class MeshType, class... Params>
class Cabana::Grid::Array< Scalar, EntityType, MeshType, Params >

Array of field data on the local mesh.

Template Parameters

Scalar	Scalar type.
EntityType	Array entity type (node, cell, face, edge).
MeshType	Mesh type (uniform, non-uniform).
Params	Kokkos View parameters.

Member Typedef Documentation

subarray_type

template<class Scalar, class EntityType, class MeshType, class... Params>

using Cabana::Grid::Array< Scalar, EntityType, MeshType, Params >::subarray_type

Initial value:

 Array<Scalar, EntityType, MeshType, subview_layout,
                                memory_space, subview_memory_traits>

Subarray type.

subview_type

template<class Scalar, class EntityType, class MeshType, class... Params>

using Cabana::Grid::Array< Scalar, EntityType, MeshType, Params >::subview_type

Initial value:

 decltype( createSubview(
        _data, _layout->indexSpace( Ghost(), Local() ) ) )

Subview type.

view_type

template<class Scalar, class EntityType, class MeshType, class... Params>

using Cabana::Grid::Array< Scalar, EntityType, MeshType, Params >::view_type

Initial value:

 std::conditional_t<
        3 == num_space_dim, Kokkos::View<value_type****, Params...>,
        std::conditional_t<2 == num_space_dim,
                           Kokkos::View<value_type***, Params...>, void>>

View type.

Constructor & Destructor Documentation

Array() [1/2]

template<class Scalar, class EntityType, class MeshType, class... Params>

Cabana::Grid::Array< Scalar, EntityType, MeshType, Params >::Array ( const std::string & label, const std::shared_ptr< array_layout > & layout )

inline

Create an array with the given layout. Arrays are constructed over the ghosted index space of the layout.

Parameters

label	A label for the array.
layout	The array layout over which to construct the view.

Array() [2/2]

template<class Scalar, class EntityType, class MeshType, class... Params>

Cabana::Grid::Array< Scalar, EntityType, MeshType, Params >::Array ( const std::shared_ptr< array_layout > & layout, const view_type & view )

inline

Create an array with the given layout and view. This view should match the array index spaces in size.

Parameters

layout	The layout of the array.
view	The array data.

---

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

• grid/src/Cabana_Grid_Array.hpp