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

// MOOSE includes
#include "DiracKernelInfo.h"
#include "MooseVariableInterface.h"
#include "DiracKernelBase.h"

// forward declarations
template <typename>
class DiracKernelTempl;

using DiracKernel = DiracKernelTempl<Real>;
using VectorDiracKernel = DiracKernelTempl<RealVectorValue>;

template <typename T>
class DiracKernelTempl : public DiracKernelBase, public MooseVariableInterface<T>
{
public:
  static InputParameters validParams();

  DiracKernelTempl(const InputParameters & parameters);

  virtual void computeResidual() override;

  virtual void computeJacobian() override;

  virtual Real computeQpOffDiagJacobian(unsigned int jvar) override;

  virtual void computeOffDiagJacobian(unsigned int jvar) override;

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

  virtual void addPoints() override = 0;

protected:
  virtual Real computeQpResidual() = 0;

  virtual Real computeQpJacobian();

  MooseVariableField<T> & _var;

  // shape functions

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

  // test functions

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

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

  const bool _drop_duplicate_points;

  // @{ Point-not-found behavior
  enum class PointNotFoundBehavior
  {
    ERROR,
    WARNING,
    IGNORE
  };
  const PointNotFoundBehavior _point_not_found_behavior;
  // @}
};