https://mooseframework.inl.gov
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Protected Attributes | Private Attributes | List of all members
LinearFVScalarAdvection Class Reference

An advection kernel that implements the advection term for the passive scalar transport equation. More...

#include <LinearFVScalarAdvection.h>

Inheritance diagram for LinearFVScalarAdvection:
[legend]

Public Types

enum  ResidualTagType { ResidualTagType::NonReference, ResidualTagType::Reference }
 
typedef DataFileName DataFileParameterType
 

Public Member Functions

 LinearFVScalarAdvection (const InputParameters &params)
 
virtual Real computeElemMatrixContribution () override
 
virtual Real computeNeighborMatrixContribution () override
 
virtual Real computeElemRightHandSideContribution () override
 
virtual Real computeNeighborRightHandSideContribution () override
 
virtual Real computeBoundaryMatrixContribution (const LinearFVBoundaryCondition &bc) override
 
virtual Real computeBoundaryRHSContribution (const LinearFVBoundaryCondition &bc) override
 
virtual void setupFaceData (const FaceInfo *face_info) override
 
virtual void addMatrixContribution () override
 
virtual void addRightHandSideContribution () override
 
virtual bool hasFaceSide (const FaceInfo &fi, bool fi_elem_side) const override
 
void setCurrentFaceArea (const Real area)
 
virtual Real computeBoundaryFlux (const LinearFVBoundaryCondition &bc)
 
virtual const MooseLinearVariableFV< Real > & variable () const override
 
void linkTaggedVectorsAndMatrices (const std::set< TagID > &vector_tags, const std::set< TagID > &matrix_tags)
 
virtual bool enabled () const
 
std::shared_ptr< MooseObject > getSharedPtr ()
 
std::shared_ptr< const MooseObject > getSharedPtr () const
 
bool isKokkosObject () const
 
MooseApp & getMooseApp () const
 
const std::string & type () const
 
const std::string & name () const
 
std::string typeAndName () const
 
MooseObjectParameterName uniqueParameterName (const std::string &parameter_name) const
 
MooseObjectName uniqueName () const
 
const InputParameters & parameters () const
 
const hit::Node * getHitNode () const
 
bool hasBase () const
 
const std::string & getBase () const
 
const T & getParam (const std::string &name) const
 
std::vector< std::pair< T1, T2 > > getParam (const std::string &param1, const std::string &param2) const
 
const T * queryParam (const std::string &name) const
 
const T & getRenamedParam (const std::string &old_name, const std::string &new_name) const
 
T getCheckedPointerParam (const std::string &name, const std::string &error_string="") const
 
bool isParamValid (const std::string &name) const
 
bool isParamSetByUser (const std::string &name) const
 
void connectControllableParams (const std::string &parameter, const std::string &object_type, const std::string &object_name, const std::string &object_parameter) const
 
void paramError (const std::string &param, Args... args) const
 
void paramWarning (const std::string &param, Args... args) const
 
void paramWarning (const std::string &param, Args... args) const
 
void paramInfo (const std::string &param, Args... args) const
 
std::string messagePrefix (const bool hit_prefix=true) const
 
std::string errorPrefix (const std::string &) const
 
void mooseError (Args &&... args) const
 
void mooseDocumentedError (const std::string &repo_name, const unsigned int issue_num, Args &&... args) const
 
void mooseErrorNonPrefixed (Args &&... args) const
 
void mooseWarning (Args &&... args) const
 
void mooseWarning (Args &&... args) const
 
void mooseWarningNonPrefixed (Args &&... args) const
 
void mooseWarningNonPrefixed (Args &&... args) const
 
void mooseDeprecated (Args &&... args) const
 
void mooseDeprecated (Args &&... args) const
 
void mooseDeprecatedNoTrace (Args &&... args) const
 
void mooseInfo (Args &&... args) const
 
void callMooseError (std::string msg, const bool with_prefix, const hit::Node *node=nullptr, const bool show_trace=true) const
 
std::string getDataFileName (const std::string &param) const
 
std::string getDataFileNameByName (const std::string &relative_path) const
 
std::string getDataFilePath (const std::string &relative_path) const
 
virtual void initialSetup ()
 
virtual void timestepSetup ()
 
virtual void jacobianSetup ()
 
virtual void residualSetup ()
 
virtual void subdomainSetup ()
 
virtual void customSetup (const ExecFlagType &)
 
const ExecFlagEnum & getExecuteOnEnum () const
 
const Function & getFunction (const std::string &name) const
 
const Function & getFunctionByName (const FunctionName &name) const
 
bool hasFunction (const std::string &param_name) const
 
bool hasFunctionByName (const FunctionName &name) const
 
Moose::Kokkos::Function getKokkosFunction (const std::string &name) const
 
const T & getKokkosFunction (const std::string &name) const
 
Moose::Kokkos::Function getKokkosFunctionByName (const FunctionName &name) const
 
const T & getKokkosFunctionByName (const FunctionName &name) const
 
bool hasKokkosFunction (const std::string &param_name) const
 
bool hasKokkosFunctionByName (const FunctionName &name) const
 
UserObjectName getUserObjectName (const std::string &param_name) const
 
const T & getUserObject (const std::string &param_name, bool is_dependency=true) const
 
const T & getUserObjectByName (const UserObjectName &object_name, bool is_dependency=true) const
 
const UserObjectBase & getUserObjectBase (const std::string &param_name, bool is_dependency=true) const
 
const UserObjectBase & getUserObjectBaseByName (const UserObjectName &object_name, bool is_dependency=true) const
 
bool isImplicit ()
 
Moose::StateArg determineState () const
 
bool isDefaultPostprocessorValue (const std::string &param_name, const unsigned int index=0) const
 
bool hasPostprocessor (const std::string &param_name, const unsigned int index=0) const
 
bool hasPostprocessorByName (const PostprocessorName &name) const
 
std::size_t coupledPostprocessors (const std::string &param_name) const
 
const PostprocessorName & getPostprocessorName (const std::string &param_name, const unsigned int index=0) const
 
const VectorPostprocessorValue & getVectorPostprocessorValue (const std::string &param_name, const std::string &vector_name) const
 
const VectorPostprocessorValue & getVectorPostprocessorValue (const std::string &param_name, const std::string &vector_name, bool needs_broadcast) const
 
const VectorPostprocessorValue & getVectorPostprocessorValueByName (const VectorPostprocessorName &name, const std::string &vector_name) const
 
const VectorPostprocessorValue & getVectorPostprocessorValueByName (const VectorPostprocessorName &name, const std::string &vector_name, bool needs_broadcast) const
 
const VectorPostprocessorValue & getVectorPostprocessorValueOld (const std::string &param_name, const std::string &vector_name) const
 
const VectorPostprocessorValue & getVectorPostprocessorValueOld (const std::string &param_name, const std::string &vector_name, bool needs_broadcast) const
 
const VectorPostprocessorValue & getVectorPostprocessorValueOldByName (const VectorPostprocessorName &name, const std::string &vector_name) const
 
const VectorPostprocessorValue & getVectorPostprocessorValueOldByName (const VectorPostprocessorName &name, const std::string &vector_name, bool needs_broadcast) const
 
const ScatterVectorPostprocessorValue & getScatterVectorPostprocessorValue (const std::string &param_name, const std::string &vector_name) const
 
const ScatterVectorPostprocessorValue & getScatterVectorPostprocessorValueByName (const VectorPostprocessorName &name, const std::string &vector_name) const
 
const ScatterVectorPostprocessorValue & getScatterVectorPostprocessorValueOld (const std::string &param_name, const std::string &vector_name) const
 
const ScatterVectorPostprocessorValue & getScatterVectorPostprocessorValueOldByName (const VectorPostprocessorName &name, const std::string &vector_name) const
 
bool hasVectorPostprocessor (const std::string &param_name, const std::string &vector_name) const
 
bool hasVectorPostprocessor (const std::string &param_name) const
 
bool hasVectorPostprocessorByName (const VectorPostprocessorName &name, const std::string &vector_name) const
 
bool hasVectorPostprocessorByName (const VectorPostprocessorName &name) const
 
const VectorPostprocessorName & getVectorPostprocessorName (const std::string &param_name) const
 
void setRandomResetFrequency (ExecFlagType exec_flag)
 
unsigned long getRandomLong () const
 
Real getRandomReal () const
 
unsigned int getSeed (std::size_t id)
 
unsigned int getMasterSeed () const
 
bool isNodal () const
 
ExecFlagType getResetOnTime () const
 
void setRandomDataPointer (RandomData *random_data)
 
virtual void meshChanged ()
 
void useVectorTag (const TagName &tag_name, VectorTagsKey)
 
void useVectorTag (TagID tag_id, VectorTagsKey)
 
void useMatrixTag (const TagName &tag_name, MatrixTagsKey)
 
void useMatrixTag (TagID tag_id, MatrixTagsKey)
 
bool isVectorTagged ()
 
bool isMatrixTagged ()
 
bool hasVectorTags () const
 
const std::set< TagID > & getVectorTags (VectorTagsKey) const
 
const std::set< TagID > & getMatrixTags (MatrixTagsKey) const
 
const std::vector< SubdomainName > & blocks () const
 
unsigned int numBlocks () const
 
virtual const std::set< SubdomainID > & blockIDs () const
 
unsigned int blocksMaxDimension () const
 
bool hasBlocks (const SubdomainName &name) const
 
bool hasBlocks (const std::vector< SubdomainName > &names) const
 
bool hasBlocks (const std::set< SubdomainName > &names) const
 
bool hasBlocks (SubdomainID id) const
 
bool hasBlocks (const std::vector< SubdomainID > &ids) const
 
bool hasBlocks (const std::set< SubdomainID > &ids) const
 
bool isBlockSubset (const std::set< SubdomainID > &ids) const
 
bool isBlockSubset (const std::vector< SubdomainID > &ids) const
 
bool hasBlockMaterialProperty (const std::string &prop_name)
 
const std::set< SubdomainID > & meshBlockIDs () const
 
virtual bool blockRestricted () const
 
virtual void checkVariable (const MooseVariableFieldBase &variable) const
 
MooseVariableBase * mooseVariableBase () const
 
MooseVariableField< Real > & mooseVariableField ()
 
MooseVariableFE< Real > * mooseVariable () const
 
MooseVariableFV< Real > * mooseVariableFV () const
 
MooseLinearVariableFV< Real > * mooseLinearVariableFV () const
 
const std::set< MooseVariableFieldBase *> & getMooseVariableDependencies () const
 
std::set< MooseVariableFieldBase *> checkAllVariables (const DofObjectType &dof_object, const std::set< MooseVariableFieldBase * > &vars_to_omit={})
 
virtual std::set< MooseVariableFieldBase *> checkVariables (const libMesh::Node &node, const std::set< MooseVariableFieldBase * > &vars_to_check)
 
std::set< MooseVariableFieldBase *> checkVariables (const libMesh::Elem &element, const std::set< MooseVariableFieldBase * > &vars_to_check)
 
void addMooseVariableDependency (MooseVariableFieldBase *var)
 
void addMooseVariableDependency (const std::vector< MooseVariableFieldBase * > &vars)
 
Moose::FaceArg makeFace (const FaceInfo &fi, const Moose::FV::LimiterType limiter_type, const bool elem_is_upwind, const bool correct_skewness=false, const Moose::StateArg *state_limiter=nullptr) const
 
Moose::FaceArg makeCDFace (const FaceInfo &fi, const bool correct_skewness=false) const
 
bool hasUserObject (const std::string &param_name) const
 
bool hasUserObject (const std::string &param_name) const
 
bool hasUserObject (const std::string &param_name) const
 
bool hasUserObject (const std::string &param_name) const
 
bool hasUserObjectByName (const UserObjectName &object_name) const
 
bool hasUserObjectByName (const UserObjectName &object_name) const
 
bool hasUserObjectByName (const UserObjectName &object_name) const
 
bool hasUserObjectByName (const UserObjectName &object_name) const
 
const PostprocessorValue & getPostprocessorValue (const std::string &param_name, const unsigned int index=0) const
 
const PostprocessorValue & getPostprocessorValue (const std::string &param_name, const unsigned int index=0) const
 
const PostprocessorValue & getPostprocessorValueOld (const std::string &param_name, const unsigned int index=0) const
 
const PostprocessorValue & getPostprocessorValueOld (const std::string &param_name, const unsigned int index=0) const
 
const PostprocessorValue & getPostprocessorValueOlder (const std::string &param_name, const unsigned int index=0) const
 
const PostprocessorValue & getPostprocessorValueOlder (const std::string &param_name, const unsigned int index=0) const
 
virtual const PostprocessorValue & getPostprocessorValueByName (const PostprocessorName &name) const
 
virtual const PostprocessorValue & getPostprocessorValueByName (const PostprocessorName &name) const
 
const PostprocessorValue & getPostprocessorValueOldByName (const PostprocessorName &name) const
 
const PostprocessorValue & getPostprocessorValueOldByName (const PostprocessorName &name) const
 
const PostprocessorValue & getPostprocessorValueOlderByName (const PostprocessorName &name) const
 
const PostprocessorValue & getPostprocessorValueOlderByName (const PostprocessorName &name) const
 
bool isVectorPostprocessorDistributed (const std::string &param_name) const
 
bool isVectorPostprocessorDistributed (const std::string &param_name) const
 
bool isVectorPostprocessorDistributedByName (const VectorPostprocessorName &name) const
 
bool isVectorPostprocessorDistributedByName (const VectorPostprocessorName &name) const
 
const Parallel::Communicator & comm () const
 
processor_id_type n_processors () const
 
processor_id_type processor_id () const
 
const FVFaceInterpolationMethod & getFVFaceInterpolationMethod (const InterpolationMethodName &name) const
 
const FVAdvectedInterpolationMethod & getFVAdvectedInterpolationMethod (const InterpolationMethodName &name) const
 
bool hasFVInterpolationMethod (const InterpolationMethodName &name) const
 

Static Public Member Functions

static InputParameters validParams ()
 
static void callMooseError (MooseApp *const app, const InputParameters &params, std::string msg, const bool with_prefix, const hit::Node *node, const bool show_trace=true)
 
static std::string deduceFunctorName (const std::string &name, const InputParameters &params)
 
static void setRMParamsAdvection (const InputParameters &obj_params, InputParameters &rm_params, const unsigned short conditional_extended_layers)
 
static void setRMParamsDiffusion (const InputParameters &obj_params, InputParameters &rm_params, const unsigned short conditional_extended_layers)
 

Public Attributes

 usingCombinedWarningSolutionWarnings
 
const ConsoleStream _console
 

Static Public Attributes

static const std::string type_param
 
static const std::string name_param
 
static const std::string unique_name_param
 
static const std::string app_param
 
static const std::string moose_base_param
 
static const std::string kokkos_object_param
 

Protected Member Functions

std::string deduceFunctorName (const std::string &name) const
 
Moose::FaceArg singleSidedFaceArg (const FaceInfo *fi, Moose::FV::LimiterType limiter_type=Moose::FV::LimiterType::CentralDifference, bool correct_skewness=false) const
 
void requestVariableCellGradient (const std::string &variable_name)
 
void flagInvalidSolutionInternal (const InvalidSolutionID invalid_solution_id) const
 
InvalidSolutionID registerInvalidSolutionInternal (const std::string &message, const bool warning) const
 
virtual void addUserObjectDependencyHelper (const UserObjectBase &) const
 
virtual void addPostprocessorDependencyHelper (const PostprocessorName &) const
 
virtual void addVectorPostprocessorDependencyHelper (const VectorPostprocessorName &) const
 
T & declareRestartableData (const std::string &data_name, Args &&... args)
 
ManagedValue< T > declareManagedRestartableDataWithContext (const std::string &data_name, void *context, Args &&... args)
 
const T & getRestartableData (const std::string &data_name) const
 
T & declareRestartableDataWithContext (const std::string &data_name, void *context, Args &&... args)
 
T & declareRecoverableData (const std::string &data_name, Args &&... args)
 
T & declareRestartableDataWithObjectName (const std::string &data_name, const std::string &object_name, Args &&... args)
 
T & declareRestartableDataWithObjectNameWithContext (const std::string &data_name, const std::string &object_name, void *context, Args &&... args)
 
std::string restartableName (const std::string &data_name) const
 
void prepareVectorTag (Assembly &assembly, unsigned int ivar)
 
void prepareVectorTag (Assembly &assembly, unsigned int ivar, ResidualTagType tag_type)
 
void prepareVectorTag (Assembly &assembly, unsigned int ivar, ResidualTagType tag_type)
 
void prepareVectorTag (Assembly &assembly, unsigned int ivar, ResidualTagType tag_type)
 
void prepareVectorTag (Assembly &assembly, unsigned int ivar, ResidualTagType tag_type)
 
void prepareVectorTagNeighbor (Assembly &assembly, unsigned int ivar)
 
void prepareVectorTagLower (Assembly &assembly, unsigned int ivar)
 
void prepareMatrixTag (Assembly &assembly, unsigned int ivar, unsigned int jvar)
 
void prepareMatrixTag (Assembly &assembly, unsigned int ivar, unsigned int jvar, DenseMatrix< Number > &k) const
 
void prepareMatrixTagNonlocal (Assembly &assembly, unsigned int ivar, unsigned int jvar)
 
void prepareMatrixTagNeighbor (Assembly &assembly, unsigned int ivar, unsigned int jvar, Moose::DGJacobianType type)
 
void prepareMatrixTagNeighbor (Assembly &assembly, unsigned int ivar, unsigned int jvar, Moose::DGJacobianType type, DenseMatrix< Number > &k) const
 
void prepareMatrixTagLower (Assembly &assembly, unsigned int ivar, unsigned int jvar, Moose::ConstraintJacobianType type)
 
void accumulateTaggedLocalResidual ()
 
void assignTaggedLocalResidual ()
 
void accumulateTaggedLocalMatrix ()
 
void accumulateTaggedLocalMatrix (Assembly &assembly, unsigned int ivar, unsigned int jvar, const DenseMatrix< Number > &k)
 
void accumulateTaggedLocalMatrix (Assembly &assembly, unsigned int ivar, unsigned int jvar, Moose::DGJacobianType type, const DenseMatrix< Number > &k)
 
void accumulateTaggedNonlocalMatrix ()
 
void assignTaggedLocalMatrix ()
 
void addResiduals (Assembly &assembly, const Residuals &residuals, const Indices &dof_indices, Real scaling_factor)
 
void addResiduals (Assembly &assembly, const Residuals &residuals, const Indices &dof_indices, const std::vector< Real > &scaling_factors)
 
void addResiduals (Assembly &assembly, const DenseVector< T > &residuals, const Indices &dof_indices, Real scaling_factor)
 
void addResiduals (Assembly &assembly, const ADResidualsPacket &packet)
 
void addResidualsAndJacobian (Assembly &assembly, const Residuals &residuals, const Indices &dof_indices, Real scaling_factor)
 
void addResidualsAndJacobian (Assembly &assembly, const ADResidualsPacket &packet)
 
void addJacobian (Assembly &assembly, const Residuals &residuals, const Indices &dof_indices, Real scaling_factor)
 
void addJacobian (Assembly &assembly, const Residuals &residuals, const Indices &dof_indices, const std::vector< Real > &scaling_factors)
 
void addJacobian (Assembly &assembly, const ADResidualsPacket &packet)
 
void addJacobian (Assembly &assembly, const DenseMatrix< Real > &local_k, const std::vector< dof_id_type > &row_indices, const std::vector< dof_id_type > &column_indices, Real scaling_factor)
 
void addResidualsWithoutConstraints (Assembly &assembly, const Residuals &residuals, const Indices &dof_indices, Real scaling_factor)
 
void addResidualsAndJacobianWithoutConstraints (Assembly &assembly, const Residuals &residuals, const Indices &dof_indices, Real scaling_factor)
 
void addJacobianWithoutConstraints (Assembly &assembly, const Residuals &residuals, const Indices &dof_indices, Real scaling_factor)
 
void addJacobianElement (Assembly &assembly, Real value, dof_id_type row_index, dof_id_type column_index, Real scaling_factor)
 
void setResidual (SystemBase &sys, const T &residual, MooseVariableFE< T > &var)
 
void setResidual (SystemBase &sys, Real residual, dof_id_type dof_index)
 
void setResidual (SystemBase &sys, SetResidualFunctor set_residual_functor)
 
virtual bool hasBlockMaterialPropertyHelper (const std::string &prop_name)
 
void initializeBlockRestrictable (const MooseObject *moose_object)
 
void initializeKokkosBlockRestrictable ()
 
Moose::CoordinateSystemType getBlockCoordSystem ()
 
KOKKOS_FUNCTION dof_id_type numKokkosBlockElements () const
 
KOKKOS_FUNCTION dof_id_type numKokkosBlockNodes () const
 
KOKKOS_FUNCTION dof_id_type numKokkosBlockSides () const
 
KOKKOS_FUNCTION ContiguousElementID kokkosBlockElementID (Moose::Kokkos::ThreadID tid) const
 
KOKKOS_FUNCTION ContiguousElementID kokkosBlockNodeID (Moose::Kokkos::ThreadID tid) const
 
KOKKOS_FUNCTION auto kokkosBlockElementSideID (Moose::Kokkos::ThreadID tid) const
 
const Moose::Functor< T > & getFunctor (const std::string &name)
 
const Moose::Functor< T > & getFunctor (const std::string &name, THREAD_ID tid)
 
const Moose::Functor< T > & getFunctor (const std::string &name, SubProblem &subproblem)
 
const Moose::Functor< T > & getFunctor (const std::string &name, SubProblem &subproblem, THREAD_ID tid)
 
bool isFunctor (const std::string &name) const
 
bool isFunctor (const std::string &name, const SubProblem &subproblem) const
 
Moose::ElemArg makeElemArg (const Elem *elem, bool correct_skewnewss=false) const
 
void checkFunctorSupportsSideIntegration (const std::string &name, bool qp_integration)
 
const Moose::Functor< T > & getFunctorByName (const std::string &name)
 
virtual const OutputTools< Real >::VariableValue & value ()
 
virtual const OutputTools< Real >::VariableValue & valueOld ()
 
virtual const OutputTools< Real >::VariableValue & valueOlder ()
 
virtual const OutputTools< Real >::VariableValue & dot ()
 
virtual const OutputTools< Real >::VariableValue & dotDot ()
 
virtual const OutputTools< Real >::VariableValue & dotOld ()
 
virtual const OutputTools< Real >::VariableValue & dotDotOld ()
 
virtual const VariableValue & dotDu ()
 
virtual const VariableValue & dotDotDu ()
 
virtual const OutputTools< Real >::VariableGradient & gradient ()
 
virtual const OutputTools< Real >::VariableGradient & gradientOld ()
 
virtual const OutputTools< Real >::VariableGradient & gradientOlder ()
 
virtual const OutputTools< Real >::VariableSecond & second ()
 
virtual const OutputTools< Real >::VariableSecond & secondOld ()
 
virtual const OutputTools< Real >::VariableSecond & secondOlder ()
 
virtual const OutputTools< Real >::VariableTestSecond & secondTest ()
 
virtual const OutputTools< Real >::VariableTestSecond & secondTestFace ()
 
virtual const OutputTools< Real >::VariablePhiSecond & secondPhi ()
 
virtual const OutputTools< Real >::VariablePhiSecond & secondPhiFace ()
 

Protected Attributes

const RhieChowMassFlux & _mass_flux_provider
 The Rhie-Chow user object that provides us with the face velocity. More...
 
const FaceInfo * _current_face_info
 
Real _current_face_area
 
FaceInfo::VarFaceNeighbors _current_face_type
 
bool _cached_matrix_contribution
 
bool _cached_rhs_contribution
 
const bool _force_boundary_execution
 
DenseVector< dof_id_type > _dof_indices
 
DenseMatrix< Real > _matrix_contribution
 
DenseVector< Real > _rhs_contribution
 
MooseLinearVariableFV< Real > & _var
 
const unsigned int _var_num
 
const unsigned int _sys_num
 
FEProblemBase & _fe_problem
 
SystemBase & _sys
 
libMesh::LinearImplicitSystem & _linear_system
 
const THREAD_ID _tid
 
MooseMesh & _mesh
 
std::vector< NumericVector< Number > *> _vectors
 
std::vector< SparseMatrix< Number > *> _matrices
 
const bool & _enabled
 
MooseApp & _app
 
Factory & _factory
 
ActionFactory & _action_factory
 
const std::string & _type
 
const std::string & _name
 
const InputParameters & _pars
 
const ExecFlagEnum & _execute_enum
 
const ExecFlagType & _current_execute_flag
 
const InputParameters & _ti_params
 
FEProblemBase & _ti_feproblem
 
bool _is_implicit
 
Real & _t
 
const Real & _t_old
 
int & _t_step
 
Real & _dt
 
Real & _dt_old
 
bool _is_transient
 
MooseApp & _restartable_app
 
const std::string _restartable_system_name
 
const THREAD_ID _restartable_tid
 
const bool _restartable_read_only
 
FEProblemBase & _mci_feproblem
 
SubProblem & _subproblem
 
DenseVector< Number > _local_re
 
DenseMatrix< Number > _local_ke
 
DenseMatrix< Number > _nonlocal_ke
 
const MaterialData * _blk_material_data
 
bool _nodal
 
MooseVariableFE< Real > * _variable
 
MooseVariableFV< Real > * _fv_variable
 
MooseLinearVariableFV< Real > * _linear_fv_variable
 
MooseVariableField< Real > * _field_variable
 
Assembly * _mvi_assembly
 
const Parallel::Communicator & _communicator
 
const InputParameters & _fvim_params
 
FEProblemBase & _fvim_feproblem
 
const THREAD_ID _fvim_tid
 

Private Attributes

const FVAdvectedInterpolationMethod & _adv_interp_method
 The interpolation method to use for the advected quantity. More...
 
FVAdvectedInterpolationMethod::AdvectedSystemContribution _adv_interp_result
 Cached weights/correction for the current face (refreshed in setupFaceData) More...
 
VectorValue< Real > _elem_grad_storage
 Reusable gradient storage used when advected interpolation requires gradients. More...
 
VectorValue< Real > _neighbor_grad_storage
 
Real _volumetric_face_flux
 Container for the velocity on the face which will be reused in the advection term's matrix and right hand side contribution. More...
 
const Moose::Functor< ADReal > *const _u_slip
 slip velocity in direction x More...
 
const Moose::Functor< ADReal > *const _v_slip
 slip velocity in direction y More...
 
const Moose::Functor< ADReal > *const _w_slip
 slip velocity in direction z More...
 
bool _add_slip_model
 Whether to use an additional slip velocity to compute the face flux. More...
 

Detailed Description

An advection kernel that implements the advection term for the passive scalar transport equation.

Definition at line 21 of file LinearFVScalarAdvection.h.

Constructor & Destructor Documentation

◆ LinearFVScalarAdvection()

LinearFVScalarAdvection::LinearFVScalarAdvection ( const InputParameters &  params)

Definition at line 34 of file LinearFVScalarAdvection.C.

35  : LinearFVFluxKernel(params),
36  FVInterpolationMethodInterface(this),
37  _mass_flux_provider(getUserObject<RhieChowMassFlux>("rhie_chow_user_object")),
38  _adv_interp_method(getFVAdvectedInterpolationMethod(
39  getParam<InterpolationMethodName>("advected_interp_method_name"))),
40  _volumetric_face_flux(0.0),
41  _u_slip(isParamValid("u_slip") ? &getFunctor<ADReal>("u_slip") : nullptr),
42  _v_slip(isParamValid("v_slip") ? &getFunctor<ADReal>("v_slip") : nullptr),
43  _w_slip(isParamValid("w_slip") ? &getFunctor<ADReal>("w_slip") : nullptr),
44  _add_slip_model(isParamValid("u_slip") ? true : false)
45 {
46  if (_adv_interp_method.needsGradients())
47  _var.computeCellGradients(_adv_interp_method.gradientLimiter());
48 }
LinearFVScalarAdvection::_adv_interp_method
const FVAdvectedInterpolationMethod & _adv_interp_method
The interpolation method to use for the advected quantity.
Definition: LinearFVScalarAdvection.h:47
LinearFVFluxKernel::_var
MooseLinearVariableFV< Real > & _var
FVAdvectedInterpolationMethod::gradientLimiter
virtual Moose::FV::GradientLimiterType gradientLimiter() const
FVInterpolationMethodInterface::getFVAdvectedInterpolationMethod
const FVAdvectedInterpolationMethod & getFVAdvectedInterpolationMethod(const InterpolationMethodName &name) const
LinearFVScalarAdvection::_add_slip_model
bool _add_slip_model
Whether to use an additional slip velocity to compute the face flux.
Definition: LinearFVScalarAdvection.h:68
FVInterpolationMethodInterface::FVInterpolationMethodInterface
FVInterpolationMethodInterface(const MooseObject *moose_object)
LinearFVScalarAdvection::_mass_flux_provider
const RhieChowMassFlux & _mass_flux_provider
The Rhie-Chow user object that provides us with the face velocity.
Definition: LinearFVScalarAdvection.h:43
LinearFVFluxKernel::LinearFVFluxKernel
LinearFVFluxKernel(const InputParameters &params)
LinearFVScalarAdvection::_volumetric_face_flux
Real _volumetric_face_flux
Container for the velocity on the face which will be reused in the advection term&#39;s matrix and right ...
Definition: LinearFVScalarAdvection.h:58
FVAdvectedInterpolationMethod::needsGradients
virtual bool needsGradients() const
LinearFVScalarAdvection::_v_slip
const Moose::Functor< ADReal > *const _v_slip
slip velocity in direction y
Definition: LinearFVScalarAdvection.h:63
LinearFVFluxKernel::isParamValid
bool isParamValid(const std::string &name) const
LinearFVScalarAdvection::_w_slip
const Moose::Functor< ADReal > *const _w_slip
slip velocity in direction z
Definition: LinearFVScalarAdvection.h:65
LinearFVScalarAdvection::_u_slip
const Moose::Functor< ADReal > *const _u_slip
slip velocity in direction x
Definition: LinearFVScalarAdvection.h:61

Member Function Documentation

◆ computeBoundaryMatrixContribution()

Real LinearFVScalarAdvection::computeBoundaryMatrixContribution ( const LinearFVBoundaryCondition &  bc)
overridevirtual

Implements LinearFVFluxKernel.

Definition at line 77 of file LinearFVScalarAdvection.C.

78 {
79  const auto * const adv_bc = static_cast<const LinearFVAdvectionDiffusionBC *>(&bc);
80  mooseAssert(adv_bc, "This should be a valid BC!");
81 
82  const auto boundary_value_matrix_contrib = adv_bc->computeBoundaryValueMatrixContribution();
83 
84  // We support internal boundaries too so we have to make sure the normal points always outward
85  const auto factor = (_current_face_type == FaceInfo::VarFaceNeighbors::ELEM) ? 1.0 : -1.0;
86 
87  return boundary_value_matrix_contrib * factor * _volumetric_face_flux * _current_face_area;
88 }
LinearFVFluxKernel::_current_face_type
FaceInfo::VarFaceNeighbors _current_face_type
LinearFVScalarAdvection::_volumetric_face_flux
Real _volumetric_face_flux
Container for the velocity on the face which will be reused in the advection term&#39;s matrix and right ...
Definition: LinearFVScalarAdvection.h:58

◆ computeBoundaryRHSContribution()

Real LinearFVScalarAdvection::computeBoundaryRHSContribution ( const LinearFVBoundaryCondition &  bc)
overridevirtual

Implements LinearFVFluxKernel.

Definition at line 91 of file LinearFVScalarAdvection.C.

92 {
93  const auto * const adv_bc = static_cast<const LinearFVAdvectionDiffusionBC *>(&bc);
94  mooseAssert(adv_bc, "This should be a valid BC!");
95 
96  // We support internal boundaries too so we have to make sure the normal points always outward
97  const auto factor = (_current_face_type == FaceInfo::VarFaceNeighbors::ELEM ? 1.0 : -1.0);
98 
99  const auto boundary_value_rhs_contrib = adv_bc->computeBoundaryValueRHSContribution();
100  return -boundary_value_rhs_contrib * factor * _volumetric_face_flux * _current_face_area;
101 }
LinearFVFluxKernel::_current_face_type
FaceInfo::VarFaceNeighbors _current_face_type
LinearFVScalarAdvection::_volumetric_face_flux
Real _volumetric_face_flux
Container for the velocity on the face which will be reused in the advection term&#39;s matrix and right ...
Definition: LinearFVScalarAdvection.h:58

◆ computeElemMatrixContribution()

Real LinearFVScalarAdvection::computeElemMatrixContribution ( )
overridevirtual

Implements LinearFVFluxKernel.

Definition at line 51 of file LinearFVScalarAdvection.C.

52 {
53  const auto & coeffs = _adv_interp_result.weights_matrix;
54  return coeffs.first * _volumetric_face_flux * _current_face_area;
55 }
LinearFVScalarAdvection::_volumetric_face_flux
Real _volumetric_face_flux
Container for the velocity on the face which will be reused in the advection term&#39;s matrix and right ...
Definition: LinearFVScalarAdvection.h:58
LinearFVScalarAdvection::_adv_interp_result
FVAdvectedInterpolationMethod::AdvectedSystemContribution _adv_interp_result
Cached weights/correction for the current face (refreshed in setupFaceData)
Definition: LinearFVScalarAdvection.h:50

◆ computeElemRightHandSideContribution()

Real LinearFVScalarAdvection::computeElemRightHandSideContribution ( )
overridevirtual

Implements LinearFVFluxKernel.

Definition at line 65 of file LinearFVScalarAdvection.C.

66 {
67  return _adv_interp_result.rhs_face_value * _volumetric_face_flux * _current_face_area;
68 }
LinearFVScalarAdvection::_volumetric_face_flux
Real _volumetric_face_flux
Container for the velocity on the face which will be reused in the advection term&#39;s matrix and right ...
Definition: LinearFVScalarAdvection.h:58
LinearFVScalarAdvection::_adv_interp_result
FVAdvectedInterpolationMethod::AdvectedSystemContribution _adv_interp_result
Cached weights/correction for the current face (refreshed in setupFaceData)
Definition: LinearFVScalarAdvection.h:50

◆ computeNeighborMatrixContribution()

Real LinearFVScalarAdvection::computeNeighborMatrixContribution ( )
overridevirtual

Implements LinearFVFluxKernel.

Definition at line 58 of file LinearFVScalarAdvection.C.

59 {
60  const auto & coeffs = _adv_interp_result.weights_matrix;
61  return coeffs.second * _volumetric_face_flux * _current_face_area;
62 }
LinearFVScalarAdvection::_volumetric_face_flux
Real _volumetric_face_flux
Container for the velocity on the face which will be reused in the advection term&#39;s matrix and right ...
Definition: LinearFVScalarAdvection.h:58
LinearFVScalarAdvection::_adv_interp_result
FVAdvectedInterpolationMethod::AdvectedSystemContribution _adv_interp_result
Cached weights/correction for the current face (refreshed in setupFaceData)
Definition: LinearFVScalarAdvection.h:50

◆ computeNeighborRightHandSideContribution()

Real LinearFVScalarAdvection::computeNeighborRightHandSideContribution ( )
overridevirtual

Implements LinearFVFluxKernel.

Definition at line 71 of file LinearFVScalarAdvection.C.

72 {
73  return -_adv_interp_result.rhs_face_value * _volumetric_face_flux * _current_face_area;
74 }
LinearFVScalarAdvection::_volumetric_face_flux
Real _volumetric_face_flux
Container for the velocity on the face which will be reused in the advection term&#39;s matrix and right ...
Definition: LinearFVScalarAdvection.h:58
LinearFVScalarAdvection::_adv_interp_result
FVAdvectedInterpolationMethod::AdvectedSystemContribution _adv_interp_result
Cached weights/correction for the current face (refreshed in setupFaceData)
Definition: LinearFVScalarAdvection.h:50

◆ setupFaceData()

void LinearFVScalarAdvection::setupFaceData ( const FaceInfo *  face_info)
overridevirtual

Reimplemented from LinearFVFluxKernel.

Definition at line 104 of file LinearFVScalarAdvection.C.

105 {
106  LinearFVFluxKernel::setupFaceData(face_info);
107 
108  // Caching the velocity on the face which will be reused in the advection term's matrix and right
109  // hand side contributions
110  _volumetric_face_flux = _mass_flux_provider.getVolumetricFaceFlux(*face_info);
111 
112  // Adjust volumetric face flux using the slip velocity
113  // TODO: add boundaries
114  if (_u_slip && face_info->neighborPtr())
115  {
116  const auto state = determineState();
117  Moose::FaceArg face_arg;
118  // TODO Add boundary treatment to be able select two-term expansion if desired
119  face_arg = Moose::FaceArg{face_info,
120  Moose::FV::LimiterType::CentralDifference,
121  true,
122  false,
123  face_info->neighborPtr(),
124  nullptr};
125 
126  RealVectorValue velocity_slip_vel_vec;
127  if (_u_slip)
128  velocity_slip_vel_vec(0) = (*_u_slip)(face_arg, state).value();
129  if (_v_slip)
130  velocity_slip_vel_vec(1) = (*_v_slip)(face_arg, state).value();
131  if (_w_slip)
132  velocity_slip_vel_vec(2) = (*_w_slip)(face_arg, state).value();
133  _volumetric_face_flux += velocity_slip_vel_vec * face_info->normal();
134  }
135 
136  // Only internal faces need advected interpolation results; boundary contributions are handled
137  // through the linear FV boundary conditions.
138  if (_current_face_type != FaceInfo::VarFaceNeighbors::BOTH)
139  return;
140 
141  const auto state = determineState();
142  const auto & elem_info = *_current_face_info->elemInfo();
143  const auto & neighbor_info = *_current_face_info->neighborInfo();
144 
145  const Real elem_value = _var.getElemValue(elem_info, state);
146  const Real neighbor_value = _var.getElemValue(neighbor_info, state);
147  if (_adv_interp_method.needsGradients())
148  {
149  const auto limiter_type = _adv_interp_method.gradientLimiter();
150  _elem_grad_storage = _var.gradSln(elem_info, state, limiter_type);
151  _neighbor_grad_storage = _var.gradSln(neighbor_info, state, limiter_type);
152  }
153 
154  _adv_interp_result = _adv_interp_method.advectedInterpolate(*_current_face_info,
155  elem_value,
156  neighbor_value,
157  &_elem_grad_storage,
158  &_neighbor_grad_storage,
159  _volumetric_face_flux);
160 }
LinearFVScalarAdvection::_adv_interp_method
const FVAdvectedInterpolationMethod & _adv_interp_method
The interpolation method to use for the advected quantity.
Definition: LinearFVScalarAdvection.h:47
LinearFVScalarAdvection::_elem_grad_storage
VectorValue< Real > _elem_grad_storage
Reusable gradient storage used when advected interpolation requires gradients.
Definition: LinearFVScalarAdvection.h:53
LinearFVFluxKernel::determineState
Moose::StateArg determineState() const
FaceInfo::neighborInfo
const ElemInfo * neighborInfo() const
LinearFVFluxKernel::_var
MooseLinearVariableFV< Real > & _var
LinearFVFluxKernel::setupFaceData
virtual void setupFaceData(const FaceInfo *face_info)
FaceInfo::elemInfo
const ElemInfo * elemInfo() const
FVAdvectedInterpolationMethod::gradientLimiter
virtual Moose::FV::GradientLimiterType gradientLimiter() const
LinearFVFluxKernel::_current_face_type
FaceInfo::VarFaceNeighbors _current_face_type
MooseLinearVariableFV< Real >::gradSln
VectorValue< Real > gradSln(const ElemInfo &elem_info, const StateArg &state) const
LinearFVFluxKernel::_current_face_info
const FaceInfo * _current_face_info
FaceInfo::neighborPtr
const Elem * neighborPtr() const
FVAdvectedInterpolationMethod::advectedInterpolate
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
RhieChowMassFlux::getVolumetricFaceFlux
Real getVolumetricFaceFlux(const FaceInfo &fi) const
Get the volumetric face flux (used in advection terms)
Definition: RhieChowMassFlux.C:304
LinearFVScalarAdvection::_mass_flux_provider
const RhieChowMassFlux & _mass_flux_provider
The Rhie-Chow user object that provides us with the face velocity.
Definition: LinearFVScalarAdvection.h:43
LinearFVFluxKernel::value
virtual const OutputTools< Real >::VariableValue & value()
FaceInfo::normal
const Point & normal() const
LinearFVScalarAdvection::_volumetric_face_flux
Real _volumetric_face_flux
Container for the velocity on the face which will be reused in the advection term&#39;s matrix and right ...
Definition: LinearFVScalarAdvection.h:58
Real
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
FVAdvectedInterpolationMethod::needsGradients
virtual bool needsGradients() const
LinearFVScalarAdvection::_neighbor_grad_storage
VectorValue< Real > _neighbor_grad_storage
Definition: LinearFVScalarAdvection.h:54
MooseLinearVariableFV< Real >::getElemValue
Real getElemValue(const ElemInfo &elem_info, const StateArg &state) const
LinearFVScalarAdvection::_v_slip
const Moose::Functor< ADReal > *const _v_slip
slip velocity in direction y
Definition: LinearFVScalarAdvection.h:63
LinearFVScalarAdvection::_adv_interp_result
FVAdvectedInterpolationMethod::AdvectedSystemContribution _adv_interp_result
Cached weights/correction for the current face (refreshed in setupFaceData)
Definition: LinearFVScalarAdvection.h:50
LinearFVScalarAdvection::_w_slip
const Moose::Functor< ADReal > *const _w_slip
slip velocity in direction z
Definition: LinearFVScalarAdvection.h:65
LinearFVScalarAdvection::_u_slip
const Moose::Functor< ADReal > *const _u_slip
slip velocity in direction x
Definition: LinearFVScalarAdvection.h:61

◆ validParams()

InputParameters LinearFVScalarAdvection::validParams ( )
static

Definition at line 17 of file LinearFVScalarAdvection.C.

18 {
19  InputParameters params = LinearFVFluxKernel::validParams();
20  params.addClassDescription("Represents the matrix and right hand side contributions of an "
21  "advection term for a passive scalar.");
22  params.addRequiredParam<UserObjectName>(
23  "rhie_chow_user_object",
24  "The rhie-chow user-object which is used to determine the face velocity.");
25  params.addRequiredParam<InterpolationMethodName>(
26  "advected_interp_method_name",
27  "Name of the FVInterpolationMethod to use for the advected quantity.");
28  params.addParam<MooseFunctorName>("u_slip", "The slip-velocity in the x direction.");
29  params.addParam<MooseFunctorName>("v_slip", "The slip-velocity in the y direction.");
30  params.addParam<MooseFunctorName>("w_slip", "The slip-velocity in the z direction.");
31  return params;
32 }
InputParameters::addParam
void addParam(const std::string &name, const std::initializer_list< typename T::value_type > &value, const std::string &doc_string)
InputParameters::addRequiredParam
void addRequiredParam(const std::string &name, const std::string &doc_string)
LinearFVFluxKernel::validParams
static InputParameters validParams()
InputParameters::addClassDescription
void addClassDescription(const std::string &doc_string)

Member Data Documentation

◆ _add_slip_model

bool LinearFVScalarAdvection::_add_slip_model
private

Whether to use an additional slip velocity to compute the face flux.

Definition at line 68 of file LinearFVScalarAdvection.h.

◆ _adv_interp_method

const FVAdvectedInterpolationMethod& LinearFVScalarAdvection::_adv_interp_method
private

The interpolation method to use for the advected quantity.

Definition at line 47 of file LinearFVScalarAdvection.h.

Referenced by LinearFVScalarAdvection(), and setupFaceData().

◆ _adv_interp_result

FVAdvectedInterpolationMethod::AdvectedSystemContribution LinearFVScalarAdvection::_adv_interp_result
private

Cached weights/correction for the current face (refreshed in setupFaceData)

Definition at line 50 of file LinearFVScalarAdvection.h.

Referenced by computeElemMatrixContribution(), computeElemRightHandSideContribution(), computeNeighborMatrixContribution(), computeNeighborRightHandSideContribution(), and setupFaceData().

◆ _elem_grad_storage

VectorValue<Real> LinearFVScalarAdvection::_elem_grad_storage
private

Reusable gradient storage used when advected interpolation requires gradients.

Definition at line 53 of file LinearFVScalarAdvection.h.

Referenced by setupFaceData().

◆ _mass_flux_provider

const RhieChowMassFlux& LinearFVScalarAdvection::_mass_flux_provider
protected

The Rhie-Chow user object that provides us with the face velocity.

Definition at line 43 of file LinearFVScalarAdvection.h.

Referenced by setupFaceData().

◆ _neighbor_grad_storage

VectorValue<Real> LinearFVScalarAdvection::_neighbor_grad_storage
private

Definition at line 54 of file LinearFVScalarAdvection.h.

Referenced by setupFaceData().

◆ _u_slip

const Moose::Functor<ADReal>* const LinearFVScalarAdvection::_u_slip
private

slip velocity in direction x

Definition at line 61 of file LinearFVScalarAdvection.h.

Referenced by setupFaceData().

◆ _v_slip

const Moose::Functor<ADReal>* const LinearFVScalarAdvection::_v_slip
private

slip velocity in direction y

Definition at line 63 of file LinearFVScalarAdvection.h.

Referenced by setupFaceData().

◆ _volumetric_face_flux

Real LinearFVScalarAdvection::_volumetric_face_flux
private

Container for the velocity on the face which will be reused in the advection term's matrix and right hand side contribution.

Definition at line 58 of file LinearFVScalarAdvection.h.

Referenced by computeBoundaryMatrixContribution(), computeBoundaryRHSContribution(), computeElemMatrixContribution(), computeElemRightHandSideContribution(), computeNeighborMatrixContribution(), computeNeighborRightHandSideContribution(), and setupFaceData().

◆ _w_slip

const Moose::Functor<ADReal>* const LinearFVScalarAdvection::_w_slip
private

slip velocity in direction z

Definition at line 65 of file LinearFVScalarAdvection.h.

Referenced by setupFaceData().

The documentation for this class was generated from the following files:
Generated on Sun Aug 2 2026 21:37:05 for https://mooseframework.inl.gov by   doxygen 1.8.14