This is a wrapper that forwards calls to the implementation, which can be switched out at any time without disturbing references to FunctorBase. More...

#include <MooseFunctor.h>

Inheritance diagram for Moose::FunctorEnvelope< T >:

[legend]

Public Types
using	FunctorType = FunctorBase< T >

using	ValueType = T

using	GradientType = typename FunctorReturnType< T, FunctorEvaluationKind::Gradient >::type
	This rigmarole makes it so that a user can create functors that return containers (std::vector, std::array).

using	DotType = ValueType

Public Member Functions
	FunctorEnvelope (const FunctorBase< T > &wrapped)

	FunctorEnvelope (std::unique_ptr< FunctorBase< T > > &&wrapped)

	FunctorEnvelope (FunctorBase< T > &&)=delete
	Prevent wrapping of a temporary object.

void	assign (const FunctorBase< T > &wrapped)

void	assign (std::unique_ptr< FunctorBase< T > > &&wrapped)

void	assign (FunctorBase< T > &&)=delete
	Prevent wrapping of a temporary object.

	FunctorEnvelope (const FunctorEnvelope &)=delete

	FunctorEnvelope (FunctorEnvelope &&)=delete

FunctorEnvelope &	operator= (const FunctorEnvelope &)=delete

FunctorEnvelope &	operator= (FunctorEnvelope &&)=delete

virtual	~FunctorEnvelope ()=default

virtual bool	wrapsNull () const override

virtual std::string	returnType () const override

virtual bool	ownsWrappedFunctor () const override

template<typename T2 >
bool	wrapsType () const

virtual bool	isExtrapolatedBoundaryFace (const FaceInfo &fi, const Elem *const elem, const StateArg &state) const override
	Returns whether this (sided) face is an extrapolated boundary face for this functor.

virtual bool	isConstant () const override
	Returns true if this functor is a constant.

virtual bool	hasBlocks (const SubdomainID id) const override
	Returns whether the functor is defined on this block.

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

bool	supportsFaceArg () const override final
	Whether this functor supports evaluation with FaceArg.

bool	supportsElemSideQpArg () const override final
	Whether this functor supports evaluation with ElemSideQpArg.

template<FunctorEvaluationKind FET, typename Space , typename State >
FunctorReturnType< T, FET >::type	genericEvaluate (const Space &r, const State &state) const
	Perform a generic evaluation based on the supplied template argument `FET` and supplied spatial and temporal arguments.

const MooseFunctorName &	functorName () const
	Return the functor name.

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)
	Set how often to clear the functor evaluation cache.

bool	isInternalFace (const FaceInfo &) const
	Returns true if the face is an internal face.

void	checkFace (const Moose::FaceArg &face) const
	Examines the incoming face argument.


ValueType	operator() (const ElemArg &elem, const StateArg &state) const
	Same as their `evaluate` overloads with the same arguments but allows for caching implementation.

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
	Same as their `evaluateGradient` overloads with the same arguments but allows for caching implementation.

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
	Same as their `evaluateDot` overloads with the same arguments but allows for caching implementation.

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
	Same as their `evaluateGradDot` overloads with the same arguments but allows for caching implementation.

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 ValueType	evaluate (const ElemArg &elem, const StateArg &state) const override
	Forward calls to wrapped object.

virtual ValueType	evaluate (const FaceArg &face, const StateArg &state) const override

virtual ValueType	evaluate (const ElemQpArg &qp, const StateArg &state) const override

virtual ValueType	evaluate (const ElemSideQpArg &qp, const StateArg &state) const override

virtual ValueType	evaluate (const ElemPointArg &elem_point, const StateArg &state) const override
	Evaluate the functor with a given element and point.

virtual ValueType	evaluate (const NodeArg &node, const StateArg &state) const override

virtual GradientType	evaluateGradient (const ElemArg &elem, const StateArg &state) const override
	Evaluate the functor gradient with a given element.

virtual GradientType	evaluateGradient (const FaceArg &face, const StateArg &state) const override

virtual GradientType	evaluateGradient (const ElemQpArg &qp, const StateArg &state) const override

virtual GradientType	evaluateGradient (const ElemSideQpArg &qp, const StateArg &state) const override

virtual GradientType	evaluateGradient (const ElemPointArg &elem_point, const StateArg &state) const override
	Evaluate the functor gradient with a given element and point.

virtual GradientType	evaluateGradient (const NodeArg &node, const StateArg &state) const override

virtual DotType	evaluateDot (const ElemArg &elem, const StateArg &state) const override
	Evaluate the functor time derivative with a given element.

virtual DotType	evaluateDot (const FaceArg &face, const StateArg &state) const override

virtual DotType	evaluateDot (const ElemQpArg &qp, const StateArg &state) const override

virtual DotType	evaluateDot (const ElemSideQpArg &qp, const StateArg &state) const override

virtual DotType	evaluateDot (const ElemPointArg &elem_point, const StateArg &state) const override
	Evaluate the functor time derivative with a given element and point.

virtual DotType	evaluateDot (const NodeArg &node, const StateArg &state) const override

virtual GradientType	evaluateGradDot (const ElemArg &elem, const StateArg &state) const override
	Evaluate the functor gradient-dot with a given element.

virtual GradientType	evaluateGradDot (const FaceArg &face, const StateArg &state) const override

virtual GradientType	evaluateGradDot (const ElemQpArg &qp, const StateArg &state) const override

virtual GradientType	evaluateGradDot (const ElemSideQpArg &qp, const StateArg &state) const override

virtual GradientType	evaluateGradDot (const ElemPointArg &elem_point, const StateArg &state) const override
	Evaluate the functor gradient-dot with a given element and point.

virtual GradientType	evaluateGradDot (const NodeArg &node, const StateArg &state) const override

Private Member Functions
void	clearCacheData ()
	clear cache data

template<typename SpaceArg , typename StateArg >
ValueType	queryQpCache (unsigned int qp, const libMesh::QBase &qrule, std::vector< std::pair< bool, T > > &qp_cache_data, const SpaceArg &space, const StateArg &state) const
	check a qp cache and if invalid then evaluate

template<typename SpaceArg >
ValueType	queryFVArgCache (std::map< SpaceArg, ValueType > &cache_data, const SpaceArg &space) const
	check a finite volume spatial argument cache and if invalid then evaluate

Private Attributes
std::unique_ptr< FunctorBase< T > >	_owned
	Our wrapped object.

const FunctorBase< T > *	_wrapped

std::set< ExecFlagType >	_clearance_schedule
	How often to clear the material property cache.

bool	_always_evaluate
	Boolean to check if we always need evaluation.

dof_id_type	_current_qp_map_key = libMesh::DofObject::invalid_id
	Current key for qp map cache.

std::vector< std::pair< bool, ValueType > > *	_current_qp_map_value = nullptr
	Current value for qp map cache.

std::unordered_map< dof_id_type, std::vector< std::pair< bool, ValueType > > >	_qp_to_value
	Cached element quadrature point functor property evaluations.

dof_id_type	_current_side_qp_map_key = libMesh::DofObject::invalid_id
	Current key for side-qp map cache.

std::vector< std::vector< std::pair< bool, ValueType > > > *	_current_side_qp_map_value
	Current value for side-qp map cache.

std::unordered_map< dof_id_type, std::vector< std::vector< std::pair< bool, ValueType > > > >	_side_qp_to_value
	Cached element quadrature point functor property evaluations.

std::map< ElemArg, ValueType >	_elem_arg_to_value
	Map from element arguments to their cached evaluations.

std::map< FaceArg, ValueType >	_face_arg_to_value
	Map from face arguments to their cached evaluations.

std::map< NodeArg, ValueType >	_node_arg_to_value
	Map from nodal arguments to their cached evaluations.

MooseFunctorName	_functor_name
	name of the functor

Friends
class	::SubProblem

Detailed Description

template<typename T>
class Moose::FunctorEnvelope< T >

This is a wrapper that forwards calls to the implementation, which can be switched out at any time without disturbing references to FunctorBase.

Implementation motivated by https://stackoverflow.com/a/65455485/4493669

Definition at line 1046 of file MooseFunctor.h.

Member Typedef Documentation

◆ DotType

template<typename T >

using Moose::FunctorBase< T >::DotType = ValueType

inherited

Definition at line 150 of file MooseFunctor.h.

◆ FunctorType

template<typename T >

using Moose::FunctorBase< T >::FunctorType = FunctorBase<T>

inherited

Definition at line 140 of file MooseFunctor.h.

◆ GradientType

template<typename T >

using Moose::FunctorBase< T >::GradientType = typename FunctorReturnType<T, FunctorEvaluationKind::Gradient>::type

inherited

This rigmarole makes it so that a user can create functors that return containers (std::vector, std::array).

This logic will make it such that if a user requests a functor type T that is a container of algebraic types, for example Reals, then the GradientType will be a container of the gradients of those algebraic types, in this example VectorValue<Reals>. So if T is std::vector<Real>, then GradientType will be std::vector<VectorValue<Real>>. As another example: T = std::array<VectorValue<Real>, 1> -> GradientType = std::array<TensorValue<Real>, 1>

Definition at line 149 of file MooseFunctor.h.

◆ ValueType

template<typename T >

using Moose::FunctorBase< T >::ValueType = T

inherited

Definition at line 141 of file MooseFunctor.h.

Constructor & Destructor Documentation

◆ FunctorEnvelope() [1/5]

template<typename T >

Moose::FunctorEnvelope< T >::FunctorEnvelope ( const FunctorBase< T > & wrapped )

inline

Parameters

wrapped The functor to wrap. We will not not own the wrapped object

Definition at line 1056 of file MooseFunctor.h.

    : FunctorBase<T>("wraps_" + wrapped.functorName()), FunctorEnvelopeBase(), _wrapped(&wrapped)
  {
  }

◆ FunctorEnvelope() [2/5]

template<typename T >

Moose::FunctorEnvelope< T >::FunctorEnvelope ( std::unique_ptr< FunctorBase< T > > && wrapped )

inline

Parameters

wrapped A unique pointer around the functor to wrap. We will own the wrapped object, e.g. if we are ever destructed or we are reassigned to wrap another functor, then this functor will be destructed

Definition at line 1066 of file MooseFunctor.h.

    : FunctorBase<T>("wraps_" + wrapped->functorName()),
      FunctorEnvelopeBase(),
      _owned(std::move(wrapped)),
      _wrapped(_owned.get())
  {
  }

◆ FunctorEnvelope() [3/5]

template<typename T >

Moose::FunctorEnvelope< T >::FunctorEnvelope ( FunctorBase< T > && )

delete

Prevent wrapping of a temporary object.

If we are to own a functor, the unique_ptr constructor overload should be used

◆ FunctorEnvelope() [4/5]

template<typename T >

Moose::FunctorEnvelope< T >::FunctorEnvelope ( const FunctorEnvelope< T > & )

delete

◆ FunctorEnvelope() [5/5]

template<typename T >

Moose::FunctorEnvelope< T >::FunctorEnvelope ( FunctorEnvelope< T > && )

delete

◆ ~FunctorEnvelope()

template<typename T >

virtual Moose::FunctorEnvelope< T >::~FunctorEnvelope ( )

virtualdefault

Member Function Documentation

◆ assign() [1/3]

template<typename T >

void Moose::FunctorEnvelope< T >::assign ( const FunctorBase< T > & wrapped )

inline

Parameters

wrapped The functor to wrap. We will not not own the wrapped object. If we previously owned a functor, it will be destructed

Definition at line 1084 of file MooseFunctor.h.

  {
    _owned.reset();
    _wrapped = &wrapped;
  }

◆ assign() [2/3]

template<typename T >

void Moose::FunctorEnvelope< T >::assign ( FunctorBase< T > && )

delete

Prevent wrapping of a temporary object.

If we are to own a functor, the unique_ptr assign overload should be used

◆ assign() [3/3]

template<typename T >

void Moose::FunctorEnvelope< T >::assign ( std::unique_ptr< FunctorBase< T > > && wrapped )

inline

Parameters

wrapped A unique pointer around the functor to wrap. We will own the wrapped object. If we previously owned a functor, it will be destructed

Definition at line 1094 of file MooseFunctor.h.

  {
    _owned = std::move(wrapped);
    _wrapped = _owned.get();
  }

◆ checkFace()

template<typename T >

void Moose::FunctorBase< T >::checkFace ( const Moose::FaceArg & face ) const

inherited

Examines the incoming face argument.

If the face argument producer (residual object, postprocessor, etc.) did not indicate a sidedness to the face, e.g. if the face_side member of the FaceArg is nullptr, then we may "modify" the sidedness of the argument if we are only defined on one side of the face. If the face argument producer \emph has indicated a sidedness and we are not defined on that side, then we will error

Parameters

face	The face argument created by the face argument producer, likely a residual object

Returns: A face with possibly changed sidedness depending on whether we aren't defined on both sides of the face

Definition at line 738 of file MooseFunctor.h.

{
#if DEBUG
  const Elem * const elem = face.face_side;
  const FaceInfo * const fi = face.fi;
  mooseAssert(fi, "face info should be non-null");
  bool check_elem_def = false;
  bool check_neighbor_def = false;
  // We check if the functor is defined on both sides of the face
  if (!elem)
  {
    if (!hasFaceSide(*fi, true))
      check_neighbor_def = true;
    else if (!hasFaceSide(*fi, false))
      check_elem_def = true;
  }
  else if (elem == fi->elemPtr())
    check_elem_def = true;
  else
  {
    mooseAssert(elem == fi->neighborPtr(), "This has to match something");
    check_neighbor_def = true;
  }
 
  if (check_elem_def && !hasFaceSide(*fi, true))
  {
    std::string additional_message = "It is not defined on the neighbor side either.";
    if (hasFaceSide(*fi, false))
      additional_message = "It is however defined on the neighbor side.";
    additional_message += " Face centroid: " + Moose::stringify(fi->faceCentroid());
    mooseError(_functor_name,
               " is not defined on the element side of the face information, but a face argument "
               "producer "
               "(e.g. residual object, postprocessor, etc.) has requested evaluation there.\n",
               additional_message);
  }
  if (check_neighbor_def && !hasFaceSide(*fi, false))
  {
    std::string additional_message = "It is not defined on the element side either.";
    if (hasFaceSide(*fi, true))
      additional_message = "It is however defined on the element side.";
    additional_message += " Face centroid: " + Moose::stringify(fi->faceCentroid());
    mooseError(
        _functor_name,
        " is not defined on the neighbor side of the face information, but a face argument "
        "producer (e.g. residual object, postprocessor, etc.) has requested evaluation there.\n",
        additional_message);
  }
#endif
}

◆ clearCacheData()

template<typename T >

void Moose::FunctorBase< T >::clearCacheData ( )

privateinherited

clear cache data

Definition at line 795 of file MooseFunctor.h.

{
  for (auto & map_pr : _qp_to_value)
    for (auto & pr : map_pr.second)
      pr.first = false;
 
  for (auto & map_pr : _side_qp_to_value)
  {
    auto & side_vector = map_pr.second;
    for (auto & qp_vector : side_vector)
      for (auto & pr : qp_vector)
        pr.first = false;
  }
 
  _current_qp_map_key = libMesh::DofObject::invalid_id;
  _current_qp_map_value = nullptr;
  _current_side_qp_map_key = libMesh::DofObject::invalid_id;
  _current_side_qp_map_value = nullptr;
 
  _elem_arg_to_value.clear();
  _face_arg_to_value.clear();
  _node_arg_to_value.clear();
}

◆ customSetup()

template<typename T >

void Moose::FunctorBase< T >::customSetup ( const ExecFlagType & exec_type )

overridevirtualinherited

Implements Moose::FunctorAbstract.

Reimplemented in Function.

Definition at line 845 of file MooseFunctor.h.

{
  if (_clearance_schedule.count(exec_type))
    clearCacheData();
}

Referenced by Function::customSetup().

◆ dot() [1/6]

template<typename T >

FunctorBase< T >::DotType Moose::FunctorBase< T >::dot	(	const ElemArg &	elem,
		const StateArg &	state
	)		const

inherited

Same as their evaluateDot overloads with the same arguments but allows for caching implementation.

These are the methods a user will call in their code

Definition at line 896 of file MooseFunctor.h.

{
  return evaluateDot(elem, state);
}

Referenced by FVFunctorTimeKernel::computeQpResidual(), Moose::ADWrapperFunctor< T >::evaluateDot(), Moose::ADWrapperFunctor< T >::evaluateDot(), Moose::ADWrapperFunctor< T >::evaluateDot(), Moose::ADWrapperFunctor< T >::evaluateDot(), Moose::ADWrapperFunctor< T >::evaluateDot(), and Moose::ADWrapperFunctor< T >::evaluateDot().

◆ dot() [2/6]

template<typename T >

FunctorBase< T >::DotType Moose::FunctorBase< T >::dot	(	const ElemPointArg &	elem_point,
		const StateArg &	state
	)		const

inherited

Definition at line 925 of file MooseFunctor.h.

{
  return evaluateDot(elem_point, state);
}

◆ dot() [3/6]

template<typename T >

FunctorBase< T >::DotType Moose::FunctorBase< T >::dot	(	const ElemQpArg &	qp,
		const StateArg &	state
	)		const

inherited

Definition at line 911 of file MooseFunctor.h.

{
  return evaluateDot(elem_qp, state);
}

◆ dot() [4/6]

template<typename T >

FunctorBase< T >::DotType Moose::FunctorBase< T >::dot	(	const ElemSideQpArg &	qp,
		const StateArg &	state
	)		const

inherited

Definition at line 918 of file MooseFunctor.h.

{
  return evaluateDot(elem_side_qp, state);
}

◆ dot() [5/6]

template<typename T >

FunctorBase< T >::DotType Moose::FunctorBase< T >::dot	(	const FaceArg &	face,
		const StateArg &	state
	)		const

inherited

Definition at line 903 of file MooseFunctor.h.

{
  checkFace(face);
  return evaluateDot(face, state);
}

◆ dot() [6/6]

template<typename T >

FunctorBase< T >::DotType Moose::FunctorBase< T >::dot	(	const NodeArg &	node,
		const StateArg &	state
	)		const

inherited

Definition at line 932 of file MooseFunctor.h.

{
  return evaluateDot(node, state);
}

◆ evaluate() [1/6]

template<typename T >

virtual ValueType Moose::FunctorEnvelope< T >::evaluate	(	const ElemArg &	elem,
		const StateArg &	state
	)		const

inlineoverrideprotectedvirtual

Forward calls to wrapped object.

Implements Moose::FunctorBase< T >.

Definition at line 1155 of file MooseFunctor.h.

  {
    return _wrapped->operator()(elem, state);
  }

◆ evaluate() [2/6]

template<typename T >

virtual ValueType Moose::FunctorEnvelope< T >::evaluate	(	const ElemPointArg &	elem_point,
		const StateArg &	state
	)		const

inlineoverrideprotectedvirtual

Evaluate the functor with a given element and point.

Some example implementations of this method could perform a two-term Taylor expansion using cell-centered value and gradient

Implements Moose::FunctorBase< T >.

Definition at line 1171 of file MooseFunctor.h.

  {
    return _wrapped->operator()(elem_point, state);
  }

◆ evaluate() [3/6]

template<typename T >

virtual ValueType Moose::FunctorEnvelope< T >::evaluate	(	const ElemQpArg &	qp,
		const StateArg &	state
	)		const

inlineoverrideprotectedvirtual

Parameters

qp	See the `ElemQpArg` doxygen
state	See the `StateArg` doxygen

Returns: The functor evaluated at the requested state and space

Implements Moose::FunctorBase< T >.

Definition at line 1163 of file MooseFunctor.h.

  {
    return _wrapped->operator()(qp, state);
  }

◆ evaluate() [4/6]

template<typename T >

virtual ValueType Moose::FunctorEnvelope< T >::evaluate	(	const ElemSideQpArg &	side_qp,
		const StateArg &	state
	)		const

inlineoverrideprotectedvirtual

Parameters

side_qp	See the `ElemSideQpArg` doxygen
state	See the `StateArg` doxygen

Returns: The functor evaluated at the requested state and space

Implements Moose::FunctorBase< T >.

Definition at line 1167 of file MooseFunctor.h.

  {
    return _wrapped->operator()(qp, state);
  }

◆ evaluate() [5/6]

template<typename T >

virtual ValueType Moose::FunctorEnvelope< T >::evaluate	(	const FaceArg &	face,
		const StateArg &	state
	)		const

inlineoverrideprotectedvirtual

Parameters

face	See the `FaceArg` doxygen
state	See the `StateArg` doxygen

Returns: The functor evaluated at the requested state and space

Implements Moose::FunctorBase< T >.

Definition at line 1159 of file MooseFunctor.h.

  {
    return _wrapped->operator()(face, state);
  }

◆ evaluate() [6/6]

template<typename T >

virtual ValueType Moose::FunctorEnvelope< T >::evaluate	(	const NodeArg &	node,
		const StateArg &	state
	)		const

inlineoverrideprotectedvirtual

Implements Moose::FunctorBase< T >.

Definition at line 1175 of file MooseFunctor.h.

  {
    return _wrapped->operator()(node, state);
  }

◆ evaluateDot() [1/6]

template<typename T >

virtual DotType Moose::FunctorEnvelope< T >::evaluateDot	(	const ElemArg &	,
		const StateArg &
	)		const

inlineoverrideprotectedvirtual

Evaluate the functor time derivative with a given element.

Some example implementations of this method could compute an element-average or evaluate at the element centroid

Reimplemented from Moose::FunctorBase< T >.

Definition at line 1207 of file MooseFunctor.h.

  {
    return _wrapped->dot(elem, state);
  }

◆ evaluateDot() [2/6]

template<typename T >

virtual DotType Moose::FunctorEnvelope< T >::evaluateDot	(	const ElemPointArg &	,
		const StateArg &
	)		const

inlineoverrideprotectedvirtual

Evaluate the functor time derivative with a given element and point.

Reimplemented from Moose::FunctorBase< T >.

Definition at line 1223 of file MooseFunctor.h.

  {
    return _wrapped->dot(elem_point, state);
  }

◆ evaluateDot() [3/6]

template<typename T >

virtual DotType Moose::FunctorEnvelope< T >::evaluateDot	(	const ElemQpArg &	,
		const StateArg &
	)		const

inlineoverrideprotectedvirtual

Parameters

qp	See the `ElemQpArg` doxygen
state	See the `StateArg` doxygen

Returns: The functor time derivative evaluated at the requested state and space

Reimplemented from Moose::FunctorBase< T >.

Definition at line 1215 of file MooseFunctor.h.

  {
    return _wrapped->dot(qp, state);
  }

◆ evaluateDot() [4/6]

template<typename T >

virtual DotType Moose::FunctorEnvelope< T >::evaluateDot	(	const ElemSideQpArg &	,
		const StateArg &
	)		const

inlineoverrideprotectedvirtual

Parameters

side_qp	See the `ElemSideQpArg` doxygen
state	See the `StateArg` doxygen

Returns: The functor time derivative evaluated at the requested state and space

Reimplemented from Moose::FunctorBase< T >.

Definition at line 1219 of file MooseFunctor.h.

  {
    return _wrapped->dot(qp, state);
  }

◆ evaluateDot() [5/6]

template<typename T >

virtual DotType Moose::FunctorEnvelope< T >::evaluateDot	(	const FaceArg &	,
		const StateArg &
	)		const

inlineoverrideprotectedvirtual

Parameters

face	See the `FaceArg` doxygen
state	See the `StateArg` doxygen

Returns: The functor time derivative evaluated at the requested state and space

Reimplemented from Moose::FunctorBase< T >.

Definition at line 1211 of file MooseFunctor.h.

  {
    return _wrapped->dot(face, state);
  }

◆ evaluateDot() [6/6]

template<typename T >

virtual DotType Moose::FunctorEnvelope< T >::evaluateDot	(	const NodeArg &	node,
		const StateArg &	state
	)		const

inlineoverrideprotectedvirtual

Reimplemented from Moose::FunctorBase< T >.

Definition at line 1228 of file MooseFunctor.h.

  {
    return _wrapped->dot(node, state);
  }

◆ evaluateGradDot() [1/6]

template<typename T >

virtual GradientType Moose::FunctorEnvelope< T >::evaluateGradDot	(	const ElemArg &	,
		const StateArg &
	)		const

inlineoverrideprotectedvirtual

Evaluate the functor gradient-dot with a given element.

Some example implementations of this method could compute an element-average or evaluate at the element centroid

Reimplemented from Moose::FunctorBase< T >.

Definition at line 1233 of file MooseFunctor.h.

  {
    return _wrapped->gradDot(elem, state);
  }

◆ evaluateGradDot() [2/6]

template<typename T >

virtual GradientType Moose::FunctorEnvelope< T >::evaluateGradDot	(	const ElemPointArg &	,
		const StateArg &
	)		const

inlineoverrideprotectedvirtual

Evaluate the functor gradient-dot with a given element and point.

Reimplemented from Moose::FunctorBase< T >.

Definition at line 1250 of file MooseFunctor.h.

  {
    return _wrapped->gradDot(elem_point, state);
  }

◆ evaluateGradDot() [3/6]

template<typename T >

virtual GradientType Moose::FunctorEnvelope< T >::evaluateGradDot	(	const ElemQpArg &	,
		const StateArg &
	)		const

inlineoverrideprotectedvirtual

Parameters

qp	See the `ElemQpArg` doxygen
state	See the `StateArg` doxygen

Returns: The functor gradient-dot evaluated at the requested state and space

Reimplemented from Moose::FunctorBase< T >.

Definition at line 1241 of file MooseFunctor.h.

  {
    return _wrapped->gradDot(qp, state);
  }

◆ evaluateGradDot() [4/6]

template<typename T >

virtual GradientType Moose::FunctorEnvelope< T >::evaluateGradDot	(	const ElemSideQpArg &	,
		const StateArg &
	)		const

inlineoverrideprotectedvirtual

Parameters

side_qp	See the `ElemSideQpArg` doxygen
state	See the `StateArg` doxygen

Returns: The functor gradient-dot evaluated at the requested state and space

Reimplemented from Moose::FunctorBase< T >.

Definition at line 1245 of file MooseFunctor.h.

  {
    return _wrapped->gradDot(qp, state);
  }

◆ evaluateGradDot() [5/6]

template<typename T >

virtual GradientType Moose::FunctorEnvelope< T >::evaluateGradDot	(	const FaceArg &	,
		const StateArg &
	)		const

inlineoverrideprotectedvirtual

Parameters

face	See the `FaceArg` doxygen
state	See the `StateArg` doxygen

Returns: The functor gradient-dot evaluated at the requested state and space

Reimplemented from Moose::FunctorBase< T >.

Definition at line 1237 of file MooseFunctor.h.

  {
    return _wrapped->gradDot(face, state);
  }

◆ evaluateGradDot() [6/6]

template<typename T >

virtual GradientType Moose::FunctorEnvelope< T >::evaluateGradDot	(	const NodeArg &	node,
		const StateArg &	state
	)		const

inlineoverrideprotectedvirtual

Reimplemented from Moose::FunctorBase< T >.

Definition at line 1255 of file MooseFunctor.h.

  {
    return _wrapped->gradDot(node, state);
  }

◆ evaluateGradient() [1/6]

template<typename T >

virtual GradientType Moose::FunctorEnvelope< T >::evaluateGradient	(	const ElemArg &	,
		const StateArg &
	)		const

inlineoverrideprotectedvirtual

Evaluate the functor gradient with a given element.

Some example implementations of this method could compute an element-average or evaluate at the element centroid

Reimplemented from Moose::FunctorBase< T >.

Definition at line 1180 of file MooseFunctor.h.

  {
    return _wrapped->gradient(elem, state);
  }

◆ evaluateGradient() [2/6]

template<typename T >

virtual GradientType Moose::FunctorEnvelope< T >::evaluateGradient	(	const ElemPointArg &	,
		const StateArg &
	)		const

inlineoverrideprotectedvirtual

Evaluate the functor gradient with a given element and point.

Reimplemented from Moose::FunctorBase< T >.

Definition at line 1197 of file MooseFunctor.h.

  {
    return _wrapped->gradient(elem_point, state);
  }

◆ evaluateGradient() [3/6]

template<typename T >

virtual GradientType Moose::FunctorEnvelope< T >::evaluateGradient	(	const ElemQpArg &	,
		const StateArg &
	)		const

inlineoverrideprotectedvirtual

Parameters

qp	See the `ElemQpArg` doxygen
state	See the `StateArg` doxygen

Returns: The functor gradient evaluated at the requested state and space

Reimplemented from Moose::FunctorBase< T >.

Definition at line 1188 of file MooseFunctor.h.

  {
    return _wrapped->gradient(qp, state);
  }

◆ evaluateGradient() [4/6]

template<typename T >

virtual GradientType Moose::FunctorEnvelope< T >::evaluateGradient	(	const ElemSideQpArg &	,
		const StateArg &
	)		const

inlineoverrideprotectedvirtual

Parameters

side_qp	See the `ElemSideQpArg` doxygen
state	See the `StateArg` doxygen

Returns: The functor gradient evaluated at the requested state and space

Reimplemented from Moose::FunctorBase< T >.

Definition at line 1192 of file MooseFunctor.h.

  {
    return _wrapped->gradient(qp, state);
  }

◆ evaluateGradient() [5/6]

template<typename T >

virtual GradientType Moose::FunctorEnvelope< T >::evaluateGradient	(	const FaceArg &	,
		const StateArg &
	)		const

inlineoverrideprotectedvirtual

Parameters

face	See the `FaceArg` doxygen
state	See the `StateArg` doxygen

Returns: The functor gradient evaluated at the requested state and space

Reimplemented from Moose::FunctorBase< T >.

Definition at line 1184 of file MooseFunctor.h.

  {
    return _wrapped->gradient(face, state);
  }

◆ evaluateGradient() [6/6]

template<typename T >

virtual GradientType Moose::FunctorEnvelope< T >::evaluateGradient	(	const NodeArg &	node,
		const StateArg &	state
	)		const

inlineoverrideprotectedvirtual

Reimplemented from Moose::FunctorBase< T >.

Definition at line 1202 of file MooseFunctor.h.

  {
    return _wrapped->gradient(node, state);
  }

◆ functorName()

template<typename T >

const MooseFunctorName & Moose::FunctorBase< T >::functorName ( ) const

inlineinherited

Return the functor name.

Definition at line 176 of file MooseFunctor.h.

176{ return _functor_name; }

◆ genericEvaluate()

template<typename T >

template<FunctorEvaluationKind FET, typename Space , typename State >

FunctorReturnType< T, FET >::type Moose::FunctorBase< T >::genericEvaluate	(	const Space &	r,
		const State &	state
	)		const

inherited

Perform a generic evaluation based on the supplied template argument FET and supplied spatial and temporal arguments.

Definition at line 993 of file MooseFunctor.h.

{
  if constexpr (FET == FunctorEvaluationKind::Value)
    return (*this)(r, state);
  else if constexpr (FET == FunctorEvaluationKind::Gradient)
    return gradient(r, state);
  else if constexpr (FET == FunctorEvaluationKind::Dot)
    return dot(r, state);
  else
    return gradDot(r, state);
}

◆ gradDot() [1/6]

template<typename T >

FunctorBase< T >::GradientType Moose::FunctorBase< T >::gradDot	(	const ElemArg &	elem,
		const StateArg &	state
	)		const

inherited

Same as their evaluateGradDot overloads with the same arguments but allows for caching implementation.

These are the methods a user will call in their code

Definition at line 939 of file MooseFunctor.h.

{
  return evaluateGradDot(elem, state);
}

Referenced by Moose::ADWrapperFunctor< T >::evaluateGradDot(), Moose::VectorComponentFunctor< T >::evaluateGradDot(), Moose::ADWrapperFunctor< T >::evaluateGradDot(), Moose::ADWrapperFunctor< T >::evaluateGradDot(), Moose::ADWrapperFunctor< T >::evaluateGradDot(), Moose::ADWrapperFunctor< T >::evaluateGradDot(), Moose::VectorComponentFunctor< T >::evaluateGradDot(), and Moose::ADWrapperFunctor< T >::evaluateGradDot().

◆ gradDot() [2/6]

template<typename T >

FunctorBase< T >::GradientType Moose::FunctorBase< T >::gradDot	(	const ElemPointArg &	elem_point,
		const StateArg &	state
	)		const

inherited

Definition at line 968 of file MooseFunctor.h.

{
  return evaluateGradDot(elem_point, state);
}

◆ gradDot() [3/6]

template<typename T >

FunctorBase< T >::GradientType Moose::FunctorBase< T >::gradDot	(	const ElemQpArg &	qp,
		const StateArg &	state
	)		const

inherited

Definition at line 954 of file MooseFunctor.h.

{
  return evaluateGradDot(elem_qp, state);
}

◆ gradDot() [4/6]

template<typename T >

FunctorBase< T >::GradientType Moose::FunctorBase< T >::gradDot	(	const ElemSideQpArg &	qp,
		const StateArg &	state
	)		const

inherited

Definition at line 961 of file MooseFunctor.h.

{
  return evaluateGradDot(elem_side_qp, state);
}

◆ gradDot() [5/6]

template<typename T >

FunctorBase< T >::GradientType Moose::FunctorBase< T >::gradDot	(	const FaceArg &	face,
		const StateArg &	state
	)		const

inherited

Definition at line 946 of file MooseFunctor.h.

{
  checkFace(face);
  return evaluateGradDot(face, state);
}

◆ gradDot() [6/6]

template<typename T >

FunctorBase< T >::GradientType Moose::FunctorBase< T >::gradDot	(	const NodeArg &	node,
		const StateArg &	state
	)		const

inherited

Definition at line 975 of file MooseFunctor.h.

{
  return evaluateGradDot(node, state);
}

◆ gradient() [1/6]

template<typename T >

FunctorBase< T >::GradientType Moose::FunctorBase< T >::gradient	(	const ElemArg &	elem,
		const StateArg &	state
	)		const

inherited

Same as their evaluateGradient overloads with the same arguments but allows for caching implementation.

These are the methods a user will call in their code

Definition at line 853 of file MooseFunctor.h.

{
  return evaluateGradient(elem, state);
}

◆ gradient() [2/6]

template<typename T >

FunctorBase< T >::GradientType Moose::FunctorBase< T >::gradient	(	const ElemPointArg &	elem_point,
		const StateArg &	state
	)		const

inherited

Definition at line 882 of file MooseFunctor.h.

{
  return evaluateGradient(elem_point, state);
}

◆ gradient() [3/6]

template<typename T >

FunctorBase< T >::GradientType Moose::FunctorBase< T >::gradient	(	const ElemQpArg &	qp,
		const StateArg &	state
	)		const

inherited

Definition at line 868 of file MooseFunctor.h.

{
  return evaluateGradient(elem_qp, state);
}

◆ gradient() [4/6]

template<typename T >

FunctorBase< T >::GradientType Moose::FunctorBase< T >::gradient	(	const ElemSideQpArg &	qp,
		const StateArg &	state
	)		const

inherited

Definition at line 875 of file MooseFunctor.h.

{
  return evaluateGradient(elem_side_qp, state);
}

◆ gradient() [5/6]

template<typename T >

FunctorBase< T >::GradientType Moose::FunctorBase< T >::gradient	(	const FaceArg &	face,
		const StateArg &	state
	)		const

inherited

Definition at line 860 of file MooseFunctor.h.

{
  checkFace(face);
  return evaluateGradient(face, state);
}

◆ gradient() [6/6]

template<typename T >

FunctorBase< T >::GradientType Moose::FunctorBase< T >::gradient	(	const NodeArg &	node,
		const StateArg &	state
	)		const

inherited

Definition at line 889 of file MooseFunctor.h.

{
  return evaluateGradient(node, state);
}

◆ hasBlocks()

template<typename T >

virtual bool Moose::FunctorEnvelope< T >::hasBlocks ( const SubdomainID ) const

inlineoverridevirtual

Returns whether the functor is defined on this block.

Reimplemented from Moose::FunctorBase< T >.

Definition at line 1141 of file MooseFunctor.h.

1141{ return _wrapped->hasBlocks(id); }

◆ hasFaceSide()

template<typename T >

virtual bool Moose::FunctorEnvelope< T >::hasFaceSide	(	const FaceInfo &	fi,
		const bool	fi_elem_side
	)		const

inlineoverridevirtual

Reimplemented from Moose::FunctorBase< T >.

Definition at line 1142 of file MooseFunctor.h.

  {
    return _wrapped->hasFaceSide(fi, fi_elem_side);
  }

◆ isConstant()

template<typename T >

virtual bool Moose::FunctorEnvelope< T >::isConstant ( ) const

inlineoverridevirtual

Returns true if this functor is a constant.

Reimplemented from Moose::FunctorBase< T >.

Definition at line 1140 of file MooseFunctor.h.

1140{ return _wrapped->isConstant(); }

◆ isExtrapolatedBoundaryFace()

template<typename T >

virtual bool Moose::FunctorEnvelope< T >::isExtrapolatedBoundaryFace	(	const FaceInfo &	,
		const Elem *const	,
		const StateArg &
	)		const

inlineoverridevirtual

Returns whether this (sided) face is an extrapolated boundary face for this functor.

Reimplemented from Moose::FunctorBase< T >.

Definition at line 1134 of file MooseFunctor.h.

  {
    return _wrapped->isExtrapolatedBoundaryFace(fi, elem, state);
  }

◆ isInternalFace()

template<typename T >

bool Moose::FunctorBase< T >::isInternalFace ( const FaceInfo & fi ) const

inherited

Returns true if the face is an internal face.

Definition at line 575 of file MooseFunctor.h.

{
  if (!fi.neighborPtr())
    return false;
 
  return hasBlocks(fi.elem().subdomain_id()) && hasBlocks(fi.neighborPtr()->subdomain_id());
}

Referenced by FVAnisotropicDiffusion::computeQpResidual(), and FVDiffusion::computeQpResidual().

◆ jacobianSetup()

template<typename T >

void Moose::FunctorBase< T >::jacobianSetup ( )

overridevirtualinherited

Implements Moose::FunctorAbstract.

Reimplemented in MooseLinearVariableFV< OutputType >, MooseLinearVariableFV< ComputeValueType >, MooseLinearVariableFV< Real >, MooseLinearVariableFV< RealEigenVector >, MooseLinearVariableFV< RealVectorValue >, MooseLinearVariableFV< T >, MooseVariableFE< OutputType >, MooseVariableFE< ComputeValueType >, MooseVariableFE< Real >, MooseVariableFE< RealEigenVector >, MooseVariableFE< RealVectorValue >, MooseVariableFE< T >, MooseVariableField< OutputType >, MooseVariableField< ComputeValueType >, MooseVariableField< Real >, MooseVariableField< RealEigenVector >, MooseVariableField< RealVectorValue >, MooseVariableField< T >, MooseVariableFV< OutputType >, MooseVariableFV< ComputeValueType >, MooseVariableFV< Real >, MooseVariableFV< RealEigenVector >, MooseVariableFV< RealVectorValue >, MooseVariableFV< T >, and Function.

Definition at line 837 of file MooseFunctor.h.

{
  if (_clearance_schedule.count(EXEC_NONLINEAR))
    clearCacheData();
}

Referenced by Function::jacobianSetup().

◆ operator()() [1/6]

template<typename T >

FunctorBase< T >::ValueType Moose::FunctorBase< T >::operator()	(	const ElemArg &	elem,
		const StateArg &	state
	)		const

inherited

Same as their evaluate overloads with the same arguments but allows for caching implementation.

These are the methods a user will call in their code

Definition at line 603 of file MooseFunctor.h.

{
  if (_always_evaluate)
    return evaluate(elem, state);
 
  mooseAssert(state.state == 0,
              "Cached evaluations are only currently supported for the current state.");
 
  return queryFVArgCache(_elem_arg_to_value, elem);
}

◆ operator()() [2/6]

template<typename T >

FunctorBase< T >::ValueType Moose::FunctorBase< T >::operator()	(	const ElemPointArg &	elem_point,
		const StateArg &	state
	)		const

inherited

Definition at line 713 of file MooseFunctor.h.

{
  return evaluate(elem_point, state);
}

◆ operator()() [3/6]

template<typename T >

FunctorBase< T >::ValueType Moose::FunctorBase< T >::operator()	(	const ElemQpArg &	qp,
		const StateArg &	state
	)		const

inherited

Definition at line 662 of file MooseFunctor.h.

{
  if (_always_evaluate)
    return evaluate(elem_qp, state);
 
  const auto elem_id = elem_qp.elem->id();
  if (elem_id != _current_qp_map_key)
  {
    _current_qp_map_key = elem_id;
    _current_qp_map_value = &_qp_to_value[elem_id];
  }
  auto & qp_data = *_current_qp_map_value;
  const auto qp = elem_qp.qp;
  const auto * const qrule = elem_qp.qrule;
  mooseAssert(qrule, "qrule must be non-null");
 
  return queryQpCache(qp, *qrule, qp_data, elem_qp, state);
}

◆ operator()() [4/6]

template<typename T >

FunctorBase< T >::ValueType Moose::FunctorBase< T >::operator()	(	const ElemSideQpArg &	qp,
		const StateArg &	state
	)		const

inherited

Definition at line 683 of file MooseFunctor.h.

{
  if (_always_evaluate)
    return evaluate(elem_side_qp, state);
 
  const Elem * const elem = elem_side_qp.elem;
  mooseAssert(elem, "elem must be non-null");
  const auto elem_id = elem->id();
  if (elem_id != _current_side_qp_map_key)
  {
    _current_side_qp_map_key = elem_id;
    _current_side_qp_map_value = &_side_qp_to_value[elem_id];
  }
  auto & side_qp_data = *_current_side_qp_map_value;
  const auto side = elem_side_qp.side;
  const auto qp = elem_side_qp.qp;
  const auto * const qrule = elem_side_qp.qrule;
  mooseAssert(qrule, "qrule must be non-null");
 
  // Check and see whether we even have sized for this side
  if (side >= side_qp_data.size())
    side_qp_data.resize(elem->n_sides());
 
  // Ok we were sized enough for our side
  auto & qp_data = side_qp_data[side];
  return queryQpCache(qp, *qrule, qp_data, elem_side_qp, state);
}

◆ operator()() [5/6]

template<typename T >

FunctorBase< T >::ValueType Moose::FunctorBase< T >::operator()	(	const FaceArg &	face,
		const StateArg &	state
	)		const

inherited

Definition at line 616 of file MooseFunctor.h.

{
  checkFace(face_in);
 
  if (_always_evaluate)
    return evaluate(face_in, state);
 
  mooseAssert(state.state == 0,
              "Cached evaluations are only currently supported for the current state.");
 
  return queryFVArgCache(_face_arg_to_value, face_in);
}

◆ operator()() [6/6]

template<typename T >

FunctorBase< T >::ValueType Moose::FunctorBase< T >::operator()	(	const NodeArg &	node,
		const StateArg &	state
	)		const

inherited

Definition at line 730 of file MooseFunctor.h.

{
  mooseAssert(node.subdomain_ids, "Subdomain IDs must be supplied to the node argument");
  return evaluate(node, state);
}

◆ operator=() [1/2]

template<typename T >

FunctorEnvelope & Moose::FunctorEnvelope< T >::operator= ( const FunctorEnvelope< T > & )

delete

◆ operator=() [2/2]

template<typename T >

FunctorEnvelope & Moose::FunctorEnvelope< T >::operator= ( FunctorEnvelope< T > && )

delete

◆ ownsWrappedFunctor()

template<typename T >

virtual bool Moose::FunctorEnvelope< T >::ownsWrappedFunctor ( ) const

inlineoverridevirtual

Returns: Whether this envelope owns its wrapped functor. This envelope may briefly own null functors during simulation setup or it may own non-AD or AD wrappers of "true" functors, but we should never own any "true" functors, e.g. we expect memory of "true" functors to be managed by warehouses (e.g. variable, function, etc.), or by the SubProblem itself. With this expectation, we don't have to worry about performing setup calls

Implements Moose::FunctorEnvelopeBase.

Definition at line 1123 of file MooseFunctor.h.

1123{ return _owned.get(); }

◆ queryFVArgCache()

template<typename T >

template<typename SpaceArg >

FunctorBase< T >::ValueType Moose::FunctorBase< T >::queryFVArgCache	(	std::map< SpaceArg, ValueType > &	cache_data,
		const SpaceArg &	space
	)		const

privateinherited

check a finite volume spatial argument cache and if invalid then evaluate

Definition at line 586 of file MooseFunctor.h.

{
  // We don't want to evaluate if the key already exists, so instead we value initialize
  auto [it, inserted] = cache_data.try_emplace(space, ValueType());
  auto & value = it->second;
 
  if (inserted)
    // value not ready to go
    // this function is only called from functions that assert we are in the current time state
    value = evaluate(space, currentState());
 
  return value;
}

◆ queryQpCache()

template<typename T >

template<typename SpaceArg , typename StateArg >

FunctorBase< T >::ValueType Moose::FunctorBase< T >::queryQpCache	(	unsigned int	qp,
		const libMesh::QBase &	qrule,
		std::vector< std::pair< bool, T > > &	qp_cache_data,
		const SpaceArg &	space,
		const StateArg &	state
	)		const

privateinherited

check a qp cache and if invalid then evaluate

Definition at line 632 of file MooseFunctor.h.

{
  // Check and see whether we even have sized for this quadrature point. If we haven't then we
  // must evaluate
  if (qp >= qp_cache_data.size())
  {
    qp_cache_data.resize(qrule.n_points(), std::make_pair(false, ValueType()));
    auto & pr = qp_cache_data[qp];
    pr.second = evaluate(space, state);
    pr.first = true;
    return pr.second;
  }
 
  // We've already sized for this qp, so let's see whether we have a valid cache value
  auto & pr = qp_cache_data[qp];
  if (pr.first)
    return pr.second;
 
  // No valid cache value so evaluate
  pr.second = evaluate(space, state);
  pr.first = true;
  return pr.second;
}

◆ residualSetup()

template<typename T >

void Moose::FunctorBase< T >::residualSetup ( )

overridevirtualinherited

Implements Moose::FunctorAbstract.

Reimplemented in MooseLinearVariableFV< OutputType >, MooseLinearVariableFV< ComputeValueType >, MooseLinearVariableFV< Real >, MooseLinearVariableFV< RealEigenVector >, MooseLinearVariableFV< RealVectorValue >, MooseLinearVariableFV< T >, MooseVariableFE< OutputType >, MooseVariableFE< ComputeValueType >, MooseVariableFE< Real >, MooseVariableFE< RealEigenVector >, MooseVariableFE< RealVectorValue >, MooseVariableFE< T >, MooseVariableField< OutputType >, MooseVariableField< ComputeValueType >, MooseVariableField< Real >, MooseVariableField< RealEigenVector >, MooseVariableField< RealVectorValue >, MooseVariableField< T >, MooseVariableFV< OutputType >, MooseVariableFV< ComputeValueType >, MooseVariableFV< Real >, MooseVariableFV< RealEigenVector >, MooseVariableFV< RealVectorValue >, MooseVariableFV< T >, and Function.

Definition at line 829 of file MooseFunctor.h.

{
  if (_clearance_schedule.count(EXEC_LINEAR))
    clearCacheData();
}

Referenced by Function::residualSetup().

◆ returnType()

template<typename T >

virtual std::string Moose::FunctorEnvelope< T >::returnType ( ) const

inlineoverridevirtual

Returns: a string representation of the return type of this functor

Implements Moose::FunctorEnvelopeBase.

Definition at line 1121 of file MooseFunctor.h.

1121{ return libMesh::demangle(typeid(T).name()); }

libMesh::Quality::name

std::string name(const ElemQuality q)

libMesh::demangle

std::string demangle(const char *name)

◆ setCacheClearanceSchedule()

template<typename T >

void Moose::FunctorBase< T >::setCacheClearanceSchedule ( const std::set< ExecFlagType > & clearance_schedule )

inherited

Set how often to clear the functor evaluation cache.

Definition at line 720 of file MooseFunctor.h.

{
  if (clearance_schedule.count(EXEC_ALWAYS))
    _always_evaluate = true;
 
  _clearance_schedule = clearance_schedule;
}

◆ supportsElemSideQpArg()

template<typename T >

bool Moose::FunctorEnvelope< T >::supportsElemSideQpArg ( ) const

inlinefinaloverridevirtual

Whether this functor supports evaluation with ElemSideQpArg.

Implements Moose::FunctorBase< T >.

Definition at line 1148 of file MooseFunctor.h.

1148{ return true; }

◆ supportsFaceArg()

template<typename T >

bool Moose::FunctorEnvelope< T >::supportsFaceArg ( ) const

inlinefinaloverridevirtual

Whether this functor supports evaluation with FaceArg.

Implements Moose::FunctorBase< T >.

Definition at line 1147 of file MooseFunctor.h.

1147{ return true; }

◆ timestepSetup()

template<typename T >

void Moose::FunctorBase< T >::timestepSetup ( )

overridevirtualinherited

Implements Moose::FunctorAbstract.

Reimplemented in Function, MemoryUsage, NumNonlinearIterations, MooseLinearVariableFV< OutputType >, MooseLinearVariableFV< ComputeValueType >, MooseLinearVariableFV< Real >, MooseLinearVariableFV< RealEigenVector >, MooseLinearVariableFV< RealVectorValue >, MooseLinearVariableFV< T >, MooseVariableField< OutputType >, MooseVariableField< ComputeValueType >, MooseVariableField< Real >, MooseVariableField< RealEigenVector >, MooseVariableField< RealVectorValue >, MooseVariableField< T >, MooseVariableFV< OutputType >, MooseVariableFV< ComputeValueType >, MooseVariableFV< Real >, MooseVariableFV< RealEigenVector >, MooseVariableFV< RealVectorValue >, and MooseVariableFV< T >.

Definition at line 821 of file MooseFunctor.h.

{
  if (_clearance_schedule.count(EXEC_TIMESTEP_BEGIN))
    clearCacheData();
}

Referenced by Function::timestepSetup().

◆ wrapsNull()

template<typename T >

virtual bool Moose::FunctorEnvelope< T >::wrapsNull ( ) const

inlineoverridevirtual

Returns: whether this object wraps a null functor

Implements Moose::FunctorEnvelopeBase.

Definition at line 1116 of file MooseFunctor.h.

1116{ return wrapsType<NullFunctor<T>>(); }

◆ wrapsType()

template<typename T >

template<typename T2 >

bool Moose::FunctorEnvelope< T >::wrapsType ( ) const

inline

Returns: whether the wrapped object is of the requested type

Definition at line 1129 of file MooseFunctor.h.

  {
    return dynamic_cast<const T2 *>(_wrapped);
  }

Friends And Related Symbol Documentation

◆ ::SubProblem

template<typename T >

friend class ::SubProblem

friend

Definition at line 1266 of file MooseFunctor.h.

Member Data Documentation

◆ _always_evaluate

template<typename T >

bool Moose::FunctorBase< T >::_always_evaluate

privateinherited

Boolean to check if we always need evaluation.

Definition at line 523 of file MooseFunctor.h.

◆ _clearance_schedule

template<typename T >

std::set<ExecFlagType> Moose::FunctorBase< T >::_clearance_schedule

privateinherited

How often to clear the material property cache.

Definition at line 520 of file MooseFunctor.h.

◆ _current_qp_map_key

template<typename T >

dof_id_type Moose::FunctorBase< T >::_current_qp_map_key = libMesh::DofObject::invalid_id

mutableprivateinherited

Current key for qp map cache.

Definition at line 529 of file MooseFunctor.h.

◆ _current_qp_map_value

template<typename T >

std::vector<std::pair<bool, ValueType> >* Moose::FunctorBase< T >::_current_qp_map_value = nullptr

mutableprivateinherited

Current value for qp map cache.

Definition at line 532 of file MooseFunctor.h.

◆ _current_side_qp_map_key

template<typename T >

dof_id_type Moose::FunctorBase< T >::_current_side_qp_map_key = libMesh::DofObject::invalid_id

mutableprivateinherited

Current key for side-qp map cache.

Definition at line 545 of file MooseFunctor.h.

◆ _current_side_qp_map_value

template<typename T >

std::vector<std::vector<std::pair<bool, ValueType> > >* Moose::FunctorBase< T >::_current_side_qp_map_value

mutableprivateinherited

Initial value:

=

nullptr

Current value for side-qp map cache.

Definition at line 548 of file MooseFunctor.h.

◆ _elem_arg_to_value

template<typename T >

std::map<ElemArg, ValueType> Moose::FunctorBase< T >::_elem_arg_to_value

mutableprivateinherited

Map from element arguments to their cached evaluations.

Definition at line 561 of file MooseFunctor.h.

◆ _face_arg_to_value

template<typename T >

std::map<FaceArg, ValueType> Moose::FunctorBase< T >::_face_arg_to_value

mutableprivateinherited

Map from face arguments to their cached evaluations.

Definition at line 564 of file MooseFunctor.h.

◆ _functor_name

template<typename T >

MooseFunctorName Moose::FunctorBase< T >::_functor_name

privateinherited

name of the functor

Definition at line 570 of file MooseFunctor.h.

Referenced by Moose::FunctorBase< T >::functorName().

◆ _node_arg_to_value

template<typename T >

std::map<NodeArg, ValueType> Moose::FunctorBase< T >::_node_arg_to_value

mutableprivateinherited

Map from nodal arguments to their cached evaluations.

Definition at line 567 of file MooseFunctor.h.

◆ _owned

template<typename T >

std::unique_ptr<FunctorBase<T> > Moose::FunctorEnvelope< T >::_owned

private

Our wrapped object.

Definition at line 1263 of file MooseFunctor.h.

Referenced by Moose::FunctorEnvelope< T >::assign(), Moose::FunctorEnvelope< T >::assign(), and Moose::FunctorEnvelope< T >::ownsWrappedFunctor().

◆ _qp_to_value

template<typename T >

std::unordered_map<dof_id_type, std::vector<std::pair<bool, ValueType> > > Moose::FunctorBase< T >::_qp_to_value

mutableprivateinherited

Cached element quadrature point functor property evaluations.

The map key is the element id. The map values should have size corresponding to the number of quadrature points on the element. The vector elements are pairs. The first member of the pair indicates whether a cached value has been computed. The second member of the pair is the (cached) value. If the boolean is false, then the value cannot be trusted

Definition at line 539 of file MooseFunctor.h.

◆ _side_qp_to_value

template<typename T >

std::unordered_map<dof_id_type, std::vector<std::vector<std::pair<bool, ValueType> > > > Moose::FunctorBase< T >::_side_qp_to_value

mutableprivateinherited

Cached element quadrature point functor property evaluations.

The map key is the element id. The map values are a multi-dimensional vector (or vector of vectors) with the first index corresponding to the side and the second index corresponding to the quadrature point index. The elements returned after double indexing are pairs. The first member of the pair indicates whether a cached value has been computed. The second member of the pair is the (cached) value. If the boolean is false, then the value cannot be trusted

Definition at line 558 of file MooseFunctor.h.

◆ _wrapped

template<typename T >

const FunctorBase<T>* Moose::FunctorEnvelope< T >::_wrapped

private

Definition at line 1264 of file MooseFunctor.h.

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

include/base/MooseFunctor.h

Public Types

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ DotType

◆ FunctorType

◆ GradientType

◆ ValueType

Constructor & Destructor Documentation

◆ FunctorEnvelope() [1/5]

◆ FunctorEnvelope() [2/5]

◆ FunctorEnvelope() [3/5]

◆ FunctorEnvelope() [4/5]

◆ FunctorEnvelope() [5/5]

◆ ~FunctorEnvelope()

Member Function Documentation

◆ assign() [1/3]

◆ assign() [2/3]

◆ assign() [3/3]

◆ checkFace()

◆ clearCacheData()

◆ customSetup()

◆ dot() [1/6]

◆ dot() [2/6]

◆ dot() [3/6]

◆ dot() [4/6]

◆ dot() [5/6]

◆ dot() [6/6]

◆ evaluate() [1/6]

◆ evaluate() [2/6]

◆ evaluate() [3/6]

◆ evaluate() [4/6]

◆ evaluate() [5/6]

◆ evaluate() [6/6]

◆ evaluateDot() [1/6]

◆ evaluateDot() [2/6]

◆ evaluateDot() [3/6]

◆ evaluateDot() [4/6]

◆ evaluateDot() [5/6]

◆ evaluateDot() [6/6]

◆ evaluateGradDot() [1/6]

◆ evaluateGradDot() [2/6]

◆ evaluateGradDot() [3/6]

◆ evaluateGradDot() [4/6]

◆ evaluateGradDot() [5/6]

◆ evaluateGradDot() [6/6]

◆ evaluateGradient() [1/6]

◆ evaluateGradient() [2/6]

◆ evaluateGradient() [3/6]

◆ evaluateGradient() [4/6]

◆ evaluateGradient() [5/6]

◆ evaluateGradient() [6/6]

◆ functorName()

◆ genericEvaluate()

◆ gradDot() [1/6]

◆ gradDot() [2/6]

◆ gradDot() [3/6]

◆ gradDot() [4/6]

◆ gradDot() [5/6]

◆ gradDot() [6/6]

◆ gradient() [1/6]

◆ gradient() [2/6]

◆ gradient() [3/6]

◆ gradient() [4/6]

◆ gradient() [5/6]

◆ gradient() [6/6]

◆ hasBlocks()

◆ hasFaceSide()

◆ isConstant()

◆ isExtrapolatedBoundaryFace()

◆ isInternalFace()

◆ jacobianSetup()

◆ operator()() [1/6]

◆ operator()() [2/6]

◆ operator()() [3/6]

◆ operator()() [4/6]