Moose::Kokkos::VariableNodalValue Class Reference

#include <KokkosVariableValue.h>

Inheritance diagram for Moose::Kokkos::VariableNodalValue:

Public Member Functions
	VariableNodalValue (Array< System > &systems, Variable var)
	Constructor. More...
	VariableNodalValue (Array< System > &systems, const MooseVariableBase &var, const TagName &tag=Moose::SOLUTION_TAG)
	Constructor. More...
KOKKOS_FUNCTION	operator bool () const
	Get whether the variable was coupled. More...
KOKKOS_FUNCTION Real	operator() (ContiguousNodeID node, unsigned int comp=0) const
	Get the current variable nodal value. More...
KOKKOS_FUNCTION const Array< System > &	kokkosSystems () const
	Get the const reference of the Kokkos systems. More...
Array< System > &	kokkosSystems ()
	Get the writeable host reference of the Kokkos systems. More...
KOKKOS_FUNCTION const System &	kokkosSystem (unsigned int sys) const
	Get the const reference of a Kokkos system. More...
System &	kokkosSystem (unsigned int sys)
	Get the writeable reference of a Kokkos system. More...

Private Attributes
Variable	_var
	Coupled Kokkos variable. More...

Detailed Description

Definition at line 176 of file KokkosVariableValue.h.

Constructor & Destructor Documentation

VariableNodalValue() [1/2]

Moose::Kokkos::VariableNodalValue::VariableNodalValue ( Array< System > &  systems, Variable  var  )

inline

Constructor.

Parameters

systems	The Kokkos systems
var	The Kokkos variable

Definition at line 184 of file KokkosVariableValue.h.

: SystemHolder(systems), _var(var) {}

VariableNodalValue() [2/2]

Moose::Kokkos::VariableNodalValue::VariableNodalValue ( Array< System > &  systems, const MooseVariableBase &  var, const TagName &  tag = Moose::SOLUTION_TAG  )

inline

Constructor.

Parameters

systems	The Kokkos systems
var	The MOOSE variable
tag	The vector tag name

Definition at line 191 of file KokkosVariableValue.h.

    : SystemHolder(systems), _var(var, tag)
  {
  }

Member Function Documentation

kokkosSystem() [1/2]

KOKKOS_FUNCTION const System& Moose::Kokkos::SystemHolder::kokkosSystem ( unsigned int  sys ) const

inlineinherited

Get the const reference of a Kokkos system.

Parameters

sys	The system number

Returns

The const reference of the Kokkos system depending on the architecture this function is being called on

Definition at line 615 of file KokkosSystem.h.

Referenced by Moose::Kokkos::ResidualObject::accumulateTaggedElementalMatrix(), Moose::Kokkos::ResidualObject::accumulateTaggedElementalResidual(), Moose::Kokkos::ResidualObject::accumulateTaggedNodalMatrix(), Moose::Kokkos::ResidualObject::accumulateTaggedNodalResidual(), and operator()().

  {
    KOKKOS_IF_ON_HOST(return _systems_host[sys];)

    return _systems_device[sys];
  }

kokkosSystem() [2/2]

System& Moose::Kokkos::SystemHolder::kokkosSystem ( unsigned int  sys )

inlineinherited

Get the writeable reference of a Kokkos system.

Parameters

sys	The system number

Returns

The writeable host reference of the Kokkos system

Definition at line 626 of file KokkosSystem.h.

{ return _systems_host[sys]; }

kokkosSystems() [1/2]

KOKKOS_FUNCTION const Array<System>& Moose::Kokkos::SystemHolder::kokkosSystems ( ) const

inlineinherited

Get the const reference of the Kokkos systems.

Returns

The const reference of the Kokkos systems depending on the architecture this function is being called on

Definition at line 598 of file KokkosSystem.h.

  {
    KOKKOS_IF_ON_HOST(return _systems_host;)

    return _systems_device;
  }

kokkosSystems() [2/2]

Array<System>& Moose::Kokkos::SystemHolder::kokkosSystems ( )

inlineinherited

Get the writeable host reference of the Kokkos systems.

Returns

The writeable host reference of the Kokkos systems

Definition at line 608 of file KokkosSystem.h.

{ return _systems_host; }

operator bool()

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

inline

Get whether the variable was coupled.

Returns

Whether the variable was coupled

Definition at line 202 of file KokkosVariableValue.h.

{ return _var.coupled(); }

operator()()

KOKKOS_FUNCTION Real Moose::Kokkos::VariableNodalValue::operator() ( ContiguousNodeID  node, unsigned int  comp = 0  ) const

inline

Get the current variable nodal value.

Parameters

node	The current contiguous node ID
comp	The variable component

Returns

The variable nodal value

Definition at line 210 of file KokkosVariableValue.h.

  {
    if (_var.coupled())
    {
      auto dof = kokkosSystem(_var.sys(comp)).getNodeLocalDofIndex(node, _var.var(comp));

      return kokkosSystem(_var.sys(comp)).getVectorDofValue(dof, _var.tag());
    }
    else
      return _var.value(comp);
  }

Member Data Documentation

_var

Variable Moose::Kokkos::VariableNodalValue::_var

private

Coupled Kokkos variable.

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