Moose::Kokkos::FVDatum Class Reference

Device-side geometric context for finite volume kernels and boundary conditions. More...

#include <KokkosDatum.h>

Inheritance diagram for Moose::Kokkos::FVDatum:

Public Member Functions
KOKKOS_FUNCTION	FVDatum (ContiguousElementID elem, const unsigned int side, const Mesh &mesh)
	Constructor. More...
KOKKOS_FUNCTION Real3	faceCentroid () const
	Get the centroid of the current element side. More...
KOKKOS_FUNCTION Real3	faceNormal () const
	Get the outward unit normal of the current element side. More...
KOKKOS_FUNCTION Real	faceDCNMag () const
	Get the distance from the current element centroid to its neighbor centroid. More...
KOKKOS_FUNCTION Real	faceDCFMag () const
	Get the distance from the current element centroid to the current side centroid. More...
KOKKOS_FUNCTION Real	faceArea () const
	Get the coordinate-weighted area of the current element side. More...
KOKKOS_FUNCTION Real3	elementCentroid () const
	Get the current element centroid. More...
KOKKOS_FUNCTION Real	elementVolume () const
	Get the coordinate-weighted current element volume. More...
KOKKOS_FUNCTION const Mesh &	mesh () const
	Get the Kokkos mesh. More...
KOKKOS_FUNCTION const ElementInfo &	elem () const
	Get the element information object. More...
KOKKOS_FUNCTION ContiguousElementID	elemID () const
	Get the contiguous element ID. More...
KOKKOS_FUNCTION bool	hasNeighbor () const
	Get whether the current side has a neighbor. More...
KOKKOS_FUNCTION const ElementInfo &	neighbor () const
	Get the neighbor element information object. More...
KOKKOS_FUNCTION ContiguousElementID	neighborID () const
	Get the contiguous neighbor element ID. More...
KOKKOS_FUNCTION unsigned int	side () const
	Get the side index. More...
KOKKOS_FUNCTION bool	isSide () const
	Get whether the current datum is on a side. More...
KOKKOS_FUNCTION ContiguousSubdomainID	subdomain () const
	Get the contiguous subdomain ID. More...
KOKKOS_FUNCTION ContiguousSubdomainID	neighborSubdomain () const
	Get the contiguous neighbor subdomain ID. More...

Static Protected Member Functions
static KOKKOS_FUNCTION ElementInfo	neighborInfo (ContiguousElementID elem, const unsigned int side, const Mesh &mesh)
	Get the neighbor element information object for an element side. More...

Protected Attributes
const Mesh &	_mesh
	Reference to the Kokkos mesh. More...
const ElementInfo	_elem
	Current element information object. More...
const unsigned int	_side = libMesh::invalid_uint
	Current side index. More...
const ElementInfo	_neighbor
	Current neighbor element information object. More...

Detailed Description

Device-side geometric context for finite volume kernels and boundary conditions.

Definition at line 167 of file KokkosDatum.h.

Constructor & Destructor Documentation

FVDatum()

KOKKOS_FUNCTION Moose::Kokkos::FVDatum::FVDatum ( ContiguousElementID  elem, const unsigned int  side, const Mesh &  mesh  )

inline

Constructor.

Parameters

elem	The contiguous element ID
side	The element side index, or libMesh::invalid_uint for element-only data
mesh	The Kokkos mesh

Definition at line 235 of file KokkosDatum.h.

  : MeshDatum(elem, side, mesh)
{
}

Member Function Documentation

elem()

KOKKOS_FUNCTION const ElementInfo& Moose::Kokkos::MeshDatum::elem ( ) const

inlineinherited

Get the element information object.

Returns

The element information object

Definition at line 46 of file KokkosDatum.h.

Referenced by Moose::Kokkos::ResidualObject::accumulateTaggedElementalMatrix(), KokkosCopyValueAux::computeElementInternal(), KokkosTimeDerivative::computeJacobianInternal(), Moose::Kokkos::ResidualObject::computeJacobianInternal(), Moose::Kokkos::ADKernel::computeResidualInternal(), Moose::Kokkos::ADIntegratedBC::computeResidualInternal(), Moose::Kokkos::ResidualObject::computeResidualInternal(), Moose::Kokkos::VariableValueTempl< is_ad >::get(), Moose::Kokkos::VariableGradientTempl< is_ad >::get(), Moose::Kokkos::MeshDatum::neighborInfo(), Moose::Kokkos::VariablePhiValue::operator()(), Moose::Kokkos::VariablePhiGradient::operator()(), Moose::Kokkos::VariableTestValue::operator()(), Moose::Kokkos::VariableTestGradient::operator()(), and Moose::Kokkos::AuxKernel::setElementSolution().

{ return _elem; }

elementCentroid()

KOKKOS_FUNCTION Real3 Moose::Kokkos::FVDatum::elementCentroid ( ) const

inline

Get the current element centroid.

Precondition

The current element is locally owned.

Returns

The element centroid

Definition at line 225 of file KokkosDatum.h.

Referenced by KokkosLinearFVSource::computeRightHandSideContribution().

{ return _mesh.getElementCentroid(_elem.id); }

elementVolume()

KOKKOS_FUNCTION Real Moose::Kokkos::FVDatum::elementVolume ( ) const

inline

Get the coordinate-weighted current element volume.

Precondition

The current element is locally owned.

Returns

The element volume including the coordinate transformation factor

Definition at line 232 of file KokkosDatum.h.

Referenced by KokkosLinearFVSource::computeRightHandSideContribution().

{ return _mesh.getElementVolume(_elem.id); }

elemID()

KOKKOS_FUNCTION ContiguousElementID Moose::Kokkos::MeshDatum::elemID ( ) const

inlineinherited

Get the contiguous element ID.

Returns

The contiguous element ID

Definition at line 52 of file KokkosDatum.h.

Referenced by KokkosExtraIDIntegralVectorPostprocessor::execute(), Moose::Kokkos::LinearFVFluxKernel::hasBoundaryData(), and KokkosExtraIDIntegralVectorPostprocessor::reduce().

{ return _elem.id; }

faceArea()

KOKKOS_FUNCTION Real Moose::Kokkos::FVDatum::faceArea ( ) const

inline

Get the coordinate-weighted area of the current element side.

Precondition

This datum represents a valid side of a locally owned element.

Returns

The side area including the coordinate transformation factor

Definition at line 218 of file KokkosDatum.h.

Referenced by KokkosLinearFVAdvection::computeBoundaryMatrixContribution(), KokkosLinearFVDiffusion::computeBoundaryMatrixContribution(), KokkosLinearFVAdvection::computeBoundaryRightHandSideContribution(), KokkosLinearFVDiffusion::computeBoundaryRightHandSideContribution(), KokkosLinearFVAdvection::computeInternalMatrixContribution(), KokkosLinearFVAdvection::computeInternalNeighborMatrixContribution(), and KokkosLinearFVDiffusion::faceConductance().

{ return _mesh.getSideArea(_elem.id, _side); }

faceCentroid()

KOKKOS_FUNCTION Real3 Moose::Kokkos::FVDatum::faceCentroid ( ) const

inline

Get the centroid of the current element side.

Precondition

This datum represents a valid side of a locally owned element.

Returns

The side centroid

Definition at line 184 of file KokkosDatum.h.

Referenced by KokkosLinearFVFunctorNeumannBC::computeBoundaryNormalGradient(), KokkosLinearFVFunctorDirichletBC::computeBoundaryNormalGradient(), KokkosLinearFVFunctorNeumannBC::computeBoundaryValue(), KokkosLinearFVFunctorDirichletBC::computeBoundaryValue(), and KokkosLinearFVDiffusion::faceDiffusionCoefficient().

{ return _mesh.getSideCentroid(_elem.id, _side); }

faceDCFMag()

KOKKOS_FUNCTION Real Moose::Kokkos::FVDatum::faceDCFMag ( ) const

inline

Get the distance from the current element centroid to the current side centroid.

Precondition

This datum represents a valid side of a locally owned element.

Returns

The element-centroid to side-centroid distance

Definition at line 208 of file KokkosDatum.h.

Referenced by KokkosLinearFVFunctorDirichletBC::computeBoundaryNormalGradient(), and KokkosLinearFVFunctorNeumannBC::computeBoundaryValue().

  {
    return _mesh.getElementCentroidToSideCentroidDistance(_elem.id, _side);
  }

faceDCNMag()

KOKKOS_FUNCTION Real Moose::Kokkos::FVDatum::faceDCNMag ( ) const

inline

Get the distance from the current element centroid to its neighbor centroid.

Precondition

This datum represents a side of a locally owned element with a neighbor.

Returns

The element-centroid to neighbor-centroid distance

Definition at line 198 of file KokkosDatum.h.

Referenced by KokkosLinearFVDiffusion::faceConductance().

  {
    return _mesh.getElementCentroidToNeighborCentroidDistance(_elem.id, _side);
  }

faceNormal()

KOKKOS_FUNCTION Real3 Moose::Kokkos::FVDatum::faceNormal ( ) const

inline

Get the outward unit normal of the current element side.

Precondition

This datum represents a valid side of a locally owned element.

Returns

The side normal

Definition at line 191 of file KokkosDatum.h.

Referenced by KokkosLinearFVAdvection::normalFaceFlux().

{ return _mesh.getSideNormal(_elem.id, _side); }

hasNeighbor()

KOKKOS_FUNCTION bool Moose::Kokkos::MeshDatum::hasNeighbor ( ) const

inlineinherited

Get whether the current side has a neighbor.

Returns

Whether the current side has a neighbor

Definition at line 149 of file KokkosDatum.h.

Referenced by Moose::Kokkos::LinearFVFluxKernel::hasFaceNeighbor().

{
  return _neighbor.id != libMesh::DofObject::invalid_id;
}

isSide()

KOKKOS_FUNCTION bool Moose::Kokkos::MeshDatum::isSide ( ) const

inlineinherited

Get whether the current datum is on a side.

Returns

Whether the current datum is on a side

Definition at line 85 of file KokkosDatum.h.

Referenced by Moose::Kokkos::Datum::normals(), and Moose::Kokkos::Datum::reinitTransform().

{ return _side != libMesh::invalid_uint; }

mesh()

KOKKOS_FUNCTION const Mesh& Moose::Kokkos::MeshDatum::mesh ( ) const

inlineinherited

Get the Kokkos mesh.

Returns

The Kokkos mesh

Definition at line 40 of file KokkosDatum.h.

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

{ return _mesh; }

neighbor()

KOKKOS_FUNCTION const ElementInfo& Moose::Kokkos::MeshDatum::neighbor ( ) const

inlineinherited

Get the neighbor element information object.

Returns

The neighbor element information object. If there is no neighbor or if this datum is not meant to represent face data, then this will point to a default constructed ElementInfo whose data members represent invalid state (e.g. hold invalid_uint, invalid_id like values)

Definition at line 67 of file KokkosDatum.h.

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

{ return _neighbor; }

neighborID()

KOKKOS_FUNCTION ContiguousElementID Moose::Kokkos::MeshDatum::neighborID ( ) const

inlineinherited

Get the contiguous neighbor element ID.

Returns

The contiguous neighbor element ID or libMesh::DofObject::invalid_id

Definition at line 73 of file KokkosDatum.h.

Referenced by Moose::Kokkos::LinearFVFluxKernel::operator()().

{ return _neighbor.id; }

neighborInfo()

KOKKOS_FUNCTION ElementInfo Moose::Kokkos::MeshDatum::neighborInfo ( ContiguousElementID  elem, const unsigned int  side, const Mesh &  mesh  )

inlinestaticprotectedinherited

Get the neighbor element information object for an element side.

Parameters

elem	The contiguous element ID
side	The side index
mesh	The Kokkos mesh

Returns

The neighbor element information object, or a default ElementInfo (a default constructed ElementInfo's data members all represent invalid state) when elem is libMesh::DofObject::invalid_id, side is libMesh::invalid_uint, or the Kokkos mesh has no contiguous neighbor ID for the side. The latter includes exterior boundary sides with no libMesh neighbor and sides whose libMesh neighbor is libMesh::remote_elem. Off-process neighbors present as ghost elements have contiguous IDs and return their ElementInfo.

Definition at line 155 of file KokkosDatum.h.

{
  if (elem == libMesh::DofObject::invalid_id || side == libMesh::invalid_uint)
    return {};

  const auto neighbor = mesh.getNeighbor(elem, side);
  return neighbor == libMesh::DofObject::invalid_id ? ElementInfo{} : mesh.getElementInfo(neighbor);
}

neighborSubdomain()

KOKKOS_FUNCTION ContiguousSubdomainID Moose::Kokkos::MeshDatum::neighborSubdomain ( ) const

inlineinherited

Get the contiguous neighbor subdomain ID.

Returns

The contiguous neighbor subdomain ID

Definition at line 97 of file KokkosDatum.h.

Referenced by Moose::Kokkos::LinearFVFluxKernel::hasFaceNeighbor().

{ return _neighbor.subdomain; }

side()

KOKKOS_FUNCTION unsigned int Moose::Kokkos::MeshDatum::side ( ) const

inlineinherited

Get the side index.

Returns

The side index

Definition at line 79 of file KokkosDatum.h.

Referenced by Moose::Kokkos::VariableValueTempl< is_ad >::get(), Moose::Kokkos::VariableGradientTempl< is_ad >::get(), Moose::Kokkos::LinearFVFluxKernel::hasBoundaryData(), Moose::Kokkos::MeshDatum::neighborInfo(), Moose::Kokkos::VariablePhiValue::operator()(), Moose::Kokkos::VariablePhiGradient::operator()(), Moose::Kokkos::VariableTestValue::operator()(), and Moose::Kokkos::VariableTestGradient::operator()().

{ return _side; }

subdomain()

KOKKOS_FUNCTION ContiguousSubdomainID Moose::Kokkos::MeshDatum::subdomain ( ) const

inlineinherited

Get the contiguous subdomain ID.

Returns

The contiguous subdomain ID

Definition at line 91 of file KokkosDatum.h.

Referenced by KokkosExtraIDIntegralVectorPostprocessor::execute(), and KokkosExtraIDIntegralVectorPostprocessor::reduce().

{ return _elem.subdomain; }

Member Data Documentation

_elem

const ElementInfo Moose::Kokkos::MeshDatum::_elem

protectedinherited

Current element information object.

Definition at line 125 of file KokkosDatum.h.

Referenced by Moose::Kokkos::MeshDatum::elem(), elementCentroid(), elementVolume(), Moose::Kokkos::MeshDatum::elemID(), Moose::Kokkos::Datum::extraElemID(), faceArea(), faceCentroid(), faceDCFMag(), faceDCNMag(), faceNormal(), Moose::Kokkos::Datum::reinitTransform(), and Moose::Kokkos::MeshDatum::subdomain().

_mesh

const Mesh& Moose::Kokkos::MeshDatum::_mesh

protectedinherited

Reference to the Kokkos mesh.

Definition at line 120 of file KokkosDatum.h.

Referenced by elementCentroid(), elementVolume(), Moose::Kokkos::Datum::extraElemID(), faceArea(), faceCentroid(), faceDCFMag(), faceDCNMag(), faceNormal(), and Moose::Kokkos::MeshDatum::mesh().

_neighbor

const ElementInfo Moose::Kokkos::MeshDatum::_neighbor

protectedinherited

Current neighbor element information object.

Definition at line 135 of file KokkosDatum.h.

Referenced by Moose::Kokkos::MeshDatum::hasNeighbor(), Moose::Kokkos::MeshDatum::neighbor(), Moose::Kokkos::MeshDatum::neighborID(), and Moose::Kokkos::MeshDatum::neighborSubdomain().

_side

const unsigned int Moose::Kokkos::MeshDatum::_side = libMesh::invalid_uint

protectedinherited

Current side index.

Definition at line 130 of file KokkosDatum.h.

Referenced by faceArea(), faceCentroid(), faceDCFMag(), faceDCNMag(), faceNormal(), Moose::Kokkos::MeshDatum::isSide(), Moose::Kokkos::Datum::reinitTransform(), and Moose::Kokkos::MeshDatum::side().

---

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

• include/kokkos/base/KokkosDatum.h