MortarScalarBase.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 "MortarConstraint.h"

class MortarScalarBase : public MortarConstraint
{
public:
  static InputParameters validParams();

  MortarScalarBase(const InputParameters & parameters);

  // Using declarations necessary to pull in computeResidual with different parameter list and avoid
  // hidden method warning
  using MortarConstraintBase::computeResidual;

  // Using declarations necessary to pull in computeJacobian with different parameter list and avoid
  // hidden method warning
  using MortarConstraintBase::computeJacobian;

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

  virtual void computeResidual() override;
  virtual void computeJacobian() override;

protected:
  virtual Real computeScalarQpResidual();

  virtual void computeScalarJacobian();

  virtual Real computeScalarQpJacobian() { return 0; }

  void computeScalarOffDiagJacobian();

  virtual Real computeScalarQpOffDiagJacobian(const Moose::MortarType /*mortar_type*/,
                                              const unsigned int /*jvar_num*/)
  {
    return 0;
  }

  void computeOffDiagJacobianScalar(unsigned int) override final;
  void computeOffDiagJacobianScalar(const Moose::MortarType mortar_type,
                                    const unsigned int svar_num);

  virtual Real computeQpOffDiagJacobianScalar(const Moose::MortarType /*mortar_type*/,
                                              unsigned int /*svar_num*/)
  {
    return 0;
  }

  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 /*jvar_num*/) {}

  virtual void initScalarQpOffDiagJacobian(const Moose::MortarType /*mortar_type*/,
                                           const unsigned int /*jvar_num*/)
  {
  }

  const bool _use_scalar;

  const bool _compute_scalar_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
MortarScalarBase::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;
}

inline void
MortarScalarBase::computeOffDiagJacobianScalar(unsigned int)
{
  mooseError("Must call the mortar type overload instead");
}