KernelBase.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
 
#include "MooseObject.h"
#include "BlockRestrictable.h"
#include "SetupInterface.h"
#include "CoupleableMooseVariableDependencyIntermediateInterface.h"
#include "FunctionInterface.h"
#include "UserObjectInterface.h"
#include "TransientInterface.h"
#include "PostprocessorInterface.h"
#include "VectorPostprocessorInterface.h"
#include "MaterialPropertyInterface.h"
#include "RandomInterface.h"
#include "GeometricSearchInterface.h"
#include "Restartable.h"
#include "MeshChangedInterface.h"
#include "TaggingInterface.h"
#include "ElementIDInterface.h"
 
class MooseMesh;
class SubProblem;
class KernelBase;
class Assembly;
template <typename>
class MooseVariableFE;
typedef MooseVariableFE<Real> MooseVariable;
typedef MooseVariableFE<VectorValue<Real>> VectorMooseVariable;
 
template <>
InputParameters validParams<KernelBase>();
 
class KernelBase : public MooseObject,
                   public BlockRestrictable,
                   public SetupInterface,
                   public CoupleableMooseVariableDependencyIntermediateInterface,
                   public FunctionInterface,
                   public UserObjectInterface,
                   public TransientInterface,
                   public PostprocessorInterface,
                   public VectorPostprocessorInterface,
                   public MaterialPropertyInterface,
                   public RandomInterface,
                   protected GeometricSearchInterface,
                   public Restartable,
                   public MeshChangedInterface,
                   public TaggingInterface,
                   public ElementIDInterface
{
public:
  static InputParameters validParams();
 
  KernelBase(const InputParameters & parameters);
 
  virtual ~KernelBase();
 
  virtual void computeResidual() = 0;
 
  virtual void computeJacobian() = 0;
 
  virtual void computeOffDiagJacobian(MooseVariableFEBase & jvar) = 0;
 
  virtual void computeADOffDiagJacobian()
  {
    mooseError("The computeADOffDiagJacobian method should only be called on ADKernel objects");
  }
 
  virtual void computeOffDiagJacobianScalar(unsigned int jvar) = 0;
 
  virtual void computeNonlocalJacobian() {}
 
  virtual void computeNonlocalOffDiagJacobian(unsigned int /* jvar */) {}
 
  virtual MooseVariableFEBase & variable() = 0;
 
  SubProblem & subProblem() { return _subproblem; }
 
protected:
  virtual void precalculateResidual() {}
  virtual void precalculateJacobian() {}
  virtual void precalculateOffDiagJacobian(unsigned int /* jvar */) {}
 
protected:
  SubProblem & _subproblem;
 
  FEProblemBase & _fe_problem;
 
  SystemBase & _sys;
 
  THREAD_ID _tid;
 
  Assembly & _assembly;
 
  MooseMesh & _mesh;
 
  const Elem * const & _current_elem;
 
  const Real & _current_elem_volume;
 
  unsigned int _qp;
 
  const MooseArray<Point> & _q_point;
 
  const QBase * const & _qrule;
 
  const MooseArray<Real> & _JxW;
 
  const MooseArray<Real> & _coord;
 
  unsigned int _i;
 
  unsigned int _j;
 
  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;
 
  std::vector<unsigned int> _displacements;
};