This is essentially a forwarding functor that forwards the spatial and temporal evaluation arguments to the parent vector functor and then returns the result indexed at a given component. More...

#include <VectorComponentFunctor.h>

Inheritance diagram for Moose::VectorComponentFunctor< T >:

[legend]

Public Types
using	VectorArg = typename libMesh::TensorTools::IncrementRank< T >::type

using	VectorFunctor = FunctorBase< VectorArg >

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
	VectorComponentFunctor (const VectorFunctor &vector, const unsigned int component)

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

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

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.

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

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

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

ValueType	operator() (const PointArg &point, 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

GradientType	gradient (const PointArg &point, 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

DotType	dot (const PointArg &point, 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

GradientType	gradDot (const PointArg &point, const StateArg &state) const

Protected Member Functions
Functor evaluation routines
These methods are all for evaluating functors with different kinds of spatial arguments. Each of these methods also takes a state argument. For a description of the state argument, please see the `StateArg` doxygen
virtual GradientType	evaluateGradient (const ElemQpArg &, const StateArg &) const

virtual GradientType	evaluateGradient (const ElemSideQpArg &, const StateArg &) const

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

virtual GradientType	evaluateGradient (const NodeArg &, const StateArg &) const

virtual GradientType	evaluateGradient (const PointArg &, const StateArg &) const

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

virtual DotType	evaluateDot (const FaceArg &, const StateArg &) const

virtual DotType	evaluateDot (const ElemQpArg &, const StateArg &) const

virtual DotType	evaluateDot (const ElemSideQpArg &, const StateArg &) const

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

virtual DotType	evaluateDot (const NodeArg &, const StateArg &) const

virtual DotType	evaluateDot (const PointArg &, const StateArg &) const

virtual GradientType	evaluateGradDot (const ElemQpArg &, const StateArg &) const

virtual GradientType	evaluateGradDot (const ElemSideQpArg &, const StateArg &) const

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

virtual GradientType	evaluateGradDot (const NodeArg &, const StateArg &) const

virtual GradientType	evaluateGradDot (const PointArg &, const StateArg &) const

Private Member Functions
ValueType	evaluate (const ElemArg &elem, const StateArg &state) const override final
	Evaluate the functor with a given element.

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

ValueType	evaluate (const ElemQpArg &elem_qp, const StateArg &state) const override final

ValueType	evaluate (const ElemSideQpArg &elem_side_qp, const StateArg &state) const override final

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

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

ValueType	evaluate (const PointArg &point, const StateArg &state) const override final
	Evaluate the functor at a physical point without any mesh information.

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

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

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

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

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
const VectorFunctor &	_vector
	The parent vector functor.

const unsigned int	_component
	The component at which we'll index the parent vector functor evaluation result.

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

Detailed Description

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

This is essentially a forwarding functor that forwards the spatial and temporal evaluation arguments to the parent vector functor and then returns the result indexed at a given component.

Definition at line 21 of file VectorComponentFunctor.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.

◆ VectorArg

template<typename T >

using Moose::VectorComponentFunctor< T >::VectorArg = typename libMesh::TensorTools::IncrementRank<T>::type

Definition at line 27 of file VectorComponentFunctor.h.

◆ VectorFunctor

template<typename T >

using Moose::VectorComponentFunctor< T >::VectorFunctor = FunctorBase<VectorArg>

Definition at line 28 of file VectorComponentFunctor.h.

Constructor & Destructor Documentation

◆ VectorComponentFunctor()

template<typename T >

Moose::VectorComponentFunctor< T >::VectorComponentFunctor	(	const VectorFunctor &	vector,
		const unsigned int	component
	)

inline

Definition at line 30 of file VectorComponentFunctor.h.

    : FunctorBase<T>(vector.functorName() + "_" + std::to_string(component)),
      _vector(vector),
      _component(component)
  {
  }

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 \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 773 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 830 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 880 of file MooseFunctor.h.

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

Referenced by Function::customSetup().

◆ dot() [1/7]

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 938 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(), Moose::ADWrapperFunctor< T >::evaluateDot(), and Moose::ADWrapperFunctor< T >::evaluateDot().

◆ dot() [2/7]

template<typename T >

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

inherited

Definition at line 967 of file MooseFunctor.h.

{
  return evaluateDot(elem_point, state);
}

◆ dot() [3/7]

template<typename T >

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

inherited

Definition at line 953 of file MooseFunctor.h.

{
  return evaluateDot(elem_qp, state);
}

◆ dot() [4/7]

template<typename T >

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

inherited

Definition at line 960 of file MooseFunctor.h.

{
  return evaluateDot(elem_side_qp, state);
}

◆ dot() [5/7]

template<typename T >

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

inherited

Definition at line 945 of file MooseFunctor.h.

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

◆ dot() [6/7]

template<typename T >

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

inherited

Definition at line 974 of file MooseFunctor.h.

{
  return evaluateDot(node, state);
}

◆ dot() [7/7]

template<typename T >

FunctorBase< T >::DotType Moose::FunctorBase< T >::dot	(	const PointArg &	point,
		const StateArg &	state
	)		const

inherited

Definition at line 981 of file MooseFunctor.h.

{
  return evaluateDot(point, state);
}

◆ evaluate() [1/7]

template<typename T >

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

inlinefinaloverrideprivatevirtual

Evaluate the functor with a given element.

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

Implements Moose::FunctorBase< T >.

Definition at line 52 of file VectorComponentFunctor.h.

  {
    return _vector(elem, state)(_component);
  }

◆ evaluate() [2/7]

template<typename T >

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

inlinefinaloverrideprivatevirtual

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 73 of file VectorComponentFunctor.h.

  {
    return _vector(elem_point, state)(_component);
  }

◆ evaluate() [3/7]

template<typename T >

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

inlinefinaloverrideprivatevirtual

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 62 of file VectorComponentFunctor.h.

  {
    return _vector(elem_qp, state)(_component);
  }

◆ evaluate() [4/7]

template<typename T >

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

inlinefinaloverrideprivatevirtual

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 67 of file VectorComponentFunctor.h.

  {
    return _vector(elem_side_qp, state)(_component);
  }

◆ evaluate() [5/7]

template<typename T >

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

inlinefinaloverrideprivatevirtual

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 57 of file VectorComponentFunctor.h.

  {
    return _vector(face, state)(_component);
  }

◆ evaluate() [6/7]

template<typename T >

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

inlinefinaloverrideprivatevirtual

Implements Moose::FunctorBase< T >.

Definition at line 78 of file VectorComponentFunctor.h.

  {
    return _vector(node, state)(_component);
  }

◆ evaluate() [7/7]

template<typename T >

ValueType Moose::VectorComponentFunctor< T >::evaluate	(	const PointArg &	,
		const StateArg &
	)		const

inlinefinaloverrideprivatevirtual

Evaluate the functor at a physical point without any mesh information.

Functors that need mesh information, e.g. field variables, do not support this

Reimplemented from Moose::FunctorBase< T >.

Definition at line 83 of file VectorComponentFunctor.h.

  {
    return _vector(point, state)(_component);
  }

◆ evaluateDot() [1/7]

template<typename T >

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

inlineprotectedvirtualinherited

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

Definition at line 409 of file MooseFunctor.h.

  {
    mooseError("Element time derivative not implemented for functor " + functorName());
  }

◆ evaluateDot() [2/7]

template<typename T >

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

inlineprotectedvirtualinherited

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

Definition at line 449 of file MooseFunctor.h.

  {
    mooseError("Element-point time derivative not implemented for functor " + functorName());
  }

◆ evaluateDot() [3/7]

template<typename T >

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

inlineprotectedvirtualinherited

Parameters

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

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

Definition at line 429 of file MooseFunctor.h.

  {
    mooseError("Element quadrature point time derivative not implemented for functor " +
               functorName());
  }

◆ evaluateDot() [4/7]

template<typename T >

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

inlineprotectedvirtualinherited

Parameters

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

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

Definition at line 440 of file MooseFunctor.h.

  {
    mooseError("Element side quadrature point time derivative not implemented for functor " +
               functorName());
  }

◆ evaluateDot() [5/7]

template<typename T >

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

inlineprotectedvirtualinherited

Parameters

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

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

Definition at line 419 of file MooseFunctor.h.

  {
    mooseError("Face time derivative not implemented for functor " + functorName());
  }

◆ evaluateDot() [6/7]

template<typename T >

virtual DotType Moose::FunctorBase< T >::evaluateDot	(	const NodeArg &	,
		const StateArg &
	)		const

inlineprotectedvirtualinherited

Definition at line 454 of file MooseFunctor.h.

  {
    mooseError("Time derivative at node not implemented for functor " + functorName());
  }

◆ evaluateDot() [7/7]

template<typename T >

virtual DotType Moose::FunctorBase< T >::evaluateDot	(	const PointArg &	,
		const StateArg &
	)		const

inlineprotectedvirtualinherited

Definition at line 459 of file MooseFunctor.h.

  {
    mooseError("Time derivative at point not implemented for functor " + functorName());
  }

◆ evaluateGradDot() [1/7]

template<typename T >

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

inlinefinaloverrideprivatevirtual

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 101 of file VectorComponentFunctor.h.

  {
    return _vector.gradDot(elem_arg, state).row(_component);
  }

◆ evaluateGradDot() [2/7]

template<typename T >

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

inlineprotectedvirtualinherited

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

Definition at line 508 of file MooseFunctor.h.

  {
    mooseError("Element-point gradient-dot not implemented for functor " + functorName());
  }

◆ evaluateGradDot() [3/7]

template<typename T >

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

inlineprotectedvirtualinherited

Parameters

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

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

Definition at line 488 of file MooseFunctor.h.

  {
    mooseError("Element quadrature point gradient-dot not implemented for functor " +
               functorName());
  }

◆ evaluateGradDot() [4/7]

template<typename T >

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

inlineprotectedvirtualinherited

Parameters

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

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

Definition at line 499 of file MooseFunctor.h.

  {
    mooseError("Element side quadrature point gradient-dot not implemented for functor " +
               functorName());
  }

◆ evaluateGradDot() [5/7]

template<typename T >

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

inlinefinaloverrideprivatevirtual

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 107 of file VectorComponentFunctor.h.

  {
    return _vector.gradDot(face, state).row(_component);
  }

◆ evaluateGradDot() [6/7]

template<typename T >

virtual GradientType Moose::FunctorBase< T >::evaluateGradDot	(	const NodeArg &	,
		const StateArg &
	)		const

inlineprotectedvirtualinherited

Definition at line 513 of file MooseFunctor.h.

  {
    mooseError("Gradient-dot at node not implemented for functor " + functorName());
  }

◆ evaluateGradDot() [7/7]

template<typename T >

virtual GradientType Moose::FunctorBase< T >::evaluateGradDot	(	const PointArg &	,
		const StateArg &
	)		const

inlineprotectedvirtualinherited

Definition at line 518 of file MooseFunctor.h.

  {
    mooseError("Gradient-dot at point not implemented for functor " + functorName());
  }

◆ evaluateGradient() [1/7]

template<typename T >

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

inlinefinaloverrideprivatevirtual

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 89 of file VectorComponentFunctor.h.

  {
    return _vector.gradient(elem_arg, state).row(_component);
  }

◆ evaluateGradient() [2/7]

template<typename T >

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

inlineprotectedvirtualinherited

Evaluate the functor gradient with a given element and point.

Definition at line 390 of file MooseFunctor.h.

  {
    mooseError("Element-point gradient not implemented for functor " + functorName());
  }

◆ evaluateGradient() [3/7]

template<typename T >

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

inlineprotectedvirtualinherited

Parameters

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

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

Reimplemented in Moose::ConstantFunctor< T >, MooseVariableFE< OutputType >, MooseVariableFE< ComputeValueType >, MooseVariableFE< Real >, MooseVariableFE< RealEigenVector >, MooseVariableFE< RealVectorValue >, MooseVariableFE< T >, Function, Postprocessor, MooseVariableScalar, Moose::FunctorEnvelope< T >, Moose::FunctorEnvelope< ADReal >, Moose::FunctorEnvelope< GenericReal< is_ad > >, Moose::FunctorEnvelope< GenericRealVectorValue< is_ad > >, Moose::FunctorEnvelope< libMesh::VectorValue >, Moose::FunctorEnvelope< Moose::GenericType< Real, is_ad > >, Moose::FunctorEnvelope< Moose::GenericType< T, is_ad > >, Moose::FunctorEnvelope< Real >, Moose::FunctorEnvelope< RealVectorValue >, Moose::FunctorEnvelope< VectorValue< GenericReal< is_ad > > >, Moose::ADWrapperFunctor< T >, Moose::RawValueFunctor< T >, MooseLinearVariableFV< OutputType >, MooseLinearVariableFV< ComputeValueType >, MooseLinearVariableFV< Real >, MooseLinearVariableFV< RealEigenVector >, MooseLinearVariableFV< RealVectorValue >, MooseLinearVariableFV< T >, MooseVariableFV< OutputType >, MooseVariableFV< ComputeValueType >, MooseVariableFV< Real >, MooseVariableFV< RealEigenVector >, MooseVariableFV< RealVectorValue >, and MooseVariableFV< T >.

Definition at line 371 of file MooseFunctor.h.

  {
    mooseError("Element quadrature point gradient not implemented for functor " + functorName());
  }

◆ evaluateGradient() [4/7]

template<typename T >

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

inlineprotectedvirtualinherited

Parameters

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

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

Definition at line 381 of file MooseFunctor.h.

  {
    mooseError("Element side quadrature point gradient not implemented for functor " +
               functorName());
  }

◆ evaluateGradient() [5/7]

template<typename T >

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

inlinefinaloverrideprivatevirtual

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 95 of file VectorComponentFunctor.h.

  {
    return _vector.gradient(face, state).row(_component);
  }

◆ evaluateGradient() [6/7]

template<typename T >

virtual GradientType Moose::FunctorBase< T >::evaluateGradient	(	const NodeArg &	,
		const StateArg &
	)		const

inlineprotectedvirtualinherited

◆ evaluateGradient() [7/7]

template<typename T >

virtual GradientType Moose::FunctorBase< T >::evaluateGradient	(	const PointArg &	,
		const StateArg &
	)		const

inlineprotectedvirtualinherited

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

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 988 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(), Moose::ADWrapperFunctor< T >::evaluateGradDot(), and Moose::ADWrapperFunctor< T >::evaluateGradDot().

◆ gradDot() [2/7]

template<typename T >

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

inherited

Definition at line 1017 of file MooseFunctor.h.

{
  return evaluateGradDot(elem_point, state);
}

◆ gradDot() [3/7]

template<typename T >

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

inherited

Definition at line 1003 of file MooseFunctor.h.

{
  return evaluateGradDot(elem_qp, state);
}

◆ gradDot() [4/7]

template<typename T >

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

inherited

Definition at line 1010 of file MooseFunctor.h.

{
  return evaluateGradDot(elem_side_qp, state);
}

◆ gradDot() [5/7]

template<typename T >

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

inherited

Definition at line 995 of file MooseFunctor.h.

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

◆ gradDot() [6/7]

template<typename T >

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

inherited

Definition at line 1024 of file MooseFunctor.h.

{
  return evaluateGradDot(node, state);
}

◆ gradDot() [7/7]

template<typename T >

FunctorBase< T >::GradientType Moose::FunctorBase< T >::gradDot	(	const PointArg &	point,
		const StateArg &	state
	)		const

inherited

Definition at line 1031 of file MooseFunctor.h.

{
  return evaluateGradDot(point, state);
}

◆ gradient() [1/7]

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

{
  return evaluateGradient(elem, state);
}

◆ gradient() [2/7]

template<typename T >

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

inherited

Definition at line 917 of file MooseFunctor.h.

{
  return evaluateGradient(elem_point, state);
}

◆ gradient() [3/7]

template<typename T >

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

inherited

Definition at line 903 of file MooseFunctor.h.

{
  return evaluateGradient(elem_qp, state);
}

◆ gradient() [4/7]

template<typename T >

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

inherited

Definition at line 910 of file MooseFunctor.h.

{
  return evaluateGradient(elem_side_qp, state);
}

◆ gradient() [5/7]

template<typename T >

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

inherited

Definition at line 895 of file MooseFunctor.h.

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

◆ gradient() [6/7]

template<typename T >

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

inherited

Definition at line 924 of file MooseFunctor.h.

{
  return evaluateGradient(node, state);
}

◆ gradient() [7/7]

template<typename T >

FunctorBase< T >::GradientType Moose::FunctorBase< T >::gradient	(	const PointArg &	point,
		const StateArg &	state
	)		const

inherited

Definition at line 931 of file MooseFunctor.h.

{
  return evaluateGradient(point, state);
}

◆ hasBlocks()

template<typename T >

bool Moose::VectorComponentFunctor< T >::hasBlocks ( SubdomainID ) const

inlineoverridevirtual

Returns whether the functor is defined on this block.

Reimplemented from Moose::FunctorBase< T >.

Definition at line 40 of file VectorComponentFunctor.h.

40{ return _vector.hasBlocks(sub_id); }

Moose::FunctorBase::hasBlocks

virtual bool hasBlocks(SubdomainID) const

Returns whether the functor is defined on this block.

Definition MooseFunctor.h:247

◆ hasFaceSide()

template<typename T >

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

overridevirtualinherited

Implements FaceArgInterface.

Definition at line 1038 of file MooseFunctor.h.

{
  if (fi_elem_side)
    return hasBlocks(fi.elem().subdomain_id());
  else
    return fi.neighborPtr() && hasBlocks(fi.neighbor().subdomain_id());
}

Referenced by InternalSideIntegralVariablePostprocessor::hasFaceSide(), SideIntegralVariablePostprocessor::hasFaceSide(), and Moose::ADWrapperFunctor< T >::hasFaceSide().

◆ isConstant()

template<typename T >

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

inlinevirtualinherited

Returns true if this functor is a constant.

Definition at line 270 of file MooseFunctor.h.

270{ return false; }

Referenced by Moose::ADWrapperFunctor< T >::isConstant().

◆ isExtrapolatedBoundaryFace()

template<typename T >

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

overridevirtual

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

Reimplemented from Moose::FunctorBase< T >.

Definition at line 115 of file VectorComponentFunctor.h.

{
  return _vector.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 603 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 872 of file MooseFunctor.h.

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

Referenced by Function::jacobianSetup().

◆ operator()() [1/7]

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 631 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/7]

template<typename T >

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

inherited

Definition at line 741 of file MooseFunctor.h.

{
  return evaluate(elem_point, state);
}

◆ operator()() [3/7]

template<typename T >

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

inherited

Definition at line 690 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/7]

template<typename T >

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

inherited

Definition at line 711 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/7]

template<typename T >

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

inherited

Definition at line 644 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/7]

template<typename T >

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

inherited

Definition at line 758 of file MooseFunctor.h.

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

◆ operator()() [7/7]

template<typename T >

FunctorBase< T >::ValueType Moose::FunctorBase< T >::operator()	(	const PointArg &	point,
		const StateArg &	state
	)		const

inherited

Definition at line 766 of file MooseFunctor.h.

{
  return evaluate(point, state);
}

◆ 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 614 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 660 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 864 of file MooseFunctor.h.

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

Referenced by Function::residualSetup().

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

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

◆ supportsElemSideQpArg()

template<typename T >

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

inlinefinaloverridevirtual

Whether this functor supports evaluation with ElemSideQpArg.

Implements Moose::FunctorBase< T >.

Definition at line 43 of file VectorComponentFunctor.h.

43{ return _vector.supportsElemSideQpArg(); }

Moose::FunctorBase::supportsElemSideQpArg

virtual bool supportsElemSideQpArg() const =0

Whether this functor supports evaluation with ElemSideQpArg.

◆ supportsFaceArg()

template<typename T >

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

inlinefinaloverridevirtual

Whether this functor supports evaluation with FaceArg.

Implements Moose::FunctorBase< T >.

Definition at line 42 of file VectorComponentFunctor.h.

42{ return _vector.supportsFaceArg(); }

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

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

Referenced by Function::timestepSetup().

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 551 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 548 of file MooseFunctor.h.

◆ _component

template<typename T >

const unsigned int Moose::VectorComponentFunctor< T >::_component

private

The component at which we'll index the parent vector functor evaluation result.

Definition at line 50 of file VectorComponentFunctor.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 557 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 560 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 573 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 576 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 589 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 592 of file MooseFunctor.h.

◆ _functor_name

template<typename T >

MooseFunctorName Moose::FunctorBase< T >::_functor_name

privateinherited

name of the functor

Definition at line 598 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 595 of file MooseFunctor.h.

◆ _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 567 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 586 of file MooseFunctor.h.

◆ _vector

template<typename T >

const VectorFunctor& Moose::VectorComponentFunctor< T >::_vector

private

The parent vector functor.

Definition at line 47 of file VectorComponentFunctor.h.

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

include/utils/VectorComponentFunctor.h

Public Types

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ DotType

◆ FunctorType

◆ GradientType

◆ ValueType

◆ VectorArg

◆ VectorFunctor

Constructor & Destructor Documentation

◆ VectorComponentFunctor()

Member Function Documentation

◆ checkFace()

◆ clearCacheData()

◆ customSetup()

◆ dot() [1/7]

◆ dot() [2/7]

◆ dot() [3/7]

◆ dot() [4/7]

◆ dot() [5/7]

◆ dot() [6/7]

◆ dot() [7/7]

◆ evaluate() [1/7]

◆ evaluate() [2/7]

◆ evaluate() [3/7]

◆ evaluate() [4/7]

◆ evaluate() [5/7]

◆ evaluate() [6/7]

◆ evaluate() [7/7]

◆ evaluateDot() [1/7]

◆ evaluateDot() [2/7]

◆ evaluateDot() [3/7]

◆ evaluateDot() [4/7]

◆ evaluateDot() [5/7]

◆ evaluateDot() [6/7]

◆ evaluateDot() [7/7]

◆ evaluateGradDot() [1/7]

◆ evaluateGradDot() [2/7]

◆ evaluateGradDot() [3/7]

◆ evaluateGradDot() [4/7]

◆ evaluateGradDot() [5/7]

◆ evaluateGradDot() [6/7]

◆ evaluateGradDot() [7/7]

◆ evaluateGradient() [1/7]

◆ evaluateGradient() [2/7]

◆ evaluateGradient() [3/7]

◆ evaluateGradient() [4/7]

◆ evaluateGradient() [5/7]

◆ evaluateGradient() [6/7]

◆ evaluateGradient() [7/7]

◆ functorName()

◆ genericEvaluate()

◆ gradDot() [1/7]

◆ gradDot() [2/7]

◆ gradDot() [3/7]

◆ gradDot() [4/7]

◆ gradDot() [5/7]

◆ gradDot() [6/7]

◆ gradDot() [7/7]

◆ gradient() [1/7]

◆ gradient() [2/7]

◆ gradient() [3/7]

◆ gradient() [4/7]

◆ gradient() [5/7]

◆ gradient() [6/7]

◆ gradient() [7/7]

◆ hasBlocks()

◆ hasFaceSide()

◆ isConstant()

◆ isExtrapolatedBoundaryFace()

◆ isInternalFace()

◆ jacobianSetup()

◆ operator()() [1/7]

◆ operator()() [2/7]

◆ operator()() [3/7]

◆ operator()() [4/7]