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

// MOOSE includes
#include "DiracKernelInfo.h"
#include "ResidualObject.h"
#include "CoupleableMooseVariableDependencyIntermediateInterface.h"
#include "MaterialPropertyInterface.h"
#include "GeometricSearchInterface.h"
#include "MooseVariableField.h"
#include "MooseVariableInterface.h"
#include "BlockRestrictable.h"

class DiracKernelBase : public ResidualObject,
                        public CoupleableMooseVariableDependencyIntermediateInterface,
                        public MaterialPropertyInterface,
                        protected GeometricSearchInterface,
                        public BlockRestrictable
{
public:
  static InputParameters validParams();

  DiracKernelBase(const InputParameters & parameters);

  virtual Real computeQpOffDiagJacobian(unsigned int jvar);

  virtual void computeOffDiagJacobian(unsigned int jvar) override = 0;

  virtual void addPoints() = 0;

  bool hasPointsOnElem(const Elem * elem);

  bool isActiveAtPoint(const Elem * elem, const Point & p);

  void clearPoints();

  void clearPointsCaches();

  virtual void meshChanged() override { clearPointsCaches(); };

protected:
  void addPoint(const Elem * elem, Point p, unsigned id = libMesh::invalid_uint);

  const Elem * addPoint(Point p, unsigned id = libMesh::invalid_uint);

  unsigned currentPointCachedID();

  const Elem * const & _current_elem;

  const Moose::CoordinateSystemType & _coord_sys;

  DiracKernelInfo & _dirac_kernel_info;

  DiracKernelInfo _local_dirac_kernel_info;

  Point _current_point;

  unsigned int _qp;
  const MooseArray<Point> & _q_point;
  const MooseArray<Point> & _physical_point;
  const QBase * const & _qrule;
  const MooseArray<Real> & _JxW;

  unsigned int _i, _j;

  const bool _drop_duplicate_points;

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

  const bool _allow_moving_sources;

  typedef std::map<unsigned, std::pair<const Elem *, Point>> point_cache_t;
  point_cache_t _point_cache;

  typedef std::map<const Elem *, std::vector<std::pair<Point, unsigned>>> reverse_cache_t;
  reverse_cache_t _reverse_point_cache;

private:
  void updateCaches(const Elem * old_elem, const Elem * new_elem, Point p, unsigned id);

  const Elem * addPointWithValidId(Point p, unsigned id);
};