waves
Basic FE playground
katoptron::ElementsList Class Reference

Class used to store the element information including: More...

#include <ElementsList.h>

Public Member Functions

 ElementsList (Problem &pbl, Teuchos::RCP< Map > map)
 ElementsList constructor. More...
 
local_ordinal_type getElementNumber (void) const
 Return the number of local elements i.e. the number of elements owned by the calling process. More...
 
local_ordinal_type getElementType (const local_ordinal_type e) const
 Return the type of the local element of local ID e. Argument: More...
 
local_ordinal_type getElementSize (const local_ordinal_type e) const
 Return the size of the local element of local ID e. Argument: More...
 
local_ordinal_type getElementMaterial (const local_ordinal_type e) const
 Return the material ID of the local element of ID e. Argument: More...
 
local_ordinal_type getElementNode (const local_ordinal_type e, local_ordinal_type i) const
 Return the local ID of the ith node of the local element of ID e. Argument: More...
 
local_ordinal_type isLocal (const local_ordinal_type e) const
 Return whether local element of ID e is owned by this MPI process (i.e whether it is not a ghost element). Argument: More...
 

Private Types

typedef Map::local_ordinal_type local_ordinal_type
 

Private Attributes

Kokkos::View< int **, Kokkos::LayoutRight > elements
 
local_ordinal_type elements_number
 
local_ordinal_type elements_type
 
local_ordinal_type elements_size
 
local_ordinal_type elements_material
 
local_ordinal_type elements_owned
 
local_ordinal_type elements_nodes
 

Detailed Description

Class used to store the element information including:

  • The number of local elements,
  • The type of every elements,
  • The size of each elements,
  • The material ID of each elements,
  • The local node ID of each elements.

Member Typedef Documentation

◆ local_ordinal_type

Constructor & Destructor Documentation

◆ ElementsList()

ElementsList::ElementsList ( Problem pbl,
Teuchos::RCP< Map map 
)

ElementsList constructor.

This constructor allocates 1 Kokkos::View which stores all the required information related to the elements, including:

  • all their local node IDs,
  • their size, type, and material (at most one material per element).

Arguments:

  • pbl: a Problem object,
  • map: an RCP to a Map object.

Member Function Documentation

◆ getElementMaterial()

local_ordinal_type katoptron::ElementsList::getElementMaterial ( const local_ordinal_type  e) const
inline

Return the material ID of the local element of ID e. Argument:

  • e: local ID of the element.

◆ getElementNode()

local_ordinal_type katoptron::ElementsList::getElementNode ( const local_ordinal_type  e,
local_ordinal_type  i 
) const
inline

Return the local ID of the ith node of the local element of ID e. Argument:

  • e: local ID of the element,
  • i: element local ID of the node.

◆ getElementNumber()

local_ordinal_type katoptron::ElementsList::getElementNumber ( void  ) const
inline

Return the number of local elements i.e. the number of elements owned by the calling process.

◆ getElementSize()

local_ordinal_type katoptron::ElementsList::getElementSize ( const local_ordinal_type  e) const
inline

Return the size of the local element of local ID e. Argument:

  • e: local ID of the element.

◆ getElementType()

local_ordinal_type katoptron::ElementsList::getElementType ( const local_ordinal_type  e) const
inline

Return the type of the local element of local ID e. Argument:

  • e: local ID of the element.

◆ isLocal()

local_ordinal_type katoptron::ElementsList::isLocal ( const local_ordinal_type  e) const
inline

Return whether local element of ID e is owned by this MPI process (i.e whether it is not a ghost element). Argument:

  • e: local ID of the element.

Member Data Documentation

◆ elements

Kokkos::View<int **, Kokkos::LayoutRight> katoptron::ElementsList::elements
private

◆ elements_material

local_ordinal_type katoptron::ElementsList::elements_material
private

◆ elements_nodes

local_ordinal_type katoptron::ElementsList::elements_nodes
private

◆ elements_number

local_ordinal_type katoptron::ElementsList::elements_number
private

◆ elements_owned

local_ordinal_type katoptron::ElementsList::elements_owned
private

◆ elements_size

local_ordinal_type katoptron::ElementsList::elements_size
private

◆ elements_type

local_ordinal_type katoptron::ElementsList::elements_type
private

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