ADArrayKernel.h

Go to the documentation of this file.

//* This file is part of the MOOSE framework
//* https://www.mooseframework.org
//*
//* 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 "MooseVariableInterface.h"
#include "ADFunctorInterface.h"

class ADArrayKernel : public KernelBase,
                      public MooseVariableInterface<RealEigenVector>,
                      public ADFunctorInterface
{
public:
  static InputParameters validParams();

  ADArrayKernel(const InputParameters & parameters);

  virtual void computeResidual() override;
  virtual void computeJacobian() override;
  virtual void computeOffDiagJacobian(unsigned int jvar) override;
  virtual void jacobianSetup() override;

  virtual const ArrayMooseVariable & variable() const override { return _var; }

protected:
  virtual void computeQpResidual(ADRealEigenVector & residual) = 0;

  virtual void initQpResidual() {}

  ArrayMooseVariable & _var;

  const ArrayVariableTestValue & _test;

  const ArrayVariableTestGradient & _grad_test;
  const MappedArrayVariablePhiGradient & _array_grad_test;

  const ArrayVariablePhiValue & _phi;

  const ArrayVariablePhiGradient & _grad_phi;

  const ADArrayVariableValue & _u;

  const ADArrayVariableGradient & _grad_u;

  const unsigned int _count;

  // Pre-allocated vector for storing the AD array residual of the kernel
  std::vector<ADReal> _local_ad_re;

private:
  ADRealEigenVector _work_vector;

  const Elem * _my_elem = nullptr;
};