Wraps non-AD functors such that they can be used in objects that have requested the functor as AD. More...

#include <ADWrapperFunctor.h>

Inheritance diagram for Moose::ADWrapperFunctor< T >:

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). More...

using	DotType = ValueType

Public Member Functions
	ADWrapperFunctor (const FunctorBase< typename MetaPhysicL::RawType< T >::value_type > &non_ad_functor)

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

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

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

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. More...

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

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. More...

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

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. More...

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

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


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

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. More...

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. More...

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. More...

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

ValueType	evaluate (const ElemArg &elem, const StateArg &state) const override
	Forward calls to wrapped object. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Private Attributes
const FunctorBase< typename MetaPhysicL::RawType< T >::value_type > &	_non_ad_functor
	Our wrapped AD object. More...

Detailed Description

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

Wraps non-AD functors such that they can be used in objects that have requested the functor as AD.

Definition at line 20 of file ADWrapperFunctor.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

◆ ADWrapperFunctor()

template<typename T >

Moose::ADWrapperFunctor< T >::ADWrapperFunctor ( const FunctorBase< typename MetaPhysicL::RawType< T >::value_type > & non_ad_functor )

inline

Definition at line 27 of file ADWrapperFunctor.h.

     : FunctorBase<T>(non_ad_functor.functorName() + "_ad_ified", {EXEC_ALWAYS}),
       _non_ad_functor(non_ad_functor)
   {
   }

Member Function Documentation

◆ 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 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 732 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
 }

◆ customSetup()

template<typename T >

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

overridevirtualinherited

Implements Moose::FunctorAbstract.

Reimplemented in Function.

Definition at line 839 of file MooseFunctor.h.

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

◆ 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 890 of file MooseFunctor.h.

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

 {
   return evaluateDot(elem, state);
 }

◆ dot() [2/6]

template<typename T >

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

inherited

Definition at line 897 of file MooseFunctor.h.

 {
   checkFace(face);
   return evaluateDot(face, 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 905 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 912 of file MooseFunctor.h.

 {
   return evaluateDot(elem_side_qp, state);
 }

◆ dot() [5/6]

template<typename T >

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

inherited

Definition at line 919 of file MooseFunctor.h.

 {
   return evaluateDot(elem_point, 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 926 of file MooseFunctor.h.

 {
   return evaluateDot(node, state);
 }

◆ evaluate() [1/6]

template<typename T >

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

inlineoverrideprotectedvirtual

Forward calls to wrapped object.

Implements Moose::FunctorBase< T >.

Definition at line 60 of file ADWrapperFunctor.h.

   {
     return _non_ad_functor(elem, state);
   }

◆ evaluate() [2/6]

template<typename T >

ValueType Moose::ADWrapperFunctor< 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 64 of file ADWrapperFunctor.h.

   {
     return _non_ad_functor(face, state);
   }

◆ evaluate() [3/6]

template<typename T >

ValueType Moose::ADWrapperFunctor< 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 68 of file ADWrapperFunctor.h.

   {
     return _non_ad_functor(qp, state);
   }

◆ evaluate() [4/6]

template<typename T >

ValueType Moose::ADWrapperFunctor< 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 72 of file ADWrapperFunctor.h.

   {
     return _non_ad_functor(qp, state);
   }

◆ evaluate() [5/6]

template<typename T >

ValueType Moose::ADWrapperFunctor< 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 76 of file ADWrapperFunctor.h.

   {
     return _non_ad_functor(elem_point, state);
   }

◆ evaluate() [6/6]

template<typename T >

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

inlineoverrideprotectedvirtual

Implements Moose::FunctorBase< T >.

Definition at line 80 of file ADWrapperFunctor.h.

   {
     return _non_ad_functor(node, state);
   }

◆ evaluateDot() [1/6]

template<typename T >

DotType Moose::ADWrapperFunctor< 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 111 of file ADWrapperFunctor.h.

   {
     return _non_ad_functor.dot(elem, state);
   }

◆ evaluateDot() [2/6]

template<typename T >

DotType Moose::ADWrapperFunctor< 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 115 of file ADWrapperFunctor.h.

   {
     return _non_ad_functor.dot(face, state);
   }

◆ evaluateDot() [3/6]

template<typename T >

DotType Moose::ADWrapperFunctor< 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 119 of file ADWrapperFunctor.h.

   {
     return _non_ad_functor.dot(qp, state);
   }

◆ evaluateDot() [4/6]

template<typename T >

DotType Moose::ADWrapperFunctor< 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 123 of file ADWrapperFunctor.h.

   {
     return _non_ad_functor.dot(qp, state);
   }

◆ evaluateDot() [5/6]

template<typename T >

DotType Moose::ADWrapperFunctor< 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 127 of file ADWrapperFunctor.h.

   {
     return _non_ad_functor.dot(elem_point, state);
   }

◆ evaluateDot() [6/6]

template<typename T >

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

inlineoverrideprotectedvirtual

Reimplemented from Moose::FunctorBase< T >.

Definition at line 131 of file ADWrapperFunctor.h.

   {
     return _non_ad_functor.dot(node, state);
   }

◆ evaluateGradDot() [1/6]

template<typename T >

GradientType Moose::ADWrapperFunctor< 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 136 of file ADWrapperFunctor.h.

   {
     return _non_ad_functor.gradDot(elem, state);
   }

◆ evaluateGradDot() [2/6]

template<typename T >

GradientType Moose::ADWrapperFunctor< 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 140 of file ADWrapperFunctor.h.

   {
     return _non_ad_functor.gradDot(face, state);
   }

◆ evaluateGradDot() [3/6]

template<typename T >

GradientType Moose::ADWrapperFunctor< 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 144 of file ADWrapperFunctor.h.

   {
     return _non_ad_functor.gradDot(qp, state);
   }

◆ evaluateGradDot() [4/6]

template<typename T >

GradientType Moose::ADWrapperFunctor< 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 148 of file ADWrapperFunctor.h.

   {
     return _non_ad_functor.gradDot(qp, state);
   }

◆ evaluateGradDot() [5/6]

template<typename T >

GradientType Moose::ADWrapperFunctor< 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 152 of file ADWrapperFunctor.h.

   {
     return _non_ad_functor.gradDot(elem_point, state);
   }

◆ evaluateGradDot() [6/6]

template<typename T >

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

inlineoverrideprotectedvirtual

Reimplemented from Moose::FunctorBase< T >.

Definition at line 157 of file ADWrapperFunctor.h.

   {
     return _non_ad_functor.gradDot(node, state);
   }

◆ evaluateGradient() [1/6]

template<typename T >

GradientType Moose::ADWrapperFunctor< 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 85 of file ADWrapperFunctor.h.

   {
     return _non_ad_functor.gradient(elem, state);
   }

◆ evaluateGradient() [2/6]

template<typename T >

GradientType Moose::ADWrapperFunctor< 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 89 of file ADWrapperFunctor.h.

   {
     return _non_ad_functor.gradient(face, state);
   }

◆ evaluateGradient() [3/6]

template<typename T >

GradientType Moose::ADWrapperFunctor< 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 93 of file ADWrapperFunctor.h.

   {
     return _non_ad_functor.gradient(qp, state);
   }

◆ evaluateGradient() [4/6]

template<typename T >

GradientType Moose::ADWrapperFunctor< 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 97 of file ADWrapperFunctor.h.

   {
     return _non_ad_functor.gradient(qp, state);
   }

◆ evaluateGradient() [5/6]

template<typename T >

GradientType Moose::ADWrapperFunctor< 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 101 of file ADWrapperFunctor.h.

   {
     return _non_ad_functor.gradient(elem_point, state);
   }

◆ evaluateGradient() [6/6]

template<typename T >

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

inlineoverrideprotectedvirtual

Reimplemented from Moose::FunctorBase< T >.

Definition at line 106 of file ADWrapperFunctor.h.

   {
     return _non_ad_functor.gradient(node, state);
   }

◆ functorName()

template<typename T>

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

inlineinherited

Return the functor name.

Definition at line 170 of file MooseFunctor.h.

Referenced by Moose::FunctorBase< libMesh::VectorValue >::evaluateDot(), Moose::FunctorBase< libMesh::VectorValue >::evaluateGradDot(), Moose::FunctorBase< libMesh::VectorValue >::evaluateGradient(), and Moose::FunctorBase< libMesh::VectorValue >::hasBlocks().

170 { return _functor_name; }

Moose::FunctorBase::_functor_name

MooseFunctorName _functor_name

name of the functor

Definition: MooseFunctor.h:564

◆ 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 987 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 933 of file MooseFunctor.h.

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

 {
   return evaluateGradDot(elem, state);
 }

◆ gradDot() [2/6]

template<typename T >

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

inherited

Definition at line 940 of file MooseFunctor.h.

 {
   checkFace(face);
   return evaluateGradDot(face, 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 948 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 955 of file MooseFunctor.h.

 {
   return evaluateGradDot(elem_side_qp, state);
 }

◆ gradDot() [5/6]

template<typename T >

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

inherited

Definition at line 962 of file MooseFunctor.h.

 {
   return evaluateGradDot(elem_point, 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 969 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 847 of file MooseFunctor.h.

Referenced by GradientJumpIndicator::computeQpIntegral(), Moose::FV::containerInterpolate(), Moose::VectorComponentFunctor< T >::evaluateGradient(), Moose::ADWrapperFunctor< T >::evaluateGradient(), and Moose::FV::greenGaussGradient().

 {
   return evaluateGradient(elem, state);
 }

◆ gradient() [2/6]

template<typename T >

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

inherited

Definition at line 854 of file MooseFunctor.h.

 {
   checkFace(face);
   return evaluateGradient(face, 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 862 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 869 of file MooseFunctor.h.

 {
   return evaluateGradient(elem_side_qp, state);
 }

◆ gradient() [5/6]

template<typename T >

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

inherited

Definition at line 876 of file MooseFunctor.h.

 {
   return evaluateGradient(elem_point, 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 883 of file MooseFunctor.h.

 {
   return evaluateGradient(node, state);
 }

◆ hasBlocks()

template<typename T >

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

inlineoverridevirtual

Returns whether the functor is defined on this block.

Reimplemented from Moose::FunctorBase< T >.

Definition at line 40 of file ADWrapperFunctor.h.

   {
     return _non_ad_functor.hasBlocks(id);
   }

◆ hasFaceSide()

template<typename T >

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

inlineoverridevirtual

Reimplemented from Moose::FunctorBase< T >.

Definition at line 44 of file ADWrapperFunctor.h.

   {
     return _non_ad_functor.hasFaceSide(fi, fi_elem_side);
   }

◆ isConstant()

template<typename T >

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

inlineoverridevirtual

Returns true if this functor is a constant.

Reimplemented from Moose::FunctorBase< T >.

Definition at line 39 of file ADWrapperFunctor.h.

39 { return _non_ad_functor.isConstant(); }

Moose::ADWrapperFunctor::_non_ad_functor

const FunctorBase< typename MetaPhysicL::RawType< T >::value_type > & _non_ad_functor

Our wrapped AD object.

Definition: ADWrapperFunctor.h:165

Moose::FunctorBase::isConstant

virtual bool isConstant() const

Returns true if this functor is a constant.

Definition: MooseFunctor.h:260

◆ isExtrapolatedBoundaryFace()

template<typename T >

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

inlineoverridevirtual

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

Reimplemented from Moose::FunctorBase< T >.

Definition at line 33 of file ADWrapperFunctor.h.

   {
     return _non_ad_functor.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 569 of file MooseFunctor.h.

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

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

◆ jacobianSetup()

template<typename T >

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

overridevirtualinherited

Implements Moose::FunctorAbstract.

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

Definition at line 831 of file MooseFunctor.h.

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

◆ 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 597 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 FaceArg &	face,
		const StateArg &	state
	)		const

inherited

Definition at line 610 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()() [3/6]

template<typename T >

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

inherited

Definition at line 656 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 677 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 ElemPointArg &	elem_point,
		const StateArg &	state
	)		const

inherited

Definition at line 707 of file MooseFunctor.h.

 {
   return evaluate(elem_point, state);
 }

◆ operator()() [6/6]

template<typename T >

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

inherited

Definition at line 724 of file MooseFunctor.h.

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

◆ residualSetup()

template<typename T >

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

overridevirtualinherited

Implements Moose::FunctorAbstract.

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

Definition at line 823 of file MooseFunctor.h.

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

◆ 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 714 of file MooseFunctor.h.

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

◆ supportsElemSideQpArg()

template<typename T >

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

inlinefinaloverridevirtual

Whether this functor supports evaluation with ElemSideQpArg.

Implements Moose::FunctorBase< T >.

Definition at line 50 of file ADWrapperFunctor.h.

   {
     return _non_ad_functor.supportsElemSideQpArg();
   }

◆ supportsFaceArg()

template<typename T >

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

inlinefinaloverridevirtual

Whether this functor supports evaluation with FaceArg.

Implements Moose::FunctorBase< T >.

Definition at line 49 of file ADWrapperFunctor.h.

49 { return _non_ad_functor.supportsFaceArg(); }

Moose::ADWrapperFunctor::_non_ad_functor

const FunctorBase< typename MetaPhysicL::RawType< T >::value_type > & _non_ad_functor

Our wrapped AD object.

Definition: ADWrapperFunctor.h:165

Moose::FunctorBase::supportsFaceArg

virtual bool supportsFaceArg() const =0

Whether this functor supports evaluation with FaceArg.

◆ timestepSetup()

template<typename T >

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

overridevirtualinherited

Implements Moose::FunctorAbstract.

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

Definition at line 815 of file MooseFunctor.h.

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

Member Data Documentation

◆ _non_ad_functor

template<typename T >

const FunctorBase<typename MetaPhysicL::RawType<T>::value_type>& Moose::ADWrapperFunctor< T >::_non_ad_functor

private

Our wrapped AD object.

Definition at line 165 of file ADWrapperFunctor.h.

Referenced by Moose::ADWrapperFunctor< T >::evaluate(), Moose::ADWrapperFunctor< T >::evaluateDot(), Moose::ADWrapperFunctor< T >::evaluateGradDot(), Moose::ADWrapperFunctor< T >::evaluateGradient(), Moose::ADWrapperFunctor< T >::hasBlocks(), Moose::ADWrapperFunctor< T >::hasFaceSide(), Moose::ADWrapperFunctor< T >::isConstant(), Moose::ADWrapperFunctor< T >::isExtrapolatedBoundaryFace(), Moose::ADWrapperFunctor< T >::supportsElemSideQpArg(), and Moose::ADWrapperFunctor< T >::supportsFaceArg().

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

include/utils/ADWrapperFunctor.h

Public Types

Public Member Functions

Protected Member Functions

Private Attributes

Detailed Description

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

Member Typedef Documentation

◆ DotType

◆ FunctorType

◆ GradientType

◆ ValueType

Constructor & Destructor Documentation

◆ ADWrapperFunctor()

Member Function Documentation

◆ checkFace()

◆ 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]

◆ operator()() [5/6]

◆ operator()() [6/6]

◆ residualSetup()

◆ setCacheClearanceSchedule()

◆ supportsElemSideQpArg()

◆ supportsFaceArg()

◆ timestepSetup()

Member Data Documentation

◆ _non_ad_functor

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