LinearFVGradientReader.h

Go to the documentation of this file.

//* This file is part of the MOOSE framework
//* https://mooseframework.inl.gov
//*
//* All rights reserved, see COPYRIGHT for full restrictions
//* https://github.com/idaholab/moose/blob/master/COPYRIGHT
//*
//* Licensed under LGPL 2.1, please see LICENSE for details
//* https://www.gnu.org/licenses/lgpl-2.1.html
 
#pragma once
 
#include "MooseFunctorArguments.h"
#include "MooseTypes.h"
 
#include <string>
#include <vector>
 
class SystemBase;
class ElemInfo;
class FaceInfo;
class FVGradientMethod;
 
namespace libMesh
{
template <typename T>
class NumericVector;
}
 
class LinearFVGradientReader
{
public:
  using GradientContainer = std::vector<libMesh::NumericVector<libMesh::Number> *>;
 
  using GradientStateContainer = std::vector<GradientContainer>;
 
  LinearFVGradientReader(const SystemBase & sys,
                         const GradientStateContainer & state_values,
                         const FVGradientMethod & method,
                         unsigned int variable_number);
 
  const GradientContainer & components() const;
 
  const GradientContainer & components(const Moose::StateArg & state) const;
 
  const SystemBase & system() const { return _sys; }
 
  const FVGradientMethod & method() const { return _method; }
 
  Real component(const ElemInfo & elem_info, unsigned int index) const;
 
  Real
  component(const ElemInfo & elem_info, unsigned int index, const Moose::StateArg & state) const;
 
  RealVectorValue gradient(const ElemInfo & elem_info) const;
 
  RealVectorValue gradient(const ElemInfo & elem_info, const Moose::StateArg & state) const;
 
  RealVectorValue gradient(const FaceInfo & fi) const;
 
  RealVectorValue gradient(const FaceInfo & fi, const Moose::StateArg & state) const;
 
private:
  const GradientContainer & stateComponents(const Moose::StateArg & state) const;
 
  const SystemBase & _sys;
 
  const unsigned int _system_number;
 
  const GradientStateContainer & _state_values;
 
  const FVGradientMethod & _method;
 
  const unsigned int _variable_number;
};