Moose::Kokkos::Mesh Class Reference

The Kokkos mesh object. More...

#include <KokkosMesh.h>

Classes
struct	MeshMap
	The wrapper of host maps. More...

Public Member Functions
	Mesh (MooseMesh &mesh)
	Constructor. More...
const MooseMesh &	getMesh ()
	Get the underyling MOOSE mesh. More...
bool	initialized () const
	Get whether the mesh was initialized. More...
void	update ()
	Update the mesh. More...
void	setNeedsElementGeometry ()
	Mark that element geometry data is needed; initElementGeometry() will be called on the next update() More...
void	setNeedsElementSideGeometry ()
	Mark that element-side geometry data is needed; initElementSideGeometry() will be called on the next update() More...
auto	getNumSubdomains () const
	Get the number of subdomains. More...
auto	getNumLocalElementTypes () const
	Get the number of local elements types. More...
const auto &	getElementTypeMap () const
	Get the element type ID map. More...
dof_id_type	getNumLocalElements () const
	Get the number of local elements. More...
dof_id_type	getNumLocalAndPossiblyOneNeighborLayerGhostElements () const
	Get the total number of elements, i.e. More...
auto	getNumSubdomainLocalElements (const SubdomainID subdomain) const
	Get the number of local elements in a MOOSE subdomain. More...
auto	getNumLocalNodes () const
	Get the number of local nodes including semi-local nodes. More...
const auto &	getLocalNodes () const
	Get the list of local nodes including semi-local nodes. More...
ContiguousSubdomainID	getContiguousSubdomainID (const SubdomainID subdomain) const
	Get the contiguous subdomain ID of a MOOSE subdomain. More...
ContiguousBoundaryID	getContiguousBoundaryID (const BoundaryID boundary) const
	Get the contiguous boundary ID of a boundary. More...
unsigned int	getElementTypeID (const Elem *elem) const
	Get the element type ID of an element. More...
ContiguousElementID	getContiguousElementID (const Elem *elem) const
	Get the contiguous element ID of an element. More...
const auto &	getGhostElemIdMapping () const
	Get the ghost element ID map (host-side only) More...
auto	getSubdomainContiguousElementIDRange (const SubdomainID subdomain) const
	Get the range of contiguous element IDs for a subdomain. More...
ContiguousNodeID	getContiguousNodeID (const Node *node) const
	Get the contiguous node ID of a node. More...
const auto &	getSubdomainContiguousNodeIDs (const SubdomainID subdomain) const
	Get the list of local contiguous node IDs for a subdomain NOTE: This list excludes semi-local nodes. More...
const auto &	getBoundaryContiguousNodeIDs (const BoundaryID boundary) const
	Get the list of local contiguous node IDs for a boundary NOTE: This list excludes semi-local nodes. More...
KOKKOS_FUNCTION const auto &	getElementInfo (ContiguousElementID elem) const
	Get the element information object. More...
KOKKOS_FUNCTION ContiguousElementID	getNeighbor (ContiguousElementID elem, unsigned int side) const
	Get the neighbor contiguous element ID. More...
KOKKOS_FUNCTION Real	getSideArea (ContiguousElementID elem, unsigned int side) const
	Get the coordinate-weighted area of an element side. More...
KOKKOS_FUNCTION Real3	getSideCentroid (ContiguousElementID elem, unsigned int side) const
	Get the centroid of an element side. More...
KOKKOS_FUNCTION Real3	getSideNormal (ContiguousElementID elem, unsigned int side) const
	Get the outward unit normal of an element side. More...
KOKKOS_FUNCTION Real3	getElementCentroidToSideCentroidVector (ContiguousElementID elem, unsigned int side) const
	Get the element-centroid to side-centroid vector for an element side. More...
KOKKOS_FUNCTION Real	getElementCentroidToSideCentroidDistance (ContiguousElementID elem, unsigned int side) const
	Get the element-centroid to side-centroid distance for an element side. More...
KOKKOS_FUNCTION Real3	getElementCentroidToNeighborCentroidVector (ContiguousElementID elem, unsigned int side) const
	Get the element-centroid to neighbor-centroid vector for an element side with a neighbor. More...
KOKKOS_FUNCTION Real	getElementCentroidToNeighborCentroidDistance (ContiguousElementID elem, unsigned int side) const
	Get the element-centroid to neighbor-centroid distance for an element side with a neighbor. More...
KOKKOS_FUNCTION BoundaryID	getSideBoundaryID (ContiguousElementID elem, unsigned int side) const
KOKKOS_FUNCTION Real	getElementVolume (ContiguousElementID elem) const
	Get the coordinate-weighted volume of a local element. More...
KOKKOS_FUNCTION Real3	getElementCentroid (ContiguousElementID elem) const
	Get the centroid of a local element. More...
void	initElementGeometry ()
	Allocate and populate local element centroids and coordinate-weighted volumes. More...
void	initElementSideGeometry ()
	Allocate and populate cached side geometry: side areas, centroids, normals, element-centroid to side-centroid and element-centroid to neighbor-centroid vectors and their magnitudes, and boundary IDs. More...
KOKKOS_FUNCTION unsigned int	getNumSides (unsigned int elem_type) const
	Get the number of sides of an element type. More...
KOKKOS_FUNCTION unsigned int	getNumNodes (unsigned int elem_type) const
	Get the number of nodes of an element type. More...
KOKKOS_FUNCTION unsigned int	getNumNodes (unsigned int elem_type, unsigned int side) const
	Get the number of nodes on a side of an element type. More...
KOKKOS_FUNCTION dof_id_type	getExtraElementID (ContiguousElementID elem, unsigned int index) const
	Get the extra element ID of an element. More...
KOKKOS_FUNCTION dof_id_type	getStartingContiguousElementID (ContiguousSubdomainID subdomain) const
	Get the starting contiguous element ID of a subdomain. More...
KOKKOS_FUNCTION ContiguousNodeID	getContiguousNodeID (ContiguousElementID elem, unsigned int node) const
	Get the contiguous node ID for an element. More...
KOKKOS_FUNCTION ContiguousNodeID	getContiguousNodeID (ElementInfo info, unsigned int side, unsigned int node) const
	Get the contiguous node ID for a side. More...
KOKKOS_FUNCTION Real3	getNodePoint (ContiguousNodeID node) const
	Get the coordinate of a node. More...
KOKKOS_FUNCTION bool	isBoundaryNode (ContiguousNodeID node, ContiguousBoundaryID boundary) const
	Get whether a node is on a boundary. More...

Private Member Functions
void	initMap ()
	Initialize host maps. More...
void	initElement ()
	Initialize device element data. More...

Private Attributes
MooseMesh &	_mesh
	Reference of the MOOSE mesh. More...
bool	_initialized = false
	Flag whether the mesh was initialized. More...
std::shared_ptr< MeshMap >	_maps
	A shared pointer holding all the host maps to avoid deep copy. More...
unsigned int	_elem_id_integer = libMesh::invalid_uint
	Element integer for Kokkos contiguous element ID. More...
unsigned int	_node_id_integer = libMesh::invalid_uint
	Node integer for Kokkos contiguous node ID. More...
dof_id_type	_num_local_elems = 0
	Number of local elements. More...
dof_id_type	_num_ghost_elems = 0
	Number of ghost (off-process neighbor) elements. More...
dof_id_type	_num_local_nodes = 0
	Number of local nodes including semi-local nodes. More...
Array< ElementInfo >	_elem_info
	Element information. More...
Array2D< ContiguousElementID >	_elem_neighbor
	Neighbor contiguous element IDs of each element. More...
Array< ContiguousElementID >	_starting_elem_id
	Starting contiguous element ID of each subdomain. More...
Array2D< dof_id_type >	_extra_elem_ids
	Extra element IDs. More...
Array< unsigned int >	_num_sides
	Number of sides of each element type. More...
Array< unsigned int >	_num_nodes
	Number of nodes of each element type. More...
Array< Array< unsigned int > >	_num_side_nodes
	Number of nodes per side of each element side. More...
Array< Array2D< unsigned int > >	_local_side_node
	Map from local side node index to local element node index. More...
Array< Real3 >	_points
	Node coordinates. More...
Array2D< ContiguousNodeID >	_nodes
	Contiguous node IDs of each element. More...
Array< Array< ContiguousNodeID > >	_boundary_nodes
	Contiguous node IDs on each boundary. More...
bool	_element_geometry_initialized = false
	Whether initElementGeometry() has been called and the element geometry cache is populated. More...
bool	_needs_element_geometry = false
	Whether initElementGeometry() should be called on the next update() More...
bool	_element_side_geometry_initialized = false
	Whether initElementSideGeometry() has been called and the side geometry cache is populated. More...
bool	_needs_element_side_geometry = false
	Whether initElementSideGeometry() should be called on the next update() More...
Array< Real >	_elem_volume
	Cached coordinate-weighted local element volumes indexed by contiguous element ID. More...
Array< Real3 >	_elem_centroid
	Cached local element centroids indexed by contiguous element ID. More...
Array2D< Real >	_side_area
	Cached coordinate-weighted side areas indexed by (side, local contiguous element ID) More...
Array2D< Real3 >	_side_centroid
	Cached side centroids indexed by (side, contiguous element ID) More...
Array2D< Real3 >	_side_normal
	Cached side normals indexed by (side, contiguous element ID) More...
Array2D< Real3 >	_elem_centroid_to_side_centroid
	Element-centroid to side-centroid vectors indexed by (side, contiguous element ID) More...
Array2D< Real >	_elem_centroid_to_side_centroid_distance
	Element-centroid to side-centroid distances indexed by (side, contiguous element ID) More...
Array2D< Real3 >	_elem_centroid_to_neighbor_centroid
	Element-centroid to neighbor-centroid vectors indexed by (side, contiguous element ID) More...
Array2D< Real >	_elem_centroid_to_neighbor_centroid_distance
	Element-centroid to neighbor-centroid distances indexed by (side, contiguous element ID) More...
Array2D< BoundaryID >	_side_boundary_id
	Boundary IDs for each side indexed by (side, contiguous element ID) More...

Detailed Description

The Kokkos mesh object.

Definition at line 52 of file KokkosMesh.h.

Constructor & Destructor Documentation

Mesh()

Moose::Kokkos::Mesh::Mesh ( MooseMesh &  mesh )

inline

Constructor.

Parameters

mesh	The MOOSE mesh

Definition at line 59 of file KokkosMesh.h.

: _mesh(mesh) {}

Member Function Documentation

getBoundaryContiguousNodeIDs()

const auto& Moose::Kokkos::Mesh::getBoundaryContiguousNodeIDs ( const BoundaryID  boundary ) const

inline

Get the list of local contiguous node IDs for a boundary NOTE: This list excludes semi-local nodes.

Parameters

boundary

The MOOSE boundary ID

Returns

The list of local contiguous node IDs on the boundary

Definition at line 196 of file KokkosMesh.h.

  {
    return libmesh_map_find(_maps->boundary_node_ids, boundary);
  }

getContiguousBoundaryID()

ContiguousBoundaryID Moose::Kokkos::Mesh::getContiguousBoundaryID

(

const BoundaryID

boundary

)

const

Get the contiguous boundary ID of a boundary.

Parameters

boundary

The MOOSE boundary ID

Returns

The contiguous boundary ID

getContiguousElementID()

ContiguousElementID Moose::Kokkos::Mesh::getContiguousElementID

(

const Elem *

elem

)

const

Get the contiguous element ID of an element.

Parameters

elem	The libMesh element

Returns

The contiguous element ID

getContiguousNodeID() [1/3]

ContiguousNodeID Moose::Kokkos::Mesh::getContiguousNodeID

(

const Node *

node

)

const

Get the contiguous node ID of a node.

Parameters

node	The libMesh node

Returns

The contiguous node ID that starts from zero in each process

getContiguousNodeID() [2/3]

KOKKOS_FUNCTION ContiguousNodeID Moose::Kokkos::Mesh::getContiguousNodeID ( ContiguousElementID  elem, unsigned int  node  ) const

inline

Get the contiguous node ID for an element.

Parameters

elem	The contiguous element ID
node	The node index

Returns

The contiguous node ID

Definition at line 405 of file KokkosMesh.h.

  {
    return _nodes(node, elem);
  }

getContiguousNodeID() [3/3]

KOKKOS_FUNCTION ContiguousNodeID Moose::Kokkos::Mesh::getContiguousNodeID ( ElementInfo  info, unsigned int  side, unsigned int  node  ) const

inline

Get the contiguous node ID for a side.

Parameters

elem	The contiguous element ID
side	The side index
node	The node index

Returns

The contiguous node ID

Definition at line 417 of file KokkosMesh.h.

  {
    return _nodes(_local_side_node[info.type](node, side), info.id);
  }

getContiguousSubdomainID()

ContiguousSubdomainID Moose::Kokkos::Mesh::getContiguousSubdomainID

(

const SubdomainID

subdomain

)

const

Get the contiguous subdomain ID of a MOOSE subdomain.

Parameters

subdomain

The MOOSE subdomain ID

Returns

The contiguous subdomain ID

getElementCentroid()

KOKKOS_FUNCTION Real3 Moose::Kokkos::Mesh::getElementCentroid ( ContiguousElementID  elem ) const

inline

Get the centroid of a local element.

Parameters

elem	The local contiguous element ID

Returns

The element centroid

Definition at line 330 of file KokkosMesh.h.

Referenced by Moose::Kokkos::FVDatum::elementCentroid().

  {
    KOKKOS_ASSERT(_element_geometry_initialized);
    KOKKOS_ASSERT(elem < _elem_centroid.size());
    return _elem_centroid[elem];
  }

getElementCentroidToNeighborCentroidDistance()

KOKKOS_FUNCTION Real Moose::Kokkos::Mesh::getElementCentroidToNeighborCentroidDistance ( ContiguousElementID  elem, unsigned int  side  ) const

inline

Get the element-centroid to neighbor-centroid distance for an element side with a neighbor.

Parameters

elem	The contiguous element ID
side	The side index

Returns

The element-centroid to neighbor-centroid distance, or zero when the side has no contiguous neighbor ID

Definition at line 299 of file KokkosMesh.h.

Referenced by Moose::Kokkos::FVDatum::faceDCNMag().

  {
    KOKKOS_ASSERT(_element_side_geometry_initialized);
    return _elem_centroid_to_neighbor_centroid_distance(side, elem);
  }

getElementCentroidToNeighborCentroidVector()

KOKKOS_FUNCTION Real3 Moose::Kokkos::Mesh::getElementCentroidToNeighborCentroidVector ( ContiguousElementID  elem, unsigned int  side  ) const

inline

Get the element-centroid to neighbor-centroid vector for an element side with a neighbor.

Parameters

elem	The contiguous element ID
side	The side index

Returns

The element-centroid to neighbor-centroid vector, or a zero vector when the side has no contiguous neighbor ID

Definition at line 286 of file KokkosMesh.h.

  {
    KOKKOS_ASSERT(_element_side_geometry_initialized);
    return _elem_centroid_to_neighbor_centroid(side, elem);
  }

getElementCentroidToSideCentroidDistance()

KOKKOS_FUNCTION Real Moose::Kokkos::Mesh::getElementCentroidToSideCentroidDistance ( ContiguousElementID  elem, unsigned int  side  ) const

inline

Get the element-centroid to side-centroid distance for an element side.

Parameters

elem	The contiguous element ID
side	The side index

Returns

The element-centroid to side-centroid distance

Definition at line 273 of file KokkosMesh.h.

Referenced by Moose::Kokkos::FVDatum::faceDCFMag().

  {
    KOKKOS_ASSERT(_element_side_geometry_initialized);
    return _elem_centroid_to_side_centroid_distance(side, elem);
  }

getElementCentroidToSideCentroidVector()

KOKKOS_FUNCTION Real3 Moose::Kokkos::Mesh::getElementCentroidToSideCentroidVector ( ContiguousElementID  elem, unsigned int  side  ) const

inline

Get the element-centroid to side-centroid vector for an element side.

Parameters

elem	The contiguous element ID
side	The side index

Returns

The element-centroid to side-centroid vector

Definition at line 261 of file KokkosMesh.h.

  {
    KOKKOS_ASSERT(_element_side_geometry_initialized);
    return _elem_centroid_to_side_centroid(side, elem);
  }

getElementInfo()

KOKKOS_FUNCTION const auto& Moose::Kokkos::Mesh::getElementInfo ( ContiguousElementID  elem ) const

inline

Get the element information object.

Parameters

elem	The contiguous element ID

Returns

The element information object

Definition at line 206 of file KokkosMesh.h.

Referenced by Moose::Kokkos::MeshDatum::neighborInfo().

  {
    KOKKOS_ASSERT(elem < _elem_info.size());

    return _elem_info[elem];
  }

getElementTypeID()

unsigned int Moose::Kokkos::Mesh::getElementTypeID

(

const Elem *

elem

)

const

Get the element type ID of an element.

Parameters

elem	The libMesh element

Returns

The element type ID

getElementTypeMap()

const auto& Moose::Kokkos::Mesh::getElementTypeMap ( ) const

inline

Get the element type ID map.

Returns

The element type ID map

Definition at line 104 of file KokkosMesh.h.

{ return _maps->elem_type_id_mapping; }

getElementVolume()

KOKKOS_FUNCTION Real Moose::Kokkos::Mesh::getElementVolume ( ContiguousElementID  elem ) const

inline

Get the coordinate-weighted volume of a local element.

Parameters

elem	The local contiguous element ID

Returns

The element volume including the coordinate transformation factor

Definition at line 319 of file KokkosMesh.h.

Referenced by Moose::Kokkos::FVDatum::elementVolume().

  {
    KOKKOS_ASSERT(_element_geometry_initialized);
    KOKKOS_ASSERT(elem < _elem_volume.size());
    return _elem_volume[elem];
  }

getExtraElementID()

KOKKOS_FUNCTION dof_id_type Moose::Kokkos::Mesh::getExtraElementID ( ContiguousElementID  elem, unsigned int  index  ) const

inline

Get the extra element ID of an element.

Parameters

elem	The contiguous element ID
index	The extra element ID index

Returns

The extra element ID

Definition at line 383 of file KokkosMesh.h.

Referenced by Moose::Kokkos::Datum::extraElemID().

  {
    KOKKOS_ASSERT(elem < _extra_elem_ids.n(0));
    KOKKOS_ASSERT(index < _extra_elem_ids.n(1));

    return _extra_elem_ids(elem, index);
  }

getGhostElemIdMapping()

const auto& Moose::Kokkos::Mesh::getGhostElemIdMapping ( ) const

inline

Get the ghost element ID map (host-side only)

Returns

Map from ghost Elem* to contiguous element ID

Definition at line 163 of file KokkosMesh.h.

{ return _maps->ghost_elem_id_mapping; }

getLocalNodes()

const auto& Moose::Kokkos::Mesh::getLocalNodes ( ) const

inline

Get the list of local nodes including semi-local nodes.

Returns

The list of local nodes including semi-local nodes

Definition at line 134 of file KokkosMesh.h.

{ return _maps->local_nodes; }

getMesh()

const MooseMesh& Moose::Kokkos::Mesh::getMesh ( )

inline

Get the underyling MOOSE mesh.

Returns

The MOOSE mesh

Definition at line 64 of file KokkosMesh.h.

{ return _mesh; }

getNeighbor()

KOKKOS_FUNCTION ContiguousElementID Moose::Kokkos::Mesh::getNeighbor ( ContiguousElementID  elem, unsigned int  side  ) const

inline

Get the neighbor contiguous element ID.

Parameters

elem	The contiguous element ID
side	The side index

Returns

The neighbor contiguous element ID

Definition at line 218 of file KokkosMesh.h.

Referenced by Moose::Kokkos::MeshDatum::neighborInfo().

  {
    return _elem_neighbor(side, elem);
  }

getNodePoint()

KOKKOS_FUNCTION Real3 Moose::Kokkos::Mesh::getNodePoint ( ContiguousNodeID  node ) const

inline

Get the coordinate of a node.

Parameters

node	The contiguous node ID

Returns

The node coordinate

Definition at line 428 of file KokkosMesh.h.

Referenced by Moose::Kokkos::Assembly::computePhysicalMap(), and Moose::Kokkos::Datum::q_point().

{ return _points[node]; }

getNumLocalAndPossiblyOneNeighborLayerGhostElements()

dof_id_type Moose::Kokkos::Mesh::getNumLocalAndPossiblyOneNeighborLayerGhostElements ( ) const

inline

Get the total number of elements, i.e.

the local elements plus the ghost elements

Returns

The total number of elements

Definition at line 618 of file KokkosMesh.h.

{
  return _num_local_elems + _num_ghost_elems;
}

getNumLocalElements()

dof_id_type Moose::Kokkos::Mesh::getNumLocalElements ( ) const

inline

Get the number of local elements.

Returns

The number of local elements

Definition at line 109 of file KokkosMesh.h.

{ return _num_local_elems; }

getNumLocalElementTypes()

auto Moose::Kokkos::Mesh::getNumLocalElementTypes ( ) const

inline

Get the number of local elements types.

Returns

The number of local element types

Definition at line 99 of file KokkosMesh.h.

{ return _maps->elem_type_id_mapping.size(); }

getNumLocalNodes()

auto Moose::Kokkos::Mesh::getNumLocalNodes ( ) const

inline

Get the number of local nodes including semi-local nodes.

Returns

The number of local nodes including semi-local nodes

Definition at line 129 of file KokkosMesh.h.

{ return _num_local_nodes; }

getNumNodes() [1/2]

KOKKOS_FUNCTION unsigned int Moose::Kokkos::Mesh::getNumNodes ( unsigned int  elem_type ) const

inline

Get the number of nodes of an element type.

Parameters

elem_type

The element type ID

Returns

The number of nodes of the element type

Definition at line 363 of file KokkosMesh.h.

Referenced by Moose::Kokkos::Assembly::computePhysicalMap().

  {
    return _num_nodes[elem_type];
  }

getNumNodes() [2/2]

KOKKOS_FUNCTION unsigned int Moose::Kokkos::Mesh::getNumNodes ( unsigned int  elem_type, unsigned int  side  ) const

inline

Get the number of nodes on a side of an element type.

Parameters

elem_type	The element type ID
side	The side index

Returns

The number of nodes on the side of the element type

Definition at line 373 of file KokkosMesh.h.

  {
    return _num_side_nodes[elem_type][side];
  }

getNumSides()

KOKKOS_FUNCTION unsigned int Moose::Kokkos::Mesh::getNumSides ( unsigned int  elem_type ) const

inline

Get the number of sides of an element type.

Parameters

elem_type

The element type ID

Returns

The number of sides of the element type

Definition at line 354 of file KokkosMesh.h.

  {
    return _num_sides[elem_type];
  }

getNumSubdomainLocalElements()

auto Moose::Kokkos::Mesh::getNumSubdomainLocalElements ( const SubdomainID  subdomain ) const

inline

Get the number of local elements in a MOOSE subdomain.

Parameters

subdomain

The MOOSE subdomain ID

Returns

The local number of elements in the subdomain

Definition at line 120 of file KokkosMesh.h.

  {
    auto range = libmesh_map_find(_maps->subdomain_elem_id_ranges, subdomain);
    return range.second - range.first;
  }

getNumSubdomains()

auto Moose::Kokkos::Mesh::getNumSubdomains ( ) const

inline

Get the number of subdomains.

Returns

The number of subdomains

Definition at line 94 of file KokkosMesh.h.

{ return _maps->subdomain_id_mapping.size(); }

getSideArea()

KOKKOS_FUNCTION Real Moose::Kokkos::Mesh::getSideArea ( ContiguousElementID  elem, unsigned int  side  ) const

inline

Get the coordinate-weighted area of an element side.

Parameters

elem	The local contiguous element ID
side	The side index

Returns

The side area including the coordinate transformation factor

Definition at line 228 of file KokkosMesh.h.

Referenced by Moose::Kokkos::FVDatum::faceArea().

  {
    KOKKOS_ASSERT(_element_side_geometry_initialized);
    return _side_area(side, elem);
  }

getSideBoundaryID()

KOKKOS_FUNCTION BoundaryID Moose::Kokkos::Mesh::getSideBoundaryID ( ContiguousElementID  elem, unsigned int  side  ) const

inline

Returns

The boundary ID associated with an element side. If there is none, the returned value will be Moose::INVALID_BOUNDARY_ID

Definition at line 309 of file KokkosMesh.h.

  {
    KOKKOS_ASSERT(_element_side_geometry_initialized);
    return _side_boundary_id(side, elem);
  }

getSideCentroid()

KOKKOS_FUNCTION Real3 Moose::Kokkos::Mesh::getSideCentroid ( ContiguousElementID  elem, unsigned int  side  ) const

inline

Get the centroid of an element side.

Parameters

elem	The contiguous element ID
side	The side index

Returns

The side centroid

Definition at line 239 of file KokkosMesh.h.

Referenced by Moose::Kokkos::FVDatum::faceCentroid().

  {
    KOKKOS_ASSERT(_element_side_geometry_initialized);
    return _side_centroid(side, elem);
  }

getSideNormal()

KOKKOS_FUNCTION Real3 Moose::Kokkos::Mesh::getSideNormal ( ContiguousElementID  elem, unsigned int  side  ) const

inline

Get the outward unit normal of an element side.

Parameters

elem	The contiguous element ID
side	The side index

Returns

The side normal

Definition at line 250 of file KokkosMesh.h.

Referenced by Moose::Kokkos::FVDatum::faceNormal().

  {
    KOKKOS_ASSERT(_element_side_geometry_initialized);
    return _side_normal(side, elem);
  }

getStartingContiguousElementID()

KOKKOS_FUNCTION dof_id_type Moose::Kokkos::Mesh::getStartingContiguousElementID ( ContiguousSubdomainID  subdomain ) const

inline

Get the starting contiguous element ID of a subdomain.

Parameters

subdomain

The contiguous subdomain ID

Returns

The starting contiguous element ID

Definition at line 395 of file KokkosMesh.h.

  {
    return _starting_elem_id[subdomain];
  }

getSubdomainContiguousElementIDRange()

auto Moose::Kokkos::Mesh::getSubdomainContiguousElementIDRange ( const SubdomainID  subdomain ) const

inline

Get the range of contiguous element IDs for a subdomain.

Parameters

subdomain

The MOOSE subdomain ID

Returns

The range of contiguous element IDs in the subdomain

Definition at line 169 of file KokkosMesh.h.

  {
    const auto & range = libmesh_map_find(_maps->subdomain_elem_id_ranges, subdomain);
    return libMesh::make_range(range.first, range.second);
  }

getSubdomainContiguousNodeIDs()

const auto& Moose::Kokkos::Mesh::getSubdomainContiguousNodeIDs ( const SubdomainID  subdomain ) const

inline

Get the list of local contiguous node IDs for a subdomain NOTE: This list excludes semi-local nodes.

Parameters

subdomain

The MOOSE subdomain ID

Returns

The list of local contiguous node IDs in the subdomain

Definition at line 186 of file KokkosMesh.h.

  {
    return libmesh_map_find(_maps->subdomain_node_ids, subdomain);
  }

initElement()

void Moose::Kokkos::Mesh::initElement ( )

private

Initialize device element data.

initElementGeometry()

void Moose::Kokkos::Mesh::initElementGeometry

(

)

Allocate and populate local element centroids and coordinate-weighted volumes.

initElementSideGeometry()

void Moose::Kokkos::Mesh::initElementSideGeometry

(

)

Allocate and populate cached side geometry: side areas, centroids, normals, element-centroid to side-centroid and element-centroid to neighbor-centroid vectors and their magnitudes, and boundary IDs.

initialized()

bool Moose::Kokkos::Mesh::initialized ( ) const

inline

Get whether the mesh was initialized.

Definition at line 68 of file KokkosMesh.h.

Referenced by Moose::Kokkos::MeshHolder::kokkosMesh().

{ return _initialized; }

initMap()

void Moose::Kokkos::Mesh::initMap ( )

private

Initialize host maps.

isBoundaryNode()

KOKKOS_FUNCTION bool Moose::Kokkos::Mesh::isBoundaryNode ( ContiguousNodeID  node, ContiguousBoundaryID  boundary  ) const

inline

Get whether a node is on a boundary.

Parameters

node	The contiguous node ID
boundary	The contiguous boundary ID

Returns

Whether the node is on the boundary

Definition at line 604 of file KokkosMesh.h.

Referenced by KokkosBoundNodalKernel::skipOnBoundary().

{
  if (!_boundary_nodes[boundary].size())
    return false;

  auto begin = &_boundary_nodes[boundary].begin();
  auto end = &_boundary_nodes[boundary].end();
  auto target = Utils::find(node, begin, end);

  return target != end;
}

setNeedsElementGeometry()

void Moose::Kokkos::Mesh::setNeedsElementGeometry ( )

inline

Mark that element geometry data is needed; initElementGeometry() will be called on the next update()

Definition at line 78 of file KokkosMesh.h.

Referenced by setNeedsElementSideGeometry().

{ _needs_element_geometry = true; }

setNeedsElementSideGeometry()

void Moose::Kokkos::Mesh::setNeedsElementSideGeometry ( )

inline

Mark that element-side geometry data is needed; initElementSideGeometry() will be called on the next update()

Definition at line 84 of file KokkosMesh.h.

  {
    _needs_element_side_geometry = true;
    setNeedsElementGeometry();
  }

update()

void Moose::Kokkos::Mesh::update

(

)

Update the mesh.

Member Data Documentation

_boundary_nodes

Array<Array<ContiguousNodeID> > Moose::Kokkos::Mesh::_boundary_nodes

private

Contiguous node IDs on each boundary.

Definition at line 570 of file KokkosMesh.h.

Referenced by isBoundaryNode().

_elem_centroid

Array<Real3> Moose::Kokkos::Mesh::_elem_centroid

private

Cached local element centroids indexed by contiguous element ID.

Definition at line 583 of file KokkosMesh.h.

Referenced by getElementCentroid().

_elem_centroid_to_neighbor_centroid

Array2D<Real3> Moose::Kokkos::Mesh::_elem_centroid_to_neighbor_centroid

private

Element-centroid to neighbor-centroid vectors indexed by (side, contiguous element ID)

Definition at line 595 of file KokkosMesh.h.

Referenced by getElementCentroidToNeighborCentroidVector().

_elem_centroid_to_neighbor_centroid_distance

Array2D<Real> Moose::Kokkos::Mesh::_elem_centroid_to_neighbor_centroid_distance

private

Element-centroid to neighbor-centroid distances indexed by (side, contiguous element ID)

Definition at line 597 of file KokkosMesh.h.

Referenced by getElementCentroidToNeighborCentroidDistance().

_elem_centroid_to_side_centroid

Array2D<Real3> Moose::Kokkos::Mesh::_elem_centroid_to_side_centroid

private

Element-centroid to side-centroid vectors indexed by (side, contiguous element ID)

Definition at line 591 of file KokkosMesh.h.

Referenced by getElementCentroidToSideCentroidVector().

_elem_centroid_to_side_centroid_distance

Array2D<Real> Moose::Kokkos::Mesh::_elem_centroid_to_side_centroid_distance

private

Element-centroid to side-centroid distances indexed by (side, contiguous element ID)

Definition at line 593 of file KokkosMesh.h.

Referenced by getElementCentroidToSideCentroidDistance().

_elem_id_integer

unsigned int Moose::Kokkos::Mesh::_elem_id_integer = libMesh::invalid_uint

private

Element integer for Kokkos contiguous element ID.

Definition at line 510 of file KokkosMesh.h.

_elem_info

Array<ElementInfo> Moose::Kokkos::Mesh::_elem_info

private

Element information.

Definition at line 530 of file KokkosMesh.h.

Referenced by getElementInfo().

_elem_neighbor

Array2D<ContiguousElementID> Moose::Kokkos::Mesh::_elem_neighbor

private

Neighbor contiguous element IDs of each element.

Definition at line 534 of file KokkosMesh.h.

Referenced by getNeighbor().

_elem_volume

Array<Real> Moose::Kokkos::Mesh::_elem_volume

private

Cached coordinate-weighted local element volumes indexed by contiguous element ID.

Definition at line 581 of file KokkosMesh.h.

Referenced by getElementVolume().

_element_geometry_initialized

bool Moose::Kokkos::Mesh::_element_geometry_initialized = false

private

Whether initElementGeometry() has been called and the element geometry cache is populated.

Definition at line 573 of file KokkosMesh.h.

Referenced by getElementCentroid(), and getElementVolume().

_element_side_geometry_initialized

bool Moose::Kokkos::Mesh::_element_side_geometry_initialized = false

private

Whether initElementSideGeometry() has been called and the side geometry cache is populated.

Definition at line 577 of file KokkosMesh.h.

Referenced by getElementCentroidToNeighborCentroidDistance(), getElementCentroidToNeighborCentroidVector(), getElementCentroidToSideCentroidDistance(), getElementCentroidToSideCentroidVector(), getSideArea(), getSideBoundaryID(), getSideCentroid(), and getSideNormal().

_extra_elem_ids

Array2D<dof_id_type> Moose::Kokkos::Mesh::_extra_elem_ids

private

Extra element IDs.

Definition at line 542 of file KokkosMesh.h.

Referenced by getExtraElementID().

_initialized

bool Moose::Kokkos::Mesh::_initialized = false

private

Flag whether the mesh was initialized.

Definition at line 455 of file KokkosMesh.h.

Referenced by initialized().

_local_side_node

Array<Array2D<unsigned int> > Moose::Kokkos::Mesh::_local_side_node

private

Map from local side node index to local element node index.

Definition at line 558 of file KokkosMesh.h.

Referenced by getContiguousNodeID().

_maps

std::shared_ptr<MeshMap> Moose::Kokkos::Mesh::_maps

private

A shared pointer holding all the host maps to avoid deep copy.

Definition at line 505 of file KokkosMesh.h.

Referenced by getBoundaryContiguousNodeIDs(), getElementTypeMap(), getGhostElemIdMapping(), getLocalNodes(), getNumLocalElementTypes(), getNumSubdomainLocalElements(), getNumSubdomains(), getSubdomainContiguousElementIDRange(), and getSubdomainContiguousNodeIDs().

_mesh

MooseMesh& Moose::Kokkos::Mesh::_mesh

private

Reference of the MOOSE mesh.

Definition at line 451 of file KokkosMesh.h.

Referenced by getMesh().

_needs_element_geometry

bool Moose::Kokkos::Mesh::_needs_element_geometry = false

private

Whether initElementGeometry() should be called on the next update()

Definition at line 575 of file KokkosMesh.h.

Referenced by setNeedsElementGeometry().

_needs_element_side_geometry

bool Moose::Kokkos::Mesh::_needs_element_side_geometry = false

private

Whether initElementSideGeometry() should be called on the next update()

Definition at line 579 of file KokkosMesh.h.

Referenced by setNeedsElementSideGeometry().

_node_id_integer

unsigned int Moose::Kokkos::Mesh::_node_id_integer = libMesh::invalid_uint

private

Node integer for Kokkos contiguous node ID.

Definition at line 514 of file KokkosMesh.h.

_nodes

Array2D<ContiguousNodeID> Moose::Kokkos::Mesh::_nodes

private

Contiguous node IDs of each element.

Definition at line 566 of file KokkosMesh.h.

Referenced by getContiguousNodeID().

_num_ghost_elems

dof_id_type Moose::Kokkos::Mesh::_num_ghost_elems = 0

private

Number of ghost (off-process neighbor) elements.

Definition at line 522 of file KokkosMesh.h.

Referenced by getNumLocalAndPossiblyOneNeighborLayerGhostElements().

_num_local_elems

dof_id_type Moose::Kokkos::Mesh::_num_local_elems = 0

private

Number of local elements.

Definition at line 518 of file KokkosMesh.h.

Referenced by getNumLocalAndPossiblyOneNeighborLayerGhostElements(), and getNumLocalElements().

_num_local_nodes

dof_id_type Moose::Kokkos::Mesh::_num_local_nodes = 0

private

Number of local nodes including semi-local nodes.

Definition at line 526 of file KokkosMesh.h.

Referenced by getNumLocalNodes().

_num_nodes

Array<unsigned int> Moose::Kokkos::Mesh::_num_nodes

private

Number of nodes of each element type.

Definition at line 550 of file KokkosMesh.h.

Referenced by getNumNodes().

_num_side_nodes

Array<Array<unsigned int> > Moose::Kokkos::Mesh::_num_side_nodes

private

Number of nodes per side of each element side.

Definition at line 554 of file KokkosMesh.h.

Referenced by getNumNodes().

_num_sides

Array<unsigned int> Moose::Kokkos::Mesh::_num_sides

private

Number of sides of each element type.

Definition at line 546 of file KokkosMesh.h.

Referenced by getNumSides().

_points

Array<Real3> Moose::Kokkos::Mesh::_points

private

Node coordinates.

Definition at line 562 of file KokkosMesh.h.

Referenced by getNodePoint().

_side_area

Array2D<Real> Moose::Kokkos::Mesh::_side_area

private

Cached coordinate-weighted side areas indexed by (side, local contiguous element ID)

Definition at line 585 of file KokkosMesh.h.

Referenced by getSideArea().

_side_boundary_id

Array2D<BoundaryID> Moose::Kokkos::Mesh::_side_boundary_id

private

Boundary IDs for each side indexed by (side, contiguous element ID)

Definition at line 599 of file KokkosMesh.h.

Referenced by getSideBoundaryID().

_side_centroid

Array2D<Real3> Moose::Kokkos::Mesh::_side_centroid

private

Cached side centroids indexed by (side, contiguous element ID)

Definition at line 587 of file KokkosMesh.h.

Referenced by getSideCentroid().

_side_normal

Array2D<Real3> Moose::Kokkos::Mesh::_side_normal

private

Cached side normals indexed by (side, contiguous element ID)

Definition at line 589 of file KokkosMesh.h.

Referenced by getSideNormal().

_starting_elem_id

Array<ContiguousElementID> Moose::Kokkos::Mesh::_starting_elem_id

private

Starting contiguous element ID of each subdomain.

Definition at line 538 of file KokkosMesh.h.

Referenced by getStartingContiguousElementID().

---

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

• include/kokkos/mesh/KokkosMesh.h