Moose::Kokkos::VariableGradient Class Reference

#include <KokkosVariableValue.h>

Public Member Functions
	VariableGradient ()=default
	Default constructor. More...
	VariableGradient (Variable var)
	Constructor. More...
	VariableGradient (const MooseVariableBase &var, const TagName &tag=Moose::SOLUTION_TAG)
	Constructor. More...
KOKKOS_FUNCTION	operator bool () const
	Get whether the variable was coupled. More...
KOKKOS_FUNCTION Real3	operator() (Datum &datum, unsigned int idx, unsigned int comp=0) const
	Get the current variable gradient. More...

Private Attributes
Variable	_var
	Coupled Kokkos variable. More...

Detailed Description

Definition at line 172 of file KokkosVariableValue.h.

Constructor & Destructor Documentation

VariableGradient() [1/3]

Moose::Kokkos::VariableGradient::VariableGradient ( )

default

Default constructor.

VariableGradient() [2/3]

Moose::Kokkos::VariableGradient::VariableGradient ( Variable  var )

inline

Constructor.

Parameters

var	The Kokkos variable

Definition at line 183 of file KokkosVariableValue.h.

: _var(var) {}

VariableGradient() [3/3]

Moose::Kokkos::VariableGradient::VariableGradient ( const MooseVariableBase &  var, const TagName &  tag = Moose::SOLUTION_TAG  )

inline

Constructor.

Parameters

var	The MOOSE variable
tag	The vector tag name

Definition at line 189 of file KokkosVariableValue.h.

    : _var(var, tag)
  {
  }

Member Function Documentation

operator bool()

KOKKOS_FUNCTION Moose::Kokkos::VariableGradient::operator bool ( ) const

inline

Get whether the variable was coupled.

Returns

Whether the variable was coupled

Definition at line 198 of file KokkosVariableValue.h.

{ return _var.coupled(); }

operator()()

KOKKOS_FUNCTION Real3 Moose::Kokkos::VariableGradient::operator() ( Datum &  datum, unsigned int  idx, unsigned int  comp = 0  ) const

inline

Get the current variable gradient.

Parameters

datum	The Datum object of the current thread
idx	The local quadrature point or DOF index
comp	The variable component

Returns

The variable gradient

Definition at line 260 of file KokkosVariableValue.h.

{
  KOKKOS_ASSERT(_var.initialized());

  if (_var.coupled())
  {
    KOKKOS_ASSERT(!datum.isNodal());

    auto & elem = datum.elem();
    auto side = datum.side();
    auto offset = datum.qpOffset();

    return side == libMesh::invalid_uint
               ? datum.system(_var.sys(comp))
                     .getVectorQpGrad(elem, offset + qp, _var.var(comp), _var.tag())
               : datum.system(_var.sys(comp))
                     .getVectorQpGradFace(elem, side, datum.J(qp), qp, _var.var(comp), _var.tag());
  }
  else
    return Real3(0);
}

Member Data Documentation

_var

Variable Moose::Kokkos::VariableGradient::_var

private

Coupled Kokkos variable.

Definition at line 213 of file KokkosVariableValue.h.

Referenced by operator bool(), and operator()().

---

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

• include/kokkos/base/KokkosVariableValue.h