InterfaceKernelBase.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 "BoundaryRestrictable.h"
#include "NeighborCoupleableMooseVariableDependencyIntermediateInterface.h"
#include "TwoMaterialPropertyInterface.h"
#include "ElementIDInterface.h"

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

  InterfaceKernelBase(const InputParameters & parameters);

  virtual const MooseVariableFEBase & neighborVariable() const = 0;

  virtual void computeElementOffDiagJacobian(unsigned int jvar) = 0;

  virtual void computeNeighborOffDiagJacobian(unsigned int jvar) = 0;

  void prepareShapes(unsigned int var_num) override final;

protected:
  virtual Real computeQpJacobian(Moose::DGJacobianType /*type*/) { return 0; }

  virtual Real computeQpOffDiagJacobian(Moose::DGJacobianType /*type*/, unsigned int /*jvar*/)
  {
    return 0;
  }

  const Real & getNeighborElemVolume();

  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 * const & _current_side_elem;

  const Real & _current_side_volume;

  const Moose::CoordinateSystemType & _coord_sys;

  unsigned int _qp;

  const MooseArray<Point> & _q_point;

  const QBase * const & _qrule;

  const MooseArray<Real> & _JxW;

  const MooseArray<Real> & _coord;

  unsigned int _i, _j;

  MultiMooseEnum _save_in_var_side;

  std::vector<AuxVariableName> _save_in_strings;

  bool _has_primary_residuals_saved_in;

  std::vector<MooseVariableFEBase *> _primary_save_in_residual_variables;

  bool _has_secondary_residuals_saved_in;

  std::vector<MooseVariableFEBase *> _secondary_save_in_residual_variables;

  MultiMooseEnum _diag_save_in_var_side;

  std::vector<AuxVariableName> _diag_save_in_strings;

  bool _has_primary_jacobians_saved_in;

  std::vector<MooseVariableFEBase *> _primary_save_in_jacobian_variables;

  bool _has_secondary_jacobians_saved_in;

  std::vector<MooseVariableFEBase *> _secondary_save_in_jacobian_variables;

  static Threads::spin_mutex _resid_vars_mutex;

  static Threads::spin_mutex _jacoby_vars_mutex;
};