ADKernel.h

Go to the documentation of this file.

//* This file is part of the MOOSE framework
//* https://mooseframework.inl.gov
//*
//* All rights reserved, see COPYRIGHT for full restrictions
//* https://github.com/idaholab/moose/blob/master/COPYRIGHT
//*
//* Licensed under LGPL 2.1, please see LICENSE for details
//* https://www.gnu.org/licenses/lgpl-2.1.html

#pragma once

#include "KernelBase.h"
#include "ADFunctorInterface.h"
#include "MooseVariableInterface.h"

// forward declarations
template <typename>
class ADKernelTempl;

using ADKernel = ADKernelTempl<Real>;
using ADVectorKernel = ADKernelTempl<RealVectorValue>;

template <typename T>
class ADKernelTempl : public KernelBase, public MooseVariableInterface<T>, public ADFunctorInterface
{
public:
  static InputParameters validParams();

  ADKernelTempl(const InputParameters & parameters);

  void jacobianSetup() override;

  const MooseVariableFE<T> & variable() const override { return _var; }

protected:
  void computeJacobian() override;
  void computeResidualAndJacobian() override;
  void computeOffDiagJacobian(unsigned int) override;
  void computeOffDiagJacobianScalar(unsigned int jvar) override;

  virtual const std::vector<dof_id_type> & dofIndices() const { return _var.dofIndices(); }

protected:
  // See KernelBase base for documentation of these overridden methods
  void computeResidual() override;

  virtual void computeResidualsForJacobian();

  virtual ADReal computeQpResidual() = 0;

  virtual Real computeQpJacobian() { return 0; }

  virtual Real computeQpOffDiagJacobian(unsigned int /*jvar*/) { return 0; }

  MooseVariableFE<T> & _var;

  const ADTemplateVariableTestValue<T> & _test;

  const ADTemplateVariableTestGradient<T> & _grad_test;

  // gradient of the test function without possible displacement derivatives
  const typename OutputTools<T>::VariableTestGradient & _regular_grad_test;

  const ADTemplateVariableValue<T> & _u;

  const ADTemplateVariableGradient<T> & _grad_u;

  const MooseArray<ADReal> & _ad_JxW;

  const MooseArray<ADReal> & _ad_coord;

  const MooseArray<ADPoint> & _ad_q_point;

  const ADTemplateVariablePhiValue<T> & _phi;

  ADReal _r;
  std::vector<Real> _residuals_nonad;
  std::vector<ADReal> _residuals;

  const ADTemplateVariablePhiGradient<T> & _grad_phi;

  const typename OutputTools<T>::VariablePhiGradient & _regular_grad_phi;

private:
  void computeADJacobian();

  const Elem * _my_elem;
};