ADRayKernel.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

// Local Includes
#include "IntegralRayKernelBase.h"

// MOOSE Includes
#include "MooseVariableInterface.h"
#include "TaggingInterface.h"

// Forward declarations
template <typename>
class ADRayKernelTempl;

using ADRayKernel = ADRayKernelTempl<Real>;
// Not implementing this until there is a use case and tests for it!
// using ADVectorRayKernel = ADRayKernelTempl<RealVectorValue>;

template <typename T>
class ADRayKernelTempl : public IntegralRayKernelBase,
                         public MooseVariableInterface<T>,
                         public TaggingInterface
{
public:
  ADRayKernelTempl(const InputParameters & params);

  static InputParameters validParams();

  MooseVariableField<T> & variable() { return _var; }

  void onSegment() override final;

protected:
  virtual ADReal computeQpResidual() = 0;

  virtual void precalculateResidual(){};

  MooseVariableField<T> & _var;

  const ADTemplateVariableTestValue<T> & _test;

  const ADTemplateVariableValue<T> & _u;

  const ADTemplateVariableGradient<T> & _grad_u;

  const ADTemplateVariablePhiValue<T> & _phi;

  unsigned int _i;

  unsigned int _j;

private:
  void computeJacobian();
  void computeResidual();

  std::vector<ADReal> _residuals;
};