LinearFVGradientReader Class Reference

Read-only view of one variable's cell-centered linear finite-volume gradient values. More...

#include <LinearFVGradientReader.h>

Public Types
using	GradientContainer = std::vector< std::unique_ptr< libMesh::NumericVector< libMesh::Number > > >
	One vector per spatial component of the cell-centered gradient.

Public Member Functions
	LinearFVGradientReader (const SystemBase &sys, const GradientContainer &components, const FVGradientMethod &method, unsigned int variable_number)
const GradientContainer &	components () const
	Access the underlying component vectors keyed by spatial direction.
const SystemBase &	system () const
	System whose DOF map indexes the stored values.
const FVGradientMethod &	method () const
	Method object that produces the stored values.
Real	component (const ElemInfo &elem_info, unsigned int index) const
	Read one gradient component at an element.
RealVectorValue	gradient (const ElemInfo &elem_info) const
	Read the full gradient at an element.
RealVectorValue	gradient (const FaceInfo &fi) const
	Read the full gradient interpolated to a face.

Private Attributes
const SystemBase &	_sys
	System the variable belongs to.
const unsigned int	_system_number
	System number cached for hot lookups (from faces to dofs).
const GradientContainer &	_components
	Component vectors keyed by spatial direction.
const FVGradientMethod &	_method
	Method object that produces the stored values.
const unsigned int	_variable_number
	Variable number whose gradients are read by this object.

Detailed Description

Read-only view of one variable's cell-centered linear finite-volume gradient values.

Definition at line 32 of file LinearFVGradientReader.h.

Member Typedef Documentation

GradientContainer

using LinearFVGradientReader::GradientContainer = std::vector<std::unique_ptr<libMesh::NumericVector<libMesh::Number> >>

One vector per spatial component of the cell-centered gradient.

Definition at line 36 of file LinearFVGradientReader.h.

Constructor & Destructor Documentation

LinearFVGradientReader()

LinearFVGradientReader::LinearFVGradientReader	(	const SystemBase &	sys,
		const GradientContainer &	components,
		const FVGradientMethod &	method,
		unsigned int	variable_number
	)

Parameters

sys	System that owns the variables and gradient values.
components	Component vectors that store the gradient values.
method	Gradient method that produces the values read by this object.
variable_number	Variable number whose gradient this object reads.

Definition at line 22 of file LinearFVGradientReader.C.

  : _sys(sys),
    _system_number(sys.number()),
    _components(components),
    _method(method),
    _variable_number(variable_number)
{
}

Member Function Documentation

component()

Real LinearFVGradientReader::component	(	const ElemInfo &	elem_info,
		unsigned int	index
	)		const

Read one gradient component at an element.

Parameters

elem_info	Element whose cell-centered gradient should be read.
index	Index of the spatial component of the gradient.

Definition at line 35 of file LinearFVGradientReader.C.

{
  mooseAssert(index < _components.size(), "Gradient component index out of range.");
 
  return (*_components[index])(elem_info.dofIndices()[_system_number][_variable_number]);
}

Referenced by gradient().

components()

const GradientContainer & LinearFVGradientReader::components ( ) const

inline

Access the underlying component vectors keyed by spatial direction.

Definition at line 50 of file LinearFVGradientReader.h.

{ return _components; }

gradient() [1/2]

RealVectorValue LinearFVGradientReader::gradient

(

const ElemInfo &

elem_info

)

const

Read the full gradient at an element.

Parameters

elem_info

Element whose cell-centered gradient should be read.

Definition at line 43 of file LinearFVGradientReader.C.

{
  RealVectorValue value;
 
  for (const auto component_index : make_range(elem_info.elem()->dim()))
    value(component_index) = component(elem_info, component_index);
 
  return value;
}

Referenced by LinearFVAnisotropicDiffusion::computeBoundaryRHSContribution(), LinearFVDiffusion::computeBoundaryRHSContribution(), LinearFVAnisotropicDiffusion::computeFluxRHSContribution(), LinearFVDiffusion::computeFluxRHSContribution(), gradient(), and LinearFVAdvection::setupFaceData().

gradient() [2/2]

RealVectorValue LinearFVGradientReader::gradient

(

const FaceInfo &

fi

)

const

Read the full gradient interpolated to a face.

Parameters

fi	Face whose interpolated gradient should be read.

Definition at line 54 of file LinearFVGradientReader.C.

{
  const auto face_type = fi.faceType(std::make_pair(_variable_number, _system_number));
  mooseAssert(face_type != FaceInfo::VarFaceNeighbors::NEITHER,
              "Gradient requested on a face where the variable is defined on neither side.");
 
  const bool var_defined_on_elem = (face_type == FaceInfo::VarFaceNeighbors::BOTH) ||
                                   (face_type == FaceInfo::VarFaceNeighbors::ELEM);
  const auto * const elem_one = var_defined_on_elem ? fi.elemInfo() : fi.neighborInfo();
  const auto * const elem_two = var_defined_on_elem ? fi.neighborInfo() : fi.elemInfo();
 
  const auto elem_one_grad = gradient(*elem_one);
 
  if (face_type == FaceInfo::VarFaceNeighbors::BOTH)
  {
    mooseAssert(elem_two, "Face type indicates BOTH but neighbor information is missing.");
    const auto elem_two_grad = gradient(*elem_two);
    return Moose::FV::linearInterpolation(elem_one_grad, elem_two_grad, fi, var_defined_on_elem);
  }
  else
    return elem_one_grad;
}

method()

const FVGradientMethod & LinearFVGradientReader::method ( ) const

inline

Method object that produces the stored values.

Definition at line 56 of file LinearFVGradientReader.h.

{ return _method; }

Referenced by LinearFVGradientInterface::updateFVGradient().

system()

const SystemBase & LinearFVGradientReader::system ( ) const

inline

System whose DOF map indexes the stored values.

Definition at line 53 of file LinearFVGradientReader.h.

{ return _sys; }

Referenced by LinearFVGradientInterface::updateFVGradient().

Member Data Documentation

_components

const GradientContainer& LinearFVGradientReader::_components

private

Component vectors keyed by spatial direction.

Definition at line 85 of file LinearFVGradientReader.h.

Referenced by component(), and components().

_method

const FVGradientMethod& LinearFVGradientReader::_method

private

Method object that produces the stored values.

Definition at line 88 of file LinearFVGradientReader.h.

Referenced by method().

_sys

const SystemBase& LinearFVGradientReader::_sys

private

System the variable belongs to.

Definition at line 79 of file LinearFVGradientReader.h.

Referenced by system().

_system_number

const unsigned int LinearFVGradientReader::_system_number

private

System number cached for hot lookups (from faces to dofs).

Definition at line 82 of file LinearFVGradientReader.h.

Referenced by component(), and gradient().

_variable_number

const unsigned int LinearFVGradientReader::_variable_number

private

Variable number whose gradients are read by this object.

Definition at line 91 of file LinearFVGradientReader.h.

Referenced by component(), and gradient().

---

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

• include/utils/LinearFVGradientReader.h
• src/utils/LinearFVGradientReader.C