Moose::Kokkos::VariableValue Class Reference

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

#include <KokkosVariableValue.h>

Public Member Functions
	VariableValue ()=default
	Default constructor. More...
	VariableValue (Variable var, bool dof=false)
	Constructor. More...
	VariableValue (const MooseVariableBase &var, const TagName &tag=Moose::SOLUTION_TAG, bool dof=false)
	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...
bool	_dof = false
	Flag whether DOF values are requested. 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/3]

Moose::Kokkos::VariableValue::VariableValue ( )

default

Default constructor.

VariableValue() [2/3]

Moose::Kokkos::VariableValue::VariableValue ( Variable  var, bool  dof = false  )

inline

Constructor.

Parameters

var	The Kokkos variable
dof	Whether to get DOF values

Definition at line 132 of file KokkosVariableValue.h.

: _var(var), _dof(dof) {}

VariableValue() [3/3]

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

inline

Constructor.

Parameters

var	The MOOSE variable
tag	The vector tag name
dof	Whether to get DOF values

Definition at line 139 of file KokkosVariableValue.h.

    : _var(var, tag), _dof(dof)
  {
  }

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 150 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 218 of file KokkosVariableValue.h.

{
  KOKKOS_ASSERT(_var.initialized());

  if (_var.coupled())
  {
    auto & sys = datum.system(_var.sys(comp));
    auto var = _var.var(comp);
    auto tag = _var.tag();

    if (_dof)
    {
      unsigned int dof;

      if (datum.isNodal())
      {
        auto node = datum.node();
        dof = sys.getNodeLocalDofIndex(node, 0, var);
      }
      else
      {
        auto elem = datum.elem().id;
        dof = sys.getElemLocalDofIndex(elem, idx, var);
      }

      return sys.getVectorDofValue(dof, tag);
    }
    else
    {
      auto & elem = datum.elem();
      auto side = datum.side();
      auto offset = datum.qpOffset();

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

Member Data Documentation

_dof

bool Moose::Kokkos::VariableValue::_dof = false

private

Flag whether DOF values are requested.

Definition at line 169 of file KokkosVariableValue.h.

Referenced by operator()().

_var

Variable Moose::Kokkos::VariableValue::_var

private

Coupled Kokkos variable.

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