RayKernel.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 RayKernelTempl;

using RayKernel = RayKernelTempl<Real>;
// Not implementing this until there is a use case and tests for it!
// using VectorRayKernel = RayKernelTempl<RealVectorValue>;

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

  static InputParameters validParams();

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

  void onSegment() override final;

protected:
  virtual Real computeQpResidual() = 0;
  virtual Real computeQpJacobian() { return 0; }
  virtual Real computeQpOffDiagJacobian(const unsigned int /* jvar_num */) { return 0; }

  virtual void precalculateResidual(){};
  virtual void precalculateJacobian(){};
  virtual void precalculateOffDiagJacobian(unsigned int /* jvar_num */){};

  MooseVariableFE<T> & _var;

  const typename OutputTools<T>::VariableValue & _u;

  const typename OutputTools<T>::VariableGradient & _grad_u;

  const typename OutputTools<T>::VariableTestValue & _test;

  const typename OutputTools<T>::VariableTestGradient & _grad_test;

  const typename OutputTools<T>::VariablePhiValue & _phi;

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

  unsigned int _i;

  unsigned int _j;

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

extern template class RayKernelTempl<Real>;