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

#include <LinearFVGradientReader.h>

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

using	GradientStateContainer = std::vector< GradientContainer >
	Gradient fields indexed by solution time state.

Public Member Functions
	LinearFVGradientReader (const SystemBase &sys, const GradientStateContainer &state_values, const FVGradientMethod &method, unsigned int variable_number)

const GradientContainer &	components () const
	Access the underlying component vectors keyed by spatial direction.

const GradientContainer &	components (const Moose::StateArg &state) const
	Access the component vectors for a solution state.

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.

Real	component (const ElemInfo &elem_info, unsigned int index, const Moose::StateArg &state) const
	Read one gradient component at an element and solution state.

RealVectorValue	gradient (const ElemInfo &elem_info) const
	Read the full gradient at an element.

RealVectorValue	gradient (const ElemInfo &elem_info, const Moose::StateArg &state) const
	Read the full gradient at an element and solution state.

RealVectorValue	gradient (const FaceInfo &fi) const
	Read the full gradient interpolated to a face.

RealVectorValue	gradient (const FaceInfo &fi, const Moose::StateArg &state) const
	Read the full gradient interpolated to a face at a solution state.

Private Member Functions
const GradientContainer &	stateComponents (const Moose::StateArg &state) const
	Validate and select the component vectors for a solution state.

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 GradientStateContainer &	_state_values
	Gradient fields indexed by solution time state.

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<libMesh::NumericVector<libMesh::Number> *>

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

Definition at line 36 of file LinearFVGradientReader.h.

◆ GradientStateContainer

using LinearFVGradientReader::GradientStateContainer = std::vector<GradientContainer>

Gradient fields indexed by solution time state.

Definition at line 39 of file LinearFVGradientReader.h.

Constructor & Destructor Documentation

◆ LinearFVGradientReader()

LinearFVGradientReader::LinearFVGradientReader	(	const SystemBase &	sys,
		const GradientStateContainer &	state_values,
		const FVGradientMethod &	method,
		unsigned int	variable_number
	)

Parameters

sys	System that owns the variables and gradient values.
state_values	Gradient fields indexed by solution time state.
method	Gradient method that produces the values read by this object.
variable_number	Variable number whose gradient this object reads.

Definition at line 23 of file LinearFVGradientReader.C.

  : _sys(sys),
    _system_number(sys.number()),
    _state_values(state_values),
    _method(method),
    _variable_number(variable_number)
{
  mooseAssert(!_state_values.empty(), "Gradient state storage must contain a current state.");
}

Member Function Documentation

◆ component() [1/2]

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 37 of file LinearFVGradientReader.C.

{
  return component(elem_info, index, Moose::currentState());
}

Referenced by component(), and gradient().

◆ component() [2/2]

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

Read one gradient component at an element and solution state.

Parameters

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

Definition at line 93 of file LinearFVGradientReader.C.

{
  const auto & components = stateComponents(state);
  mooseAssert(index < components.size(), "Gradient component index out of range.");
  mooseAssert(components[index], "Gradient component vector must be initialized.");
 
  return (*components[index])(elem_info.dofIndices()[_system_number][_variable_number]);
}

◆ components() [1/2]

const LinearFVGradientReader::GradientContainer & LinearFVGradientReader::components ( ) const

Access the underlying component vectors keyed by spatial direction.

Definition at line 43 of file LinearFVGradientReader.C.

{
  return components(Moose::currentState());
}

Referenced by component(), and components().

◆ components() [2/2]

const LinearFVGradientReader::GradientContainer & LinearFVGradientReader::components ( const Moose::StateArg & state ) const

Access the component vectors for a solution state.

Parameters

state State whose gradient components should be accessed.

Definition at line 49 of file LinearFVGradientReader.C.

{
  return stateComponents(state);
}

◆ gradient() [1/4]

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 105 of file LinearFVGradientReader.C.

{
  return gradient(elem_info, Moose::currentState());
}

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

◆ gradient() [2/4]

RealVectorValue LinearFVGradientReader::gradient	(	const ElemInfo &	elem_info,
		const Moose::StateArg &	state
	)		const

Read the full gradient at an element and solution state.

Parameters

elem_info	Element whose cell-centered gradient should be read.
state	State whose gradient should be read.

Definition at line 111 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, state);
 
  return value;
}

◆ gradient() [3/4]

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 122 of file LinearFVGradientReader.C.

{
  return gradient(fi, Moose::currentState());
}

◆ gradient() [4/4]

RealVectorValue LinearFVGradientReader::gradient	(	const FaceInfo &	fi,
		const Moose::StateArg &	state
	)		const

Read the full gradient interpolated to a face at a solution state.

Parameters

fi	Face whose interpolated gradient should be read.
state	State whose gradient should be read.

Definition at line 128 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, state);
 
  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, state);
    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 65 of file LinearFVGradientReader.h.

65{ return _method; }

Referenced by LinearFVGradientManager::updateFVGradient().

◆ stateComponents()

const LinearFVGradientReader::GradientContainer & LinearFVGradientReader::stateComponents ( const Moose::StateArg & state ) const

private

Validate and select the component vectors for a solution state.

Definition at line 55 of file LinearFVGradientReader.C.

{
  mooseAssert(!_state_values.empty(), "Gradient state storage must contain a current state.");
 
  if (state.state > 0 && state.iteration_type != Moose::SolutionIterationType::Time)
    mooseError("Linear FV gradient state ",
               state.state,
               " with iteration type '",
               Moose::stringify(state.iteration_type),
               "' was requested for variable '",
               _sys.getVariable(0, _variable_number).name(),
               "'",
               " on system '",
               _sys.name(),
               "' using gradient method '",
               _method.name(),
               "'. Only time iteration states are supported for non-current gradients.");
 
  if (state.state >= _state_values.size())
    mooseError("Linear FV gradient state ",
               state.state,
               " with iteration type '",
               Moose::stringify(state.iteration_type),
               "' was requested for variable '",
               _sys.getVariable(0, _variable_number).name(),
               "'",
               " on system '",
               _sys.name(),
               "' using gradient method '",
               _method.name(),
               "', but the maximum allocated state is ",
               _state_values.size() - 1,
               ".");
 
  return _state_values[state.state];
}

Referenced by component(), and components().

◆ system()

const SystemBase & LinearFVGradientReader::system ( ) const

inline

System whose DOF map indexes the stored values.

Definition at line 62 of file LinearFVGradientReader.h.

62{ return _sys; }

Referenced by LinearFVGradientManager::updateFVGradient().

Member Data Documentation

◆ _method

const FVGradientMethod& LinearFVGradientReader::_method

private

Method object that produces the stored values.

Definition at line 123 of file LinearFVGradientReader.h.

Referenced by method(), and stateComponents().

◆ _state_values

const GradientStateContainer& LinearFVGradientReader::_state_values

private

Gradient fields indexed by solution time state.

Definition at line 120 of file LinearFVGradientReader.h.

Referenced by LinearFVGradientReader(), and stateComponents().

◆ _sys

const SystemBase& LinearFVGradientReader::_sys

private

System the variable belongs to.

Definition at line 114 of file LinearFVGradientReader.h.

Referenced by stateComponents(), and system().

◆ _system_number

const unsigned int LinearFVGradientReader::_system_number

private

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

Definition at line 117 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 126 of file LinearFVGradientReader.h.

Referenced by component(), gradient(), and stateComponents().

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

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

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ GradientContainer

◆ GradientStateContainer

Constructor & Destructor Documentation

◆ LinearFVGradientReader()

Member Function Documentation

◆ component() [1/2]

◆ component() [2/2]

◆ components() [1/2]

◆ components() [2/2]

◆ gradient() [1/4]

◆ gradient() [2/4]

◆ gradient() [3/4]

◆ gradient() [4/4]

◆ method()

◆ stateComponents()

◆ system()

Member Data Documentation

◆ _method

◆ _state_values

◆ _sys

◆ _system_number

◆ _variable_number