Moose::Kokkos::ResidualDatum Class Reference

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 for element and side data. More...
KOKKOS_FUNCTION	ResidualDatum (const ContiguousNodeID node, const Assembly &assembly, const Array< System > &systems, const Variable &ivar, const unsigned int jvar, const unsigned int comp=0)
	Constructor for node 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 ContiguousNodeID	node () const
	Get the contiguous node ID. 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 bool	isNodal () const
	Get whether the current datum is on a node. 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 = 1
	Number of local DOFs. More...
const unsigned int	_n_jdofs = 1
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 = libMesh::invalid_uint
	Current side index. More...
const ContiguousNodeID	_node = libMesh::DofObject::invalid_id
	Current contiguous node ID. More...
const ContiguousElementID	_neighbor = libMesh::DofObject::invalid_id
	Current contiguous element ID of neighbor. More...
const unsigned int	_n_qps = 1
	Number of local quadrature points. More...
const dof_id_type	_qp_offset = libMesh::DofObject::invalid_id
	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 245 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 for element and side data.

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 259 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 ContiguousNodeID  node, const Assembly &  assembly, const Array< System > &  systems, const Variable &  ivar, const unsigned int  jvar, const unsigned int  comp = 0  )

inline

Constructor for node 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 286 of file KokkosDatum.h.

    : Datum(node, 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))
  {
  }

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

{ return _assembly; }

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

{ return _elem; }

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 335 of file KokkosDatum.h.

{ return _ife; }

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 110 of file KokkosDatum.h.

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

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 340 of file KokkosDatum.h.

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

{ return _ife; }

isNodal()

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

inlineinherited

Get whether the current datum is on a node.

Returns

Whether the current datum is on a node

Definition at line 115 of file KokkosDatum.h.

Referenced by Moose::Kokkos::Datum::J(), Moose::Kokkos::Datum::JxW(), Moose::Kokkos::VariableValue::operator()(), and Moose::Kokkos::Datum::q_point().

{ return _node != libMesh::DofObject::invalid_id; }

ivar()

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

inline

Get the variable number.

Returns

The variable number

Definition at line 325 of file KokkosDatum.h.

{ return _ivar; }

J()

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

inlineinherited

Get the inverse of Jacobian matrix | dxi/dx deta/dx dzeta/dx | | dxi/dy deta/dy dzeta/dy | | dxi/dz deta/dz dzeta/dz |.

Parameters

qp	The local quadrature point index

Returns

The Jacobian matrix

Definition at line 125 of file KokkosDatum.h.

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

  {
    if (!isNodal())
      reinitTransform(qp);
    else
      _J.identity(_assembly.getDimension());

    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 345 of file KokkosDatum.h.

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

{ return _jfe; }

jvar()

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

inline

Get the coupled variable number.

Returns

The variable number

Definition at line 330 of file KokkosDatum.h.

Referenced by KokkosTimeDerivative::computeJacobianInternal(), Moose::Kokkos::ResidualObject::computeJacobianInternal(), Moose::Kokkos::IntegratedBC::computeOffDiagJacobianInternal(), and Moose::Kokkos::Kernel::computeOffDiagJacobianInternal().

{ return _jvar; }

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 139 of file KokkosDatum.h.

Referenced by KokkosTimeDerivative::computeJacobianInternal(), Moose::Kokkos::KernelValue::computeJacobianInternal(), Moose::Kokkos::KernelGrad::computeJacobianInternal(), Moose::Kokkos::IntegratedBC::computeJacobianInternal(), Moose::Kokkos::Kernel::computeJacobianInternal(), Moose::Kokkos::IntegratedBC::computeOffDiagJacobianInternal(), Moose::Kokkos::Kernel::computeOffDiagJacobianInternal(), Moose::Kokkos::TimeKernel::computeResidualInternal(), Moose::Kokkos::KernelValue::computeResidualInternal(), Moose::Kokkos::KernelGrad::computeResidualInternal(), Moose::Kokkos::IntegratedBC::computeResidualInternal(), and Moose::Kokkos::Kernel::computeResidualInternal().

  {
    if (!isNodal())
      reinitTransform(qp);
    else
      _JxW = 1;

    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 305 of file KokkosDatum.h.

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

{ return _n_idofs; }

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 310 of file KokkosDatum.h.

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

{ return _n_idofs; }

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 315 of file KokkosDatum.h.

Referenced by KokkosTimeDerivative::computeJacobianInternal(), Moose::Kokkos::KernelValue::computeJacobianInternal(), Moose::Kokkos::KernelGrad::computeJacobianInternal(), Moose::Kokkos::IntegratedBC::computeJacobianInternal(), Moose::Kokkos::Kernel::computeJacobianInternal(), Moose::Kokkos::ResidualObject::computeJacobianInternal(), Moose::Kokkos::IntegratedBC::computeOffDiagJacobianInternal(), and Moose::Kokkos::Kernel::computeOffDiagJacobianInternal().

{ return _n_jdofs; }

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

Referenced by KokkosTimeDerivative::computeJacobianInternal(), Moose::Kokkos::KernelValue::computeJacobianInternal(), Moose::Kokkos::KernelGrad::computeJacobianInternal(), Moose::Kokkos::IntegratedBC::computeJacobianInternal(), Moose::Kokkos::Kernel::computeJacobianInternal(), Moose::Kokkos::IntegratedBC::computeOffDiagJacobianInternal(), Moose::Kokkos::Kernel::computeOffDiagJacobianInternal(), Moose::Kokkos::TimeKernel::computeResidualInternal(), Moose::Kokkos::KernelValue::computeResidualInternal(), Moose::Kokkos::KernelGrad::computeResidualInternal(), Moose::Kokkos::IntegratedBC::computeResidualInternal(), Moose::Kokkos::Kernel::computeResidualInternal(), and Moose::Kokkos::Material::operator()().

{ return _n_qps; }

node()

KOKKOS_FUNCTION ContiguousNodeID Moose::Kokkos::Datum::node ( ) const

inlineinherited

Get the contiguous node ID.

Returns

The contiguous node ID

Definition at line 95 of file KokkosDatum.h.

Referenced by KokkosBoundNodalKernel< KokkosUpperBoundNodalKernel >::computeQpJacobian(), KokkosBoundNodalKernel< KokkosUpperBoundNodalKernel >::computeQpOffDiagJacobian(), KokkosBoundNodalKernel< KokkosUpperBoundNodalKernel >::computeQpResidual(), and Moose::Kokkos::VariableValue::operator()().

{ return _node; }

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 153 of file KokkosDatum.h.

  {
    if (!isNodal())
      reinitTransform(qp);
    else
      _xyz = _assembly.kokkosMesh().getNodePoint(_node);

    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 105 of file KokkosDatum.h.

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

{ return _qp_offset; }

reinit()

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

inlineinherited

Reset the reinit flag.

Definition at line 166 of file KokkosDatum.h.

Referenced by KokkosTimeDerivative::computeJacobianInternal(), Moose::Kokkos::KernelValue::computeJacobianInternal(), Moose::Kokkos::KernelGrad::computeJacobianInternal(), Moose::Kokkos::IntegratedBC::computeJacobianInternal(), Moose::Kokkos::Kernel::computeJacobianInternal(), Moose::Kokkos::IntegratedBC::computeOffDiagJacobianInternal(), Moose::Kokkos::Kernel::computeOffDiagJacobianInternal(), Moose::Kokkos::TimeKernel::computeResidualInternal(), Moose::Kokkos::KernelValue::computeResidualInternal(), Moose::Kokkos::KernelGrad::computeResidualInternal(), Moose::Kokkos::IntegratedBC::computeResidualInternal(), Moose::Kokkos::Kernel::computeResidualInternal(), and Moose::Kokkos::Material::operator()().

{ _transform_reinit = false; }

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

{ return _side; }

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.

{ return _elem.subdomain; }

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

{ return _systems[sys]; }

var()

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

inline

Get the variable number.

Returns

The variable number

Definition at line 320 of file KokkosDatum.h.

{ return _ivar; }

Member Data Documentation

_assembly

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

protectedinherited

Reference of the Kokkos assembly.

Definition at line 172 of file KokkosDatum.h.

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

_elem

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

protectedinherited

Current element information object.

Definition at line 180 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 359 of file KokkosDatum.h.

Referenced by fe(), and ife().

_ivar

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

protected

Variable numbers.

Definition at line 355 of file KokkosDatum.h.

Referenced by ivar(), and var().

_jfe

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

protected

Definition at line 359 of file KokkosDatum.h.

Referenced by jfe().

_jvar

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

protected

Definition at line 355 of file KokkosDatum.h.

Referenced by jvar().

_n_idofs

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

protected

Number of local DOFs.

Definition at line 363 of file KokkosDatum.h.

Referenced by n_dofs(), and n_idofs().

_n_jdofs

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

protected

Definition at line 363 of file KokkosDatum.h.

Referenced by n_jdofs().

_n_qps

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

protectedinherited

Number of local quadrature points.

Definition at line 196 of file KokkosDatum.h.

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

_neighbor

const ContiguousElementID Moose::Kokkos::Datum::_neighbor = libMesh::DofObject::invalid_id

protectedinherited

Current contiguous element ID of neighbor.

Definition at line 192 of file KokkosDatum.h.

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

_node

const ContiguousNodeID Moose::Kokkos::Datum::_node = libMesh::DofObject::invalid_id

protectedinherited

Current contiguous node ID.

Definition at line 188 of file KokkosDatum.h.

Referenced by Moose::Kokkos::Datum::isNodal(), Moose::Kokkos::Datum::node(), and Moose::Kokkos::Datum::q_point().

_qp_offset

const dof_id_type Moose::Kokkos::Datum::_qp_offset = libMesh::DofObject::invalid_id

protectedinherited

Starting offset into the global quadrature point index.

Definition at line 200 of file KokkosDatum.h.

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

_side

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

protectedinherited

Current side index.

Definition at line 184 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 176 of file KokkosDatum.h.

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

_tag

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

protected

Solution tag ID.

Definition at line 351 of file KokkosDatum.h.

---

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

• include/kokkos/base/KokkosDatum.h