DGKernelBase.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 "MooseArray.h"
#include "NeighborResidualObject.h"
#include "BlockRestrictable.h"
#include "BoundaryRestrictable.h"
#include "NeighborCoupleableMooseVariableDependencyIntermediateInterface.h"
#include "TwoMaterialPropertyInterface.h"
#include "ElementIDInterface.h"

#include "Assembly.h"

#define usingDGKernelBaseMembers                                                                   \
  usingNeighborCoupleableMembers;                                                                  \
  usingFunctionInterfaceMembers;                                                                   \
  usingBlockRestrictableMembers;                                                                   \
  usingTransientInterfaceMembers

class DGKernelBase : public NeighborResidualObject,
                     public BlockRestrictable,
                     public BoundaryRestrictable,
                     public NeighborCoupleableMooseVariableDependencyIntermediateInterface,
                     public TwoMaterialPropertyInterface,
                     public ElementIDInterface
{
public:
  static InputParameters validParams();

  DGKernelBase(const InputParameters & parameters);

  virtual void computeElemNeighResidual(Moose::DGResidualType type) = 0;

  virtual void computeResidual() override;

  virtual void computeElemNeighJacobian(Moose::DGJacobianType type) = 0;

  virtual void computeJacobian() override;

  virtual void computeOffDiagElemNeighJacobian(Moose::DGJacobianType type,
                                               const MooseVariableFEBase & jvar) = 0;

  virtual void computeOffDiagJacobian(unsigned int jvar) override;

  void prepareShapes(unsigned int var_num) override final;

protected:
  const Elem * const & _current_elem;

  const Real & _current_elem_volume;

  const Elem * const & _neighbor_elem;

  const Real & _neighbor_elem_volume;

  const unsigned int & _current_side;
  const Elem *& _current_side_elem;
  const Real & _current_side_volume;

  const Moose::CoordinateSystemType & _coord_sys;
  const MooseArray<Point> & _q_point;
  const QBase * const & _qrule;
  const MooseArray<Real> & _JxW;
  const MooseArray<Real> & _coord;
  const MooseArray<Point> & _normals;

  bool _has_save_in;
  std::vector<MooseVariableFEBase *> _save_in;
  std::vector<AuxVariableName> _save_in_strings;

  bool _has_diag_save_in;
  std::vector<MooseVariableFEBase *> _diag_save_in;
  std::vector<AuxVariableName> _diag_save_in_strings;

  const Real & getNeighborElemVolume() const { return _assembly.neighborVolume(); }

public:
  // boundary id used for internal edges (all DG kernels lives on this boundary id -- a made-up
  // number)
  static const BoundaryID InternalBndId;

protected:
  unsigned int _qp;

  unsigned int _i, _j;

  BoundaryID _boundary_id;

  static Threads::spin_mutex _resid_vars_mutex;
  static Threads::spin_mutex _jacoby_vars_mutex;

  bool excludeBoundary() const;

private:
  std::set<BoundaryID> _excluded_boundaries;

  friend class ADDGKernel;
};