https://mooseframework.inl.gov
Public Types | Public Member Functions | Protected Member Functions | List of all members
FictionalFaceCenteredMapFunctor< T, Map > Class Template Reference
Inheritance diagram for FictionalFaceCenteredMapFunctor< T, Map >:
[legend]

Public Types

using ElemArg = Moose::ElemArg
 
using FaceArg = Moose::FaceArg
 
using ElemQpArg = Moose::ElemQpArg
 
using ElemSideQpArg = Moose::ElemSideQpArg
 
using ElemPointArg = Moose::ElemPointArg
 
using StateArg = Moose::StateArg
 
using NodeArg = Moose::NodeArg
 
typedef FunctorBase< T > FunctorType
 
typedef T ValueType
 
typedef typename FunctorReturnType< T, FunctorEvaluationKind::Gradient >::type GradientType
 
typedef ValueType DotType
 

Public Member Functions

 FictionalFaceCenteredMapFunctor (const MooseMesh &mesh, const std::set< SubdomainID > &sub_ids, const std::string &name)
 
bool hasBlocks (SubdomainID) const override
 
ValueType evaluate (const FaceInfo *const fi) const
 Evaluate the face functor using a FaceInfo argument. More...
 
bool supportsFaceArg () const override final
 
bool supportsElemSideQpArg () const override final
 
FunctorReturnType< T, FET >::type genericEvaluate (const Space &r, const State &state) const
 
const MooseFunctorName & functorName () const
 
virtual void residualSetup () override
 
virtual void jacobianSetup () override
 
virtual void timestepSetup () override
 
virtual void customSetup (const ExecFlagType &exec_type) override
 
void setCacheClearanceSchedule (const std::set< ExecFlagType > &clearance_schedule)
 
virtual bool isExtrapolatedBoundaryFace (const FaceInfo &, const Elem *, const StateArg &) const
 
bool isInternalFace (const FaceInfo &) const
 
virtual bool isConstant () const
 
virtual bool hasFaceSide (const FaceInfo &fi, const bool fi_elem_side) const override
 
void checkFace (const Moose::FaceArg &face) const
 
ValueType operator() (const ElemArg &elem, const StateArg &state) const
 
ValueType operator() (const FaceArg &face, const StateArg &state) const
 
ValueType operator() (const ElemQpArg &qp, const StateArg &state) const
 
ValueType operator() (const ElemSideQpArg &qp, const StateArg &state) const
 
ValueType operator() (const ElemPointArg &elem_point, const StateArg &state) const
 
ValueType operator() (const NodeArg &node, const StateArg &state) const
 
ValueType operator() (const ElemArg &elem, const StateArg &state) const
 
ValueType operator() (const FaceArg &face, const StateArg &state) const
 
ValueType operator() (const ElemQpArg &qp, const StateArg &state) const
 
ValueType operator() (const ElemSideQpArg &qp, const StateArg &state) const
 
ValueType operator() (const ElemPointArg &elem_point, const StateArg &state) const
 
ValueType operator() (const NodeArg &node, const StateArg &state) const
 
GradientType gradient (const ElemArg &elem, const StateArg &state) const
 
GradientType gradient (const FaceArg &face, const StateArg &state) const
 
GradientType gradient (const ElemQpArg &qp, const StateArg &state) const
 
GradientType gradient (const ElemSideQpArg &qp, const StateArg &state) const
 
GradientType gradient (const ElemPointArg &elem_point, const StateArg &state) const
 
GradientType gradient (const NodeArg &node, const StateArg &state) const
 
GradientType gradient (const ElemArg &elem, const StateArg &state) const
 
GradientType gradient (const FaceArg &face, const StateArg &state) const
 
GradientType gradient (const ElemQpArg &qp, const StateArg &state) const
 
GradientType gradient (const ElemSideQpArg &qp, const StateArg &state) const
 
GradientType gradient (const ElemPointArg &elem_point, const StateArg &state) const
 
GradientType gradient (const NodeArg &node, const StateArg &state) const
 
DotType dot (const ElemArg &elem, const StateArg &state) const
 
DotType dot (const FaceArg &face, const StateArg &state) const
 
DotType dot (const ElemQpArg &qp, const StateArg &state) const
 
DotType dot (const ElemSideQpArg &qp, const StateArg &state) const
 
DotType dot (const ElemPointArg &elem_point, const StateArg &state) const
 
DotType dot (const NodeArg &node, const StateArg &state) const
 
DotType dot (const ElemArg &elem, const StateArg &state) const
 
DotType dot (const FaceArg &face, const StateArg &state) const
 
DotType dot (const ElemQpArg &qp, const StateArg &state) const
 
DotType dot (const ElemSideQpArg &qp, const StateArg &state) const
 
DotType dot (const ElemPointArg &elem_point, const StateArg &state) const
 
DotType dot (const NodeArg &node, const StateArg &state) const
 
GradientType gradDot (const ElemArg &elem, const StateArg &state) const
 
GradientType gradDot (const FaceArg &face, const StateArg &state) const
 
GradientType gradDot (const ElemQpArg &qp, const StateArg &state) const
 
GradientType gradDot (const ElemSideQpArg &qp, const StateArg &state) const
 
GradientType gradDot (const ElemPointArg &elem_point, const StateArg &state) const
 
GradientType gradDot (const NodeArg &node, const StateArg &state) const
 
GradientType gradDot (const ElemArg &elem, const StateArg &state) const
 
GradientType gradDot (const FaceArg &face, const StateArg &state) const
 
GradientType gradDot (const ElemQpArg &qp, const StateArg &state) const
 
GradientType gradDot (const ElemSideQpArg &qp, const StateArg &state) const
 
GradientType gradDot (const ElemPointArg &elem_point, const StateArg &state) const
 
GradientType gradDot (const NodeArg &node, const StateArg &state) const
 

Protected Member Functions

virtual GradientType evaluateGradient (const ElemArg &, const StateArg &) const
 
virtual GradientType evaluateGradient (const FaceArg &, const StateArg &) const
 
virtual GradientType evaluateGradient (const ElemQpArg &, const StateArg &) const
 
virtual GradientType evaluateGradient (const ElemSideQpArg &, const StateArg &) const
 
virtual GradientType evaluateGradient (const ElemPointArg &, const StateArg &) const
 
virtual GradientType evaluateGradient (const NodeArg &, const StateArg &) const
 
virtual GradientType evaluateGradient (const ElemArg &, const StateArg &) const
 
virtual GradientType evaluateGradient (const FaceArg &, const StateArg &) const
 
virtual GradientType evaluateGradient (const ElemQpArg &, const StateArg &) const
 
virtual GradientType evaluateGradient (const ElemSideQpArg &, const StateArg &) const
 
virtual GradientType evaluateGradient (const ElemPointArg &, const StateArg &) const
 
virtual GradientType evaluateGradient (const NodeArg &, const StateArg &) const
 
virtual DotType evaluateDot (const ElemArg &, const StateArg &) const
 
virtual DotType evaluateDot (const FaceArg &, const StateArg &) const
 
virtual DotType evaluateDot (const ElemQpArg &, const StateArg &) const
 
virtual DotType evaluateDot (const ElemSideQpArg &, const StateArg &) const
 
virtual DotType evaluateDot (const ElemPointArg &, const StateArg &) const
 
virtual DotType evaluateDot (const NodeArg &, const StateArg &) const
 
virtual DotType evaluateDot (const ElemArg &, const StateArg &) const
 
virtual DotType evaluateDot (const FaceArg &, const StateArg &) const
 
virtual DotType evaluateDot (const ElemQpArg &, const StateArg &) const
 
virtual DotType evaluateDot (const ElemSideQpArg &, const StateArg &) const
 
virtual DotType evaluateDot (const ElemPointArg &, const StateArg &) const
 
virtual DotType evaluateDot (const NodeArg &, const StateArg &) const
 
virtual GradientType evaluateGradDot (const ElemArg &, const StateArg &) const
 
virtual GradientType evaluateGradDot (const FaceArg &, const StateArg &) const
 
virtual GradientType evaluateGradDot (const ElemQpArg &, const StateArg &) const
 
virtual GradientType evaluateGradDot (const ElemSideQpArg &, const StateArg &) const
 
virtual GradientType evaluateGradDot (const ElemPointArg &, const StateArg &) const
 
virtual GradientType evaluateGradDot (const NodeArg &, const StateArg &) const
 
virtual GradientType evaluateGradDot (const ElemArg &, const StateArg &) const
 
virtual GradientType evaluateGradDot (const FaceArg &, const StateArg &) const
 
virtual GradientType evaluateGradDot (const ElemQpArg &, const StateArg &) const
 
virtual GradientType evaluateGradDot (const ElemSideQpArg &, const StateArg &) const
 
virtual GradientType evaluateGradDot (const ElemPointArg &, const StateArg &) const
 
virtual GradientType evaluateGradDot (const NodeArg &, const StateArg &) const
 

Detailed Description

template<typename T, typename Map>
class FictionalFaceCenteredMapFunctor< T, Map >

Definition at line 23 of file TestFaceCenteredMapFunctor.C.

Member Typedef Documentation

◆ ElemArg

template<typename T, typename Map>
using FaceCenteredMapFunctor< T, Map >::ElemArg = Moose::ElemArg
inherited

Definition at line 31 of file FaceCenteredMapFunctor.h.

◆ ElemPointArg

template<typename T, typename Map>
using FaceCenteredMapFunctor< T, Map >::ElemPointArg = Moose::ElemPointArg
inherited

Definition at line 35 of file FaceCenteredMapFunctor.h.

◆ ElemQpArg

template<typename T, typename Map>
using FaceCenteredMapFunctor< T, Map >::ElemQpArg = Moose::ElemQpArg
inherited

Definition at line 33 of file FaceCenteredMapFunctor.h.

◆ ElemSideQpArg

template<typename T, typename Map>
using FaceCenteredMapFunctor< T, Map >::ElemSideQpArg = Moose::ElemSideQpArg
inherited

Definition at line 34 of file FaceCenteredMapFunctor.h.

◆ FaceArg

template<typename T, typename Map>
using FaceCenteredMapFunctor< T, Map >::FaceArg = Moose::FaceArg
inherited

Definition at line 32 of file FaceCenteredMapFunctor.h.

◆ NodeArg

template<typename T, typename Map>
using FaceCenteredMapFunctor< T, Map >::NodeArg = Moose::NodeArg
inherited

Definition at line 37 of file FaceCenteredMapFunctor.h.

◆ StateArg

template<typename T, typename Map>
using FaceCenteredMapFunctor< T, Map >::StateArg = Moose::StateArg
inherited

Definition at line 36 of file FaceCenteredMapFunctor.h.

Constructor & Destructor Documentation

◆ FictionalFaceCenteredMapFunctor()

template<typename T , typename Map >
FictionalFaceCenteredMapFunctor< T, Map >::FictionalFaceCenteredMapFunctor ( const MooseMesh &  mesh,
const std::set< SubdomainID > &  sub_ids,
const std::string &  name 
)
inline

Definition at line 26 of file TestFaceCenteredMapFunctor.C.

29  : FaceCenteredMapFunctor<T, Map>(mesh, sub_ids, name)
30  {
31  }
FaceCenteredMapFunctor
A functor whose evaluation relies on querying a map where the keys are face info ids and the values c...
Definition: FaceCenteredMapFunctor.h:25
mesh
MeshBase & mesh
name
const std::string name
Definition: Setup.h:20

Member Function Documentation

◆ evaluate()

template<typename T , typename Map >
FaceCenteredMapFunctor< T, Map >::ValueType FaceCenteredMapFunctor< T, Map >::evaluate ( const FaceInfo *const  fi) const
inherited

Evaluate the face functor using a FaceInfo argument.

Parameters
fiThe object containing the face information

Definition at line 132 of file FaceCenteredMapFunctor.C.

Referenced by RhieChowMassFlux::getMassFlux().

133 {
134  try
135  {
136  return libmesh_map_find(*this, fi->id());
137  }
138  catch (libMesh::LogicError &)
139  {
140  if (!_sub_ids.empty() && !_sub_ids.count(fi->elem().subdomain_id()))
141  {
142  if (fi->neighborPtr() && !_sub_ids.count(fi->neighborPtr()->subdomain_id()))
143  mooseError("Attempted to evaluate FaceCenteredMapFunctor '",
144  this->functorName(),
145  "' with an element subdomain id of '",
146  fi->elem().subdomain_id(),
147  fi->neighborPtr() ? " or neighbor subdomain id of '" +
148  std::to_string(fi->neighborPtr()->subdomain_id()) + "'"
149  : "",
150  "' but that subdomain id is not one of the subdomain ids the functor is "
151  "restricted to.");
152  }
153  else
154  mooseError("Attempted access into FaceCenteredMapFunctor '",
155  this->functorName(),
156  "' with a key that does not yet exist in the map. Make sure to fill your "
157  "FaceCenteredMapFunctor for all elements you will attempt to access later.");
158 
159  return typename FaceCenteredMapFunctor<T, Map>::ValueType();
160  }
161 }
mooseError
void mooseError(Args &&... args)
FaceInfo::elem
const Elem & elem() const
FaceInfo::neighborPtr
const Elem * neighborPtr() const
Moose::FunctorBase::functorName
const MooseFunctorName & functorName() const
libMesh::Elem::subdomain_id
subdomain_id_type subdomain_id() const
FaceCenteredMapFunctor::_sub_ids
const std::set< SubdomainID > _sub_ids
The subdomain IDs that this functor lives on.
Definition: FaceCenteredMapFunctor.h:62
FaceInfo::id
dof_id_type id() const

◆ hasBlocks()

template<typename T , typename Map >
bool FictionalFaceCenteredMapFunctor< T, Map >::hasBlocks ( SubdomainID  ) const
inlineoverridevirtual

Reimplemented from FaceCenteredMapFunctor< T, Map >.

Definition at line 33 of file TestFaceCenteredMapFunctor.C.

33 { return true; }

◆ supportsElemSideQpArg()

template<typename T, typename Map>
bool FaceCenteredMapFunctor< T, Map >::supportsElemSideQpArg ( ) const
inlinefinaloverridevirtualinherited

Implements Moose::FunctorBase< T >.

Definition at line 54 of file FaceCenteredMapFunctor.h.

54 { return false; }

◆ supportsFaceArg()

template<typename T, typename Map>
bool FaceCenteredMapFunctor< T, Map >::supportsFaceArg ( ) const
inlinefinaloverridevirtualinherited

Implements Moose::FunctorBase< T >.

Definition at line 53 of file FaceCenteredMapFunctor.h.

53 { return true; }
The documentation for this class was generated from the following file:
Generated on Fri Jul 18 2025 13:46:42 for https://mooseframework.inl.gov by   doxygen 1.8.14