Moose::Kokkos::VariableValue Class Reference

The Kokkos wrapper classes for MOOSE-like variable value access. More...

#include <KokkosVariableValue.h>

Public Member Functions
	VariableValue (Variable var)
	Constructor. More...
	VariableValue (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 Real	operator() (Datum &datum, unsigned int qp, unsigned int comp=0) const
	Get the current variable value. More...

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

Detailed Description

The Kokkos wrapper classes for MOOSE-like variable value access.

Definition at line 120 of file KokkosVariableValue.h.

Constructor & Destructor Documentation

VariableValue() [1/2]

Moose::Kokkos::VariableValue::VariableValue ( Variable  var )

inline

Constructor.

Parameters

var	The Kokkos variable

Definition at line 127 of file KokkosVariableValue.h.

: _var(var) {}

VariableValue() [2/2]

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

inline

Constructor.

Parameters

var	The MOOSE variable
tag	The vector tag name

Definition at line 133 of file KokkosVariableValue.h.

    : _var(var, tag)
  {
  }

Member Function Documentation

operator bool()

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

inline

Get whether the variable was coupled.

Returns

Whether the variable was coupled

Definition at line 142 of file KokkosVariableValue.h.

{ return _var.coupled(); }

operator()()

KOKKOS_FUNCTION Real Moose::Kokkos::VariableValue::operator() ( Datum &  datum, unsigned int  qp, unsigned int  comp = 0  ) const

inline

Get the current variable value.

Parameters

datum	The Datum object of the current thread
qp	The local quadrature-point index
comp	The variable component

Returns

The variable value

Definition at line 151 of file KokkosVariableValue.h.

  {
    if (_var.coupled())
    {
      auto & elem = datum.elem();
      auto side = datum.side();
      auto qp_offset = datum.qpOffset();

      return side == libMesh::invalid_uint
                 ? datum.system(_var.sys(comp))
                       .getVectorQpValue(elem, qp_offset + qp, _var.var(comp), _var.tag())
                 : datum.system(_var.sys(comp))
                       .getVectorQpValueFace(elem, side, qp, _var.var(comp), _var.tag());
    }
    else
      return _var.value(comp);
  }

Member Data Documentation

_var

Variable Moose::Kokkos::VariableValue::_var

private

Coupled Kokkos variable.

Definition at line 173 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