Moose::Kokkos::VariableGradientTempl< is_ad > Class Template Reference

#include <KokkosVariableValue.h>

Public Member Functions
	VariableGradientTempl ()=default
	Default constructor. More...
	VariableGradientTempl (Variable var)
	Constructor. More...
	VariableGradientTempl (const MooseVariableFieldBase &var, const TagName &tag=Moose::SOLUTION_TAG)
	Constructor. More...
KOKKOS_FUNCTION	operator bool () const
	Get whether the variable was coupled. More...
KOKKOS_FUNCTION auto	operator() (Datum &datum, unsigned int qp, unsigned int comp=0) const
	Get the current variable gradient. More...
KOKKOS_FUNCTION const Variable &	variable () const
	Get the Kokkos variable. More...
	VariableGradientTempl (const std::vector< const MooseVariableFieldBase *> &vars, const TagName &tag=Moose::SOLUTION_TAG)
	Constructor. More...
	VariableGradientTempl (const std::vector< MooseVariableFieldBase *> &vars, const TagName &tag=Moose::SOLUTION_TAG)

Private Types
using	real3_type = std::conditional_t< is_ad, ADReal3, Real3 >

Private Attributes
Variable	_var
	Coupled Kokkos variable. More...
Array< Real >	_seed
	Derivative seed of each component for AD. More...
	VariableGradientTempl (const VariableGradientTempl< is_ad > &object)
	Copy constructor for parallel dispatch. More...
VariableGradientTempl< is_ad > &	operator= (const VariableGradientTempl< is_ad > &object)
	Copy assignment operator. More...
KOKKOS_FUNCTION auto	operator() (AssemblyDatum &datum, unsigned int qp, unsigned int comp=0) const
	Get the current variable gradient. More...
KOKKOS_FUNCTION auto	get (Datum &datum, unsigned int qp, unsigned int comp=0, Real seed=0) const
	Get the current variable gradient. More...

Detailed Description

template<bool is_ad>
class Moose::Kokkos::VariableGradientTempl< is_ad >

Definition at line 444 of file KokkosVariableValue.h.

Member Typedef Documentation

real3_type

template<bool is_ad>

using Moose::Kokkos::VariableGradientTempl< is_ad >::real3_type = std::conditional_t<is_ad, ADReal3, Real3>

private

Definition at line 446 of file KokkosVariableValue.h.

Constructor & Destructor Documentation

VariableGradientTempl() [1/6]

template<bool is_ad>

Moose::Kokkos::VariableGradientTempl< is_ad >::VariableGradientTempl ( )

default

Default constructor.

VariableGradientTempl() [2/6]

template<bool is_ad>

Moose::Kokkos::VariableGradientTempl< is_ad >::VariableGradientTempl ( Variable  var )

inline

Constructor.

Parameters

var	The Kokkos variable

Definition at line 457 of file KokkosVariableValue.h.

                                      : _var(var)
  {
    checkVariable(_var, false, is_ad ? "ADVariableGradient" : "VariableGradient");
  }

VariableGradientTempl() [3/6]

template<bool is_ad>

Moose::Kokkos::VariableGradientTempl< is_ad >::VariableGradientTempl ( const MooseVariableFieldBase &  var, const TagName &  tag = Moose::SOLUTION_TAG  )

inline

Constructor.

Parameters

var	The MOOSE variable
tag	The vector tag name

Definition at line 466 of file KokkosVariableValue.h.

    : _var(var, tag)
  {
    checkVariable(_var, false, is_ad ? "ADVariableGradient" : "VariableGradient");
  }

VariableGradientTempl() [4/6]

template<bool is_ad>

Moose::Kokkos::VariableGradientTempl< is_ad >::VariableGradientTempl ( const std::vector< const MooseVariableFieldBase *> &  vars, const TagName &  tag = Moose::SOLUTION_TAG  )

inline

Constructor.

Parameters

vars	The MOOSE variables
tag	The vector tag name

Definition at line 478 of file KokkosVariableValue.h.

    : _var(vars, tag)
  {
    checkVariable(_var, false, is_ad ? "ADVariableGradient" : "VariableGradient");
  }

VariableGradientTempl() [5/6]

template<bool is_ad>

Moose::Kokkos::VariableGradientTempl< is_ad >::VariableGradientTempl ( const std::vector< MooseVariableFieldBase *> &  vars, const TagName &  tag = Moose::SOLUTION_TAG  )

inline

Definition at line 484 of file KokkosVariableValue.h.

    : _var(vars, tag)
  {
    checkVariable(_var, false, is_ad ? "ADVariableGradient" : "VariableGradient");
  }

VariableGradientTempl() [6/6]

template<bool is_ad>

Moose::Kokkos::VariableGradientTempl< is_ad >::VariableGradientTempl

(

const VariableGradientTempl< is_ad > &

object

)

Copy constructor for parallel dispatch.

Definition at line 558 of file KokkosVariableValue.h.

  : _var(object._var), _seed(object._seed)
{
  if constexpr (is_ad)
    if (_var.coupled())
    {
      if (!_seed.isAlloc())
        _seed.create(_var.components());

      for (unsigned int comp = 0; comp < _var.components(); ++comp)
        _seed[comp] =
            _var.dot() ? _var.mooseVar(comp)->sys().duDotDu(_var.var(comp)) : (_var.old() ? 0 : 1);

      _seed.copyToDevice();
    }
}

Member Function Documentation

get()

template<bool is_ad>

KOKKOS_FUNCTION auto Moose::Kokkos::VariableGradientTempl< is_ad >::get ( Datum &  datum, unsigned int  qp, unsigned int  comp = 0, Real  seed = 0  ) const

private

Get the current variable gradient.

Parameters

datum	The Datum object of the current thread
qp	The local quadrature point index
comp	The variable component
seed	The derivative seed (only meaningful for AD)

Returns

The variable gradient

Definition at line 603 of file KokkosVariableValue.h.

{
  KOKKOS_ASSERT(_var.initialized());

  real3_type grad;

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

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

    if constexpr (is_ad)
      grad =
          side == libMesh::invalid_uint
              ? datum.system(_var.sys(comp))
                    .getVectorQpADGrad(
                        elem, datum.J(qp), datum.qpOffset(), qp, _var.var(comp), _var.tag(), seed)
              : datum.system(_var.sys(comp))
                    .getVectorQpADGradFace(
                        elem, side, datum.J(qp), qp, _var.var(comp), _var.tag(), seed);
    else
      grad =
          side == libMesh::invalid_uint
              ? datum.system(_var.sys(comp))
                    .getVectorQpGrad(elem, datum.qpOffset() + qp, _var.var(comp), _var.tag())
              : datum.system(_var.sys(comp))
                    .getVectorQpGradFace(elem, side, datum.J(qp), qp, _var.var(comp), _var.tag());
  }

  return grad;
}

operator bool()

template<bool is_ad>

KOKKOS_FUNCTION Moose::Kokkos::VariableGradientTempl< is_ad >::operator bool ( ) const

inline

Get whether the variable was coupled.

Returns

Whether the variable was coupled

Definition at line 505 of file KokkosVariableValue.h.

{ return _var.coupled(); }

operator()() [1/2]

template<bool is_ad>

KOKKOS_FUNCTION auto Moose::Kokkos::VariableGradientTempl< is_ad >::operator() ( Datum &  datum, unsigned int  qp, unsigned int  comp = 0  ) const

inline

Get the current variable gradient.

Parameters

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

Returns

The variable gradient

Definition at line 514 of file KokkosVariableValue.h.

  {
    return get(datum, qp, comp);
  }

operator()() [2/2]

template<bool is_ad>

KOKKOS_FUNCTION auto Moose::Kokkos::VariableGradientTempl< is_ad >::operator()	(	AssemblyDatum &	datum,
		unsigned int	qp,
		unsigned int	comp = 0
	)		const

Get the current variable gradient.

Parameters

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

Returns

The variable gradient

Definition at line 586 of file KokkosVariableValue.h.

{
  if constexpr (is_ad)
  {
    Real seed =
        datum.do_derivatives() && _var.coupled() && _var.sys(comp) == datum.sys() ? _seed[comp] : 0;

    return get(datum, qp, comp, seed);
  }
  else
    return get(datum, qp, comp);
}

operator=()

template<bool is_ad>

VariableGradientTempl< is_ad > & Moose::Kokkos::VariableGradientTempl< is_ad >::operator=

(

const VariableGradientTempl< is_ad > &

object

)

Copy assignment operator.

Definition at line 577 of file KokkosVariableValue.h.

{
  _var = object._var;

  return *this;
}

variable()

template<bool is_ad>

KOKKOS_FUNCTION const Variable& Moose::Kokkos::VariableGradientTempl< is_ad >::variable ( ) const

inline

Get the Kokkos variable.

Returns

The Kokkos variable

Definition at line 533 of file KokkosVariableValue.h.

{ return _var; }

Member Data Documentation

_seed

template<bool is_ad>

Array<Real> Moose::Kokkos::VariableGradientTempl< is_ad >::_seed

private

Derivative seed of each component for AD.

Definition at line 554 of file KokkosVariableValue.h.

Referenced by Moose::Kokkos::VariableGradientTempl< is_ad >::VariableGradientTempl().

_var

template<bool is_ad>

Variable Moose::Kokkos::VariableGradientTempl< is_ad >::_var

private

Coupled Kokkos variable.

Definition at line 550 of file KokkosVariableValue.h.

Referenced by Moose::Kokkos::VariableGradientTempl< is_ad >::operator bool(), Moose::Kokkos::VariableGradientTempl< is_ad >::variable(), and Moose::Kokkos::VariableGradientTempl< is_ad >::VariableGradientTempl().

---

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

• include/kokkos/base/KokkosVariableValue.h