FaceInfo Class Reference

This data structure is used to store geometric and variable related metadata about each cell face in the mesh. More...

#include <FaceInfo.h>

Public Types
enum	VarFaceNeighbors { VarFaceNeighbors::BOTH, VarFaceNeighbors::NEITHER, VarFaceNeighbors::ELEM, VarFaceNeighbors::NEIGHBOR }
	This enum is used to indicate which side(s) of a face a particular variable is defined on. More...

Public Member Functions
	FaceInfo (const ElemInfo *elem_info, unsigned int side, const dof_id_type id, libMesh::ElemSideBuilder &side_builder)
dof_id_type	id () const
	Return the ID of the face. More...
Real	faceArea () const
	Returns the face area of face id. More...
Real &	faceCoord ()
	Sets/gets the coordinate transformation factor (for e.g. More...
Real	faceCoord () const
const Point &	normal () const
	Returns the unit normal vector for the face oriented outward from the face's elem element. More...
const Point &	faceCentroid () const
	Returns the coordinates of the face centroid. More...
Point	skewnessCorrectionVector () const
	Returns the skewness-correction vector (vector between the approximate and real face centroids). More...
const Point &	elemCentroid () const
	Returns the element centroids of the elements on the elem and neighbor sides of the face. More...
const Point &	neighborCentroid () const
VarFaceNeighbors	faceType (const std::pair< unsigned int, unsigned int > &var_sys) const
	Returns which side(s) the given variable-system number pair is defined on for this face. More...
VarFaceNeighbors &	faceType (const std::pair< unsigned int, unsigned int > &var_sys)
	Mutably returns which side(s) the given variable-system number pair is defined on for this face. More...
const std::set< BoundaryID > &	boundaryIDs () const
	Const getter for every associated boundary ID. More...
std::set< BoundaryID > &	boundaryIDs ()
	Returns the set of boundary ids for all boundaries that include this face. More...
Real	elemVolume () const
	Return the element volume. More...
Real	neighborVolume () const
	Return the neighbor volume. More...
Real	gC () const
	Return the geometric weighting factor. More...
const Point &	dCN () const
Real	dCNMag () const
const Point &	eCN () const
processor_id_type	processor_id () const
void	computeInternalCoefficients (const ElemInfo *const neighbor_info)
	Takes the ElemInfo of the neighbor cell and computes interpolation weights together with other quantities used to generate spatial operators. More...
void	computeBoundaryCoefficients ()
	Computes the interpolation weights and similar quantities with the assumption that the face is on a boundary. More...
const Elem &	elem () const
const Elem *	elemPtr () const
const Elem &	neighbor () const
const Elem *	neighborPtr () const
const ElemInfo *	elemInfo () const
const ElemInfo *	neighborInfo () const
SubdomainID	elemSubdomainID () const
SubdomainID	neighborSubdomainID () const
unsigned int	elemSideID () const
unsigned int	neighborSideID () const

Private Member Functions
std::vector< std::vector< VarFaceNeighbors > > &	faceType ()
	Getter for the face type for every stored variable. More...

Private Attributes
const ElemInfo *const	_elem_info
	the elem and neighbor elems More...
const ElemInfo *	_neighbor_info
const dof_id_type	_id
Real	_face_coord = 0
Point	_normal
const processor_id_type	_processor_id
const unsigned int	_elem_side_id
	the elem local side id More...
unsigned int	_neighbor_side_id
Real	_face_area
Point	_face_centroid
Point	_d_cn
	the distance vector between neighbor and element centroids More...
Point	_e_cn
Real	_d_cn_mag
	the distance norm between neighbor and element centroids More...
Real	_gc
	Geometric weighting factor for face value interpolation. More...
std::vector< std::vector< VarFaceNeighbors > >	_face_types_by_var
	A vector that provides the information about what face type this is for each variable. More...
std::set< BoundaryID >	_boundary_ids
	the set of boundary ids that this face is associated with More...
friend	MooseMesh
	Allows access to private members from moose mesh only. More...

Detailed Description

This data structure is used to store geometric and variable related metadata about each cell face in the mesh.

This info is used by face loops (e.g. for finite volumes method numerical flux loop). These objects can be created and cached up front. Since it only stores information that changes when the mesh is modified it only needs an update whenever the mesh changes.

Definition at line 37 of file FaceInfo.h.

Member Enumeration Documentation

VarFaceNeighbors

enum FaceInfo::VarFaceNeighbors

strong

This enum is used to indicate which side(s) of a face a particular variable is defined on.

This is important for certain BC-related finite volume calculations. Because of the way side-sets and variable block-restriction work in MOOSE, there may be boundary conditions applied to internal faces on the mesh where a variable is only active on one or even zero sides of the face. For such faces, FV needs to know which sides (if any) to add BC residual contributions to.

Enumerator
BOTH
NEITHER
ELEM
NEIGHBOR

Definition at line 52 of file FaceInfo.h.

  {
    BOTH,
    NEITHER,
    ELEM,
    NEIGHBOR
  };

Constructor & Destructor Documentation

FaceInfo()

FaceInfo::FaceInfo	(	const ElemInfo *	elem_info,
		unsigned int	side,
		const dof_id_type	id,
		libMesh::ElemSideBuilder &	side_builder
	)

Definition at line 19 of file FaceInfo.C.

  : _elem_info(elem_info),
    _neighbor_info(nullptr),
    _id(id),
    _processor_id(_elem_info->elem()->processor_id()),
    _elem_side_id(side),
    _neighbor_side_id(libMesh::invalid_uint),
    _gc(0.5)
{
  // Compute face-related quantities
  auto & face = side_builder(*_elem_info->elem(), side);
  _face_area = face.volume();
  _face_centroid = face.vertex_average();
  _normal = _elem_info->elem()->side_vertex_average_normal(side);
}

Member Function Documentation

boundaryIDs() [1/2]

const std::set<BoundaryID>& FaceInfo::boundaryIDs ( ) const

inline

Const getter for every associated boundary ID.

Definition at line 124 of file FaceInfo.h.

Referenced by LinearFVFluxKernel::addMatrixContribution(), LinearFVFluxKernel::addRightHandSideContribution(), FVFluxKernel::avoidBoundary(), BoundaryLinearFVFluxIntegral::computeFaceInfoIntegral(), MooseLinearVariableFV< Real >::evaluate(), MooseVariableFV< Real >::getDirichletBC(), MooseVariableFV< Real >::getFluxBCs(), MooseLinearVariableFV< Real >::isDirichletBoundaryFace(), and FVFluxKernel::skipForBoundary().

{ return _boundary_ids; }

boundaryIDs() [2/2]

std::set<BoundaryID>& FaceInfo::boundaryIDs ( )

inline

Returns the set of boundary ids for all boundaries that include this face.

Definition at line 127 of file FaceInfo.h.

{ return _boundary_ids; }

computeBoundaryCoefficients()

void FaceInfo::computeBoundaryCoefficients

(

)

Computes the interpolation weights and similar quantities with the assumption that the face is on a boundary.

Definition at line 60 of file FaceInfo.C.

{
  mooseAssert(!_neighbor_info, "This functions shall only be called on a boundary!");

  // Setup quantities used for the approximation of the spatial derivatives
  _d_cn = _face_centroid - _elem_info->centroid();
  _d_cn_mag = _d_cn.norm();
  _e_cn = _d_cn / _d_cn_mag;

  // For interpolation coefficients
  _gc = 1.0;
}

computeInternalCoefficients()

void FaceInfo::computeInternalCoefficients

(

const ElemInfo *const

neighbor_info

)

Takes the ElemInfo of the neighbor cell and computes interpolation weights together with other quantities used to generate spatial operators.

Definition at line 39 of file FaceInfo.C.

{
  mooseAssert(neighbor_info,
              "We need a neighbor if we want to compute interpolation coefficients!");
  _neighbor_info = neighbor_info;
  _neighbor_side_id = _neighbor_info->elem()->which_neighbor_am_i(_elem_info->elem());

  // Setup quantities used for the approximation of the spatial derivatives
  _d_cn = _neighbor_info->centroid() - _elem_info->centroid();
  _d_cn_mag = _d_cn.norm();
  _e_cn = _d_cn / _d_cn_mag;

  Point r_intersection =
      _elem_info->centroid() +
      (((_face_centroid - _elem_info->centroid()) * _normal) / (_e_cn * _normal)) * _e_cn;

  // For interpolation coefficients
  _gc = (_neighbor_info->centroid() - r_intersection).norm() / _d_cn_mag;
}

dCN()

const Point& FaceInfo::dCN ( ) const

inline

Returns

the distance vector drawn from centroid C to N, or in terms of MOOSE implementation, the distance vector obtained from subtracting the element centroid from the neighbor centroid

Definition at line 142 of file FaceInfo.h.

Referenced by FVAdvectedMinmodWeightBased::advectedInterpolate(), FVAdvectedVanLeerWeightBased::advectedInterpolate(), LinearFVAnisotropicDiffusion::computeFluxMatrixContribution(), LinearFVDiffusion::computeFluxMatrixContribution(), Moose::FV::fullLimitedInterpolation(), and Moose::FV::interpCoeffs().

{ return _d_cn; }

dCNMag()

Real FaceInfo::dCNMag ( ) const

inline

Returns

the magnitude of the distance vector between centroids C and N, or in terms of MOOSE implementation, the magnitude of the distance vector between neighbor and element centroids

Definition at line 148 of file FaceInfo.h.

Referenced by MooseVariableFV< Real >::adGradSln(), LinearFVAnisotropicDiffusion::computeFluxMatrixContribution(), LinearFVDiffusion::computeFluxMatrixContribution(), and FVOrthogonalDiffusion::computeQpResidual().

{ return _d_cn_mag; }

eCN()

const Point& FaceInfo::eCN ( ) const

inline

Returns

the normalized (e.g. unit) distance vector drawn from centroid C to N, or in terms of MOOSE implementation, the normalized (e.g. unit) distance vector obtained from subtracting the element centroid from the neighbor centroid

Definition at line 155 of file FaceInfo.h.

Referenced by MooseVariableFV< Real >::adGradSln(), LinearFVAnisotropicDiffusion::computeFluxRHSContribution(), and LinearFVDiffusion::computeFluxRHSContribution().

{ return _e_cn; }

elem()

const Elem& FaceInfo::elem ( ) const

inline

Returns the elem and neighbor elements adjacent to the face. If a face is on a mesh boundary, the neighborPtr will return nullptr - the elem will never be null.

Definition at line 85 of file FaceInfo.h.

Referenced by MooseVariableFV< Real >::adGradSln(), FVDiffusionInterface::computeQpResidual(), Moose::FV::determineElemOneAndTwo(), FVFluxBC::elemArg(), Function::evaluate(), MooseVariableFE< Real >::faceEvaluate(), SideIntegralFunctorPostprocessorTempl< false >::hasFaceSide(), FVFluxKernel::hasFaceSide(), Moose::FunctorBase< libMesh::VectorValue >::hasFaceSide(), PiecewiseByBlockLambdaFunctor< T >::isExtrapolatedBoundaryFace(), Moose::FunctorBase< libMesh::VectorValue >::isInternalFace(), Moose::FV::loopOverElemFaceInfo(), Moose::FaceArg::makeElem(), FaceArgProducerInterface::makeFace(), Moose::FV::onBoundary(), Assembly::reinitFVFace(), FVInterfaceKernel::setupData(), FVInterfaceKernel::singleSidedFaceArg(), and MooseVariableFV< Real >::uncorrectedAdGradSln().

{ return *(_elem_info->elem()); }

elemCentroid()

const Point& FaceInfo::elemCentroid ( ) const

inline

Returns the element centroids of the elements on the elem and neighbor sides of the face.

If no neighbor face is defined, a "ghost" neighbor centroid is calculated by reflecting/extrapolating from the elem centroid through the face centroid

• i.e. the vector from the elem element centroid to the face centroid is doubled in length. The tip of this new vector is the neighbor centroid. This is important for FV dirichlet BCs.

Definition at line 99 of file FaceInfo.h.

Referenced by MooseVariableFV< Real >::adGradSln(), FVAdvectedVenkatakrishnanDeferredCorrection::advectedInterpolate(), LinearFVBoundaryCondition::computeCellToFaceVector(), FVDiffusionInterface::computeQpResidual(), FVOrthogonalBoundaryDiffusion::computeQpResidual(), Moose::FV::fullLimitedInterpolation(), MooseVariableFV< Real >::getExtrapolatedBoundaryFaceValue(), and Moose::FV::Limiter< T >::rf_minmax().

{ return _elem_info->centroid(); }

elemInfo()

const ElemInfo* FaceInfo::elemInfo ( ) const

inline

Definition at line 89 of file FaceInfo.h.

Referenced by LinearFVFluxKernel::addMatrixContribution(), LinearFVFluxKernel::addRightHandSideContribution(), LinearFVFluxKernel::computeBoundaryFlux(), LinearFVAdvectionDiffusionFunctorRobinBCBase::computeBoundaryGradientRHSContribution(), LinearFVAdvectionDiffusionExtrapolatedBC::computeBoundaryNormalGradient(), LinearFVAnisotropicDiffusion::computeBoundaryRHSContribution(), LinearFVDiffusion::computeBoundaryRHSContribution(), LinearFVAdvectionDiffusionFunctorNeumannBC::computeBoundaryValue(), LinearFVAdvectionDiffusionExtrapolatedBC::computeBoundaryValue(), LinearFVAdvectionDiffusionScalarSymmetryBC::computeBoundaryValue(), LinearFVAdvectionDiffusionFunctorRobinBCBase::computeBoundaryValue(), LinearFVAdvectionDiffusionScalarSymmetryBC::computeBoundaryValueRHSContribution(), LinearFVAdvectionDiffusionFunctorNeumannBC::computeBoundaryValueRHSContribution(), LinearFVAdvectionDiffusionExtrapolatedBC::computeBoundaryValueRHSContribution(), LinearFVAdvectionDiffusionFunctorRobinBCBase::computeBoundaryValueRHSContribution(), LinearFVAnisotropicDiffusion::computeFluxRHSContribution(), LinearFVDiffusion::computeFluxRHSContribution(), MooseLinearVariableFV< Real >::gradSln(), MooseLinearVariableFV< Real >::limitedGradSln(), and LinearFVAdvection::setupFaceData().

{ return _elem_info; }

elemPtr()

const Elem* FaceInfo::elemPtr ( ) const

inline

Definition at line 86 of file FaceInfo.h.

Referenced by FVAdvectedInterpolationMethod::advectedInterpolate(), FVAdvectedInterpolationMethod::advectedInterpolateValue(), FVFunctorDirichletBCTempl< is_ad >::boundaryValue(), Moose::FunctorBase< libMesh::VectorValue >::checkFace(), LinearFVAdvectionDiffusionFunctorDirichletBC::computeBoundaryNormalGradient(), SideAdvectiveFluxIntegralTempl< is_ad >::computeFaceInfoIntegral(), FVFluxKernel::elemArg(), FVInterfaceKernel::elemArg(), Function::evaluate(), MooseLinearVariableFV< Real >::evaluate(), MooseVariableFV< Real >::evaluate(), MooseVariableFE< Real >::faceEvaluate(), LinearFVBoundaryCondition::functorFaceArg(), MooseVariableFV< Real >::getExtrapolatedBoundaryFaceValue(), FVFaceInterpolationMethod::interpolate(), and FVInterfaceKernel::singleSidedFaceArg().

{ return _elem_info->elem(); }

elemSideID()

unsigned int FaceInfo::elemSideID ( ) const

inline

Returns the elem and neighbor centroids. If no neighbor element exists, then the maximum unsigned int is returned for the neighbor side ID.

Definition at line 113 of file FaceInfo.h.

Referenced by MooseVariableFE< Real >::faceEvaluate(), and Assembly::reinitFVFace().

{ return _elem_side_id; }

elemSubdomainID()

SubdomainID FaceInfo::elemSubdomainID ( ) const

inline

Returns the elem and neighbor subdomain IDs. If no neighbor element exists, then an invalid ID is returned for the neighbor subdomain ID.

Definition at line 106 of file FaceInfo.h.

Referenced by Moose::FV::onBoundary().

{ return _elem_info->subdomain_id(); }

elemVolume()

Real FaceInfo::elemVolume ( ) const

inline

Return the element volume.

Definition at line 130 of file FaceInfo.h.

{ return _elem_info->volume(); }

faceArea()

Real FaceInfo::faceArea ( ) const

inline

Returns the face area of face id.

Definition at line 64 of file FaceInfo.h.

Referenced by FVScalarLagrangeMultiplierInterface::computeJacobian(), FVBoundaryScalarLagrangeMultiplierConstraint::computeJacobian(), FVFluxBC::computeJacobian(), FVFluxKernel::computeJacobian(), FVInterfaceKernel::computeJacobian(), FVScalarLagrangeMultiplierInterface::computeResidual(), FVBoundaryScalarLagrangeMultiplierConstraint::computeResidual(), FVFluxBC::computeResidual(), FVFluxKernel::computeResidual(), FVInterfaceKernel::computeResidual(), and Moose::FV::loopOverElemFaceInfo().

{ return _face_area; }

faceCentroid()

const Point& FaceInfo::faceCentroid ( ) const

inline

Returns the coordinates of the face centroid.

Definition at line 75 of file FaceInfo.h.

Referenced by LinearFVFluxKernel::addMatrixContribution(), LinearFVFluxKernel::addRightHandSideContribution(), MooseVariableFV< Real >::adGradSln(), FVAdvectedVenkatakrishnanDeferredCorrection::advectedInterpolate(), FVFunctionDirichletBC::boundaryValue(), Moose::FunctorBase< libMesh::VectorValue >::checkFace(), LinearFVAnisotropicDiffusion::computeBoundaryRHSContribution(), LinearFVDiffusion::computeBoundaryRHSContribution(), LinearFVBoundaryCondition::computeCellToFaceVector(), MooseMeshUtils::computeFiniteVolumeCoords(), FVFunctionNeumannBC::computeQpResidual(), FVOrthogonalBoundaryDiffusion::computeQpResidual(), FVFluxBC::computeResidual(), Moose::FV::fullLimitedInterpolation(), MooseVariableFV< Real >::getExtrapolatedBoundaryFaceValue(), Moose::FaceArg::getPoint(), Moose::FV::loopOverElemFaceInfo(), and Moose::FV::Limiter< T >::rf_minmax().

{ return _face_centroid; }

faceCoord() [1/2]

Real& FaceInfo::faceCoord ( )

inline

Sets/gets the coordinate transformation factor (for e.g.

rz, spherical coords) to be used for integration over faces.

Definition at line 68 of file FaceInfo.h.

Referenced by MooseMeshUtils::computeFiniteVolumeCoords(), FVScalarLagrangeMultiplierInterface::computeJacobian(), FVBoundaryScalarLagrangeMultiplierConstraint::computeJacobian(), FVFluxBC::computeJacobian(), FVFluxKernel::computeJacobian(), FVInterfaceKernel::computeJacobian(), FVScalarLagrangeMultiplierInterface::computeResidual(), FVBoundaryScalarLagrangeMultiplierConstraint::computeResidual(), FVFluxBC::computeResidual(), FVFluxKernel::computeResidual(), and FVInterfaceKernel::computeResidual().

{ return _face_coord; }

faceCoord() [2/2]

Real FaceInfo::faceCoord ( ) const

inline

Definition at line 69 of file FaceInfo.h.

{ return _face_coord; }

faceType() [1/3]

FaceInfo::VarFaceNeighbors FaceInfo::faceType ( const std::pair< unsigned int, unsigned int > &  var_sys ) const

inline

Returns which side(s) the given variable-system number pair is defined on for this face.

Definition at line 229 of file FaceInfo.h.

Referenced by BoundaryLinearFVFluxIntegral::computeFaceInfoIntegral(), MooseVariableFV< Real >::computeFaceValues(), FVBoundaryScalarLagrangeMultiplierConstraint::computeJacobian(), FVFluxBC::computeJacobian(), FVFluxKernel::computeJacobian(), FVBoundaryScalarLagrangeMultiplierConstraint::computeResidual(), FVFluxKernel::computeResidual(), Moose::FV::determineElemOneAndTwo(), MooseLinearVariableFV< Real >::evaluate(), MooseLinearVariableFV< Real >::gradSln(), LinearFVFluxKernel::hasFaceSide(), LinearFVBoundaryCondition::hasFaceSide(), FVBoundaryCondition::hasFaceSide(), MooseLinearVariableFV< Real >::limitedGradSln(), FVInterfaceKernel::setupData(), LinearFVFluxKernel::setupFaceData(), MooseVariableFV< Real >::uncorrectedAdGradSln(), FVFluxBC::uOnGhost(), FVFluxBC::uOnUSub(), and FVFluxBC::updateCurrentFace().

{
  mooseAssert(var_sys.second < _face_types_by_var.size(), "System number out of bounds!");
  mooseAssert(var_sys.first < _face_types_by_var[var_sys.second].size(),
              "Variable number out of bounds!");
  return _face_types_by_var[var_sys.second][var_sys.first];
}

faceType() [2/3]

FaceInfo::VarFaceNeighbors & FaceInfo::faceType ( const std::pair< unsigned int, unsigned int > &  var_sys )

inline

Mutably returns which side(s) the given variable-system number pair is defined on for this face.

Definition at line 238 of file FaceInfo.h.

{
  mooseAssert(var_sys.second < _face_types_by_var.size(), "System number out of bounds!");
  mooseAssert(var_sys.first < _face_types_by_var[var_sys.second].size(),
              "Variable number out of bounds!");
  return _face_types_by_var[var_sys.second][var_sys.first];
}

faceType() [3/3]

std::vector<std::vector<VarFaceNeighbors> >& FaceInfo::faceType ( )

inlineprivate

Getter for the face type for every stored variable.

This will be a friend of MooseMesh to make sure we can only access it from there.

Definition at line 177 of file FaceInfo.h.

{ return _face_types_by_var; }

gC()

Real FaceInfo::gC ( ) const

inline

Return the geometric weighting factor.

Definition at line 136 of file FaceInfo.h.

Referenced by FVAdvectedMinmodWeightBased::advectedInterpolate(), FVAdvectedVanLeerWeightBased::advectedInterpolate(), FVGeometricAverage::advectedInterpolate(), Moose::FV::interpCoeffs(), FVHarmonicAverage::interpolate(), and FVGeometricAverage::interpolate().

{ return _gc; }

id()

dof_id_type FaceInfo::id ( ) const

inline

Return the ID of the face.

Definition at line 61 of file FaceInfo.h.

{ return _id; }

neighbor()

const Elem & FaceInfo::neighbor ( ) const

inline

Definition at line 220 of file FaceInfo.h.

Referenced by Function::evaluate(), FVFluxKernel::hasFaceSide(), Moose::FunctorBase< libMesh::VectorValue >::hasFaceSide(), PiecewiseByBlockLambdaFunctor< T >::isExtrapolatedBoundaryFace(), Moose::FV::onBoundary(), and FVInterfaceKernel::singleSidedFaceArg().

{
  mooseAssert(_neighbor_info,
              "FaceInfo object 'const Elem & neighbor()' is called but neighbor element pointer "
              "is null. This occurs for faces at the domain boundary");
  return *(_neighbor_info->elem());
}

neighborCentroid()

const Point & FaceInfo::neighborCentroid ( ) const

inline

Definition at line 247 of file FaceInfo.h.

Referenced by MooseVariableFV< Real >::adGradSln(), FVAdvectedVenkatakrishnanDeferredCorrection::advectedInterpolate(), LinearFVBoundaryCondition::computeCellToFaceVector(), FVDiffusionInterface::computeQpResidual(), FVOrthogonalBoundaryDiffusion::computeQpResidual(), Moose::FV::fullLimitedInterpolation(), MooseVariableFV< Real >::getExtrapolatedBoundaryFaceValue(), and Moose::FV::Limiter< T >::rf_minmax().

{
  mooseAssert(_neighbor_info,
              "The neighbor is not defined on this faceInfo! A possible explanation is that the "
              "face is a (physical/processor) boundary face.");
  return _neighbor_info->centroid();
}

neighborInfo()

const ElemInfo* FaceInfo::neighborInfo ( ) const

inline

Definition at line 90 of file FaceInfo.h.

Referenced by LinearFVFluxKernel::addMatrixContribution(), LinearFVFluxKernel::addRightHandSideContribution(), LinearFVFluxKernel::computeBoundaryFlux(), LinearFVAdvectionDiffusionFunctorRobinBCBase::computeBoundaryGradientRHSContribution(), LinearFVAdvectionDiffusionExtrapolatedBC::computeBoundaryNormalGradient(), LinearFVAnisotropicDiffusion::computeBoundaryRHSContribution(), LinearFVDiffusion::computeBoundaryRHSContribution(), LinearFVAdvectionDiffusionFunctorNeumannBC::computeBoundaryValue(), LinearFVAdvectionDiffusionExtrapolatedBC::computeBoundaryValue(), LinearFVAdvectionDiffusionScalarSymmetryBC::computeBoundaryValue(), LinearFVAdvectionDiffusionFunctorRobinBCBase::computeBoundaryValue(), LinearFVAdvectionDiffusionScalarSymmetryBC::computeBoundaryValueRHSContribution(), LinearFVAdvectionDiffusionFunctorNeumannBC::computeBoundaryValueRHSContribution(), LinearFVAdvectionDiffusionExtrapolatedBC::computeBoundaryValueRHSContribution(), LinearFVAdvectionDiffusionFunctorRobinBCBase::computeBoundaryValueRHSContribution(), LinearFVAnisotropicDiffusion::computeFluxRHSContribution(), LinearFVDiffusion::computeFluxRHSContribution(), MooseLinearVariableFV< Real >::gradSln(), MooseLinearVariableFV< Real >::limitedGradSln(), and LinearFVAdvection::setupFaceData().

{ return _neighbor_info; }

neighborPtr()

const Elem* FaceInfo::neighborPtr ( ) const

inline

Definition at line 88 of file FaceInfo.h.

Referenced by MooseVariableFV< Real >::adGradSln(), FVAdvectedInterpolationMethod::advectedInterpolate(), FVAdvectedInterpolationMethod::advectedInterpolateValue(), FVFunctorDirichletBCTempl< is_ad >::boundaryValue(), Moose::FunctorBase< libMesh::VectorValue >::checkFace(), LinearFVAdvectionDiffusionFunctorDirichletBC::computeBoundaryNormalGradient(), FVDiffusionInterface::computeQpResidual(), Moose::FV::determineElemOneAndTwo(), Function::evaluate(), MooseLinearVariableFV< Real >::evaluate(), MooseVariableFV< Real >::evaluate(), MooseVariableFE< Real >::faceEvaluate(), LinearFVBoundaryCondition::functorFaceArg(), SideIntegralFunctorPostprocessorTempl< false >::hasFaceSide(), FVFluxKernel::hasFaceSide(), Moose::FunctorBase< libMesh::VectorValue >::hasFaceSide(), FVHarmonicAverage::interpolate(), FVFaceInterpolationMethod::interpolate(), PiecewiseByBlockLambdaFunctor< T >::isExtrapolatedBoundaryFace(), Moose::FunctorBase< libMesh::VectorValue >::isInternalFace(), Moose::FV::loopOverElemFaceInfo(), FaceArgProducerInterface::makeFace(), Moose::FaceArg::makeNeighbor(), FVFluxBC::neighborArg(), FVFluxKernel::neighborArg(), FVInterfaceKernel::neighborArg(), Moose::FV::onBoundary(), Assembly::reinitFVFace(), ComputeFVFluxThread< RangeType, AttribMatrixTags >::reinitVariables(), FVInterfaceKernel::singleSidedFaceArg(), and MooseVariableFV< Real >::uncorrectedAdGradSln().

{ return _neighbor_info ? _neighbor_info->elem() : nullptr; }

neighborSideID()

unsigned int FaceInfo::neighborSideID ( ) const

inline

Definition at line 114 of file FaceInfo.h.

Referenced by MooseVariableFE< Real >::faceEvaluate(), and Assembly::reinitFVFace().

{ return _neighbor_side_id; }

neighborSubdomainID()

SubdomainID FaceInfo::neighborSubdomainID ( ) const

inline

Definition at line 256 of file FaceInfo.h.

Referenced by Moose::FV::onBoundary().

{
  return _neighbor_info ? _neighbor_info->subdomain_id() : Moose::INVALID_BLOCK_ID;
}

neighborVolume()

Real FaceInfo::neighborVolume ( ) const

inline

Return the neighbor volume.

Definition at line 262 of file FaceInfo.h.

{
  mooseAssert(_neighbor_info,
              "The neighbor is not defined on this faceInfo! A possible explanation is that the "
              "face is a (physical/processor) boundary face.");
  return _neighbor_info->volume();
}

normal()

const Point& FaceInfo::normal ( ) const

inline

Returns the unit normal vector for the face oriented outward from the face's elem element.

Definition at line 72 of file FaceInfo.h.

Referenced by LinearFVAdvectionDiffusionFunctorRobinBCBase::computeBoundaryGradientMatrixContribution(), LinearFVAdvectionDiffusionFunctorRobinBCBase::computeBoundaryGradientRHSContribution(), LinearFVAnisotropicDiffusion::computeBoundaryMatrixContribution(), LinearFVAdvectionDiffusionExtrapolatedBC::computeBoundaryNormalGradient(), LinearFVAnisotropicDiffusion::computeBoundaryRHSContribution(), LinearFVDiffusion::computeBoundaryRHSContribution(), LinearFVAdvectionDiffusionScalarSymmetryBC::computeBoundaryValue(), LinearFVAdvectionDiffusionFunctorNeumannBC::computeBoundaryValue(), LinearFVAdvectionDiffusionFunctorRobinBCBase::computeBoundaryValue(), LinearFVAdvectionDiffusionFunctorRobinBCBase::computeBoundaryValueMatrixContribution(), LinearFVAdvectionDiffusionScalarSymmetryBC::computeBoundaryValueRHSContribution(), LinearFVAdvectionDiffusionFunctorNeumannBC::computeBoundaryValueRHSContribution(), LinearFVAdvectionDiffusionFunctorRobinBCBase::computeBoundaryValueRHSContribution(), LinearFVBoundaryCondition::computeCellToFaceDistance(), SideAdvectiveFluxIntegralTempl< is_ad >::computeFaceInfoIntegral(), LinearFVAnisotropicDiffusion::computeFluxMatrixContribution(), LinearFVDiffusion::computeFluxMatrixContribution(), LinearFVAnisotropicDiffusion::computeFluxRHSContribution(), LinearFVDiffusion::computeFluxRHSContribution(), FVBoundaryScalarLagrangeMultiplierConstraint::computeJacobian(), FVFluxBC::computeJacobian(), FVFluxKernel::computeJacobian(), FVBoundaryScalarLagrangeMultiplierConstraint::computeResidual(), FVFluxKernel::computeResidual(), Function::evaluate(), Moose::FV::gradUDotNormal(), Moose::FV::interpolate(), Moose::FV::loopOverElemFaceInfo(), FVInterfaceKernel::setupData(), LinearFVAdvection::setupFaceData(), and FVFluxBC::updateCurrentFace().

{ return _normal; }

processor_id()

processor_id_type FaceInfo::processor_id ( ) const

inline

Returns

the ID of the processor that owns this object

Definition at line 160 of file FaceInfo.h.

{ return _processor_id; }

skewnessCorrectionVector()

Point FaceInfo::skewnessCorrectionVector

(

)

const

Returns the skewness-correction vector (vector between the approximate and real face centroids).

Definition at line 74 of file FaceInfo.C.

Referenced by Moose::FV::skewCorrectedLinearInterpolation().

{
  const Point r_intersection =
      _elem_info->centroid() +
      (((_face_centroid - _elem_info->centroid()) * _normal) / (_e_cn * _normal)) * _e_cn;

  return _face_centroid - r_intersection;
}

Member Data Documentation

_boundary_ids

std::set<BoundaryID> FaceInfo::_boundary_ids

private

the set of boundary ids that this face is associated with

Definition at line 213 of file FaceInfo.h.

Referenced by boundaryIDs().

_d_cn

Point FaceInfo::_d_cn

private

the distance vector between neighbor and element centroids

Definition at line 198 of file FaceInfo.h.

Referenced by computeBoundaryCoefficients(), computeInternalCoefficients(), and dCN().

_d_cn_mag

Real FaceInfo::_d_cn_mag

private

the distance norm between neighbor and element centroids

Definition at line 202 of file FaceInfo.h.

Referenced by computeBoundaryCoefficients(), computeInternalCoefficients(), and dCNMag().

_e_cn

Point FaceInfo::_e_cn

private

Definition at line 199 of file FaceInfo.h.

Referenced by computeBoundaryCoefficients(), computeInternalCoefficients(), eCN(), and skewnessCorrectionVector().

_elem_info

const ElemInfo* const FaceInfo::_elem_info

private

the elem and neighbor elems

Definition at line 180 of file FaceInfo.h.

Referenced by computeBoundaryCoefficients(), computeInternalCoefficients(), elem(), elemCentroid(), elemInfo(), elemPtr(), elemSubdomainID(), elemVolume(), FaceInfo(), and skewnessCorrectionVector().

_elem_side_id

const unsigned int FaceInfo::_elem_side_id

private

the elem local side id

Definition at line 191 of file FaceInfo.h.

Referenced by elemSideID().

_face_area

Real FaceInfo::_face_area

private

Definition at line 194 of file FaceInfo.h.

Referenced by faceArea(), and FaceInfo().

_face_centroid

Point FaceInfo::_face_centroid

private

Definition at line 195 of file FaceInfo.h.

Referenced by computeBoundaryCoefficients(), computeInternalCoefficients(), faceCentroid(), FaceInfo(), and skewnessCorrectionVector().

_face_coord

Real FaceInfo::_face_coord = 0

private

Definition at line 185 of file FaceInfo.h.

Referenced by faceCoord().

_face_types_by_var

std::vector<std::vector<VarFaceNeighbors> > FaceInfo::_face_types_by_var

private

A vector that provides the information about what face type this is for each variable.

The first index is the system number; the second index of the key is the variable number within the system.

Definition at line 210 of file FaceInfo.h.

Referenced by faceType().

_gc

Real FaceInfo::_gc

private

Geometric weighting factor for face value interpolation.

Definition at line 205 of file FaceInfo.h.

Referenced by computeBoundaryCoefficients(), computeInternalCoefficients(), and gC().

_id

const dof_id_type FaceInfo::_id

private

Definition at line 183 of file FaceInfo.h.

Referenced by id().

_neighbor_info

const ElemInfo* FaceInfo::_neighbor_info

private

Definition at line 181 of file FaceInfo.h.

Referenced by computeBoundaryCoefficients(), computeInternalCoefficients(), neighbor(), neighborCentroid(), neighborInfo(), neighborPtr(), neighborSubdomainID(), and neighborVolume().

_neighbor_side_id

unsigned int FaceInfo::_neighbor_side_id

private

Definition at line 192 of file FaceInfo.h.

Referenced by computeInternalCoefficients(), and neighborSideID().

_normal

Point FaceInfo::_normal

private

Definition at line 186 of file FaceInfo.h.

Referenced by computeInternalCoefficients(), FaceInfo(), normal(), and skewnessCorrectionVector().

_processor_id

const processor_id_type FaceInfo::_processor_id

private

Definition at line 188 of file FaceInfo.h.

Referenced by processor_id().

MooseMesh

friend FaceInfo::MooseMesh

private

Allows access to private members from moose mesh only.

Definition at line 216 of file FaceInfo.h.

---

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

• include/mesh/FaceInfo.h
• src/mesh/FaceInfo.C