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

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

#include <KokkosVariableValue.h>

Public Member Functions
	VariableValueTempl ()=default
	Default constructor. More...
	VariableValueTempl (Variable var, bool dof=false)
	Constructor. More...
	VariableValueTempl (const MooseVariableFieldBase &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 auto	operator() (Datum &datum, unsigned int idx, unsigned int comp=0) const
	Get the current variable value. More...
KOKKOS_FUNCTION const Variable &	variable () const
	Get the Kokkos variable. More...
	VariableValueTempl (const std::vector< const MooseVariableFieldBase *> &vars, const TagName &tag=Moose::SOLUTION_TAG, bool dof=false)
	Constructor. More...
	VariableValueTempl (const std::vector< MooseVariableFieldBase *> &vars, const TagName &tag=Moose::SOLUTION_TAG, bool dof=false)

Private Types
using	real_type = std::conditional_t< is_ad, ADReal, Real >

Private Attributes
Variable	_var
	Coupled Kokkos variable. More...
Array< Real >	_seed
	Derivative seed of each component for AD. More...
bool	_dof = false
	Flag whether DOF values are requested. More...
	VariableValueTempl (const VariableValueTempl< is_ad > &object)
	Copy constructor for parallel dispatch. More...
VariableValueTempl< is_ad > &	operator= (const VariableValueTempl< is_ad > &object)
	Copy assignment operator. More...
KOKKOS_FUNCTION auto	operator() (AssemblyDatum &datum, unsigned int idx, unsigned int comp=0) const
	Get the current variable value. More...
KOKKOS_FUNCTION auto	get (Datum &datum, unsigned int idx, unsigned int comp=0, Real seed=0) const
	Get the current variable value. More...

Detailed Description

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

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

Definition at line 217 of file KokkosVariableValue.h.

Member Typedef Documentation

real_type

template<bool is_ad>

using Moose::Kokkos::VariableValueTempl< is_ad >::real_type = std::conditional_t<is_ad, ADReal, Real>

private

Definition at line 219 of file KokkosVariableValue.h.

Constructor & Destructor Documentation

VariableValueTempl() [1/6]

template<bool is_ad>

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

default

Default constructor.

VariableValueTempl() [2/6]

template<bool is_ad>

Moose::Kokkos::VariableValueTempl< is_ad >::VariableValueTempl ( Variable  var, bool  dof = false  )

inline

Constructor.

Parameters

var	The Kokkos variable
dof	Whether to get DOF values

Definition at line 231 of file KokkosVariableValue.h.

                                                     : _var(var), _dof(dof)
  {
    checkVariable(_var, false, is_ad ? "ADVariableValue" : "VariableValue");
  }

VariableValueTempl() [3/6]

template<bool is_ad>

Moose::Kokkos::VariableValueTempl< is_ad >::VariableValueTempl ( 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 241 of file KokkosVariableValue.h.

    : _var(var, tag), _dof(dof)
  {
    checkVariable(_var, false, is_ad ? "ADVariableValue" : "VariableValue");
  }

VariableValueTempl() [4/6]

template<bool is_ad>

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

inline

Constructor.

Parameters

vars	The MOOSE variables
tag	The vector tag name
dof	Whether to get DOF values

Definition at line 255 of file KokkosVariableValue.h.

    : _var(vars, tag), _dof(dof)
  {
    checkVariable(_var, false, is_ad ? "ADVariableValue" : "VariableValue");
  }

VariableValueTempl() [5/6]

template<bool is_ad>

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

inline

Definition at line 262 of file KokkosVariableValue.h.

    : _var(vars, tag), _dof(dof)
  {
    checkVariable(_var, false, is_ad ? "ADVariableValue" : "VariableValue");
  }

VariableValueTempl() [6/6]

template<bool is_ad>

Moose::Kokkos::VariableValueTempl< is_ad >::VariableValueTempl

(

const VariableValueTempl< is_ad > &

object

)

Copy constructor for parallel dispatch.

Definition at line 341 of file KokkosVariableValue.h.

  : _var(object._var), _seed(object._seed), _dof(object._dof)
{
  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::VariableValueTempl< is_ad >::get ( Datum &  datum, unsigned int  idx, unsigned int  comp = 0, Real  seed = 0  ) const

private

Get the current variable value.

Parameters

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

Returns

The variable value

Definition at line 387 of file KokkosVariableValue.h.

{
  KOKKOS_ASSERT(_var.initialized());

  real_type value;

  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);
      }

      if constexpr (is_ad)
        value = sys.getVectorDofADValue(dof, tag, seed);
      else
        value = sys.getVectorDofValue(dof, tag);
    }
    else
    {
      auto & elem = datum.elem();
      auto side = datum.side();

      if constexpr (is_ad)
        value = side == libMesh::invalid_uint
                    ? sys.getVectorQpADValue(elem, datum.qpOffset(), idx, var, tag, seed)
                    : sys.getVectorQpADValueFace(elem, side, idx, var, tag, seed);
      else
        value = side == libMesh::invalid_uint
                    ? sys.getVectorQpValue(elem, datum.qpOffset() + idx, var, tag)
                    : sys.getVectorQpValueFace(elem, side, idx, var, tag);
    }
  }
  else
    value = _var.value(comp);

  return value;
}

operator bool()

template<bool is_ad>

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

inline

Get whether the variable was coupled.

Returns

Whether the variable was coupled

Definition at line 284 of file KokkosVariableValue.h.

{ return _var.coupled(); }

operator()() [1/2]

template<bool is_ad>

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

inline

Get the current variable value.

Parameters

datum	The Datum object of the current thread
idx	The local quadrature point or DOF index
comp	The variable component

Returns

The variable value

Definition at line 293 of file KokkosVariableValue.h.

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

operator()() [2/2]

template<bool is_ad>

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

Get the current variable value.

Parameters

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

Returns

The variable value

Definition at line 370 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, idx, comp, seed);
  }
  else
    return get(datum, idx, comp);
}

operator=()

template<bool is_ad>

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

(

const VariableValueTempl< is_ad > &

object

)

Copy assignment operator.

Definition at line 360 of file KokkosVariableValue.h.

{
  _var = object._var;
  _dof = object._dof;

  return *this;
}

variable()

template<bool is_ad>

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

inline

Get the Kokkos variable.

Returns

The Kokkos variable

Definition at line 312 of file KokkosVariableValue.h.

Referenced by KokkosExtraIDIntegralVectorPostprocessor::execute(), KokkosNodalMaxValueId::reduce(), KokkosNodalExtremeValue::reduce(), KokkosNodalSum::reduce(), and KokkosExtraIDIntegralVectorPostprocessor::reduce().

{ return _var; }

Member Data Documentation

_dof

template<bool is_ad>

bool Moose::Kokkos::VariableValueTempl< is_ad >::_dof = false

private

Flag whether DOF values are requested.

Definition at line 337 of file KokkosVariableValue.h.

_seed

template<bool is_ad>

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

private

Derivative seed of each component for AD.

Definition at line 333 of file KokkosVariableValue.h.

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

_var

template<bool is_ad>

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

private

Coupled Kokkos variable.

Definition at line 329 of file KokkosVariableValue.h.

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

---

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

• include/kokkos/base/KokkosVariableValue.h