ADKernelValue.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 "ADKernel.h"

template <typename>
class ADKernelValueTempl;

using ADKernelValue = ADKernelValueTempl<Real>;
using ADVectorKernelValue = ADKernelValueTempl<RealVectorValue>;

template <typename T>
class ADKernelValueTempl : public ADKernelTempl<T>
{
public:
  static InputParameters validParams();

  ADKernelValueTempl(const InputParameters & parameters);

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

protected:
  void computeResidualsForJacobian() override;

  virtual typename OutputTools<typename Moose::ADType<T>::type>::OutputValue
  precomputeQpResidual() = 0;

  virtual ADReal computeQpResidual() override final;

  virtual Real precomputeQpJacobian()
  {
    mooseError("precomputeQpJacobian should not be called for AD methods");
  }

  using ADKernelTempl<T>::_assembly;
  using ADKernelTempl<T>::_var;
  using ADKernelTempl<T>::precalculateResidual;
  using ADKernelTempl<T>::_grad_test;
  using ADKernelTempl<T>::_use_displaced_mesh;
  using ADKernelTempl<T>::_qp;
  using ADKernelTempl<T>::_qrule;
  using ADKernelTempl<T>::_ad_JxW;
  using ADKernelTempl<T>::_ad_coord;
  using ADKernelTempl<T>::_i;
  using ADKernelTempl<T>::_JxW;
  using ADKernelTempl<T>::_coord;
  using ADKernelTempl<T>::_regular_grad_test;
  using ADKernelTempl<T>::accumulateTaggedLocalResidual;
  using ADKernelTempl<T>::_has_save_in;
  using ADKernelTempl<T>::_save_in;
  using ADKernelTempl<T>::_sys;
  using ADKernelTempl<T>::_j;
  using ADKernelTempl<T>::accumulateTaggedLocalMatrix;
  using ADKernelTempl<T>::prepareVectorTag;
  using ADKernelTempl<T>::_local_re;
  using ADKernelTempl<T>::_local_ke;
  using ADKernelTempl<T>::_diag_save_in;
  using ADKernelTempl<T>::_has_diag_save_in;
  using ADKernelTempl<T>::prepareMatrixTag;
  using ADKernelTempl<T>::_test;
  using ADKernelTempl<T>::_residuals;
  using ADKernelTempl<T>::getVar;
};