FaceArgProducerInterface Class Reference

An interface for producers of functor face arguments, e.g. More...

#include <FaceArgInterface.h>

Inheritance diagram for FaceArgProducerInterface:

Public Member Functions
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
	Create a functor face argument from provided component arguments.
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
	Create a face argument according to where the supplied functor is defined.
Moose::FaceArg	makeCDFace (const FaceInfo &fi, const bool correct_skewness=false) const
	Make a functor face argument with a central differencing limiter, e.g.
virtual bool	hasFaceSide (const FaceInfo &fi, const bool fi_elem_side) const =0

Detailed Description

An interface for producers of functor face arguments, e.g.

objects such as residual objects and postprocessors

Definition at line 32 of file FaceArgInterface.h.

Member Function Documentation

hasFaceSide()

virtual bool FaceArgInterface::hasFaceSide ( const FaceInfo &  fi, const bool  fi_elem_side  ) const

pure virtualinherited

Implemented in FVBoundaryCondition, FVInterfaceKernel, LinearFVBoundaryCondition, LinearFVFluxKernel, Moose::NullFunctor< T >, Moose::FunctorBase< T >, Moose::FunctorBase< ADReal >, Moose::FunctorBase< GenericReal< is_ad > >, Moose::FunctorBase< GenericRealVectorValue< is_ad > >, Moose::FunctorBase< libMesh::VectorValue >, Moose::FunctorBase< Moose::ADType< ComputeValueType >::type >, Moose::FunctorBase< Moose::ADType< OutputType >::type >, Moose::FunctorBase< Moose::ADType< Real >::type >, Moose::FunctorBase< Moose::ADType< RealEigenVector >::type >, Moose::FunctorBase< Moose::ADType< RealVectorValue >::type >, Moose::FunctorBase< Moose::ADType< T >::type >, Moose::FunctorBase< Moose::GenericType< Real, is_ad > >, Moose::FunctorBase< Moose::GenericType< T, is_ad > >, Moose::FunctorBase< Real >, Moose::FunctorBase< RealVectorValue >, Moose::FunctorBase< typename MetaPhysicL::RawType< T >::value_type >, Moose::FunctorBase< typename Moose::ADType< T >::type >, Moose::FunctorBase< VectorValue< GenericReal< is_ad > > >, Moose::FunctorBase< VectorValue< T > >, Moose::FunctorEnvelope< T >, Moose::FunctorEnvelope< ADReal >, Moose::FunctorEnvelope< GenericReal< is_ad > >, Moose::FunctorEnvelope< GenericRealVectorValue< is_ad > >, Moose::FunctorEnvelope< libMesh::VectorValue >, Moose::FunctorEnvelope< Moose::GenericType< Real, is_ad > >, Moose::FunctorEnvelope< Moose::GenericType< T, is_ad > >, Moose::FunctorEnvelope< Real >, Moose::FunctorEnvelope< RealVectorValue >, Moose::FunctorEnvelope< VectorValue< GenericReal< is_ad > > >, FVFluxKernel, InterfaceIntegralVariableValuePostprocessor, InternalSideIntegralVariablePostprocessor, SideIntegralFunctorPostprocessorTempl< is_ad >, SideIntegralFunctorPostprocessorTempl< false >, SideIntegralVariablePostprocessor, Moose::ADWrapperFunctor< T >, and Moose::RawValueFunctor< T >.

Referenced by makeFace().

makeCDFace()

Moose::FaceArg FaceArgProducerInterface::makeCDFace ( const FaceInfo &  fi, const bool  correct_skewness = false  ) const

inline

Make a functor face argument with a central differencing limiter, e.g.

compose a face argument that will tell functors to perform (possibly skew-corrected) linear interpolations from cell center values to faces

Parameters

fi	the face information
correct_skewness	whether to apply skew correction

Returns

a face argument for functors

Definition at line 116 of file FaceArgInterface.h.

{
  return makeFace(fi, Moose::FV::LimiterType::CentralDifference, true, correct_skewness);
}

Referenced by LinearFVAdvectionDiffusionFunctorNeumannBC::computeBoundaryNormalGradient(), LinearFVAdvectionDiffusionFunctorNeumannBC::computeBoundaryValue(), LinearFVAdvectionDiffusionFunctorNeumannBC::computeBoundaryValueRHSContribution(), InternalSideIntegralVariablePostprocessor::computeFaceInfoIntegral(), SideIntegralVariablePostprocessor::computeFaceInfoIntegral(), InterfaceIntegralVariableValuePostprocessor::computeQpIntegral(), LinearFVAnisotropicDiffusion::faceDiffusionTensor(), and LinearFVDiffusion::faceDiffusivity().

makeFace() [1/2]

Moose::FaceArg FaceArgProducerInterface::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

Create a functor face argument from provided component arguments.

Parameters

fi	the face information object
limiter_type	the limiter that defines how to perform interpolations to the faces
elem_is_upwind	whether the face information element is the upwind element (the value of this doesn't matter when the limiter type is CentralDifference)
correct_skewness	whether to apply skew correction

Returns

the functor face argument

Definition at line 13 of file FaceArgInterface.C.

{
  const bool defined_on_elem_side = hasFaceSide(fi, true);
  const bool defined_on_neighbor_side = hasFaceSide(fi, false);
  const Elem * const elem = defined_on_elem_side && defined_on_neighbor_side
                                ? nullptr
                                : (defined_on_elem_side ? &fi.elem() : fi.neighborPtr());
 
  if (!defined_on_elem_side && !defined_on_neighbor_side)
    mooseError("No definition on either side");
 
  return {&fi, limiter_type, elem_is_upwind, correct_skewness, elem, state_limiter};
}

Referenced by FVAdvection::computeQpResidual(), FVDivergence::computeQpResidual(), FVMatAdvection::computeQpResidual(), FVBoundaryIntegralValueConstraint::computeQpResidual(), makeCDFace(), LinearFVBoundaryCondition::singleSidedFaceArg(), LinearFVFluxKernel::singleSidedFaceArg(), FVBoundaryCondition::singleSidedFaceArg(), and FVFluxKernel::singleSidedFaceArg().

makeFace() [2/2]

template<typename FunctorType >

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 = false, const Moose::StateArg *  state_limiter = nullptr  ) const

inline

Create a face argument according to where the supplied functor is defined.

Unlike the overload above, which selects the face side according to the side reported by the face-producing object, this overload determines the face side from the supplied functor. This allows the resulting FaceArg to evaluate a functor that is defined only on the opposite side of the face from the producer.

If the functor is defined on both sides, the face argument is left unsided. If it is defined on only one side, that side is selected. An error is produced if the functor is defined on neither side.

Parameters

functor	the functor whose sidedness is queried
fi	the face information object
limiter_type	the limiter that defines how to perform interpolations to the face
elem_is_upwind	whether the face information element is the upwind element
correct_skewness	whether to apply skew correction
state_limiter	optional state used by the limiter

Returns

the functor face argument

Definition at line 91 of file FaceArgInterface.h.

{
  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};
}

---

The documentation for this class was generated from the following files:

• include/interfaces/FaceArgInterface.h
• src/interfaces/FaceArgInterface.C