https://mooseframework.inl.gov
KokkosCoupledForce.h
Go to the documentation of this file.
1 //* This file is part of the MOOSE framework
2 //* https://www.mooseframework.org
3 //*
4 //* All rights reserved, see COPYRIGHT for full restrictions
5 //* https://github.com/idaholab/moose/blob/master/COPYRIGHT
6 //*
7 //* Licensed under LGPL 2.1, please see LICENSE for details
8 //* https://www.gnu.org/licenses/lgpl-2.1.html
9 
10 #pragma once
11 
12 #include "KokkosKernel.h"
13 
18 class KokkosCoupledForce final : public Moose::Kokkos::Kernel<KokkosCoupledForce>
19 {
20 public:
22 
24 
25  KOKKOS_FUNCTION Real computeQpResidual(const unsigned int i,
26  const unsigned int qp,
27  ResidualDatum & datum) const;
28 
29 private:
31  const unsigned int _v_var;
35  const Real _coef;
36 };
37 
38 KOKKOS_FUNCTION inline Real
40  const unsigned int qp,
41  ResidualDatum & datum) const
42 {
43  return -_coef * _v(datum, qp) * _test(datum, i, qp);
44 }
const unsigned int _v_var
Coupled variable number.
const InputParameters & parameters() const
Get the parameters of the object.
Definition: MooseBase.h:131
KokkosCoupledForce(const InputParameters &parameters)
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
KOKKOS_FUNCTION Real computeQpResidual(const unsigned int i, const unsigned int qp, ResidualDatum &datum) const
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
The Kokkos wrapper classes for MOOSE-like variable value access.
The base class for a user to derive their own Kokkos kernels.
Definition: KokkosKernel.h:53
const Moose::Kokkos::VariableValue _v
Coupled variable.
static InputParameters validParams()
The Kokkos object that holds thread-private data in the parallel operations of Kokkos residual object...
Definition: KokkosDatum.h:222
Implements a source term proportional to the value of a coupled variable.
const VariableTestValue _test
Current test function.
Definition: KokkosKernel.h:151
const Real _coef
Multiplier for the coupled force term.