FVAdvectedInterpolationMethod Class Reference

Interface for interpolation methods that provide matrix and RHS contributions for advected face values. More...

#include <FVAdvectedInterpolationMethod.h>

Inheritance diagram for FVAdvectedInterpolationMethod:

Classes
struct	AdvectedSystemContribution
	Matrix/RHS contribution for an advected face interpolation. More...

Public Member Functions
virtual AdvectedSystemContribution	advectedInterpolate (const FaceInfo &face, Real elem_value, Real neighbor_value, const VectorValue< Real > *elem_grad, const VectorValue< Real > *neighbor_grad, Real mass_flux) const =0
	Compute the matrix weights for the advected face value. More...
AdvectedSystemContribution	advectedInterpolate (const Moose::FunctorBase< Real > &functor, const FaceInfo &face, const Moose::StateArg &state, const Real mass_flux) const
	Convenience overload that evaluates a scalar Moose functor at the adjacent cell centers and, if needed, its cell gradients before applying this interpolation method. More...
virtual Real	advectedInterpolateValue (const FaceInfo &face, Real elem_value, Real neighbor_value, const VectorValue< Real > *elem_grad, const VectorValue< Real > *neighbor_grad, Real mass_flux) const
	Compute the advected face value. More...
Real	advectedInterpolateValue (const Moose::FunctorBase< Real > &functor, const FaceInfo &face, const Moose::StateArg &state, const Real mass_flux) const
	Convenience overload that evaluates a scalar Moose functor at the adjacent cell centers and, if needed, its cell gradients before applying this interpolation method. More...
virtual bool	needsGradients () const
	Whether advected interpolation requires adjacent-cell gradients. More...
virtual Moose::FV::GradientLimiterType	gradientLimiter () const
	Limiter used by interpolations that require limited gradients. More...

Detailed Description

Interface for interpolation methods that provide matrix and RHS contributions for advected face values.

Definition at line 22 of file FVAdvectedInterpolationMethod.h.

Member Function Documentation

advectedInterpolate() [1/2]

virtual AdvectedSystemContribution FVAdvectedInterpolationMethod::advectedInterpolate ( const FaceInfo &  face, Real  elem_value, Real  neighbor_value, const VectorValue< Real > *  elem_grad, const VectorValue< Real > *  neighbor_grad, Real  mass_flux  ) const

pure virtual

Compute the matrix weights for the advected face value.

Interpolation is used on internal faces, boundary treatment is localized to the boundary conditions.

Parameters

face	The face being interpolated.
elem_value	Element-side scalar value.
neighbor_value	Neighbor-side scalar value.
elem_grad	Element-side cell gradient (required).
neighbor_grad	Neighbor-side cell gradient (required).
mass_flux	Face mass flux for determining upwind direction.

Implemented in FVAdvectedVenkatakrishnanDeferredCorrection, FVGeometricAverage, FVAdvectedMinmodWeightBased, FVAdvectedVanLeerWeightBased, and FVAdvectedUpwind.

Referenced by advectedInterpolate(), advectedInterpolateValue(), and LinearFVAdvection::setupFaceData().

advectedInterpolate() [2/2]

FVAdvectedInterpolationMethod::AdvectedSystemContribution FVAdvectedInterpolationMethod::advectedInterpolate	(	const Moose::FunctorBase< Real > &	functor,
		const FaceInfo &	face,
		const Moose::StateArg &	state,
		const Real	mass_flux
	)		const

Convenience overload that evaluates a scalar Moose functor at the adjacent cell centers and, if needed, its cell gradients before applying this interpolation method.

This will provide contributions to the matrix and right hand side of a linear system.

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.
mass_flux	The mass flux which will be used for the interpolation.

Definition at line 13 of file FVAdvectedInterpolationMethod.C.

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

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

  if (!needsGradients())
    return advectedInterpolate(face, elem_value, neighbor_value, nullptr, nullptr, mass_flux);

  const auto elem_grad = functor.gradient(elem_arg, state);
  const auto neighbor_grad = functor.gradient(neighbor_arg, state);
  return advectedInterpolate(
      face, elem_value, neighbor_value, &elem_grad, &neighbor_grad, mass_flux);
}

advectedInterpolateValue() [1/2]

Real FVAdvectedInterpolationMethod::advectedInterpolateValue ( const FaceInfo &  face, Real  elem_value, Real  neighbor_value, const VectorValue< Real > *  elem_grad, const VectorValue< Real > *  neighbor_grad, Real  mass_flux  ) const

virtual

Compute the advected face value.

Interpolation is used on internal faces, boundary treatment is localized to the boundary conditions.

Parameters

face	The face being interpolated.
elem_value	Element-side scalar value.
neighbor_value	Neighbor-side scalar value.
elem_grad	Element-side cell gradient (required).
neighbor_grad	Neighbor-side cell gradient (required).
mass_flux	Face mass flux for determining upwind direction.

Reimplemented in FVGeometricAverage, FVAdvectedMinmodWeightBased, FVAdvectedVanLeerWeightBased, and FVAdvectedUpwind.

Definition at line 36 of file FVAdvectedInterpolationMethod.C.

Referenced by advectedInterpolateValue().

{
  const auto result =
      advectedInterpolate(face, elem_value, neighbor_value, elem_grad, neighbor_grad, mass_flux);
  return result.weights_matrix.first * elem_value + result.weights_matrix.second * neighbor_value -
         result.rhs_face_value;
}

advectedInterpolateValue() [2/2]

Real FVAdvectedInterpolationMethod::advectedInterpolateValue	(	const Moose::FunctorBase< Real > &	functor,
		const FaceInfo &	face,
		const Moose::StateArg &	state,
		const Real	mass_flux
	)		const

Convenience overload that evaluates a scalar Moose functor at the adjacent cell centers and, if needed, its cell gradients before applying this interpolation method.

This will return the interpolated face value.

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.
mass_flux	The mass flux which will be used for the interpolation.

Definition at line 50 of file FVAdvectedInterpolationMethod.C.

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

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

  if (!needsGradients())
    return advectedInterpolateValue(face, elem_value, neighbor_value, nullptr, nullptr, mass_flux);

  const auto elem_grad = functor.gradient(elem_arg, state);
  const auto neighbor_grad = functor.gradient(neighbor_arg, state);
  return advectedInterpolateValue(
      face, elem_value, neighbor_value, &elem_grad, &neighbor_grad, mass_flux);
}

gradientLimiter()

virtual Moose::FV::GradientLimiterType FVAdvectedInterpolationMethod::gradientLimiter ( ) const

inlinevirtual

Limiter used by interpolations that require limited gradients.

Reimplemented in FVAdvectedVenkatakrishnanDeferredCorrection.

Definition at line 102 of file FVAdvectedInterpolationMethod.h.

Referenced by LinearFVAdvection::LinearFVAdvection(), and LinearFVAdvection::setupFaceData().

  {
    return Moose::FV::GradientLimiterType::None;
  }

needsGradients()

virtual bool FVAdvectedInterpolationMethod::needsGradients ( ) const

inlinevirtual

Whether advected interpolation requires adjacent-cell gradients.

Reimplemented in FVAdvectedVenkatakrishnanDeferredCorrection, FVAdvectedMinmodWeightBased, and FVAdvectedVanLeerWeightBased.

Definition at line 97 of file FVAdvectedInterpolationMethod.h.

Referenced by advectedInterpolate(), advectedInterpolateValue(), LinearFVAdvection::LinearFVAdvection(), and LinearFVAdvection::setupFaceData().

{ return false; }

---

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

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