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

#include <KokkosDatum.h>

Inheritance diagram for Moose::Kokkos::ResidualDatum:

Public Member Functions
KOKKOS_FUNCTION	ResidualDatum (const ContiguousElementID elem, const unsigned int side, const Assembly &assembly, const Array< System > &systems, const Variable &ivar, const unsigned int jvar, const unsigned int comp=0)
	Constructor. More...

KOKKOS_FUNCTION	ResidualDatum (const ContiguousElementID elem, const Assembly &assembly, const Array< System > &systems, const Variable &ivar, const unsigned int jvar, const unsigned int comp=0)
	Constructor for elemental data. More...

KOKKOS_FUNCTION unsigned int	n_dofs () const
	Get the number of local DOFs. More...

KOKKOS_FUNCTION unsigned int	n_idofs () const
	Get the number of local DOFs. More...

KOKKOS_FUNCTION unsigned int	n_jdofs () const
	Get the number of local DOFs for the coupled variable. More...

KOKKOS_FUNCTION unsigned int	var () const
	Get the variable number. More...

KOKKOS_FUNCTION unsigned int	ivar () const
	Get the variable number. More...

KOKKOS_FUNCTION unsigned int	jvar () const
	Get the coupled variable number. More...

KOKKOS_FUNCTION unsigned int	fe () const
	Get the variable FE type ID. More...

KOKKOS_FUNCTION unsigned int	ife () const
	Get the variable FE type ID. More...

KOKKOS_FUNCTION unsigned int	jfe () const
	Get the coupled variable FE type ID. 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 TagID	_tag
	Solution tag ID. More...

const unsigned int	_ivar
	Variable numbers. More...

const unsigned int	_jvar

const unsigned int	_ife
	FE type IDs of variables. More...

const unsigned int	_jfe

const unsigned int	_n_idofs
	Number of local DOFs. More...

const unsigned int	_n_jdofs

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...

Detailed Description

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

Definition at line 222 of file KokkosDatum.h.

Constructor & Destructor Documentation

◆ ResidualDatum() [1/2]

KOKKOS_FUNCTION Moose::Kokkos::ResidualDatum::ResidualDatum	(	const ContiguousElementID	elem,
		const unsigned int	side,
		const Assembly &	assembly,
		const Array< System > &	systems,
		const Variable &	ivar,
		const unsigned int	jvar,
		const unsigned int	comp = `0`
	)

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
ivar	The Kokkos variable
jvar	The coupled variable number
comp	The variable component

Definition at line 236 of file KokkosDatum.h.

     : Datum(elem, side, assembly, systems),
       _tag(ivar.tag()),
       _ivar(ivar.var(comp)),
       _jvar(jvar),
       _ife(systems[ivar.sys(comp)].getFETypeID(_ivar)),
       _jfe(systems[ivar.sys(comp)].getFETypeID(_jvar)),
       _n_idofs(assembly.getNumDofs(_elem.type, _ife)),
       _n_jdofs(assembly.getNumDofs(_elem.type, _jfe))
   {
   }

◆ ResidualDatum() [2/2]

KOKKOS_FUNCTION Moose::Kokkos::ResidualDatum::ResidualDatum	(	const ContiguousElementID	elem,
		const Assembly &	assembly,
		const Array< System > &	systems,
		const Variable &	ivar,
		const unsigned int	jvar,
		const unsigned int	comp = `0`
	)

inline

Constructor for elemental data.

Parameters

elem	The contiguous element ID of the current thread
assembly	The Kokkos assembly
systems	The Kokkos systems
ivar	The Kokkos variable
jvar	The coupled variable number
comp	The variable component

Definition at line 263 of file KokkosDatum.h.

     : ResidualDatum(elem, libMesh::invalid_uint, assembly, systems, ivar, jvar, comp)
   {
   }

Member Function Documentation

◆ assembly()

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

inlineinherited

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

inlineinherited

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

◆ fe()

KOKKOS_FUNCTION unsigned int Moose::Kokkos::ResidualDatum::fe ( ) const

inline

Get the variable FE type ID.

Returns: The variable FE type ID

Definition at line 307 of file KokkosDatum.h.

307 { return _ife; }

Moose::Kokkos::ResidualDatum::_ife

const unsigned int _ife

FE type IDs of variables.

Definition: KokkosDatum.h:331

◆ hasNeighbor()

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

inlineinherited

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

◆ ife()

KOKKOS_FUNCTION unsigned int Moose::Kokkos::ResidualDatum::ife ( ) const

inline

Get the variable FE type ID.

Returns: The variable FE type ID

Definition at line 312 of file KokkosDatum.h.

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

312 { return _ife; }

Moose::Kokkos::ResidualDatum::_ife

const unsigned int _ife

FE type IDs of variables.

Definition: KokkosDatum.h:331

◆ ivar()

KOKKOS_FUNCTION unsigned int Moose::Kokkos::ResidualDatum::ivar ( ) const

inline

Get the variable number.

Returns: The variable number

Definition at line 297 of file KokkosDatum.h.

297 { return _ivar; }

Moose::Kokkos::ResidualDatum::_ivar

const unsigned int _ivar

Variable numbers.

Definition: KokkosDatum.h:327

◆ J()

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

inlineinherited

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

◆ jfe()

KOKKOS_FUNCTION unsigned int Moose::Kokkos::ResidualDatum::jfe ( ) const

inline

Get the coupled variable FE type ID.

Returns: The variable FE type ID

Definition at line 317 of file KokkosDatum.h.

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

317 { return _jfe; }

Moose::Kokkos::ResidualDatum::_jfe

const unsigned int _jfe

Definition: KokkosDatum.h:331

◆ jvar()

KOKKOS_FUNCTION unsigned int Moose::Kokkos::ResidualDatum::jvar ( ) const

inline

Get the coupled variable number.

Returns: The variable number

Definition at line 302 of file KokkosDatum.h.

Referenced by KokkosTimeDerivative< KokkosTimeDerivativeKernel >::computeJacobianInternal(), Moose::Kokkos::ResidualObject::computeJacobianInternal(), Moose::Kokkos::Kernel< KokkosDiffusionKernel >::computeOffDiagJacobianInternal(), and Moose::Kokkos::IntegratedBC< KokkosNeumannBC >::computeOffDiagJacobianInternal().

302 { return _jvar; }

Moose::Kokkos::ResidualDatum::_jvar

const unsigned int _jvar

Definition: KokkosDatum.h:327

◆ JxW()

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

inlineinherited

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::IntegratedBC< KokkosNeumannBC >::computeResidualInternal(), and Moose::Kokkos::Kernel< KokkosDiffusionKernel >::computeResidualInternal().

   {
     reinitTransform(qp);
 
     return _JxW;
   }

◆ n_dofs()

KOKKOS_FUNCTION unsigned int Moose::Kokkos::ResidualDatum::n_dofs ( ) const

inline

Get the number of local DOFs.

Returns: The number of local DOFs

Definition at line 277 of file KokkosDatum.h.

Referenced by Moose::Kokkos::ResidualObject::computeResidualInternal().

277 { return _n_idofs; }

Moose::Kokkos::ResidualDatum::_n_idofs

const unsigned int _n_idofs

Number of local DOFs.

Definition: KokkosDatum.h:335

◆ n_idofs()

KOKKOS_FUNCTION unsigned int Moose::Kokkos::ResidualDatum::n_idofs ( ) const

inline

Get the number of local DOFs.

Returns: The number of local DOFs

Definition at line 282 of file KokkosDatum.h.

Referenced by KokkosTimeDerivative< KokkosTimeDerivativeKernel >::computeJacobianInternal(), and Moose::Kokkos::ResidualObject::computeJacobianInternal().

282 { return _n_idofs; }

Moose::Kokkos::ResidualDatum::_n_idofs

const unsigned int _n_idofs

Number of local DOFs.

Definition: KokkosDatum.h:335

◆ n_jdofs()

KOKKOS_FUNCTION unsigned int Moose::Kokkos::ResidualDatum::n_jdofs ( ) const

inline

Get the number of local DOFs for the coupled variable.

Returns: The number of local DOFs

Definition at line 287 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::ResidualObject::computeJacobianInternal(), Moose::Kokkos::Kernel< KokkosDiffusionKernel >::computeOffDiagJacobianInternal(), and Moose::Kokkos::IntegratedBC< KokkosNeumannBC >::computeOffDiagJacobianInternal().

287 { return _n_jdofs; }

Moose::Kokkos::ResidualDatum::_n_jdofs

const unsigned int _n_jdofs

Definition: KokkosDatum.h:335

◆ n_qps()

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

inlineinherited

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 )

inlineinherited

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

inlineinherited

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 ( )

inlineinherited

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

◆ side()

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

inlineinherited

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

inlineinherited

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

inlineinherited

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

◆ var()

KOKKOS_FUNCTION unsigned int Moose::Kokkos::ResidualDatum::var ( ) const

inline

Get the variable number.

Returns: The variable number

Definition at line 292 of file KokkosDatum.h.

292 { return _ivar; }

Moose::Kokkos::ResidualDatum::_ivar

const unsigned int _ivar

Variable numbers.

Definition: KokkosDatum.h:327

Member Data Documentation

◆ _assembly

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

protectedinherited

Reference of the Kokkos assembly.

Definition at line 153 of file KokkosDatum.h.

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

◆ _elem

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

protectedinherited

Current element information object.

Definition at line 161 of file KokkosDatum.h.

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

◆ _ife

const unsigned int Moose::Kokkos::ResidualDatum::_ife

protected

FE type IDs of variables.

Definition at line 331 of file KokkosDatum.h.

Referenced by fe(), and ife().

◆ _ivar

const unsigned int Moose::Kokkos::ResidualDatum::_ivar

protected

Variable numbers.

Definition at line 327 of file KokkosDatum.h.

Referenced by ivar(), and var().

◆ _jfe

const unsigned int Moose::Kokkos::ResidualDatum::_jfe

protected

Definition at line 331 of file KokkosDatum.h.

Referenced by jfe().

◆ _jvar

const unsigned int Moose::Kokkos::ResidualDatum::_jvar

protected

Definition at line 327 of file KokkosDatum.h.

Referenced by jvar().

◆ _n_idofs

const unsigned int Moose::Kokkos::ResidualDatum::_n_idofs

protected

Number of local DOFs.

Definition at line 335 of file KokkosDatum.h.

Referenced by n_dofs(), and n_idofs().

◆ _n_jdofs

const unsigned int Moose::Kokkos::ResidualDatum::_n_jdofs

protected

Definition at line 335 of file KokkosDatum.h.

Referenced by n_jdofs().

◆ _n_qps

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

protectedinherited

Number of local quadrature points.

Definition at line 173 of file KokkosDatum.h.

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

◆ _neighbor

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

protectedinherited

Current contiguous element ID of neighbor.

Definition at line 169 of file KokkosDatum.h.

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

◆ _qp_offset

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

protectedinherited

Starting offset into the global quadrature point index.

Definition at line 177 of file KokkosDatum.h.

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

◆ _side

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

protectedinherited

Current side index.

Definition at line 165 of file KokkosDatum.h.

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

◆ _systems

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

protectedinherited

Reference of the Kokkos systems.

Definition at line 157 of file KokkosDatum.h.

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

◆ _tag

const TagID Moose::Kokkos::ResidualDatum::_tag

protected

Solution tag ID.

Definition at line 323 of file KokkosDatum.h.

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

include/kokkos/base/KokkosDatum.h

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ResidualDatum() [1/2]

◆ ResidualDatum() [2/2]

Member Function Documentation

◆ assembly()

◆ elem()

◆ fe()

◆ hasNeighbor()

◆ ife()

◆ ivar()

◆ J()

◆ jfe()

◆ jvar()

◆ JxW()

◆ n_dofs()

◆ n_idofs()

◆ n_jdofs()

◆ n_qps()

◆ q_point()

◆ qpOffset()

◆ reinit()

◆ side()

◆ subdomain()

◆ system()

◆ var()

Member Data Documentation

◆ _assembly

◆ _elem

◆ _ife

◆ _ivar

◆ _jfe

◆ _jvar

◆ _n_idofs

◆ _n_jdofs

◆ _n_qps

◆ _neighbor

◆ _qp_offset

◆ _side

◆ _systems

◆ _tag