The Kokkos object that holds thread-private data in the parallel operations of any Kokkos object. More...

#include <KokkosDatum.h>

Inheritance diagram for Moose::Kokkos::Datum:

Public Member Functions
KOKKOS_FUNCTION	Datum (const ContiguousElementID elem, const unsigned int side, const Assembly &assembly, const Array< System > &systems)
	Constructor. More...

KOKKOS_FUNCTION	Datum (const ContiguousElementID elem, const Assembly &assembly, const Array< System > &systems)
	Constructor for elemental data. More...

KOKKOS_FUNCTION const Assembly &	assembly () const
	Get the Kokkos assembly. More...

KOKKOS_FUNCTION const System &	system (unsigned int sys) const
	Get the Kokkos system. More...

KOKKOS_FUNCTION const ElementInfo &	elem () const
	Get the element information object. More...

KOKKOS_FUNCTION ContiguousSubdomainID	subdomain () const
	Get the contiguous subdomain ID. More...

KOKKOS_FUNCTION unsigned int	side () const
	Get the side index. More...

KOKKOS_FUNCTION unsigned int	n_qps () const
	Get the number of local quadrature points. More...

KOKKOS_FUNCTION dof_id_type	qpOffset () const
	Get the starting offset into the global quadrature point index. More...

KOKKOS_FUNCTION bool	hasNeighbor () const
	Get whether the current side has a neighbor. More...

KOKKOS_FUNCTION const Real33 &	J (const unsigned int qp)
	Get the inverse of Jacobian matrix \| dxi/dx deta/dx dzeta/dx \| \| dxi/dy deta/dy dzeta/dy \| \| dxi/dz deta/dz dzeta/dz \|. More...

KOKKOS_FUNCTION Real	JxW (const unsigned int qp)
	Get the transformed Jacobian weight. More...

KOKKOS_FUNCTION Real3	q_point (const unsigned int qp)
	Get the physical quadrature point coordinate. More...

KOKKOS_FUNCTION void	reinit ()
	Reset the reinit flag. More...

Protected Attributes
const Assembly &	_assembly
	Reference of the Kokkos assembly. More...

const Array< System > &	_systems
	Reference of the Kokkos systems. More...

const ElementInfo	_elem
	Current element information object. More...

const unsigned int	_side
	Current side index. More...

const ContiguousElementID	_neighbor
	Current contiguous element ID of neighbor. More...

const unsigned int	_n_qps
	Number of local quadrature points. More...

const dof_id_type	_qp_offset
	Starting offset into the global quadrature point index. More...

Private Member Functions
KOKKOS_FUNCTION void	reinitTransform (const unsigned int qp)
	Compute and cache the physical transformation data. More...

Private Attributes
bool	_transform_reinit = false
	Flag whether the physical transformation data was cached. More...


Real33	_J
	Cached physical transformation data. More...

Real	_JxW

Real3	_xyz

Detailed Description

The Kokkos object that holds thread-private data in the parallel operations of any Kokkos object.

Definition at line 25 of file KokkosDatum.h.

Constructor & Destructor Documentation

◆ Datum() [1/2]

KOKKOS_FUNCTION Moose::Kokkos::Datum::Datum	(	const ContiguousElementID	elem,
		const unsigned int	side,
		const Assembly &	assembly,
		const Array< System > &	systems
	)

inline

Constructor.

Parameters

elem	The contiguous element ID of the current thread
side	The side index of the current thread
assembly	The Kokkos assembly
systems	The Kokkos systems

Definition at line 36 of file KokkosDatum.h.

     : _assembly(assembly),
       _systems(systems),
       _elem(assembly.kokkosMesh().getElementInfo(elem)),
       _side(side),
       _neighbor(_side != libMesh::invalid_uint ? assembly.kokkosMesh().getNeighbor(_elem.id, side)
                                                : libMesh::DofObject::invalid_id),
       _n_qps(side == libMesh::invalid_uint ? assembly.getNumQps(_elem)
                                            : assembly.getNumFaceQps(_elem, side)),
       _qp_offset(side == libMesh::invalid_uint ? assembly.getQpOffset(_elem)
                                                : assembly.getQpFaceOffset(_elem, side))
   {
   }

◆ Datum() [2/2]

KOKKOS_FUNCTION Moose::Kokkos::Datum::Datum	(	const ContiguousElementID	elem,
		const Assembly &	assembly,
		const Array< System > &	systems
	)

inline

Constructor for elemental data.

Parameters

elem	The contiguous element ID of the current thread
assembly	The Kokkos assembly
systems	The Kokkos systems

Definition at line 59 of file KokkosDatum.h.

     : Datum(elem, libMesh::invalid_uint, assembly, systems)
   {
   }

Member Function Documentation

◆ assembly()

KOKKOS_FUNCTION const Assembly& Moose::Kokkos::Datum::assembly ( ) const

inline

Get the Kokkos assembly.

Returns: The Kokkos assembly

Definition at line 68 of file KokkosDatum.h.

Referenced by Moose::Kokkos::VariablePhiValue::operator()(), Moose::Kokkos::VariablePhiGradient::operator()(), Moose::Kokkos::VariableTestValue::operator()(), and Moose::Kokkos::VariableTestGradient::operator()().

68 { return _assembly; }

Moose::Kokkos::Datum::_assembly

const Assembly & _assembly

Reference of the Kokkos assembly.

Definition: KokkosDatum.h:153

◆ elem()

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

inline

Get the element information object.

Returns: The element information object

Definition at line 80 of file KokkosDatum.h.

Referenced by KokkosTimeDerivative< KokkosTimeDerivativeKernel >::computeJacobianInternal(), Moose::Kokkos::ResidualObject::computeJacobianInternal(), Moose::Kokkos::ResidualObject::computeResidualInternal(), Moose::Kokkos::VariablePhiValue::operator()(), Moose::Kokkos::VariablePhiGradient::operator()(), Moose::Kokkos::VariableTestValue::operator()(), Moose::Kokkos::VariableTestGradient::operator()(), Moose::Kokkos::VariableValue::operator()(), and Moose::Kokkos::VariableGradient::operator()().

80 { return _elem; }

Moose::Kokkos::Datum::_elem

const ElementInfo _elem

Current element information object.

Definition: KokkosDatum.h:161

◆ hasNeighbor()

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

inline

Get whether the current side has a neighbor.

Returns: Whether the current side has a neighbor

Definition at line 105 of file KokkosDatum.h.

105 { return _neighbor != libMesh::DofObject::invalid_id; }

libMesh::DofObject::invalid_id

static const dof_id_type invalid_id

Moose::Kokkos::Datum::_neighbor

const ContiguousElementID _neighbor

Current contiguous element ID of neighbor.

Definition: KokkosDatum.h:169

◆ J()

KOKKOS_FUNCTION const Real33& Moose::Kokkos::Datum::J ( const unsigned int qp )

inline

Parameters

qp	The local quadrature point index

Returns: The Jacobian matrix

Definition at line 115 of file KokkosDatum.h.

Referenced by Moose::Kokkos::VariablePhiGradient::operator()(), Moose::Kokkos::VariableTestGradient::operator()(), and Moose::Kokkos::VariableGradient::operator()().

   {
     reinitTransform(qp);
 
     return _J;
   }

◆ JxW()

KOKKOS_FUNCTION Real Moose::Kokkos::Datum::JxW ( const unsigned int qp )

inline

Get the transformed Jacobian weight.

Parameters

qp	The local quadrature point index

Returns: The transformed Jacobian weights

Definition at line 126 of file KokkosDatum.h.

Referenced by KokkosTimeDerivative< KokkosTimeDerivativeKernel >::computeJacobianInternal(), Moose::Kokkos::KernelValue< Derived >::computeJacobianInternal(), Moose::Kokkos::KernelGrad< Derived >::computeJacobianInternal(), Moose::Kokkos::Kernel< KokkosDiffusionKernel >::computeJacobianInternal(), Moose::Kokkos::IntegratedBC< KokkosNeumannBC >::computeJacobianInternal(), Moose::Kokkos::IntegratedBC< KokkosNeumannBC >::computeOffDiagJacobianInternal(), Moose::Kokkos::Kernel< KokkosDiffusionKernel >::computeOffDiagJacobianInternal(), Moose::Kokkos::TimeKernel< KokkosTimeDerivativeKernel >::computeResidualInternal(), Moose::Kokkos::KernelValue< Derived >::computeResidualInternal(), Moose::Kokkos::KernelGrad< Derived >::computeResidualInternal(), Moose::Kokkos::Kernel< KokkosDiffusionKernel >::computeResidualInternal(), and Moose::Kokkos::IntegratedBC< KokkosNeumannBC >::computeResidualInternal().

   {
     reinitTransform(qp);
 
     return _JxW;
   }

◆ n_qps()

KOKKOS_FUNCTION unsigned int Moose::Kokkos::Datum::n_qps ( ) const

inline

Get the number of local quadrature points.

Returns: The number of local quadrature points

Definition at line 95 of file KokkosDatum.h.

95 { return _n_qps; }

Moose::Kokkos::Datum::_n_qps

const unsigned int _n_qps

Number of local quadrature points.

Definition: KokkosDatum.h:173

◆ q_point()

KOKKOS_FUNCTION Real3 Moose::Kokkos::Datum::q_point ( const unsigned int qp )

inline

Get the physical quadrature point coordinate.

Parameters

qp	The local quadrature point index

Returns: The physical quadrature point coordinate

Definition at line 137 of file KokkosDatum.h.

   {
     reinitTransform(qp);
 
     return _xyz;
   }

◆ qpOffset()

KOKKOS_FUNCTION dof_id_type Moose::Kokkos::Datum::qpOffset ( ) const

inline

Get the starting offset into the global quadrature point index.

Returns: The starting offset

Definition at line 100 of file KokkosDatum.h.

Referenced by Moose::Kokkos::VariableValue::operator()(), and Moose::Kokkos::VariableGradient::operator()().

100 { return _qp_offset; }

Moose::Kokkos::Datum::_qp_offset

const dof_id_type _qp_offset

Starting offset into the global quadrature point index.

Definition: KokkosDatum.h:177

◆ reinit()

KOKKOS_FUNCTION void Moose::Kokkos::Datum::reinit ( )

inline

Reset the reinit flag.

Definition at line 147 of file KokkosDatum.h.

147 { _transform_reinit = false; }

Moose::Kokkos::Datum::_transform_reinit

bool _transform_reinit

Flag whether the physical transformation data was cached.

Definition: KokkosDatum.h:189

◆ reinitTransform()

KOKKOS_FUNCTION void Moose::Kokkos::Datum::reinitTransform ( const unsigned int qp )

inlineprivate

Compute and cache the physical transformation data.

Parameters

qp	The local quadrature point index

Definition at line 201 of file KokkosDatum.h.

Referenced by J(), JxW(), and q_point().

 {
   if (_transform_reinit)
     return;
 
   if (_side == libMesh::invalid_uint)
   {
     _J = _assembly.getJacobian(_elem, qp);
     _JxW = _assembly.getJxW(_elem, qp);
     _xyz = _assembly.getQPoint(_elem, qp);
   }
   else
     _assembly.computePhysicalMap(_elem, _side, qp, &_J, &_JxW, &_xyz);
 
   _transform_reinit = true;
 }

◆ side()

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

inline

Get the side index.

Returns: The side index

Definition at line 90 of file KokkosDatum.h.

Referenced by Moose::Kokkos::VariablePhiValue::operator()(), Moose::Kokkos::VariablePhiGradient::operator()(), Moose::Kokkos::VariableTestValue::operator()(), Moose::Kokkos::VariableTestGradient::operator()(), Moose::Kokkos::VariableValue::operator()(), and Moose::Kokkos::VariableGradient::operator()().

90 { return _side; }

Moose::Kokkos::Datum::_side

const unsigned int _side

Current side index.

Definition: KokkosDatum.h:165

◆ subdomain()

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

inline

Get the contiguous subdomain ID.

Returns: The contiguous subdomain ID

Definition at line 85 of file KokkosDatum.h.

85 { return _elem.subdomain; }

Moose::Kokkos::Datum::_elem

const ElementInfo _elem

Current element information object.

Definition: KokkosDatum.h:161

Moose::Kokkos::ElementInfo::subdomain

ContiguousSubdomainID subdomain

Contiguous subdomain ID.

Definition: KokkosMesh.h:48

◆ system()

KOKKOS_FUNCTION const System& Moose::Kokkos::Datum::system ( unsigned int sys ) const

inline

Get the Kokkos system.

Parameters

sys	The system number

Returns: The Kokkos system

Definition at line 74 of file KokkosDatum.h.

Referenced by Moose::Kokkos::VariableValue::operator()(), and Moose::Kokkos::VariableGradient::operator()().

74 { return _systems[sys]; }

Moose::Kokkos::Datum::_systems

const Array< System > & _systems

Reference of the Kokkos systems.

Definition: KokkosDatum.h:157

Member Data Documentation

◆ _assembly

const Assembly& Moose::Kokkos::Datum::_assembly

protected

Reference of the Kokkos assembly.

Definition at line 153 of file KokkosDatum.h.

Referenced by assembly(), and reinitTransform().

◆ _elem

const ElementInfo Moose::Kokkos::Datum::_elem

protected

Current element information object.

Definition at line 161 of file KokkosDatum.h.

Referenced by elem(), reinitTransform(), and subdomain().

◆ _J

Real33 Moose::Kokkos::Datum::_J

private

Cached physical transformation data.

Definition at line 194 of file KokkosDatum.h.

Referenced by J(), and reinitTransform().

◆ _JxW

Real Moose::Kokkos::Datum::_JxW

private

Definition at line 195 of file KokkosDatum.h.

Referenced by JxW(), and reinitTransform().

◆ _n_qps

const unsigned int Moose::Kokkos::Datum::_n_qps

protected

Number of local quadrature points.

Definition at line 173 of file KokkosDatum.h.

Referenced by n_qps().

◆ _neighbor

const ContiguousElementID Moose::Kokkos::Datum::_neighbor

protected

Current contiguous element ID of neighbor.

Definition at line 169 of file KokkosDatum.h.

Referenced by hasNeighbor().

◆ _qp_offset

const dof_id_type Moose::Kokkos::Datum::_qp_offset

protected

Starting offset into the global quadrature point index.

Definition at line 177 of file KokkosDatum.h.

Referenced by qpOffset().

◆ _side

const unsigned int Moose::Kokkos::Datum::_side

protected

Current side index.

Definition at line 165 of file KokkosDatum.h.

Referenced by reinitTransform(), and side().

◆ _systems

const Array<System>& Moose::Kokkos::Datum::_systems

protected

Reference of the Kokkos systems.

Definition at line 157 of file KokkosDatum.h.

Referenced by system().

◆ _transform_reinit

bool Moose::Kokkos::Datum::_transform_reinit = false

private

Flag whether the physical transformation data was cached.

Definition at line 189 of file KokkosDatum.h.

Referenced by reinit(), and reinitTransform().

◆ _xyz

Real3 Moose::Kokkos::Datum::_xyz

private

Definition at line 196 of file KokkosDatum.h.

Referenced by q_point(), and reinitTransform().

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

include/kokkos/base/KokkosDatum.h

Public Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Datum() [1/2]

◆ Datum() [2/2]

Member Function Documentation

◆ assembly()

◆ elem()

◆ hasNeighbor()

◆ J()

◆ JxW()

◆ n_qps()

◆ q_point()

◆ qpOffset()

◆ reinit()

◆ reinitTransform()

◆ side()

◆ subdomain()

◆ system()

Member Data Documentation

◆ _assembly

◆ _elem

◆ _J

◆ _JxW

◆ _n_qps

◆ _neighbor

◆ _qp_offset

◆ _side

◆ _systems

◆ _transform_reinit

◆ _xyz