FVBoundaryCondition.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 "ADFunctorInterface.h"
#include "FaceArgInterface.h"
#include "MooseVariableInterface.h"

// Forward declarations
template <typename>
class MooseVariableFE;
typedef MooseVariableFE<Real> MooseVariable;
typedef MooseVariableFE<VectorValue<Real>> VectorMooseVariable;
class MooseMesh;
class Problem;
class SubProblem;
class SystemBase;
class Assembly;
class FEProblemBase;

class FVBoundaryCondition : 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 ADFunctorInterface,
                            public FaceArgProducerInterface
{
public:
  FVBoundaryCondition(const InputParameters & parameters);

  static InputParameters validParams();

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

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

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

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

  MooseVariableFV<Real> & _var;

  SubProblem & _subproblem;

  FEProblemBase & _fv_problem;

  SystemBase & _sys;

  THREAD_ID _tid;

  Assembly & _assembly;

  MooseMesh & _mesh;

  const FaceInfo * _face_info = nullptr;
};