FVFluxBC.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 "FVBoundaryCondition.h"
#include "NeighborCoupleableMooseVariableDependencyIntermediateInterface.h"
#include "TwoMaterialPropertyInterface.h"
#include "MathFVUtils.h"
#include "FVFaceResidualObject.h"
#include "SideFVFluxBCIntegral.h"

class FVFluxBC : public FVBoundaryCondition,
                 public NeighborCoupleableMooseVariableDependencyIntermediateInterface,
                 public TwoMaterialPropertyInterface,
                 public FVFaceResidualObject
{
public:
  FVFluxBC(const InputParameters & parameters);

  static InputParameters validParams();

  void computeResidual(const FaceInfo & fi) override;
  void computeJacobian(const FaceInfo & fi) override;
  void computeResidualAndJacobian(const FaceInfo & fi) override;

  void updateCurrentFace(const FaceInfo & fi);

protected:
  virtual ADReal computeQpResidual() = 0;

  const ADRealVectorValue & normal() const { return _normal; }

  const unsigned int _qp = 0;
  const ADVariableValue & _u;
  const ADVariableValue & _u_neighbor;
  // TODO: add gradients once we have reconstruction.
  ADRealVectorValue _normal;

  const ADReal & uOnUSub() const;

  const ADReal & uOnGhost() const;

  Moose::ElemArg elemArg(bool correct_skewness = false) const;

  Moose::ElemArg neighborArg(bool correct_skewness = false) const;

  FaceInfo::VarFaceNeighbors _face_type;

  // This class will want to call computeQpResidual from here considering that
  // it will directly use the boundary conditions to compute the flux.
  friend class SideFVFluxBCIntegral;
};