FaceArgInterface.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 "MooseTypes.h"
#include "FaceInfo.h"
#include "MooseFunctorArguments.h"
#include "libmesh/elem.h"
 
class FaceArgInterface
{
public:
  virtual ~FaceArgInterface() = default;
  virtual bool hasFaceSide(const FaceInfo & fi, const bool fi_elem_side) const = 0;
};
 
class FaceArgProducerInterface : public FaceArgInterface
{
public:
  Moose::FaceArg makeFace(const FaceInfo & fi,
                          const Moose::FV::LimiterType limiter_type,
                          const bool elem_is_upwind,
                          const bool correct_skewness = false,
                          const Moose::StateArg * state_limiter = nullptr) const;
 
  template <typename FunctorType>
  Moose::FaceArg makeFace(const FunctorType & functor,
                          const FaceInfo & fi,
                          const Moose::FV::LimiterType limiter_type,
                          const bool elem_is_upwind,
                          const bool correct_skewness = false,
                          const Moose::StateArg * state_limiter = nullptr) const;
 
  Moose::FaceArg makeCDFace(const FaceInfo & fi, const bool correct_skewness = false) const;
};
 
template <typename FunctorType>
inline Moose::FaceArg
FaceArgProducerInterface::makeFace(const FunctorType & functor,
                                   const FaceInfo & fi,
                                   const Moose::FV::LimiterType limiter_type,
                                   const bool elem_is_upwind,
                                   const bool correct_skewness,
                                   const Moose::StateArg * state_limiter) const
{
  const bool defined_on_elem_side = functor.hasFaceSide(fi, true);
  const bool defined_on_neighbor_side = functor.hasFaceSide(fi, false);
 
  if (!defined_on_elem_side && !defined_on_neighbor_side)
    mooseError("The functor '",
               functor.functorName(),
               "' is not defined on either side of the face with centroid ",
               fi.faceCentroid(),
               ".");
 
  const Elem * const face_side = defined_on_elem_side && defined_on_neighbor_side
                                     ? nullptr
                                     : (defined_on_elem_side ? fi.elemPtr() : fi.neighborPtr());
 
  return {&fi, limiter_type, elem_is_upwind, correct_skewness, face_side, state_limiter};
}
 
inline Moose::FaceArg
FaceArgProducerInterface::makeCDFace(const FaceInfo & fi, const bool correct_skewness) const
{
  return makeFace(fi, Moose::FV::LimiterType::CentralDifference, true, correct_skewness);
}