INSFVElementalKernel.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 "FVElementalKernel.h"
#include "INSFVMomentumResidualObject.h"

class INSFVElementalKernel : public FVElementalKernel, public INSFVMomentumResidualObject
{
public:
  static InputParameters validParams();
  INSFVElementalKernel(const InputParameters & params);

  using INSFVMomentumResidualObject::gatherRCData;
  void gatherRCData(const FaceInfo &) override final {}

  virtual ~INSFVElementalKernel() = default;

  void computeResidual() override;
  void computeJacobian() override;
  using FVElementalKernel::computeOffDiagJacobian;
  void computeOffDiagJacobian() override final {}
  void computeResidualAndJacobian() override;

protected:
  ADReal computeQpResidual() override final
  {
    mooseError("INSFVElementalKernels must implement gatherRCData and not computeQpResidual");
  }

  virtual ADReal computeSegregatedContribution()
  {
    mooseError(
        this->type(),
        " needs to implement computeSegregatedContribution to be usable with a segregated solver!");
  }

  void addResidualAndJacobian(const ADReal & residual, dof_id_type dof);
};