FVFaceInterpolationMethod Class Reference

Abstract base class for interpolation methods that produce a scalar face value from adjacent cell values. More...

#include <FVFaceInterpolationMethod.h>

Inheritance diagram for FVFaceInterpolationMethod:

Public Member Functions
virtual Real	interpolate (const FaceInfo &face, Real elem_value, Real neighbor_value) const =0
	Face interpolation operation for this method. More...
Real	interpolate (const Moose::FunctorBase< Real > &functor, const FaceInfo &face, const Moose::StateArg &state) const
	Convenience overload that evaluates a scalar Moose functor at the adjacent cell centers and then applies this interpolation method. More...

Detailed Description

Abstract base class for interpolation methods that produce a scalar face value from adjacent cell values.

Definition at line 19 of file FVFaceInterpolationMethod.h.

Member Function Documentation

interpolate() [1/2]

virtual Real FVFaceInterpolationMethod::interpolate ( const FaceInfo &  face, Real  elem_value, Real  neighbor_value  ) const

pure virtual

Face interpolation operation for this method.

Parameters

face	The face to interpolate at.
elem_value	Element-side scalar value.
neighbor_value	Neighbor-side scalar value.

Implemented in FVGeometricAverage, and FVHarmonicAverage.

Referenced by LinearFVDiffusion::faceDiffusivity(), and interpolate().

interpolate() [2/2]

Real FVFaceInterpolationMethod::interpolate	(	const Moose::FunctorBase< Real > &	functor,
		const FaceInfo &	face,
		const Moose::StateArg &	state
	)		const

Convenience overload that evaluates a scalar Moose functor at the adjacent cell centers and then applies this interpolation method.

This requires a two-sided internal face.

Parameters

functor	The function which will be interpolated onto the face.
face	The face which will be use for interpolation.
state	The state argument for which we are performing the interpolation.

Definition at line 13 of file FVFaceInterpolationMethod.C.

{
  mooseAssert(face.neighborPtr(),
              "Face interpolation with a Moose functor requires a two-sided internal face.");

  const Real elem_value = functor(Moose::ElemArg{face.elemPtr(), false}, state);
  const Real neighbor_value = functor(Moose::ElemArg{face.neighborPtr(), false}, state);
  return interpolate(face, elem_value, neighbor_value);
}

---

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

• include/fvinterpolationmethods/FVFaceInterpolationMethod.h
• src/fvinterpolationmethods/FVFaceInterpolationMethod.C