Moose::Kokkos::VectorVariableValue Class Reference

#include <KokkosVariableValue.h>

Public Member Functions
	VectorVariableValue ()=default
	Default constructor.
	VectorVariableValue (Variable var, bool dof=false)
	Constructor.
	VectorVariableValue (const MooseVariableFieldBase &var, const TagName &tag=Moose::SOLUTION_TAG, bool dof=false)
	Constructor.
KOKKOS_FUNCTION	operator bool () const
	Get whether the variable was coupled.
KOKKOS_FUNCTION const Variable &	variable () const
	Get the Kokkos variable.
KOKKOS_FUNCTION Real3	operator() (AssemblyDatum &datum, unsigned int idx, unsigned int comp=0) const
	Get the current vector variable value.

Private Attributes
Variable	_var
	Coupled Kokkos variable.
bool	_dof = false
	Flag whether DOF values are requested.

Detailed Description

Definition at line 606 of file KokkosVariableValue.h.

Constructor & Destructor Documentation

VectorVariableValue() [1/3]

Moose::Kokkos::VectorVariableValue::VectorVariableValue ( )

default

Default constructor.

VectorVariableValue() [2/3]

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

inline

Constructor.

Parameters

var	The Kokkos variable
dof	Whether to get DOF values

Definition at line 618 of file KokkosVariableValue.h.

                                                      : _var(var), _dof(dof)
  {
    checkVariable(_var, true, "VectorVariableValue");
  }

VectorVariableValue() [3/3]

Moose::Kokkos::VectorVariableValue::VectorVariableValue ( const MooseVariableFieldBase &  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 628 of file KokkosVariableValue.h.

    : _var(var, tag), _dof(dof)
  {
    checkVariable(_var, true, "VectorVariableValue");
  }

Member Function Documentation

operator bool()

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

inline

Get whether the variable was coupled.

Returns

Whether the variable was coupled

Definition at line 640 of file KokkosVariableValue.h.

{ return _var.coupled(); }

operator()()

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

inline

Get the current vector variable value.

Parameters

datum	The AssemblyDatum object of the current thread
idx	The local quadrature point index or DOF index

Returns

The vector variable value

Definition at line 778 of file KokkosVariableValue.h.

{
  KOKKOS_ASSERT(_var.initialized());
 
  Real3 value = 0;
 
  if (_var.coupled())
  {
    auto & sys = datum.system(_var.sys(comp));
    auto var = _var.var(comp);
    auto tag = _var.tag();
 
    if (_dof)
    {
      auto dimension = datum.assembly().getDimension();
 
      if (datum.isNodal())
      {
        auto node = datum.node();
 
        for (unsigned int c = 0; c < dimension; ++c)
          value(c) = sys.getVectorDofValue(sys.getNodeLocalDofIndex(node, c, var), tag);
      }
      else
      {
        auto elem = datum.elem().id;
        auto offset = idx * dimension;
 
        for (unsigned int c = 0; c < dimension; ++c)
          value(c) = sys.getVectorDofValue(sys.getElemLocalDofIndex(elem, offset + c, var), tag);
      }
    }
    else
    {
      KOKKOS_ASSERT(!datum.isNodal());
 
      auto & elem = datum.elem();
      auto side = datum.side();
 
      if (side == libMesh::invalid_uint)
        value = sys.getVectorQpVectorValue(elem, datum.qpOffset() + idx, var, tag);
      else
        value = sys.getVectorQpVectorValueFace(elem, side, idx, var, tag);
    }
  }
  else
    value = _var.vectorValue(comp);
 
  return value;
}

variable()

KOKKOS_FUNCTION const Variable & Moose::Kokkos::VectorVariableValue::variable ( ) const

inline

Get the Kokkos variable.

Returns

The Kokkos variable

Definition at line 656 of file KokkosVariableValue.h.

{ return _var; }

Member Data Documentation

_dof

bool Moose::Kokkos::VectorVariableValue::_dof = false

private

Flag whether DOF values are requested.

Definition at line 666 of file KokkosVariableValue.h.

Referenced by operator()().

_var

Variable Moose::Kokkos::VectorVariableValue::_var

private

Coupled Kokkos variable.

Definition at line 662 of file KokkosVariableValue.h.

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

---

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

• include/kokkos/base/KokkosVariableValue.h