A functor whose evaluation relies on querying a map where the keys are face info ids and the values correspond to the face values. More...

#include <FaceCenteredMapFunctor.h>

Inheritance diagram for FaceCenteredMapFunctor< T, Map >:

[legend]

Public Types
using	ElemArg = Moose::ElemArg

using	FaceArg = Moose::FaceArg

using	ElemQpArg = Moose::ElemQpArg

using	ElemSideQpArg = Moose::ElemSideQpArg

using	ElemPointArg = Moose::ElemPointArg

using	StateArg = Moose::StateArg

using	NodeArg = Moose::NodeArg

typedef FunctorBase< T >	FunctorType

typedef T	ValueType

typedef typename FunctorReturnType< T, FunctorEvaluationKind::Gradient >::type	GradientType

typedef ValueType	DotType

Public Member Functions
	FaceCenteredMapFunctor (const MooseMesh &mesh, const std::string &name)

	FaceCenteredMapFunctor (const MooseMesh &mesh, const std::set< SubdomainID > &sub_ids, const std::string &name)

bool	hasBlocks (SubdomainID sub_id) const override

ValueType	evaluate (const FaceInfo *const fi) const
	Evaluate the face functor using a FaceInfo argument.

bool	supportsFaceArg () const override final

bool	supportsElemSideQpArg () const override final

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

const MooseFunctorName &	functorName () const

virtual void	residualSetup () override

virtual void	jacobianSetup () override

virtual void	timestepSetup () override

virtual void	customSetup (const ExecFlagType &exec_type) override

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

virtual bool	isExtrapolatedBoundaryFace (const FaceInfo &, const Elem *, const StateArg &) const

bool	isInternalFace (const FaceInfo &) const

virtual bool	isConstant () const

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

void	checkFace (const Moose::FaceArg &face) const

ValueType	operator() (const ElemArg &elem, const StateArg &state) const

ValueType	operator() (const FaceArg &face, const StateArg &state) const

ValueType	operator() (const ElemQpArg &qp, const StateArg &state) const

ValueType	operator() (const ElemSideQpArg &qp, const StateArg &state) const

ValueType	operator() (const ElemPointArg &elem_point, const StateArg &state) const

ValueType	operator() (const NodeArg &node, const StateArg &state) const

ValueType	operator() (const ElemArg &elem, const StateArg &state) const

ValueType	operator() (const FaceArg &face, const StateArg &state) const

ValueType	operator() (const ElemQpArg &qp, const StateArg &state) const

ValueType	operator() (const ElemSideQpArg &qp, const StateArg &state) const

ValueType	operator() (const ElemPointArg &elem_point, const StateArg &state) const

ValueType	operator() (const NodeArg &node, const StateArg &state) const

GradientType	gradient (const ElemArg &elem, const StateArg &state) const

GradientType	gradient (const FaceArg &face, const StateArg &state) const

GradientType	gradient (const ElemQpArg &qp, const StateArg &state) const

GradientType	gradient (const ElemSideQpArg &qp, const StateArg &state) const

GradientType	gradient (const ElemPointArg &elem_point, const StateArg &state) const

GradientType	gradient (const NodeArg &node, const StateArg &state) const

GradientType	gradient (const ElemArg &elem, const StateArg &state) const

GradientType	gradient (const FaceArg &face, const StateArg &state) const

GradientType	gradient (const ElemQpArg &qp, const StateArg &state) const

GradientType	gradient (const ElemSideQpArg &qp, const StateArg &state) const

GradientType	gradient (const ElemPointArg &elem_point, const StateArg &state) const

GradientType	gradient (const NodeArg &node, const StateArg &state) const

DotType	dot (const ElemArg &elem, const StateArg &state) const

DotType	dot (const FaceArg &face, const StateArg &state) const

DotType	dot (const ElemQpArg &qp, const StateArg &state) const

DotType	dot (const ElemSideQpArg &qp, const StateArg &state) const

DotType	dot (const ElemPointArg &elem_point, const StateArg &state) const

DotType	dot (const NodeArg &node, const StateArg &state) const

DotType	dot (const ElemArg &elem, const StateArg &state) const

DotType	dot (const FaceArg &face, const StateArg &state) const

DotType	dot (const ElemQpArg &qp, const StateArg &state) const

DotType	dot (const ElemSideQpArg &qp, const StateArg &state) const

DotType	dot (const ElemPointArg &elem_point, const StateArg &state) const

DotType	dot (const NodeArg &node, const StateArg &state) const

GradientType	gradDot (const ElemArg &elem, const StateArg &state) const

GradientType	gradDot (const FaceArg &face, const StateArg &state) const

GradientType	gradDot (const ElemQpArg &qp, const StateArg &state) const

GradientType	gradDot (const ElemSideQpArg &qp, const StateArg &state) const

GradientType	gradDot (const ElemPointArg &elem_point, const StateArg &state) const

GradientType	gradDot (const NodeArg &node, const StateArg &state) const

GradientType	gradDot (const ElemArg &elem, const StateArg &state) const

GradientType	gradDot (const FaceArg &face, const StateArg &state) const

GradientType	gradDot (const ElemQpArg &qp, const StateArg &state) const

GradientType	gradDot (const ElemSideQpArg &qp, const StateArg &state) const

GradientType	gradDot (const ElemPointArg &elem_point, const StateArg &state) const

GradientType	gradDot (const NodeArg &node, const StateArg &state) const

Protected Member Functions
virtual GradientType	evaluateGradient (const ElemArg &, const StateArg &) const

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Private Member Functions
ValueType	evaluate (const ElemArg &, const StateArg &) const override final

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

ValueType	evaluate (const ElemPointArg &, const StateArg &) const override

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

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

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

void	clearCacheData ()

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

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

Private Attributes
const MooseMesh &	_mesh
	The mesh that this functor lives on.

const std::set< SubdomainID >	_sub_ids
	The subdomain IDs that this functor lives on.

std::set< ExecFlagType >	_clearance_schedule

bool	_always_evaluate

dof_id_type	_current_qp_map_key

std::vector< std::pair< bool, ValueType > > *	_current_qp_map_value

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

dof_id_type	_current_side_qp_map_key

std::vector< std::vector< std::pair< bool, ValueType > > > *	_current_side_qp_map_value

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

std::map< ElemArg, ValueType >	_elem_arg_to_value

std::map< FaceArg, ValueType >	_face_arg_to_value

std::map< NodeArg, ValueType >	_node_arg_to_value

MooseFunctorName	_functor_name

Detailed Description

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

A functor whose evaluation relies on querying a map where the keys are face info ids and the values correspond to the face values.

The primary purpose of this functor is to store face based fields (face flux, face velocity, normal gradient) often encountered in fluid dynamics problems using the finite volume method

Definition at line 25 of file FaceCenteredMapFunctor.h.

Member Typedef Documentation

◆ ElemArg

template<typename T , typename Map >

using FaceCenteredMapFunctor< T, Map >::ElemArg = Moose::ElemArg

Definition at line 31 of file FaceCenteredMapFunctor.h.

◆ ElemPointArg

template<typename T , typename Map >

using FaceCenteredMapFunctor< T, Map >::ElemPointArg = Moose::ElemPointArg

Definition at line 35 of file FaceCenteredMapFunctor.h.

◆ ElemQpArg

template<typename T , typename Map >

using FaceCenteredMapFunctor< T, Map >::ElemQpArg = Moose::ElemQpArg

Definition at line 33 of file FaceCenteredMapFunctor.h.

◆ ElemSideQpArg

template<typename T , typename Map >

using FaceCenteredMapFunctor< T, Map >::ElemSideQpArg = Moose::ElemSideQpArg

Definition at line 34 of file FaceCenteredMapFunctor.h.

◆ FaceArg

template<typename T , typename Map >

using FaceCenteredMapFunctor< T, Map >::FaceArg = Moose::FaceArg

Definition at line 32 of file FaceCenteredMapFunctor.h.

◆ NodeArg

template<typename T , typename Map >

using FaceCenteredMapFunctor< T, Map >::NodeArg = Moose::NodeArg

Definition at line 37 of file FaceCenteredMapFunctor.h.

◆ StateArg

template<typename T , typename Map >

using FaceCenteredMapFunctor< T, Map >::StateArg = Moose::StateArg

Definition at line 36 of file FaceCenteredMapFunctor.h.

Constructor & Destructor Documentation

◆ FaceCenteredMapFunctor() [1/2]

template<typename T , typename Map >

FaceCenteredMapFunctor< T, Map >::FaceCenteredMapFunctor	(	const MooseMesh &	mesh,
		const std::string &	name
	)

Definition at line 73 of file FaceCenteredMapFunctor.h.

  : Moose::FunctorBase<T>(name), _mesh(mesh)
{
}

◆ FaceCenteredMapFunctor() [2/2]

template<typename T , typename Map >

FaceCenteredMapFunctor< T, Map >::FaceCenteredMapFunctor	(	const MooseMesh &	mesh,
		const std::set< SubdomainID > &	sub_ids,
		const std::string &	name
	)

Definition at line 80 of file FaceCenteredMapFunctor.h.

  : Moose::FunctorBase<T>(name),
    _mesh(mesh),
    _sub_ids(sub_ids == mesh.meshSubdomains() ? std::set<SubdomainID>() : sub_ids)
{
}

Member Function Documentation

◆ evaluate() [1/7]

template<typename T , typename Map >

FaceCenteredMapFunctor< T, Map >::ValueType FaceCenteredMapFunctor< T, Map >::evaluate	(	const ElemArg &	elem_arg,
		const StateArg &
	)		const

finaloverrideprivatevirtual

Implements Moose::FunctorBase< T >.

Definition at line 45 of file FaceCenteredMapFunctor.C.

{
  // The following reconstruction is based on Weller's method. For more information on this,
  // we recommend:
  //
  // Weller, Hilary. "Non-orthogonal version of the arbitrary polygonal C-grid and a new diamond
  // grid." Geoscientific Model Development 7.3 (2014): 779-797.
  //
  // and
  //
  // Aguerre, Horacio J., et al. "An oscillation-free flow solver based on flux reconstruction."
  // Journal of Computational Physics 365 (2018): 135-148.
  //
  // This basically reconstructs the cell value based on flux values as follows:
  //
  // $\left( \sum_f n_f \outer S_f \right)^{-1} \sum_f (\phi_f \cdot S_f)n_f$
  //
  // where $S_f$ is the surface normal vector, $n_f$ is the unit surface vector and $\phi_f$ is a
  // vector value on the field. Hence the restriction to vector values.
 
  using ValueType = typename FaceCenteredMapFunctor<T, Map>::ValueType;
 
  // Primitive type one rank below the type of the stored data (T). If we are storing a rank two
  // tensor, this is a vector, if we are storing a vector this is just a number
  using PrimitiveType = typename MetaPhysicL::ReplaceAlgebraicType<
      T,
      typename TensorTools::DecrementRank<typename MetaPhysicL::ValueType<T>::type>::type>::type;
 
  if constexpr (libMesh::TensorTools::TensorTraits<ValueType>::rank == 1)
  {
    const auto dim = _mesh.dimension();
    // The reason why these are DenseVector/Matrix is that when the mesh dimension is lower than 3,
    // we get singular matrixes if we try to invert TensorValues.
    DenseMatrix<PrimitiveType> n_x_Sf(dim, dim);
    DenseVector<PrimitiveType> sum_normal_flux(dim);
 
    const Elem * const elem = elem_arg.elem;
 
    for (const auto side : make_range(elem->n_sides()))
    {
      const Elem * const neighbor = elem->neighbor_ptr(side);
 
      // We need to check if the faceinfo belongs to the element or the neighbor. Based on that we
      // query the faceinfo and adjust the normal to point outward of the current cell
      const bool elem_has_fi = Moose::FV::elemHasFaceInfo(*elem, neighbor);
      const FaceInfo * const fi = _mesh.faceInfo(
          elem_has_fi ? elem : neighbor, elem_has_fi ? side : neighbor->which_neighbor_am_i(elem));
      const Point & normal = elem_has_fi ? fi->normal() : Point(-fi->normal());
 
      const Point area_vector = normal * fi->faceArea();
      const ValueType face_value = this->evaluate(fi);
 
      const auto product = Moose::outer_product(normal, area_vector);
 
      const auto flux_contrib = normal * (face_value * area_vector);
      for (const auto i : make_range(dim))
      {
        sum_normal_flux(i) += flux_contrib(i);
        for (const auto j : make_range(dim))
          n_x_Sf(i, j) += product(i, j);
      }
    }
 
    // We do the inversion of the surface vector matrix here. It is symmetric
    // and small so we can do it using a Cholesky decomposition.
    DenseVector<PrimitiveType> dense_result(dim);
    n_x_Sf.cholesky_solve(sum_normal_flux, dense_result);
 
    ValueType result;
    for (const auto i : make_range(dim))
      result(i) = dense_result(i);
 
    return result;
  }
  else
  {
    (void)elem_arg; // WE do this because the GCC min complains that it is not used and
                    // [[maybe_unused]] doesnt work for GCC min
    mooseError("Cell center reconstruction is not implemented!");
  }
}

◆ evaluate() [2/7]

template<typename T , typename Map >

FaceCenteredMapFunctor< T, Map >::ValueType FaceCenteredMapFunctor< T, Map >::evaluate	(	const ElemPointArg &	,
		const StateArg &
	)		const

overrideprivatevirtual

Implements Moose::FunctorBase< T >.

Definition at line 98 of file FaceCenteredMapFunctor.h.

{
  mooseError("not implemented");
}

◆ evaluate() [3/7]

template<typename T , typename Map >

FaceCenteredMapFunctor< T, Map >::ValueType FaceCenteredMapFunctor< T, Map >::evaluate	(	const ElemQpArg &	,
		const StateArg &
	)		const

overrideprivatevirtual

Implements Moose::FunctorBase< T >.

Definition at line 105 of file FaceCenteredMapFunctor.h.

{
  mooseError("not implemented");
}

◆ evaluate() [4/7]

template<typename T , typename Map >

FaceCenteredMapFunctor< T, Map >::ValueType FaceCenteredMapFunctor< T, Map >::evaluate	(	const ElemSideQpArg &	,
		const StateArg &
	)		const

overrideprivatevirtual

Implements Moose::FunctorBase< T >.

Definition at line 112 of file FaceCenteredMapFunctor.h.

{
  mooseError("not implemented");
}

◆ evaluate() [5/7]

template<typename T , typename Map >

FaceCenteredMapFunctor< T, Map >::ValueType FaceCenteredMapFunctor< T, Map >::evaluate	(	const FaceArg &	face,
		const StateArg &
	)		const

finaloverrideprivatevirtual

Implements Moose::FunctorBase< T >.

Definition at line 129 of file FaceCenteredMapFunctor.C.

{
  return this->evaluate(face.fi);
}

◆ evaluate() [6/7]

template<typename T , typename Map >

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

Evaluate the face functor using a FaceInfo argument.

Parameters

fi	The object containing the face information

Definition at line 136 of file FaceCenteredMapFunctor.C.

{
  auto it = this->find(fi->id());
  if (it == this->end())
  {
    if (!_sub_ids.empty() && !_sub_ids.count(fi->elem().subdomain_id()))
    {
      if (fi->neighborPtr() && !_sub_ids.count(fi->neighborPtr()->subdomain_id()))
        mooseError("Attempted to evaluate FaceCenteredMapFunctor '",
                   this->functorName(),
                   "' with an element subdomain id of '",
                   fi->elem().subdomain_id(),
                   fi->neighborPtr() ? " or neighbor subdomain id of '" +
                                           std::to_string(fi->neighborPtr()->subdomain_id()) + "'"
                                     : "",
                   "' but that subdomain id is not one of the subdomain ids the functor is "
                   "restricted to.");
    }
    else
      mooseError("Attempted access into FaceCenteredMapFunctor '",
                 this->functorName(),
                 "' with a key that does not yet exist in the map. Make sure to fill your "
                 "FaceCenteredMapFunctor for all elements you will attempt to access later.");
 
    return typename FaceCenteredMapFunctor<T, Map>::ValueType();
  }
 
  return it->second;
}

Referenced by RhieChowMassFlux::getMassFlux(), and INSFVRhieChowInterpolatorSegregated::getVelocity().

◆ evaluate() [7/7]

template<typename T , typename Map >

FaceCenteredMapFunctor< T, Map >::ValueType FaceCenteredMapFunctor< T, Map >::evaluate	(	const NodeArg &	,
		const StateArg &
	)		const

finaloverrideprivatevirtual

Implements Moose::FunctorBase< T >.

Definition at line 119 of file FaceCenteredMapFunctor.h.

{
  mooseError("not implemented");
}

◆ hasBlocks()

template<typename T , typename Map >

bool FaceCenteredMapFunctor< T, Map >::hasBlocks ( SubdomainID sub_id ) const

overridevirtual

Reimplemented from Moose::FunctorBase< T >.

Reimplemented in FictionalFaceCenteredMapFunctor< T, Map >.

Definition at line 91 of file FaceCenteredMapFunctor.h.

{
  return _sub_ids.empty() || _sub_ids.count(sub_id);
}

◆ supportsElemSideQpArg()

template<typename T , typename Map >

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

inlinefinaloverridevirtual

Implements Moose::FunctorBase< T >.

Definition at line 54 of file FaceCenteredMapFunctor.h.

54{ return false; }

◆ supportsFaceArg()

template<typename T , typename Map >

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

inlinefinaloverridevirtual

Implements Moose::FunctorBase< T >.

Definition at line 53 of file FaceCenteredMapFunctor.h.

53{ return true; }

Member Data Documentation

◆ _mesh

template<typename T , typename Map >

const MooseMesh& FaceCenteredMapFunctor< T, Map >::_mesh

private

The mesh that this functor lives on.

Definition at line 58 of file FaceCenteredMapFunctor.h.

◆ _sub_ids

template<typename T , typename Map >

const std::set<SubdomainID> FaceCenteredMapFunctor< T, Map >::_sub_ids

private

The subdomain IDs that this functor lives on.

If empty, then we consider the functor to live on all subdomains

Definition at line 62 of file FaceCenteredMapFunctor.h.

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

navier_stokes/include/utils/FaceCenteredMapFunctor.h
navier_stokes/src/utils/FaceCenteredMapFunctor.C

Public Types

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ ElemArg

◆ ElemPointArg

◆ ElemQpArg

◆ ElemSideQpArg

◆ FaceArg

◆ NodeArg

◆ StateArg

Constructor & Destructor Documentation

◆ FaceCenteredMapFunctor() [1/2]

◆ FaceCenteredMapFunctor() [2/2]

Member Function Documentation

◆ evaluate() [1/7]

◆ evaluate() [2/7]

◆ evaluate() [3/7]

◆ evaluate() [4/7]

◆ evaluate() [5/7]

◆ evaluate() [6/7]

◆ evaluate() [7/7]

◆ hasBlocks()

◆ supportsElemSideQpArg()

◆ supportsFaceArg()

Member Data Documentation

◆ _mesh

◆ _sub_ids