Moose::Kokkos::VectorVariableGradient Class Reference

#include <KokkosVariableValue.h>

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

Private Attributes
Variable	_var
	Coupled Kokkos variable.

Detailed Description

Definition at line 669 of file KokkosVariableValue.h.

Constructor & Destructor Documentation

VectorVariableGradient() [1/3]

Moose::Kokkos::VectorVariableGradient::VectorVariableGradient ( )

default

Default constructor.

VectorVariableGradient() [2/3]

Moose::Kokkos::VectorVariableGradient::VectorVariableGradient ( Variable  var )

inline

Constructor.

Parameters

var	The Kokkos variable

Definition at line 680 of file KokkosVariableValue.h.

                                       : _var(var)
  {
    checkVariable(_var, true, "VectorVariableGradient");
  }

VectorVariableGradient() [3/3]

Moose::Kokkos::VectorVariableGradient::VectorVariableGradient ( const MooseVariableFieldBase &  var, const TagName &  tag = Moose::SOLUTION_TAG  )

inline

Constructor.

Parameters

var	The MOOSE variable
tag	The vector tag name

Definition at line 689 of file KokkosVariableValue.h.

    : _var(var, tag)
  {
    checkVariable(_var, true, "VectorVariableGradient");
  }

Member Function Documentation

operator bool()

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

inline

Get whether the variable was coupled.

Returns

Whether the variable was coupled

Definition at line 700 of file KokkosVariableValue.h.

{ return _var.coupled(); }

operator()()

KOKKOS_FUNCTION Real33 Moose::Kokkos::VectorVariableGradient::operator() ( AssemblyDatum &  datum, unsigned int  qp, unsigned int  comp = 0  ) const

inline

Get the current vector variable gradient.

Parameters

datum	The AssemblyDatum object of the current thread
qp	The local quadrature point index

Returns

The vector variable gradient

Definition at line 830 of file KokkosVariableValue.h.

{
  KOKKOS_ASSERT(_var.initialized());
 
  Real33 grad = 0;
 
  if (_var.coupled())
  {
    KOKKOS_ASSERT(!datum.isNodal());
 
    auto & elem = datum.elem();
    auto side = datum.side();
    auto & sys = datum.system(_var.sys(comp));
    auto var = _var.var(comp);
    auto tag = _var.tag();
 
    if (side == libMesh::invalid_uint)
      grad = sys.getVectorQpVectorGrad(elem, datum.qpOffset() + qp, var, tag);
    else
      grad = sys.getVectorQpVectorGradFace(elem, side, datum.J(qp), qp, var, tag);
  }
 
  return grad;
}

variable()

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

inline

Get the Kokkos variable.

Returns

The Kokkos variable

Definition at line 716 of file KokkosVariableValue.h.

{ return _var; }

Member Data Documentation

_var

Variable Moose::Kokkos::VectorVariableGradient::_var

private

Coupled Kokkos variable.

Definition at line 722 of file KokkosVariableValue.h.

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

---

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

• include/kokkos/base/KokkosVariableValue.h