The Kokkos mesh object. More...

#include <KokkosMesh.h>

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

Public Member Functions
	Mesh (const MooseMesh &mesh)
	Constructor. More...

const MooseMesh &	getMesh ()
	Get the underyling MOOSE mesh. More...

void	update ()
	Update the mesh. 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 &	getElementTypeMap () const
	Get the element type ID map. More...

const auto &	getContiguousElementMap () const
	Get the contiguous element ID map. More...

const auto &	getSubdomainContiguousElementIDs (const SubdomainID subdomain) const
	Get the list 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 &	getContiguousNodeMap () const
	Get the contiguous node ID map This list contains the nodes of local elements, so some nodes may belong to other processes. More...

const auto &	getSubdomainContiguousNodeIDs (const SubdomainID subdomain) const
	Get the list of contiguous node IDs for a subdomain This list strictly contains the nodes local to the current process. 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 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 ContiguousNodeID	getContiguousNodeID (ContiguousElementID elem, unsigned int node) const
	Get the contiguous node ID for an element. More...

KOKKOS_FUNCTION ContiguousNodeID	getContiguousNodeID (ContiguousElementID elem, 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
const MooseMesh &	_mesh
	Reference of the MOOSE mesh. More...

std::shared_ptr< MeshMap >	_maps
	A shared pointer holding all the host maps to avoid deep copy. More...

Array< ElementInfo >	_elem_info
	Element information. More...

Array2D< ContiguousElementID >	_elem_neighbor
	Neighbor contiguous element IDs of each element. 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< Real3 >	_points
	Node coordinates. More...

Array< Array< ContiguousNodeID > >	_boundary_nodes
	Contiguous node IDs on each boundary. More...


Array2D< ContiguousNodeID >	_nodes
	Contiguous node IDs of each element and side. More...

Array3D< ContiguousNodeID >	_nodes_face

Detailed Description

The Kokkos mesh object.

Definition at line 54 of file KokkosMesh.h.

Constructor & Destructor Documentation

◆ Mesh()

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

inline

Constructor.

Parameters

mesh	The MOOSE mesh

Definition at line 61 of file KokkosMesh.h.

61 : _mesh(mesh) {}

Moose::Kokkos::Mesh::_mesh

const MooseMesh & _mesh

Reference of the MOOSE mesh.

Definition: KokkosMesh.h:238

Member Function Documentation

◆ 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

◆ getContiguousElementMap()

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

inline

Get the contiguous element ID map.

Returns: The contiguous element ID map

Definition at line 105 of file KokkosMesh.h.

105 { return _maps->_local_elem_id_mapping; }

Moose::Kokkos::Mesh::_maps

std::shared_ptr< MeshMap > _maps

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

Definition: KokkosMesh.h:278

◆ 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 192 of file KokkosMesh.h.

   {
     return _nodes(node, elem);
   }

◆ getContiguousNodeID() [3/3]

KOKKOS_FUNCTION ContiguousNodeID Moose::Kokkos::Mesh::getContiguousNodeID	(	ContiguousElementID	elem,
		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 204 of file KokkosMesh.h.

   {
     return _nodes_face(node, side, elem);
   }

◆ getContiguousNodeMap()

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

inline

Get the contiguous node ID map This list contains the nodes of local elements, so some nodes may belong to other processes.

Returns: The contiguous node ID map

Definition at line 126 of file KokkosMesh.h.

126 { return _maps->_local_node_id_mapping; }

Moose::Kokkos::Mesh::_maps

std::shared_ptr< MeshMap > _maps

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

Definition: KokkosMesh.h:278

◆ 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

◆ 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 144 of file KokkosMesh.h.

   {
     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 100 of file KokkosMesh.h.

100 { return _maps->_elem_type_id_mapping; }

Moose::Kokkos::Mesh::_maps

std::shared_ptr< MeshMap > _maps

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

Definition: KokkosMesh.h:278

◆ getMesh()

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

inline

Get the underyling MOOSE mesh.

Returns: The MOOSE mesh

Definition at line 66 of file KokkosMesh.h.

66 { return _mesh; }

Moose::Kokkos::Mesh::_mesh

const MooseMesh & _mesh

Reference of the MOOSE mesh.

Definition: KokkosMesh.h:238

◆ 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 154 of file KokkosMesh.h.

   {
     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 215 of file KokkosMesh.h.

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

215 { return _points[node]; }

Moose::Kokkos::Mesh::_points

Array< Real3 > _points

Node coordinates.

Definition: KokkosMesh.h:303

◆ 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 172 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 182 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 163 of file KokkosMesh.h.

   {
     return _num_sides[elem_type];
   }

◆ getSubdomainContiguousElementIDs()

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

inline

Get the list of contiguous element IDs for a subdomain.

Parameters

subdomain The MOOSE subdomain ID

Returns: The list of contiguous element IDs in the subdomain

Definition at line 111 of file KokkosMesh.h.

   {
     return _maps->_subdomain_elem_ids.at(subdomain);
   }

◆ getSubdomainContiguousNodeIDs()

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

inline

Get the list of contiguous node IDs for a subdomain This list strictly contains the nodes local to the current process.

Parameters

subdomain The MOOSE subdomain ID

Returns: The list of contiguous node IDs in the subdomain

Definition at line 133 of file KokkosMesh.h.

   {
     return _maps->_subdomain_node_ids.at(subdomain);
   }

◆ initElement()

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

private

Initialize device element data.

◆ 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 319 of file KokkosMesh.h.

 {
   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;
 }

◆ 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 314 of file KokkosMesh.h.

Referenced by isBoundaryNode().

◆ _elem_info

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

private

Element information.

Definition at line 283 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 287 of file KokkosMesh.h.

Referenced by getNeighbor().

◆ _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 278 of file KokkosMesh.h.

Referenced by getContiguousElementMap(), getContiguousNodeMap(), getElementTypeMap(), getSubdomainContiguousElementIDs(), and getSubdomainContiguousNodeIDs().

◆ _mesh

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

private

Reference of the MOOSE mesh.

Definition at line 238 of file KokkosMesh.h.

Referenced by getMesh().

◆ _nodes

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

private

Contiguous node IDs of each element and side.

Definition at line 308 of file KokkosMesh.h.

Referenced by getContiguousNodeID().

◆ _nodes_face

Array3D<ContiguousNodeID> Moose::Kokkos::Mesh::_nodes_face

private

Definition at line 309 of file KokkosMesh.h.

Referenced by getContiguousNodeID().

◆ _num_nodes

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

private

Number of nodes of each element type.

Definition at line 295 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 299 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 291 of file KokkosMesh.h.

Referenced by getNumSides().

◆ _points

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

private

Node coordinates.

Definition at line 303 of file KokkosMesh.h.

Referenced by getNodePoint().

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

include/kokkos/mesh/KokkosMesh.h

Classes

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Mesh()

Member Function Documentation

◆ getContiguousBoundaryID()

◆ getContiguousElementID()

◆ getContiguousElementMap()

◆ getContiguousNodeID() [1/3]

◆ getContiguousNodeID() [2/3]

◆ getContiguousNodeID() [3/3]

◆ getContiguousNodeMap()

◆ getContiguousSubdomainID()

◆ getElementInfo()

◆ getElementTypeID()

◆ getElementTypeMap()

◆ getMesh()

◆ getNeighbor()

◆ getNodePoint()

◆ getNumNodes() [1/2]

◆ getNumNodes() [2/2]

◆ getNumSides()

◆ getSubdomainContiguousElementIDs()

◆ getSubdomainContiguousNodeIDs()

◆ initElement()

◆ initMap()

◆ isBoundaryNode()

◆ update()

Member Data Documentation

◆ _boundary_nodes

◆ _elem_info

◆ _elem_neighbor

◆ _maps

◆ _mesh

◆ _nodes

◆ _nodes_face

◆ _num_nodes

◆ _num_side_nodes

◆ _num_sides

◆ _points