KokkosFunctionDirichletBCTempl< is_ad > Class Template Reference

Imposes the essential boundary condition u = g(t, x), where g is a Kokkos function. More...

#include <KokkosFunctionDirichletBC.h>

Inheritance diagram for KokkosFunctionDirichletBCTempl< is_ad >:

Public Types
using	Base = std::conditional_t< is_ad, ADNodalBC, NodalBC >

Public Member Functions
	KokkosFunctionDirichletBCTempl (const InputParameters &parameters)
KOKKOS_FUNCTION Real	computeValue (const unsigned int qp, AssemblyDatum &datum) const
virtual bool	preset () const override
	Get whether the value is to be preset.
virtual void	presetSolution (TagID tag) override
	Dispatch solution vector preset.
template<typename Derived >
KOKKOS_FUNCTION void	operator() (PresetLoop, const ThreadID tid, const Derived &bc) const
	The preset function called by Kokkos.
template<typename Derived >
KOKKOS_FUNCTION auto	computeQpResidual (const unsigned int qp, AssemblyDatum &datum) const

Static Public Member Functions
static InputParameters	validParams ()

Protected Attributes
const Moose::Kokkos::Function	_func
	The function describing the Dirichlet condition.

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

Private Attributes
const bool	_preset
	Flag whether the value is to be preset.
TagID	_solution_tag
	Tag associated with the solution vector to be preset.

Detailed Description

template<bool is_ad>
class KokkosFunctionDirichletBCTempl< is_ad >

Imposes the essential boundary condition u = g(t, x), where g is a Kokkos function.

Definition at line 19 of file KokkosFunctionDirichletBC.h.

Member Typedef Documentation

Base

template<bool is_ad>

using Moose::Kokkos::DirichletBCBaseTempl< is_ad >::Base = std::conditional_t<is_ad, ADNodalBC, NodalBC>

inherited

Definition at line 62 of file KokkosDirichletBCBase.h.

real_type

template<bool is_ad>

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

privateinherited

Definition at line 24 of file KokkosDirichletBCBase.h.

Constructor & Destructor Documentation

KokkosFunctionDirichletBCTempl()

template<bool is_ad>

KokkosFunctionDirichletBCTempl< is_ad >::KokkosFunctionDirichletBCTempl

(

const InputParameters &

parameters

)

Member Function Documentation

computeQpResidual()

template<bool is_ad>

template<typename Derived >

KOKKOS_FUNCTION auto Moose::Kokkos::DirichletBCBaseTempl< is_ad >::computeQpResidual ( const unsigned int  qp, AssemblyDatum &  datum  ) const

inherited

Definition at line 105 of file KokkosDirichletBCBase.h.

{
  auto bc = static_cast<const Derived *>(this);
 
  return _u(datum, qp) - real_type(bc->computeValue(qp, datum));
}

computeValue()

template<bool is_ad>

KOKKOS_FUNCTION Real KokkosFunctionDirichletBCTempl< is_ad >::computeValue ( const unsigned int  qp, AssemblyDatum &  datum  ) const

inline

Definition at line 26 of file KokkosFunctionDirichletBC.h.

  {
    return _func.value(_t, datum.q_point(qp));
  }

operator()()

template<bool is_ad>

template<typename Derived >

KOKKOS_FUNCTION void Moose::Kokkos::DirichletBCBaseTempl< is_ad >::operator() ( PresetLoop  , const ThreadID  tid, const Derived &  bc  ) const

inherited

The preset function called by Kokkos.

Definition at line 88 of file KokkosDirichletBCBase.h.

{
  auto node = kokkosBoundaryNodeID(tid);
  auto & sys = kokkosSystem(_kokkos_var.sys());
  auto dof = sys.getNodeLocalDofIndex(node, 0, _kokkos_var.var());
 
  if (dof == libMesh::DofObject::invalid_id)
    return;
 
  AssemblyDatum datum(node, kokkosAssembly(), kokkosSystems(), _kokkos_var, _kokkos_var.var());
 
  sys.getVectorDofValue(dof, _solution_tag) = bc.computeValue(0, datum);
}

preset()

template<bool is_ad>

virtual bool Moose::Kokkos::DirichletBCBaseTempl< is_ad >::preset ( ) const

inlineoverridevirtualinherited

Get whether the value is to be preset.

Returns

Whether the value is to be preset

Definition at line 38 of file KokkosDirichletBCBase.h.

{ return _preset; }

presetSolution()

template<bool is_ad>

virtual void Moose::Kokkos::DirichletBCBaseTempl< is_ad >::presetSolution ( TagID  tag )

overridevirtualinherited

Dispatch solution vector preset.

Parameters

tag	The tag associated with the solution vector to be preset

validParams()

template<bool is_ad>

static InputParameters KokkosFunctionDirichletBCTempl< is_ad >::validParams ( )

static

Member Data Documentation

_func

template<bool is_ad>

const Moose::Kokkos::Function KokkosFunctionDirichletBCTempl< is_ad >::_func

protected

The function describing the Dirichlet condition.

Definition at line 33 of file KokkosFunctionDirichletBC.h.

Referenced by KokkosFunctionDirichletBCTempl< is_ad >::computeValue().

_preset

template<bool is_ad>

const bool Moose::Kokkos::DirichletBCBaseTempl< is_ad >::_preset

privateinherited

Flag whether the value is to be preset.

Definition at line 78 of file KokkosDirichletBCBase.h.

Referenced by Moose::Kokkos::DirichletBCBaseTempl< is_ad >::preset().

_solution_tag

template<bool is_ad>

TagID Moose::Kokkos::DirichletBCBaseTempl< is_ad >::_solution_tag

privateinherited

Tag associated with the solution vector to be preset.

Definition at line 82 of file KokkosDirichletBCBase.h.

---

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

• include/kokkos/bcs/KokkosFunctionDirichletBC.h