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

#include "Kernel.h"

class KernelScalarBase : public Kernel
{
public:
  static InputParameters validParams();

  KernelScalarBase(const InputParameters & parameters);

  const MooseVariableScalar & scalarVariable() const
  {
    mooseAssert(_kappa_var_ptr, "kappa pointer should have been set in the constructor");
    return *_kappa_var_ptr;
  }

  virtual void computeResidual() override;
  virtual void computeJacobian() override;
  virtual void computeOffDiagJacobian(unsigned int jvar_num) override;
  void computeOffDiagJacobianScalar(unsigned int svar_num) override;

protected:
  virtual void precalculateOffDiagJacobianScalar(unsigned int /* svar_num */) {}

  virtual void computeScalarResidual();

  virtual Real computeScalarQpResidual();

  virtual void computeScalarJacobian();

  virtual Real computeScalarQpJacobian() { return 0; }

  virtual void computeScalarOffDiagJacobian(const unsigned int jvar_num);

  virtual Real computeScalarQpOffDiagJacobian(const unsigned int /*jvar_num*/) { return 0; }

  virtual void computeOffDiagJacobianScalarLocal(const unsigned int svar_num);

  virtual void computeScalarOffDiagJacobianScalar(const unsigned int svar_num);

  virtual Real computeScalarQpOffDiagJacobianScalar(const unsigned int /*svar_num*/) { return 0; }

  virtual void initScalarQpResidual() {}

  virtual void initScalarQpJacobian(const unsigned int /*svar_num*/) {}

  virtual void initScalarQpOffDiagJacobian(const MooseVariableFEBase &) {}

  const bool _use_scalar;

  const bool _compute_scalar_residuals;

  const bool _compute_field_residuals;

  const MooseVariableScalar * const _kappa_var_ptr;

  const unsigned int _kappa_var;

  const unsigned int _k_order;

  const VariableValue & _kappa;

  unsigned int _h;
  unsigned int _l;
};

inline Real
KernelScalarBase::computeScalarQpResidual()
{
  mooseError(
      "A scalar_variable has been set and compute_scalar_residuals=true, ",
      "but the computeScalarQpResidual method was not overridden. Accidental call of base class?");
  return 0;
}