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

// MOOSE
#include "MooseObject.h"
#include "SetupInterface.h"
#include "ParallelUniqueId.h"
#include "FunctionInterface.h"
#include "DistributionInterface.h"
#include "UserObjectInterface.h"
#include "TransientInterface.h"
#include "PostprocessorInterface.h"
#include "VectorPostprocessorInterface.h"
#include "GeometricSearchInterface.h"
#include "BoundaryRestrictableRequired.h"
#include "MeshChangedInterface.h"
#include "TaggingInterface.h"
#include "MooseVariableDependencyInterface.h"
#include "NonADFunctorInterface.h"
#include "FaceArgInterface.h"
#include "MooseLinearVariableFV.h"
#include "MooseVariableInterface.h"

#include "libmesh/linear_implicit_system.h"

// Forward declerations
class MooseMesh;
class Problem;
class SubProblem;
class SystemBase;

class LinearFVBoundaryCondition : public MooseObject,
                                  public BoundaryRestrictableRequired,
                                  public SetupInterface,
                                  public FunctionInterface,
                                  public DistributionInterface,
                                  public UserObjectInterface,
                                  public TransientInterface,
                                  public PostprocessorInterface,
                                  public VectorPostprocessorInterface,
                                  public GeometricSearchInterface,
                                  public MeshChangedInterface,
                                  public TaggingInterface,
                                  public MooseVariableInterface<Real>,
                                  public MooseVariableDependencyInterface,
                                  public NonADFunctorInterface,
                                  public FaceArgProducerInterface
{
public:
  LinearFVBoundaryCondition(const InputParameters & parameters);

  static InputParameters validParams();

  virtual bool hasFaceSide(const FaceInfo & fi, bool fi_elem_side) const override;

  const SubProblem & subProblem() const { return _subproblem; }

  const MooseLinearVariableFV<Real> & variable() const { return _var; }

  virtual Real computeBoundaryValue() const = 0;

  virtual Real computeBoundaryNormalGradient() const = 0;

  void setupFaceData(const FaceInfo * face_info, const FaceInfo::VarFaceNeighbors face_type);

  const FaceInfo * currentFaceInfo() const { return _current_face_info; }
  FaceInfo::VarFaceNeighbors currentFaceType() const { return _current_face_type; }

protected:
  Real computeCellToFaceDistance() const;

  RealVectorValue computeCellToFaceVector() const;

  Moose::FaceArg singleSidedFaceArg(
      const FaceInfo * fi,
      Moose::FV::LimiterType limiter_type = Moose::FV::LimiterType::CentralDifference,
      bool correct_skewness = false) const;

  template <typename FunctorType>
  Moose::FaceArg
  functorFaceArg(const FunctorType & functor,
                 const FaceInfo * fi,
                 Moose::FV::LimiterType limiter_type = Moose::FV::LimiterType::CentralDifference,
                 bool correct_skewness = false) const;

  const THREAD_ID _tid;

  SubProblem & _subproblem;

  MooseMesh & _mesh;

  FEProblemBase & _fv_problem;

  MooseLinearVariableFV<Real> & _var;

  SystemBase & _sys;

  const FaceInfo * _current_face_info;

  FaceInfo::VarFaceNeighbors _current_face_type;

  const unsigned int _var_num;

  const unsigned int _sys_num;
};

inline void
LinearFVBoundaryCondition::setupFaceData(const FaceInfo * face_info,
                                         const FaceInfo::VarFaceNeighbors face_type)
{
  mooseAssert(
      face_info,
      "The face info pointer should not be null when passing to the LinearFVBoundaryCondition!");
  _current_face_info = face_info;
  _current_face_type = face_type;
}