https://mooseframework.inl.gov
•All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Protected Attributes | Static Protected Attributes | List of all members
FVPorousFlowDispersiveFlux Class Reference

Dispersive flux of component k in fluid phase alpha. More...

#include <FVPorousFlowDispersiveFlux.h>

Inheritance diagram for FVPorousFlowDispersiveFlux:
[legend]

Public Types

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

Public Member Functions

 FVPorousFlowDispersiveFlux (const InputParameters &params)
 
void computeResidual () override
 
void computeResidual (const FaceInfo &fi) override
 
void computeJacobian () override
 
void computeJacobian (const FaceInfo &fi) override
 
void computeResidualAndJacobian () override
 
void computeResidualAndJacobian (const FaceInfo &fi) override
 
const MooseVariableFV< Real > & variable () const override
 
bool hasFaceSide (const FaceInfo &fi, const bool fi_elem_side) const override
 
virtual void computeOffDiagJacobian (unsigned int)
 
virtual void computeOffDiagJacobianScalar (unsigned int)
 
virtual void computeNonlocalJacobian ()
 
virtual void computeNonlocalOffDiagJacobian (unsigned int)
 
const SubProblem & subProblem () const
 
virtual void prepareShapes (unsigned int var_num)
 
virtual bool enabled () const
 
std::shared_ptr< MooseObject > getSharedPtr ()
 
std::shared_ptr< const MooseObject > getSharedPtr () const
 
MooseApp & getMooseApp () const
 
const std::string & type () const
 
virtual const std::string & name () const
 
std::string typeAndName () const
 
std::string errorPrefix (const std::string &error_type) const
 
void callMooseError (std::string msg, const bool with_prefix) const
 
MooseObjectParameterName uniqueParameterName (const std::string &parameter_name) const
 
const InputParameters & parameters () const
 
MooseObjectName uniqueName () 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 & 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 &nm) const
 
void paramError (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
 
void connectControllableParams (const std::string &parameter, const std::string &object_type, const std::string &object_name, const std::string &object_parameter) const
 
void mooseError (Args &&... args) const
 
void mooseErrorNonPrefixed (Args &&... args) const
 
void mooseDocumentedError (const std::string &repo_name, const unsigned int issue_num, Args &&... args) const
 
void mooseWarning (Args &&... args) const
 
void mooseWarningNonPrefixed (Args &&... args) const
 
void mooseDeprecated (Args &&... args) const
 
void mooseInfo (Args &&... args) 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
 
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 UserObject & getUserObjectBase (const std::string &param_name, bool is_dependency=true) const
 
const UserObject & 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 (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
 
const GenericMaterialProperty< T, is_ad > & getGenericMaterialProperty (const std::string &name, MaterialData &material_data, const unsigned int state=0)
 
const GenericMaterialProperty< T, is_ad > & getGenericMaterialProperty (const std::string &name, const unsigned int state=0)
 
const GenericMaterialProperty< T, is_ad > & getGenericMaterialProperty (const std::string &name, const unsigned int state=0)
 
const MaterialProperty< T > & getMaterialProperty (const std::string &name, MaterialData &material_data, const unsigned int state=0)
 
const MaterialProperty< T > & getMaterialProperty (const std::string &name, const unsigned int state=0)
 
const MaterialProperty< T > & getMaterialProperty (const std::string &name, const unsigned int state=0)
 
const ADMaterialProperty< T > & getADMaterialProperty (const std::string &name, MaterialData &material_data)
 
const ADMaterialProperty< T > & getADMaterialProperty (const std::string &name)
 
const ADMaterialProperty< T > & getADMaterialProperty (const std::string &name)
 
const MaterialProperty< T > & getMaterialPropertyOld (const std::string &name, MaterialData &material_data)
 
const MaterialProperty< T > & getMaterialPropertyOld (const std::string &name)
 
const MaterialProperty< T > & getMaterialPropertyOld (const std::string &name)
 
const MaterialProperty< T > & getMaterialPropertyOlder (const std::string &name, MaterialData &material_data)
 
const MaterialProperty< T > & getMaterialPropertyOlder (const std::string &name)
 
const MaterialProperty< T > & getMaterialPropertyOlder (const std::string &name)
 
const GenericMaterialProperty< T, is_ad > & getGenericMaterialPropertyByName (const MaterialPropertyName &name, MaterialData &material_data, const unsigned int state)
 
const GenericMaterialProperty< T, is_ad > & getGenericMaterialPropertyByName (const MaterialPropertyName &name, const unsigned int state=0)
 
const GenericMaterialProperty< T, is_ad > & getGenericMaterialPropertyByName (const MaterialPropertyName &name, const unsigned int state=0)
 
const MaterialProperty< T > & getMaterialPropertyByName (const MaterialPropertyName &name, MaterialData &material_data, const unsigned int state=0)
 
const MaterialProperty< T > & getMaterialPropertyByName (const MaterialPropertyName &name, const unsigned int state=0)
 
const MaterialProperty< T > & getMaterialPropertyByName (const MaterialPropertyName &name, const unsigned int state=0)
 
const ADMaterialProperty< T > & getADMaterialPropertyByName (const MaterialPropertyName &name, MaterialData &material_data)
 
const ADMaterialProperty< T > & getADMaterialPropertyByName (const MaterialPropertyName &name)
 
const ADMaterialProperty< T > & getADMaterialPropertyByName (const MaterialPropertyName &name)
 
const MaterialProperty< T > & getMaterialPropertyOldByName (const MaterialPropertyName &name, MaterialData &material_data)
 
const MaterialProperty< T > & getMaterialPropertyOldByName (const MaterialPropertyName &name)
 
const MaterialProperty< T > & getMaterialPropertyOldByName (const MaterialPropertyName &name)
 
const MaterialProperty< T > & getMaterialPropertyOlderByName (const MaterialPropertyName &name, MaterialData &material_data)
 
const MaterialProperty< T > & getMaterialPropertyOlderByName (const MaterialPropertyName &name)
 
const MaterialProperty< T > & getMaterialPropertyOlderByName (const MaterialPropertyName &name)
 
std::pair< const MaterialProperty< T > *, std::set< SubdomainID > > getBlockMaterialProperty (const MaterialPropertyName &name)
 
const GenericMaterialProperty< T, is_ad > & getGenericZeroMaterialProperty (const std::string &name)
 
const GenericMaterialProperty< T, is_ad > & getGenericZeroMaterialProperty ()
 
const GenericMaterialProperty< T, is_ad > & getGenericZeroMaterialPropertyByName (const std::string &prop_name)
 
const MaterialProperty< T > & getZeroMaterialProperty (Ts... args)
 
std::set< SubdomainID > getMaterialPropertyBlocks (const std::string &name)
 
std::vector< SubdomainName > getMaterialPropertyBlockNames (const std::string &name)
 
std::set< BoundaryID > getMaterialPropertyBoundaryIDs (const std::string &name)
 
std::vector< BoundaryName > getMaterialPropertyBoundaryNames (const std::string &name)
 
void checkBlockAndBoundaryCompatibility (std::shared_ptr< MaterialBase > discrete)
 
std::unordered_map< SubdomainID, std::vector< MaterialBase *> > buildRequiredMaterials (bool allow_stateful=true)
 
void statefulPropertiesAllowed (bool)
 
bool getMaterialPropertyCalled () const
 
const std::unordered_set< unsigned int > & getMatPropDependencies () const
 
virtual void resolveOptionalProperties ()
 
const GenericMaterialProperty< T, is_ad > & getPossiblyConstantGenericMaterialPropertyByName (const MaterialPropertyName &prop_name, MaterialData &material_data, const unsigned int state)
 
MooseVariableBase * mooseVariableBase () const
 
MooseVariableField< Real > & mooseVariableField ()
 
MooseVariableFE< Real > * mooseVariable () const
 
MooseVariableFV< Real > * mooseVariableFV () const
 
MooseLinearVariableFV< Real > * mooseLinearVariableFV () const
 
virtual const VariableValue & coupledNeighborValue (const std::string &var_name, unsigned int comp=0) const
 
std::vector< const VariableValue *> coupledNeighborValues (const std::string &var_name) const
 
std::vector< const VariableValue *> coupledNeighborValuesOld (const std::string &var_name) const
 
std::vector< const VariableValue *> coupledNeighborValuesOlder (const std::string &var_name) const
 
virtual const ADVariableValue & adCoupledNeighborValue (const std::string &var_name, unsigned int comp=0) const
 
const auto & coupledGenericNeighborValue (const std::string &var_name, unsigned int comp=0) const
 
const auto & coupledGenericNeighborGradient (const std::string &var_name, unsigned int comp=0) const
 
virtual const ADVariableValue & adCoupledNeighborValueDot (const std::string &var_name, unsigned int comp=0) const
 
std::vector< const ADVariableValue *> adCoupledNeighborValues (const std::string &var_name) const
 
virtual const ADVectorVariableValue & adCoupledVectorNeighborValue (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableValue & coupledNeighborValueDot (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableValue & coupledNeighborValueDotDu (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableValue & coupledNeighborValueOld (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableValue & coupledNeighborValueOlder (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableGradient & coupledNeighborGradient (const std::string &var_name, unsigned int comp=0) const
 
virtual std::vector< const VariableGradient *> coupledNeighborGradients (const std::string &var_name) const
 
virtual const VariableGradient & coupledNeighborGradientOld (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableGradient & coupledNeighborGradientOlder (const std::string &var_name, unsigned int comp=0) const
 
virtual const ADVariableGradient & adCoupledNeighborGradient (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableGradient & coupledVectorNeighborGradient (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableGradient & coupledVectorNeighborGradientOld (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableGradient & coupledVectorNeighborGradientOlder (const std::string &var_name, unsigned int comp=0) const
 
virtual const ArrayVariableValue & coupledArrayNeighborValue (const std::string &var_name, unsigned int comp=0) const
 
virtual const ArrayVariableGradient & coupledArrayNeighborGradient (const std::string &var_name, unsigned int comp=0) const
 
virtual const ArrayVariableGradient & coupledArrayNeighborGradientOld (const std::string &var_name, unsigned int comp=0) const
 
virtual const ArrayVariableGradient & coupledArrayNeighborGradientOlder (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableSecond & coupledNeighborSecond (const std::string &var_name, unsigned int i=0) const
 
virtual const VariableValue & coupledNeighborDofValues (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableValue & coupledNeighborDofValuesOld (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableValue & coupledNeighborDofValuesOlder (const std::string &var_name, unsigned int comp=0) const
 
const std::unordered_map< std::string, std::vector< MooseVariableFieldBase *> > & getCoupledVars () const
 
const std::vector< MooseVariableFieldBase *> & getCoupledMooseVars () const
 
const std::vector< MooseVariable *> & getCoupledStandardMooseVars () const
 
const std::vector< VectorMooseVariable *> & getCoupledVectorMooseVars () const
 
const std::vector< ArrayMooseVariable *> & getCoupledArrayMooseVars () const
 
void addFEVariableCoupleableVectorTag (TagID tag)
 
void addFEVariableCoupleableMatrixTag (TagID tag)
 
std::set< TagID > & getFEVariableCoupleableVectorTags ()
 
const std::set< TagID > & getFEVariableCoupleableVectorTags () const
 
std::set< TagID > & getFEVariableCoupleableMatrixTags ()
 
const std::set< TagID > & getFEVariableCoupleableMatrixTags () const
 
auto & getWritableCoupledVariables () const
 
bool hasWritableCoupledVariables () const
 
const ADVariableValue * getADDefaultValue (const std::string &var_name) const
 
const ADVectorVariableValue * getADDefaultVectorValue (const std::string &var_name) const
 
const ADVariableGradient & getADDefaultGradient () const
 
const ADVectorVariableGradient & getADDefaultVectorGradient () const
 
const ADVariableSecond & getADDefaultSecond () const
 
const ADVectorVariableCurl & getADDefaultCurl () const
 
const std::vector< MooseVariableScalar *> & getCoupledMooseScalarVars ()
 
const std::set< TagID > & getScalarVariableCoupleableVectorTags () const
 
const std::set< TagID > & getScalarVariableCoupleableMatrixTags () const
 
const std::set< MooseVariableFieldBase *> & getMooseVariableDependencies () const
 
std::set< MooseVariableFieldBase *> checkAllVariables (const DofObjectType &dof_object, const std::set< MooseVariableFieldBase * > &vars_to_omit={})
 
std::set< MooseVariableFieldBase *> checkVariables (const DofObjectType &dof_object, const std::set< MooseVariableFieldBase * > &vars_to_check)
 
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 GenericMaterialProperty< T, is_ad > & getGenericNeighborMaterialProperty (const std::string &name, const unsigned int state=0)
 
const GenericMaterialProperty< T, is_ad > & getGenericNeighborMaterialProperty (const std::string &name, const unsigned int state=0)
 
const MaterialProperty< T > & getNeighborMaterialProperty (const std::string &name, const unsigned int state=0)
 
const MaterialProperty< T > & getNeighborMaterialProperty (const std::string &name, const unsigned int state=0)
 
const ADMaterialProperty< T > & getNeighborADMaterialProperty (const std::string &name)
 
const ADMaterialProperty< T > & getNeighborADMaterialProperty (const std::string &name)
 
const MaterialProperty< T > & getNeighborMaterialPropertyOld (const std::string &name)
 
const MaterialProperty< T > & getNeighborMaterialPropertyOld (const std::string &name)
 
const MaterialProperty< T > & getNeighborMaterialPropertyOlder (const std::string &name)
 
const MaterialProperty< T > & getNeighborMaterialPropertyOlder (const std::string &name)
 
const GenericMaterialProperty< T, is_ad > & getGenericNeighborMaterialPropertyByName (const std::string &name, const unsigned int state=0)
 
const GenericMaterialProperty< T, is_ad > & getGenericNeighborMaterialPropertyByName (const std::string &name, const unsigned int state=0)
 
const MaterialProperty< T > & getNeighborMaterialPropertyByName (const std::string &name, const unsigned int state=0)
 
const MaterialProperty< T > & getNeighborMaterialPropertyByName (const std::string &name, const unsigned int state=0)
 
const ADMaterialProperty< T > & getNeighborADMaterialPropertyByName (const std::string &name)
 
const ADMaterialProperty< T > & getNeighborADMaterialPropertyByName (const std::string &name)
 
const GenericOptionalMaterialProperty< T, is_ad > & getGenericOptionalMaterialProperty (const std::string &name, const unsigned int state=0)
 
const GenericOptionalMaterialProperty< T, is_ad > & getGenericOptionalMaterialProperty (const std::string &name, const unsigned int state=0)
 
const OptionalMaterialProperty< T > & getOptionalMaterialProperty (const std::string &name, const unsigned int state=0)
 
const OptionalMaterialProperty< T > & getOptionalMaterialProperty (const std::string &name, const unsigned int state=0)
 
const OptionalADMaterialProperty< T > & getOptionalADMaterialProperty (const std::string &name)
 
const OptionalADMaterialProperty< T > & getOptionalADMaterialProperty (const std::string &name)
 
const OptionalMaterialProperty< T > & getOptionalMaterialPropertyOld (const std::string &name)
 
const OptionalMaterialProperty< T > & getOptionalMaterialPropertyOld (const std::string &name)
 
const OptionalMaterialProperty< T > & getOptionalMaterialPropertyOlder (const std::string &name)
 
const OptionalMaterialProperty< T > & getOptionalMaterialPropertyOlder (const std::string &name)
 
MaterialBase & getMaterial (const std::string &name)
 
MaterialBase & getMaterial (const std::string &name)
 
MaterialBase & getMaterialByName (const std::string &name, bool no_warn=false)
 
MaterialBase & getMaterialByName (const std::string &name, bool no_warn=false)
 
bool hasMaterialProperty (const std::string &name)
 
bool hasMaterialProperty (const std::string &name)
 
bool hasMaterialPropertyByName (const std::string &name)
 
bool hasMaterialPropertyByName (const std::string &name)
 
bool hasADMaterialProperty (const std::string &name)
 
bool hasADMaterialProperty (const std::string &name)
 
bool hasADMaterialPropertyByName (const std::string &name)
 
bool hasADMaterialPropertyByName (const std::string &name)
 
bool hasGenericMaterialProperty (const std::string &name)
 
bool hasGenericMaterialProperty (const std::string &name)
 
bool hasGenericMaterialPropertyByName (const std::string &name)
 
bool hasGenericMaterialPropertyByName (const std::string &name)
 
const Parallel::Communicator & comm () const
 
processor_id_type n_processors () const
 
processor_id_type processor_id () const
 

Static Public Member Functions

static InputParameters validParams ()
 
static std::string deduceFunctorName (const std::string &name, const InputParameters &params)
 
static void setRMParams (const InputParameters &obj_params, InputParameters &rm_params, unsigned short ghost_layers)
 

Public Attributes

const ConsoleStream _console
 

Static Public Attributes

static constexpr PropertyValue::id_type default_property_id
 
static constexpr PropertyValue::id_type zero_property_id
 

Protected Member Functions

virtual ADReal computeQpResidual () override
 
std::string deduceFunctorName (const std::string &name) const
 
virtual ADReal gradUDotNormal (const Moose::StateArg &time) const
 
virtual bool skipForBoundary (const FaceInfo &fi) const
 
const RealVectorValue & normal () const
 
bool onBoundary (const FaceInfo &fi) const
 
Moose::ElemArg elemArg (bool correct_skewness=false) const
 
Moose::ElemArg neighborArg (bool correct_skewness=false) const
 
Moose::FaceArg singleSidedFaceArg (const FaceInfo *fi=nullptr, Moose::FV::LimiterType limiter_type=Moose::FV::LimiterType::CentralDifference, bool correct_skewness=false, const Moose::StateArg *state_limiter=nullptr) const
 
bool avoidBoundary (const FaceInfo &fi) const
 
void adjustRMGhostLayers (const unsigned short ghost_layers) const
 
virtual void precalculateResidual ()
 
virtual void precalculateJacobian ()
 
virtual void precalculateOffDiagJacobian (unsigned int)
 
const MooseVariableFieldBase & getVariable (unsigned int jvar_num) const
 
virtual void addUserObjectDependencyHelper (const UserObject &) 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 DenseVector< T > &residuals, const Indices &dof_indices, Real scaling_factor)
 
void addResidualsAndJacobian (Assembly &assembly, const Residuals &residuals, const Indices &dof_indices, Real scaling_factor)
 
void addJacobian (Assembly &assembly, const Residuals &residuals, const Indices &dof_indices, Real scaling_factor)
 
void addJacobian (Assembly &assembly, 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)
 
Moose::CoordinateSystemType getBlockCoordSystem ()
 
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)
 
virtual void checkMaterialProperty (const std::string &name, const unsigned int state)
 
void markMatPropRequested (const std::string &)
 
MaterialPropertyName getMaterialPropertyName (const std::string &name) const
 
void checkExecutionStage ()
 
virtual const OutputTools< Real >::VariableValue & neighborValue ()
 
const VectorVariableValue & neighborValue ()
 
virtual const OutputTools< Real >::VariableValue & neighborValueOld ()
 
const VectorVariableValue & neighborValueOld ()
 
virtual const OutputTools< Real >::VariableValue & neighborValueOlder ()
 
const VectorVariableValue & neighborValueOlder ()
 
virtual const OutputTools< Real >::VariableGradient & neighborGradient ()
 
virtual const OutputTools< Real >::VariableGradient & neighborGradientOld ()
 
virtual const OutputTools< Real >::VariableGradient & neighborGradientOlder ()
 
virtual const OutputTools< Real >::VariableSecond & neighborSecond ()
 
virtual const OutputTools< Real >::VariableSecond & neighborSecondOld ()
 
virtual const OutputTools< Real >::VariableSecond & neighborSecondOlder ()
 
virtual const OutputTools< Real >::VariableTestSecond & neighborSecondTest ()
 
virtual const OutputTools< Real >::VariablePhiSecond & neighborSecondPhi ()
 
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 ()
 
virtual void coupledCallback (const std::string &, bool) const
 
virtual bool isCoupled (const std::string &var_name, unsigned int i=0) const
 
virtual bool isCoupledConstant (const std::string &var_name) const
 
unsigned int coupledComponents (const std::string &var_name) const
 
VariableName coupledName (const std::string &var_name, unsigned int comp=0) const
 
std::vector< VariableName > coupledNames (const std::string &var_name) const
 
virtual unsigned int coupled (const std::string &var_name, unsigned int comp=0) const
 
std::vector< unsigned int > coupledIndices (const std::string &var_name) const
 
virtual const VariableValue & coupledValue (const std::string &var_name, unsigned int comp=0) const
 
std::vector< const VariableValue *> coupledValues (const std::string &var_name) const
 
std::vector< const VectorVariableValue *> coupledVectorValues (const std::string &var_name) const
 
const GenericVariableValue< is_ad > & coupledGenericValue (const std::string &var_name, unsigned int comp=0) const
 
const GenericVariableValue< false > & coupledGenericValue (const std::string &var_name, unsigned int comp) const
 
const GenericVariableValue< true > & coupledGenericValue (const std::string &var_name, unsigned int comp) const
 
std::vector< const GenericVariableValue< is_ad > *> coupledGenericValues (const std::string &var_name) const
 
std::vector< const GenericVariableValue< false > *> coupledGenericValues (const std::string &var_name) const
 
std::vector< const GenericVariableValue< true > *> coupledGenericValues (const std::string &var_name) const
 
const GenericVariableValue< is_ad > & coupledGenericDofValue (const std::string &var_name, unsigned int comp=0) const
 
const GenericVariableValue< false > & coupledGenericDofValue (const std::string &var_name, unsigned int comp) const
 
const GenericVariableValue< true > & coupledGenericDofValue (const std::string &var_name, unsigned int comp) const
 
const GenericVariableValue< is_ad > & coupledGenericDot (const std::string &var_name, unsigned int comp=0) const
 
const GenericVariableValue< false > & coupledGenericDot (const std::string &var_name, unsigned int comp) const
 
const GenericVariableValue< true > & coupledGenericDot (const std::string &var_name, unsigned int comp) const
 
const GenericVariableValue< is_ad > & coupledGenericDotDot (const std::string &var_name, unsigned int comp=0) const
 
const GenericVariableValue< false > & coupledGenericDotDot (const std::string &var_name, unsigned int comp) const
 
const GenericVariableValue< true > & coupledGenericDotDot (const std::string &var_name, unsigned int comp) const
 
virtual const VariableValue & coupledValueLower (const std::string &var_name, unsigned int comp=0) const
 
const ADVariableValue & adCoupledValue (const std::string &var_name, unsigned int comp=0) const
 
std::vector< const ADVariableValue *> adCoupledValues (const std::string &var_name) const
 
const ADVariableValue & adCoupledLowerValue (const std::string &var_name, unsigned int comp=0) const
 
const ADVectorVariableValue & adCoupledVectorValue (const std::string &var_name, unsigned int comp=0) const
 
std::vector< const ADVectorVariableValue *> adCoupledVectorValues (const std::string &var_name) const
 
virtual const VariableValue & coupledVectorTagValue (const std::string &var_names, TagID tag, unsigned int index=0) const
 
virtual const VariableValue & coupledVectorTagValue (const std::string &var_names, const std::string &tag_name, unsigned int index=0) const
 
std::vector< const VariableValue *> coupledVectorTagValues (const std::string &var_names, TagID tag) const
 
std::vector< const VariableValue *> coupledVectorTagValues (const std::string &var_names, const std::string &tag_name) const
 
virtual const ArrayVariableValue & coupledVectorTagArrayValue (const std::string &var_names, TagID tag, unsigned int index=0) const
 
virtual const ArrayVariableValue & coupledVectorTagArrayValue (const std::string &var_names, const std::string &tag_name, unsigned int index=0) const
 
std::vector< const ArrayVariableValue *> coupledVectorTagArrayValues (const std::string &var_names, TagID tag) const
 
std::vector< const ArrayVariableValue *> coupledVectorTagArrayValues (const std::string &var_names, const std::string &tag_name) const
 
virtual const VariableGradient & coupledVectorTagGradient (const std::string &var_names, TagID tag, unsigned int index=0) const
 
virtual const VariableGradient & coupledVectorTagGradient (const std::string &var_names, const std::string &tag_name, unsigned int index=0) const
 
std::vector< const VariableGradient *> coupledVectorTagGradients (const std::string &var_names, TagID tag) const
 
std::vector< const VariableGradient *> coupledVectorTagGradients (const std::string &var_names, const std::string &tag_name) const
 
virtual const ArrayVariableGradient & coupledVectorTagArrayGradient (const std::string &var_names, TagID tag, unsigned int index=0) const
 
virtual const ArrayVariableGradient & coupledVectorTagArrayGradient (const std::string &var_names, const std::string &tag_name, unsigned int index=0) const
 
std::vector< const ArrayVariableGradient *> coupledVectorTagArrayGradients (const std::string &var_names, TagID tag) const
 
std::vector< const ArrayVariableGradient *> coupledVectorTagArrayGradients (const std::string &var_names, const std::string &tag_name) const
 
virtual const VariableValue & coupledVectorTagDofValue (const std::string &var_name, TagID tag, unsigned int index=0) const
 
virtual const VariableValue & coupledVectorTagDofValue (const std::string &var_names, const std::string &tag_name, unsigned int index=0) const
 
const ArrayVariableValue & coupledVectorTagArrayDofValue (const std::string &var_name, const std::string &tag_name, unsigned int comp=0) const
 
std::vector< const VariableValue *> coupledVectorTagDofValues (const std::string &var_names, TagID tag) const
 
std::vector< const VariableValue *> coupledVectorTagDofValues (const std::string &var_names, const std::string &tag_name) const
 
virtual const VariableValue & coupledMatrixTagValue (const std::string &var_names, TagID tag, unsigned int index=0) const
 
virtual const VariableValue & coupledMatrixTagValue (const std::string &var_names, const std::string &tag_name, unsigned int index=0) const
 
std::vector< const VariableValue *> coupledMatrixTagValues (const std::string &var_names, TagID tag) const
 
std::vector< const VariableValue *> coupledMatrixTagValues (const std::string &var_names, const std::string &tag_name) const
 
virtual const VectorVariableValue & coupledVectorValue (const std::string &var_name, unsigned int comp=0) const
 
virtual const ArrayVariableValue & coupledArrayValue (const std::string &var_name, unsigned int comp=0) const
 
std::vector< const ArrayVariableValue *> coupledArrayValues (const std::string &var_name) const
 
MooseWritableVariable & writableVariable (const std::string &var_name, unsigned int comp=0)
 
virtual VariableValue & writableCoupledValue (const std::string &var_name, unsigned int comp=0)
 
void checkWritableVar (MooseWritableVariable *var)
 
virtual const VariableValue & coupledValueOld (const std::string &var_name, unsigned int comp=0) const
 
std::vector< const VariableValue *> coupledValuesOld (const std::string &var_name) const
 
virtual const VariableValue & coupledValueOlder (const std::string &var_name, unsigned int comp=0) const
 
std::vector< const VariableValue *> coupledValuesOlder (const std::string &var_name) const
 
virtual const VariableValue & coupledValuePreviousNL (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableValue & coupledVectorValueOld (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableValue & coupledVectorValueOlder (const std::string &var_name, unsigned int comp=0) const
 
virtual const ArrayVariableValue & coupledArrayValueOld (const std::string &var_name, unsigned int comp=0) const
 
virtual const ArrayVariableValue & coupledArrayValueOlder (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableGradient & coupledGradient (const std::string &var_name, unsigned int comp=0) const
 
std::vector< const VariableGradient *> coupledGradients (const std::string &var_name) const
 
const ADVariableGradient & adCoupledGradient (const std::string &var_name, unsigned int comp=0) const
 
const ADVariableGradient & adCoupledGradientDot (const std::string &var_name, unsigned int comp=0) const
 
std::vector< const ADVariableGradient *> adCoupledGradients (const std::string &var_name) const
 
const GenericVariableGradient< is_ad > & coupledGenericGradient (const std::string &var_name, unsigned int comp=0) const
 
const GenericVariableGradient< false > & coupledGenericGradient (const std::string &var_name, unsigned int comp) const
 
const GenericVariableGradient< true > & coupledGenericGradient (const std::string &var_name, unsigned int comp) const
 
std::vector< const GenericVariableGradient< is_ad > *> coupledGenericGradients (const std::string &var_name) const
 
std::vector< const GenericVariableGradient< false > *> coupledGenericGradients (const std::string &var_name) const
 
std::vector< const GenericVariableGradient< true > *> coupledGenericGradients (const std::string &var_name) const
 
const ADVectorVariableGradient & adCoupledVectorGradient (const std::string &var_name, unsigned int comp=0) const
 
const ADVariableSecond & adCoupledSecond (const std::string &var_name, unsigned int comp=0) const
 
const ADVectorVariableSecond & adCoupledVectorSecond (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableGradient & coupledGradientOld (const std::string &var_name, unsigned int comp=0) const
 
std::vector< const VariableGradient *> coupledGradientsOld (const std::string &var_name) const
 
virtual const VariableGradient & coupledGradientOlder (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableGradient & coupledGradientPreviousNL (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableGradient & coupledGradientDot (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableGradient & coupledGradientDotDot (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableGradient & coupledVectorGradient (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableGradient & coupledVectorGradientOld (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableGradient & coupledVectorGradientOlder (const std::string &var_name, unsigned int comp=0) const
 
virtual const ArrayVariableGradient & coupledArrayGradient (const std::string &var_name, unsigned int comp=0) const
 
virtual const ArrayVariableGradient & coupledArrayGradientOld (const std::string &var_name, unsigned int comp=0) const
 
virtual const ArrayVariableGradient & coupledArrayGradientOlder (const std::string &var_name, unsigned int comp=0) const
 
virtual const ArrayVariableGradient & coupledArrayGradientDot (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableCurl & coupledCurl (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableCurl & coupledCurlOld (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableCurl & coupledCurlOlder (const std::string &var_name, unsigned int comp=0) const
 
const ADVectorVariableCurl & adCoupledCurl (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableDivergence & coupledDiv (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableDivergence & coupledDivOld (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableDivergence & coupledDivOlder (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableSecond & coupledSecond (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableSecond & coupledSecondOld (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableSecond & coupledSecondOlder (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableSecond & coupledSecondPreviousNL (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableValue & coupledDot (const std::string &var_name, unsigned int comp=0) const
 
std::vector< const VariableValue *> coupledDots (const std::string &var_name) const
 
virtual const VariableValue & coupledDotDot (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableValue & coupledDotOld (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableValue & coupledDotDotOld (const std::string &var_name, unsigned int comp=0) const
 
const ADVariableValue & adCoupledDot (const std::string &var_name, unsigned int comp=0) const
 
std::vector< const ADVariableValue *> adCoupledDots (const std::string &var_name) const
 
const ADVariableValue & adCoupledDotDot (const std::string &var_name, unsigned int comp=0) const
 
const ADVectorVariableValue & adCoupledVectorDot (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableValue & coupledVectorDot (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableValue & coupledVectorDotDot (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableValue & coupledVectorDotOld (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableValue & coupledVectorDotDotOld (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableValue & coupledVectorDotDu (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableValue & coupledVectorDotDotDu (const std::string &var_name, unsigned int comp=0) const
 
virtual const ArrayVariableValue & coupledArrayDot (const std::string &var_name, unsigned int comp=0) const
 
virtual const ArrayVariableValue & coupledArrayDotDot (const std::string &var_name, unsigned int comp=0) const
 
virtual const ArrayVariableValue & coupledArrayDotOld (const std::string &var_name, unsigned int comp=0) const
 
virtual const ArrayVariableValue & coupledArrayDotDotOld (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableValue & coupledDotDu (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableValue & coupledDotDotDu (const std::string &var_name, unsigned int comp=0) const
 
const VariableValue & coupledArrayDotDu (const std::string &var_name, unsigned int comp=0) const
 
const T & coupledNodalValue (const std::string &var_name, unsigned int comp=0) const
 
const Moose::ADType< T >::type & adCoupledNodalValue (const std::string &var_name, unsigned int comp=0) const
 
const T & coupledNodalValueOld (const std::string &var_name, unsigned int comp=0) const
 
const T & coupledNodalValueOlder (const std::string &var_name, unsigned int comp=0) const
 
const T & coupledNodalValuePreviousNL (const std::string &var_name, unsigned int comp=0) const
 
const T & coupledNodalDot (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableValue & coupledNodalDotDot (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableValue & coupledNodalDotOld (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableValue & coupledNodalDotDotOld (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableValue & coupledDofValues (const std::string &var_name, unsigned int comp=0) const
 
std::vector< const VariableValue *> coupledAllDofValues (const std::string &var_name) const
 
virtual const VariableValue & coupledDofValuesOld (const std::string &var_name, unsigned int comp=0) const
 
std::vector< const VariableValue *> coupledAllDofValuesOld (const std::string &var_name) const
 
virtual const VariableValue & coupledDofValuesOlder (const std::string &var_name, unsigned int comp=0) const
 
std::vector< const VariableValue *> coupledAllDofValuesOlder (const std::string &var_name) const
 
virtual const ArrayVariableValue & coupledArrayDofValues (const std::string &var_name, unsigned int comp=0) const
 
virtual const ADVariableValue & adCoupledDofValues (const std::string &var_name, unsigned int comp=0) const
 
const ADVariableValue & adZeroValue () const
 
const ADVariableGradient & adZeroGradient () const
 
const ADVariableSecond & adZeroSecond () const
 
const GenericVariableValue< is_ad > & genericZeroValue ()
 
const GenericVariableValue< false > & genericZeroValue ()
 
const GenericVariableValue< true > & genericZeroValue ()
 
const GenericVariableGradient< is_ad > & genericZeroGradient ()
 
const GenericVariableGradient< false > & genericZeroGradient ()
 
const GenericVariableGradient< true > & genericZeroGradient ()
 
const GenericVariableSecond< is_ad > & genericZeroSecond ()
 
const GenericVariableSecond< false > & genericZeroSecond ()
 
const GenericVariableSecond< true > & genericZeroSecond ()
 
bool checkVar (const std::string &var_name, unsigned int comp=0, unsigned int comp_bound=0) const
 
const MooseVariableFieldBase * getFEVar (const std::string &var_name, unsigned int comp) const
 
const MooseVariableFieldBase * getFieldVar (const std::string &var_name, unsigned int comp) const
 
MooseVariableFieldBase * getFieldVar (const std::string &var_name, unsigned int comp)
 
const T * getVarHelper (const std::string &var_name, unsigned int comp) const
 
T * getVarHelper (const std::string &var_name, unsigned int comp)
 
MooseVariable * getVar (const std::string &var_name, unsigned int comp)
 
const MooseVariable * getVar (const std::string &var_name, unsigned int comp) const
 
VectorMooseVariable * getVectorVar (const std::string &var_name, unsigned int comp)
 
const VectorMooseVariable * getVectorVar (const std::string &var_name, unsigned int comp) const
 
ArrayMooseVariable * getArrayVar (const std::string &var_name, unsigned int comp)
 
const ArrayMooseVariable * getArrayVar (const std::string &var_name, unsigned int comp) const
 
void validateExecutionerType (const std::string &name, const std::string &fn_name) const
 
std::vector< T > coupledVectorHelper (const std::string &var_name, const Func &func) const
 
bool isCoupledScalar (const std::string &var_name, unsigned int i=0) const
 
unsigned int coupledScalarComponents (const std::string &var_name) const
 
unsigned int coupledScalar (const std::string &var_name, unsigned int comp=0) const
 
libMesh::Order coupledScalarOrder (const std::string &var_name, unsigned int comp=0) const
 
const VariableValue & coupledScalarValue (const std::string &var_name, unsigned int comp=0) const
 
const ADVariableValue & adCoupledScalarValue (const std::string &var_name, unsigned int comp=0) const
 
const GenericVariableValue< is_ad > & coupledGenericScalarValue (const std::string &var_name, unsigned int comp=0) const
 
const GenericVariableValue< false > & coupledGenericScalarValue (const std::string &var_name, const unsigned int comp) const
 
const GenericVariableValue< true > & coupledGenericScalarValue (const std::string &var_name, const unsigned int comp) const
 
const VariableValue & coupledVectorTagScalarValue (const std::string &var_name, TagID tag, unsigned int comp=0) const
 
const VariableValue & coupledMatrixTagScalarValue (const std::string &var_name, TagID tag, unsigned int comp=0) const
 
const VariableValue & coupledScalarValueOld (const std::string &var_name, unsigned int comp=0) const
 
const VariableValue & coupledScalarValueOlder (const std::string &var_name, unsigned int comp=0) const
 
const VariableValue & coupledScalarDot (const std::string &var_name, unsigned int comp=0) const
 
const ADVariableValue & adCoupledScalarDot (const std::string &var_name, unsigned int comp=0) const
 
const VariableValue & coupledScalarDotDot (const std::string &var_name, unsigned int comp=0) const
 
const VariableValue & coupledScalarDotOld (const std::string &var_name, unsigned int comp=0) const
 
const VariableValue & coupledScalarDotDotOld (const std::string &var_name, unsigned int comp=0) const
 
const VariableValue & coupledScalarDotDu (const std::string &var_name, unsigned int comp=0) const
 
const VariableValue & coupledScalarDotDotDu (const std::string &var_name, unsigned int comp=0) const
 
const MooseVariableScalar * getScalarVar (const std::string &var_name, unsigned int comp) const
 
void addMooseVariableDependency (MooseVariableFieldBase *var)
 
void addMooseVariableDependency (const std::vector< MooseVariableFieldBase * > &vars)
 
const GenericMaterialProperty< T, is_ad > * defaultGenericMaterialProperty (const std::string &name)
 
const GenericMaterialProperty< T, is_ad > * defaultGenericMaterialProperty (const std::string &name)
 
const MaterialProperty< T > * defaultMaterialProperty (const std::string &name)
 
const MaterialProperty< T > * defaultMaterialProperty (const std::string &name)
 
const ADMaterialProperty< T > * defaultADMaterialProperty (const std::string &name)
 
const ADMaterialProperty< T > * defaultADMaterialProperty (const std::string &name)
 

Protected Attributes

const PorousFlowDictator & _dictator
 UserObject that holds information (number of phases, components, etc) More...
 
const unsigned int _num_phases
 Number of fluid phases present. More...
 
const unsigned int _fluid_component
 Index of the fluid component this kernel applies to. More...
 
const ADMaterialProperty< std::vector< Real > > & _density
 Fluid density. More...
 
const ADMaterialProperty< std::vector< Real > > & _viscosity
 Fluid viscosity. More...
 
const ADMaterialProperty< std::vector< Real > > & _viscosity_neighbor
 
const ADMaterialProperty< std::vector< Real > > & _relperm
 Relative permeability. More...
 
const ADMaterialProperty< std::vector< Real > > & _relperm_neighbor
 
const ADMaterialProperty< std::vector< std::vector< Real > > > & _mass_fractions
 Mass fraction of fluid components in fluid phases. More...
 
const ADMaterialProperty< std::vector< std::vector< Real > > > & _mass_fractions_neighbor
 
const ADMaterialProperty< std::vector< std::vector< RealGradient > > > & _grad_mass_frac
 
const ADMaterialProperty< RealTensorValue > & _permeability
 Permeability. More...
 
const ADMaterialProperty< RealTensorValue > & _permeability_neighbor
 
const ADMaterialProperty< std::vector< Real > > & _pressure
 Fluid pressure. More...
 
const ADMaterialProperty< std::vector< Real > > & _pressure_neighbor
 
const ADMaterialProperty< std::vector< RealGradient > > & _grad_p
 
const ADMaterialProperty< Real > & _porosity
 Porosity. More...
 
const ADMaterialProperty< Real > & _porosity_neighbor
 
const ADMaterialProperty< std::vector< Real > > & _tortuosity
 Tortuosity tau_0 * tau_{alpha} for fluid phase alpha. More...
 
const ADMaterialProperty< std::vector< Real > > & _tortuosity_neighbor
 
const MaterialProperty< std::vector< std::vector< Real > > > & _diffusion_coeff
 Diffusion coefficients of component k in fluid phase alpha. More...
 
const MaterialProperty< std::vector< std::vector< Real > > > & _diffusion_coeff_neighbor
 
const RealVectorValue & _gravity
 Gravity vector. More...
 
const ADRankTwoTensor _identity_tensor
 
const std::vector< Real > _disp_long
 Longitudinal dispersivity for each phase. More...
 
const std::vector< Real > _disp_trans
 Transverse dispersivity for each phase. More...
 
MooseVariableFV< Real > & _var
 
const unsigned int _qp
 
const ADVariableValue & _u_elem
 
const ADVariableValue & _u_neighbor
 
RealVectorValue _normal
 
const FaceInfo * _face_info
 
FaceInfo::VarFaceNeighbors _face_type
 
std::unordered_set< BoundaryID > _boundaries_to_force
 
SubProblem & _subproblem
 
FEProblemBase & _fe_problem
 
SystemBase & _sys
 
THREAD_ID _tid
 
Assembly & _assembly
 
MooseMesh & _mesh
 
const bool & _enabled
 
MooseApp & _app
 
const std::string _type
 
const std::string _name
 
const InputParameters & _pars
 
Factory & _factory
 
ActionFactory & _action_factory
 
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
 
DenseVector< Number > _local_re
 
DenseMatrix< Number > _local_ke
 
DenseMatrix< Number > _nonlocal_ke
 
const MaterialData * _blk_material_data
 
MaterialData & _neighbor_material_data
 
const InputParameters & _mi_params
 
const std::string _mi_name
 
const MooseObjectName _mi_moose_object_name
 
FEProblemBase & _mi_feproblem
 
SubProblem & _mi_subproblem
 
const THREAD_ID _mi_tid
 
const Moose::MaterialDataType _material_data_type
 
MaterialData & _material_data
 
bool _stateful_allowed
 
bool _get_material_property_called
 
std::vector< std::unique_ptr< PropertyValue > > _default_properties
 
std::unordered_set< unsigned int > _material_property_dependencies
 
const MaterialPropertyName _get_suffix
 
const bool _use_interpolated_state
 
bool _nodal
 
MooseVariableFE< Real > * _variable
 
MooseVariableFV< Real > * _fv_variable
 
MooseLinearVariableFV< Real > * _linear_fv_variable
 
MooseVariableField< Real > * _field_variable
 
Assembly * _mvi_assembly
 
bool _neighbor_nodal
 
const InputParameters & _c_parameters
 
const std::string & _c_name
 
const std::string & _c_type
 
FEProblemBase & _c_fe_problem
 
const SystemBase *const _c_sys
 
std::unordered_map< std::string, std::vector< MooseVariableFieldBase *> > _coupled_vars
 
std::vector< MooseVariableFieldBase *> _coupled_moose_vars
 
std::vector< MooseVariable *> _coupled_standard_moose_vars
 
std::vector< VectorMooseVariable *> _coupled_vector_moose_vars
 
std::vector< ArrayMooseVariable *> _coupled_array_moose_vars
 
std::vector< MooseVariableFV< Real > *> _coupled_standard_fv_moose_vars
 
std::vector< MooseLinearVariableFV< Real > *> _coupled_standard_linear_fv_moose_vars
 
const std::unordered_map< std::string, std::string > & _new_to_deprecated_coupled_vars
 
bool _c_nodal
 
bool _c_is_implicit
 
const bool _c_allow_element_to_nodal_coupling
 
THREAD_ID _c_tid
 
std::unordered_map< std::string, std::vector< std::unique_ptr< VariableValue > > > _default_value
 
std::unordered_map< std::string, std::unique_ptr< MooseArray< ADReal > > > _ad_default_value
 
std::unordered_map< std::string, std::unique_ptr< VectorVariableValue > > _default_vector_value
 
std::unordered_map< std::string, std::unique_ptr< ArrayVariableValue > > _default_array_value
 
std::unordered_map< std::string, std::unique_ptr< MooseArray< ADRealVectorValue > > > _ad_default_vector_value
 
VariableValue _default_value_zero
 
VariableGradient _default_gradient
 
MooseArray< ADRealVectorValue > _ad_default_gradient
 
MooseArray< ADRealTensorValue > _ad_default_vector_gradient
 
VariableSecond _default_second
 
MooseArray< ADRealTensorValue > _ad_default_second
 
MooseArray< ADRealVectorValue > _ad_default_curl
 
const VariableValue & _zero
 
const VariablePhiValue & _phi_zero
 
const MooseArray< ADReal > & _ad_zero
 
const VariableGradient & _grad_zero
 
const MooseArray< ADRealVectorValue > & _ad_grad_zero
 
const VariablePhiGradient & _grad_phi_zero
 
const VariableSecond & _second_zero
 
const MooseArray< ADRealTensorValue > & _ad_second_zero
 
const VariablePhiSecond & _second_phi_zero
 
const VectorVariableValue & _vector_zero
 
const VectorVariableCurl & _vector_curl_zero
 
VectorVariableValue _default_vector_value_zero
 
VectorVariableGradient _default_vector_gradient
 
VectorVariableCurl _default_vector_curl
 
VectorVariableDivergence _default_div
 
ArrayVariableValue _default_array_value_zero
 
ArrayVariableGradient _default_array_gradient
 
bool _coupleable_neighbor
 
FEProblemBase & _sc_fe_problem
 
const THREAD_ID _sc_tid
 
const Real & _real_zero
 
const VariableValue & _scalar_zero
 
const Point & _point_zero
 
const Parallel::Communicator & _communicator
 

Static Protected Attributes

static const std::string _interpolated_old
 
static const std::string _interpolated_older
 

Detailed Description

Dispersive flux of component k in fluid phase alpha.

Includes the effects of both molecular diffusion and hydrodynamic dispersion

Definition at line 21 of file FVPorousFlowDispersiveFlux.h.

Constructor & Destructor Documentation

◆ FVPorousFlowDispersiveFlux()

FVPorousFlowDispersiveFlux::FVPorousFlowDispersiveFlux ( const InputParameters &  params)

Definition at line 36 of file FVPorousFlowDispersiveFlux.C.

37  : FVFluxKernel(params),
38  _dictator(getUserObject<PorousFlowDictator>("PorousFlowDictator")),
39  _num_phases(_dictator.numPhases()),
40  _fluid_component(getParam<unsigned int>("fluid_component")),
41  _density(getADMaterialProperty<std::vector<Real>>("PorousFlow_fluid_phase_density_qp")),
42  _viscosity(getADMaterialProperty<std::vector<Real>>("PorousFlow_viscosity_qp")),
43  _viscosity_neighbor(
44  getNeighborADMaterialProperty<std::vector<Real>>("PorousFlow_viscosity_qp")),
45  _relperm(getADMaterialProperty<std::vector<Real>>("PorousFlow_relative_permeability_qp")),
46  _relperm_neighbor(
47  getNeighborADMaterialProperty<std::vector<Real>>("PorousFlow_relative_permeability_qp")),
48  _mass_fractions(
49  getADMaterialProperty<std::vector<std::vector<Real>>>("PorousFlow_mass_frac_qp")),
50  _mass_fractions_neighbor(
51  getNeighborADMaterialProperty<std::vector<std::vector<Real>>>("PorousFlow_mass_frac_qp")),
52  _grad_mass_frac(getADMaterialProperty<std::vector<std::vector<RealGradient>>>(
53  "PorousFlow_grad_mass_frac_qp")),
54  _permeability(getADMaterialProperty<RealTensorValue>("PorousFlow_permeability_qp")),
55  _permeability_neighbor(
56  getNeighborADMaterialProperty<RealTensorValue>("PorousFlow_permeability_qp")),
57  _pressure(getADMaterialProperty<std::vector<Real>>("PorousFlow_porepressure_qp")),
58  _pressure_neighbor(
59  getNeighborADMaterialProperty<std::vector<Real>>("PorousFlow_porepressure_qp")),
60  _grad_p(getADMaterialProperty<std::vector<RealGradient>>("PorousFlow_grad_porepressure_qp")),
61  _porosity(getADMaterialProperty<Real>("PorousFlow_porosity_qp")),
62  _porosity_neighbor(getNeighborADMaterialProperty<Real>("PorousFlow_porosity_qp")),
63  _tortuosity(getADMaterialProperty<std::vector<Real>>("PorousFlow_tortuosity_qp")),
64  _tortuosity_neighbor(
65  getNeighborADMaterialProperty<std::vector<Real>>("PorousFlow_tortuosity_qp")),
66  _diffusion_coeff(
67  getMaterialProperty<std::vector<std::vector<Real>>>("PorousFlow_diffusion_coeff_qp")),
68  _diffusion_coeff_neighbor(getNeighborMaterialProperty<std::vector<std::vector<Real>>>(
69  "PorousFlow_diffusion_coeff_qp")),
70  _gravity(getParam<RealVectorValue>("gravity")),
71  _identity_tensor(ADRankTwoTensor::initIdentity),
72  _disp_long(getParam<std::vector<Real>>("disp_long")),
73  _disp_trans(getParam<std::vector<Real>>("disp_trans"))
74 {
75  if (_fluid_component >= _dictator.numComponents())
76  paramError(
77  "fluid_component",
78  "The Dictator proclaims that the maximum fluid component index in this simulation is ",
79  _dictator.numComponents() - 1,
80  " whereas you have used ",
81  _fluid_component,
82  ". Remember that indexing starts at 0. The Dictator does not take such mistakes lightly.");
83 
84  // Check that sufficient values of the dispersion coefficients have been entered
85  if (_disp_long.size() != _num_phases)
86  paramError(
87  "disp_long",
88  "The number of longitudinal dispersion coefficients is not equal to the number of phases");
89 
90  if (_disp_trans.size() != _num_phases)
91  paramError("disp_trans",
92  "The number of transverse dispersion coefficients disp_trans is not equal to the "
93  "number of phases");
94 }
FVPorousFlowDispersiveFlux::_viscosity_neighbor
const ADMaterialProperty< std::vector< Real > > & _viscosity_neighbor
Definition: FVPorousFlowDispersiveFlux.h:42
FVPorousFlowDispersiveFlux::_dictator
const PorousFlowDictator & _dictator
UserObject that holds information (number of phases, components, etc)
Definition: FVPorousFlowDispersiveFlux.h:31
FVFluxKernel::getNeighborMaterialProperty
const MaterialProperty< T > & getNeighborMaterialProperty(const std::string &name, const unsigned int state=0)
FVPorousFlowDispersiveFlux::_porosity
const ADMaterialProperty< Real > & _porosity
Porosity.
Definition: FVPorousFlowDispersiveFlux.h:63
PorousFlowDictator::numComponents
unsigned int numComponents() const
The number of fluid components.
Definition: PorousFlowDictator.C:108
FVPorousFlowDispersiveFlux::_pressure_neighbor
const ADMaterialProperty< std::vector< Real > > & _pressure_neighbor
Definition: FVPorousFlowDispersiveFlux.h:59
FVPorousFlowDispersiveFlux::_grad_p
const ADMaterialProperty< std::vector< RealGradient > > & _grad_p
Definition: FVPorousFlowDispersiveFlux.h:60
FVPorousFlowDispersiveFlux::_disp_trans
const std::vector< Real > _disp_trans
Transverse dispersivity for each phase.
Definition: FVPorousFlowDispersiveFlux.h:82
FVPorousFlowDispersiveFlux::_density
const ADMaterialProperty< std::vector< Real > > & _density
Fluid density.
Definition: FVPorousFlowDispersiveFlux.h:38
FVFluxKernel::getADMaterialProperty
const ADMaterialProperty< T > & getADMaterialProperty(const std::string &name, MaterialData &material_data)
FVPorousFlowDispersiveFlux::_relperm_neighbor
const ADMaterialProperty< std::vector< Real > > & _relperm_neighbor
Definition: FVPorousFlowDispersiveFlux.h:46
FVFluxKernel::FVFluxKernel
FVFluxKernel(const InputParameters &params)
FVPorousFlowDispersiveFlux::_identity_tensor
const ADRankTwoTensor _identity_tensor
Definition: FVPorousFlowDispersiveFlux.h:76
FVPorousFlowDispersiveFlux::_num_phases
const unsigned int _num_phases
Number of fluid phases present.
Definition: FVPorousFlowDispersiveFlux.h:33
FVPorousFlowDispersiveFlux::_permeability
const ADMaterialProperty< RealTensorValue > & _permeability
Permeability.
Definition: FVPorousFlowDispersiveFlux.h:54
FVFluxKernel::getParam
const T & getParam(const std::string &name) const
FVPorousFlowDispersiveFlux::_mass_fractions
const ADMaterialProperty< std::vector< std::vector< Real > > > & _mass_fractions
Mass fraction of fluid components in fluid phases.
Definition: FVPorousFlowDispersiveFlux.h:49
FVFluxKernel::paramError
void paramError(const std::string &param, Args... args) const
PorousFlowDictator::numPhases
unsigned int numPhases() const
The number of fluid phases.
Definition: PorousFlowDictator.C:102
FVPorousFlowDispersiveFlux::_pressure
const ADMaterialProperty< std::vector< Real > > & _pressure
Fluid pressure.
Definition: FVPorousFlowDispersiveFlux.h:58
FVPorousFlowDispersiveFlux::_tortuosity_neighbor
const ADMaterialProperty< std::vector< Real > > & _tortuosity_neighbor
Definition: FVPorousFlowDispersiveFlux.h:68
FVPorousFlowDispersiveFlux::_permeability_neighbor
const ADMaterialProperty< RealTensorValue > & _permeability_neighbor
Definition: FVPorousFlowDispersiveFlux.h:55
FVPorousFlowDispersiveFlux::_porosity_neighbor
const ADMaterialProperty< Real > & _porosity_neighbor
Definition: FVPorousFlowDispersiveFlux.h:64
FVPorousFlowDispersiveFlux::_diffusion_coeff
const MaterialProperty< std::vector< std::vector< Real > > > & _diffusion_coeff
Diffusion coefficients of component k in fluid phase alpha.
Definition: FVPorousFlowDispersiveFlux.h:71
FVPorousFlowDispersiveFlux::_tortuosity
const ADMaterialProperty< std::vector< Real > > & _tortuosity
Tortuosity tau_0 * tau_{alpha} for fluid phase alpha.
Definition: FVPorousFlowDispersiveFlux.h:67
FVPorousFlowDispersiveFlux::_mass_fractions_neighbor
const ADMaterialProperty< std::vector< std::vector< Real > > > & _mass_fractions_neighbor
Definition: FVPorousFlowDispersiveFlux.h:50
FVPorousFlowDispersiveFlux::_viscosity
const ADMaterialProperty< std::vector< Real > > & _viscosity
Fluid viscosity.
Definition: FVPorousFlowDispersiveFlux.h:41
FVFluxKernel::getMaterialProperty
const MaterialProperty< T > & getMaterialProperty(const std::string &name, MaterialData &material_data, const unsigned int state=0)
FVPorousFlowDispersiveFlux::_diffusion_coeff_neighbor
const MaterialProperty< std::vector< std::vector< Real > > > & _diffusion_coeff_neighbor
Definition: FVPorousFlowDispersiveFlux.h:72
FVPorousFlowDispersiveFlux::_disp_long
const std::vector< Real > _disp_long
Longitudinal dispersivity for each phase.
Definition: FVPorousFlowDispersiveFlux.h:79
FVPorousFlowDispersiveFlux::_gravity
const RealVectorValue & _gravity
Gravity vector.
Definition: FVPorousFlowDispersiveFlux.h:75
FVPorousFlowDispersiveFlux::_grad_mass_frac
const ADMaterialProperty< std::vector< std::vector< RealGradient > > > & _grad_mass_frac
Definition: FVPorousFlowDispersiveFlux.h:51
FVPorousFlowDispersiveFlux::_fluid_component
const unsigned int _fluid_component
Index of the fluid component this kernel applies to.
Definition: FVPorousFlowDispersiveFlux.h:35
FVPorousFlowDispersiveFlux::_relperm
const ADMaterialProperty< std::vector< Real > > & _relperm
Relative permeability.
Definition: FVPorousFlowDispersiveFlux.h:45
FVFluxKernel::getNeighborADMaterialProperty
const ADMaterialProperty< T > & getNeighborADMaterialProperty(const std::string &name)

Member Function Documentation

◆ computeQpResidual()

ADReal FVPorousFlowDispersiveFlux::computeQpResidual ( )
overrideprotectedvirtual

Implements FVFluxKernel.

Definition at line 97 of file FVPorousFlowDispersiveFlux.C.

98 {
99  ADReal flux = 0.0;
100  ADRankTwoTensor dispersion;
101  ADReal diffusion;
102 
103  for (unsigned int p = 0; p < _num_phases; ++p)
104  {
105  // Diffusive component
106  ADRealGradient gradX;
107 
108  const auto state = determineState();
109  const auto dudn = gradUDotNormal(state);
110 
111  // If we are on a boundary face, use the reconstructed gradient computed in _grad_mass_frac
112  if (onBoundary(*_face_info))
113  {
114  gradX = -1 * _grad_mass_frac[_qp][p][_fluid_component];
115  diffusion = _porosity[_qp] * _tortuosity[_qp][p] * _density[_qp][p] *
116  _diffusion_coeff[_qp][p][_fluid_component];
117  }
118  else
119  {
120  // If we are on an internal face, calculate the gradient explicitly
121  const auto & X_elem = _mass_fractions[_qp][p][_fluid_component];
122  const auto & X_neighbor = _mass_fractions_neighbor[_qp][p][_fluid_component];
123 
124  gradX = (X_elem - X_neighbor) * _face_info->eCN() / _face_info->dCNMag();
125 
126  const auto coeff =
127  _porosity[_qp] * _tortuosity[_qp][p] * _diffusion_coeff[_qp][p][_fluid_component];
128 
129  const auto coeff_neighbor = _porosity_neighbor[_qp] * _tortuosity_neighbor[_qp][p] *
130  _diffusion_coeff_neighbor[_qp][p][_fluid_component];
131 
132  interpolate(
133  Moose::FV::InterpMethod::Average, diffusion, coeff, coeff_neighbor, *_face_info, true);
134  }
135 
136  // Dispersive component. Calculate Darcy velocity
137  ADRealGradient gradp;
138  ADRealTensorValue mobility;
139 
140  // If we are on a boundary face, use the gradient computed in _grad_p
141  if (onBoundary(*_face_info))
142  {
143  gradp = -_grad_p[_qp][p] + _density[_qp][p] * _gravity;
144  mobility = _relperm[_qp][p] * _permeability[_qp] * _density[_qp][p] / _viscosity[_qp][p];
145  }
146  else
147  {
148  // If we are on an internal face, calculate the gradient explicitly
149  const auto & p_elem = _pressure[_qp][p];
150  const auto & p_neighbor = _pressure_neighbor[_qp][p];
151 
152  gradp = (p_elem - p_neighbor) * _face_info->eCN() / _face_info->dCNMag() +
153  _density[_qp][p] * _gravity;
154 
155  const auto mobility_element = _relperm[_qp][p] * _permeability[_qp] / _viscosity[_qp][p];
156 
157  const auto mobility_neighbor =
158  _relperm_neighbor[_qp][p] * _permeability_neighbor[_qp] / _viscosity_neighbor[_qp][p];
159 
160  interpolate(Moose::FV::InterpMethod::Upwind,
161  mobility,
162  mobility_element,
163  mobility_neighbor,
164  gradp,
165  *_face_info,
166  true);
167  }
168 
169  const auto velocity = mobility * gradp;
170  const auto velocity_abs = MetaPhysicL::raw_value(velocity).norm();
171 
172  if (!MooseUtils::isZero(velocity_abs))
173  {
174  const auto v2 = ADRankTwoTensor::selfOuterProduct(velocity);
175 
176  // Add longitudinal dispersion to diffusive component
177  diffusion += _disp_trans[p] * velocity_abs;
178  dispersion = (_disp_long[p] - _disp_trans[p]) * v2 / velocity_abs;
179  }
180 
181  flux += (diffusion * _identity_tensor + dispersion) * _density[_qp][p] * gradX * _normal;
182  }
183 
184  return flux;
185 }
FVPorousFlowDispersiveFlux::_viscosity_neighbor
const ADMaterialProperty< std::vector< Real > > & _viscosity_neighbor
Definition: FVPorousFlowDispersiveFlux.h:42
FVFluxKernel::gradUDotNormal
virtual ADReal gradUDotNormal(const Moose::StateArg &time) const
MooseUtils::isZero
bool isZero(const T &value, const Real tolerance=TOLERANCE *TOLERANCE *TOLERANCE)
FVFluxKernel::_face_info
const FaceInfo * _face_info
FVFluxKernel::determineState
Moose::StateArg determineState() const
FVPorousFlowDispersiveFlux::_porosity
const ADMaterialProperty< Real > & _porosity
Porosity.
Definition: FVPorousFlowDispersiveFlux.h:63
MetaPhysicL::raw_value
auto raw_value(const Eigen::Map< T > &in)
FVPorousFlowDispersiveFlux::_pressure_neighbor
const ADMaterialProperty< std::vector< Real > > & _pressure_neighbor
Definition: FVPorousFlowDispersiveFlux.h:59
FVPorousFlowDispersiveFlux::_grad_p
const ADMaterialProperty< std::vector< RealGradient > > & _grad_p
Definition: FVPorousFlowDispersiveFlux.h:60
FVPorousFlowDispersiveFlux::_disp_trans
const std::vector< Real > _disp_trans
Transverse dispersivity for each phase.
Definition: FVPorousFlowDispersiveFlux.h:82
FVPorousFlowDispersiveFlux::_density
const ADMaterialProperty< std::vector< Real > > & _density
Fluid density.
Definition: FVPorousFlowDispersiveFlux.h:38
FVFluxKernel::_normal
RealVectorValue _normal
ADReal
DualNumber< Real, DNDerivativeType, true > ADReal
FVPorousFlowDispersiveFlux::_relperm_neighbor
const ADMaterialProperty< std::vector< Real > > & _relperm_neighbor
Definition: FVPorousFlowDispersiveFlux.h:46
RankTwoTensorTempl< ADReal >::selfOuterProduct
static RankTwoTensorTempl< ADReal > selfOuterProduct(const libMesh::TypeVector< ADReal > &)
FVFluxKernel::onBoundary
bool onBoundary(const FaceInfo &fi) const
FVPorousFlowDispersiveFlux::_identity_tensor
const ADRankTwoTensor _identity_tensor
Definition: FVPorousFlowDispersiveFlux.h:76
FVPorousFlowDispersiveFlux::_num_phases
const unsigned int _num_phases
Number of fluid phases present.
Definition: FVPorousFlowDispersiveFlux.h:33
FVFluxKernel::_qp
const unsigned int _qp
FVPorousFlowDispersiveFlux::_permeability
const ADMaterialProperty< RealTensorValue > & _permeability
Permeability.
Definition: FVPorousFlowDispersiveFlux.h:54
FVPorousFlowDispersiveFlux::_mass_fractions
const ADMaterialProperty< std::vector< std::vector< Real > > > & _mass_fractions
Mass fraction of fluid components in fluid phases.
Definition: FVPorousFlowDispersiveFlux.h:49
FVPorousFlowDispersiveFlux::_pressure
const ADMaterialProperty< std::vector< Real > > & _pressure
Fluid pressure.
Definition: FVPorousFlowDispersiveFlux.h:58
FVPorousFlowDispersiveFlux::_tortuosity_neighbor
const ADMaterialProperty< std::vector< Real > > & _tortuosity_neighbor
Definition: FVPorousFlowDispersiveFlux.h:68
FaceInfo::dCNMag
Real dCNMag() const
FVPorousFlowDispersiveFlux::_permeability_neighbor
const ADMaterialProperty< RealTensorValue > & _permeability_neighbor
Definition: FVPorousFlowDispersiveFlux.h:55
FVPorousFlowDispersiveFlux::_porosity_neighbor
const ADMaterialProperty< Real > & _porosity_neighbor
Definition: FVPorousFlowDispersiveFlux.h:64
FVPorousFlowDispersiveFlux::_diffusion_coeff
const MaterialProperty< std::vector< std::vector< Real > > > & _diffusion_coeff
Diffusion coefficients of component k in fluid phase alpha.
Definition: FVPorousFlowDispersiveFlux.h:71
FVPorousFlowDispersiveFlux::_tortuosity
const ADMaterialProperty< std::vector< Real > > & _tortuosity
Tortuosity tau_0 * tau_{alpha} for fluid phase alpha.
Definition: FVPorousFlowDispersiveFlux.h:67
FVPorousFlowDispersiveFlux::_mass_fractions_neighbor
const ADMaterialProperty< std::vector< std::vector< Real > > > & _mass_fractions_neighbor
Definition: FVPorousFlowDispersiveFlux.h:50
FaceInfo::eCN
const Point & eCN() const
FVPorousFlowDispersiveFlux::_viscosity
const ADMaterialProperty< std::vector< Real > > & _viscosity
Fluid viscosity.
Definition: FVPorousFlowDispersiveFlux.h:41
FVPorousFlowDispersiveFlux::_diffusion_coeff_neighbor
const MaterialProperty< std::vector< std::vector< Real > > > & _diffusion_coeff_neighbor
Definition: FVPorousFlowDispersiveFlux.h:72
FVPorousFlowDispersiveFlux::_disp_long
const std::vector< Real > _disp_long
Longitudinal dispersivity for each phase.
Definition: FVPorousFlowDispersiveFlux.h:79
FVPorousFlowDispersiveFlux::_gravity
const RealVectorValue & _gravity
Gravity vector.
Definition: FVPorousFlowDispersiveFlux.h:75
NS::velocity
static const std::string velocity
Definition: NS.h:45
FVPorousFlowDispersiveFlux::_grad_mass_frac
const ADMaterialProperty< std::vector< std::vector< RealGradient > > > & _grad_mass_frac
Definition: FVPorousFlowDispersiveFlux.h:51
interpolate
void interpolate(InterpMethod m, T &result, const T2 &value1, const T3 &value2, const FaceInfo &fi, const bool one_is_elem)
FVPorousFlowDispersiveFlux::_fluid_component
const unsigned int _fluid_component
Index of the fluid component this kernel applies to.
Definition: FVPorousFlowDispersiveFlux.h:35
FVPorousFlowDispersiveFlux::_relperm
const ADMaterialProperty< std::vector< Real > > & _relperm
Relative permeability.
Definition: FVPorousFlowDispersiveFlux.h:45

◆ validParams()

InputParameters FVPorousFlowDispersiveFlux::validParams ( )
static

Definition at line 17 of file FVPorousFlowDispersiveFlux.C.

18 {
19  InputParameters params = FVFluxKernel::validParams();
20  RealVectorValue g(0, 0, -9.81);
21  params.addParam<RealVectorValue>("gravity", g, "Gravity vector. Defaults to (0, 0, -9.81)");
22  params.addRequiredParam<UserObjectName>("PorousFlowDictator",
23  "The PorousFlowDictator UserObject");
24  params.addParam<unsigned int>("fluid_component", 0, "The fluid component");
25  params.addRequiredParam<std::vector<Real>>(
26  "disp_long", "Vector of longitudinal dispersion coefficients for each phase");
27  params.addRequiredParam<std::vector<Real>>(
28  "disp_trans", "Vector of transverse dispersion coefficients for each phase");
29  params.addClassDescription(
30  "Dispersive and diffusive flux of the component given by fluid_component in all phases");
31  params.set<unsigned short>("ghost_layers") = 2;
32  params.addClassDescription("Advective Darcy flux");
33  return params;
34 }
InputParameters::addParam
void addParam(const std::string &name, const std::initializer_list< typename T::value_type > &value, const std::string &doc_string)
InputParameters::set
T & set(const std::string &name, bool quiet_mode=false)
InputParameters::addRequiredParam
void addRequiredParam(const std::string &name, const std::string &doc_string)
FVFluxKernel::validParams
static InputParameters validParams()
InputParameters::addClassDescription
void addClassDescription(const std::string &doc_string)

Member Data Documentation

◆ _density

const ADMaterialProperty<std::vector<Real> >& FVPorousFlowDispersiveFlux::_density
protected

Fluid density.

Definition at line 38 of file FVPorousFlowDispersiveFlux.h.

Referenced by computeQpResidual().

◆ _dictator

const PorousFlowDictator& FVPorousFlowDispersiveFlux::_dictator
protected

UserObject that holds information (number of phases, components, etc)

Definition at line 31 of file FVPorousFlowDispersiveFlux.h.

Referenced by FVPorousFlowDispersiveFlux().

◆ _diffusion_coeff

const MaterialProperty<std::vector<std::vector<Real> > >& FVPorousFlowDispersiveFlux::_diffusion_coeff
protected

Diffusion coefficients of component k in fluid phase alpha.

Definition at line 71 of file FVPorousFlowDispersiveFlux.h.

Referenced by computeQpResidual().

◆ _diffusion_coeff_neighbor

const MaterialProperty<std::vector<std::vector<Real> > >& FVPorousFlowDispersiveFlux::_diffusion_coeff_neighbor
protected

Definition at line 72 of file FVPorousFlowDispersiveFlux.h.

Referenced by computeQpResidual().

◆ _disp_long

const std::vector<Real> FVPorousFlowDispersiveFlux::_disp_long
protected

Longitudinal dispersivity for each phase.

Definition at line 79 of file FVPorousFlowDispersiveFlux.h.

Referenced by computeQpResidual(), and FVPorousFlowDispersiveFlux().

◆ _disp_trans

const std::vector<Real> FVPorousFlowDispersiveFlux::_disp_trans
protected

Transverse dispersivity for each phase.

Definition at line 82 of file FVPorousFlowDispersiveFlux.h.

Referenced by computeQpResidual(), and FVPorousFlowDispersiveFlux().

◆ _fluid_component

const unsigned int FVPorousFlowDispersiveFlux::_fluid_component
protected

Index of the fluid component this kernel applies to.

Definition at line 35 of file FVPorousFlowDispersiveFlux.h.

Referenced by computeQpResidual(), and FVPorousFlowDispersiveFlux().

◆ _grad_mass_frac

const ADMaterialProperty<std::vector<std::vector<RealGradient> > >& FVPorousFlowDispersiveFlux::_grad_mass_frac
protected

Definition at line 51 of file FVPorousFlowDispersiveFlux.h.

Referenced by computeQpResidual().

◆ _grad_p

const ADMaterialProperty<std::vector<RealGradient> >& FVPorousFlowDispersiveFlux::_grad_p
protected

Definition at line 60 of file FVPorousFlowDispersiveFlux.h.

Referenced by computeQpResidual().

◆ _gravity

const RealVectorValue& FVPorousFlowDispersiveFlux::_gravity
protected

Gravity vector.

Definition at line 75 of file FVPorousFlowDispersiveFlux.h.

Referenced by computeQpResidual().

◆ _identity_tensor

const ADRankTwoTensor FVPorousFlowDispersiveFlux::_identity_tensor
protected

Definition at line 76 of file FVPorousFlowDispersiveFlux.h.

Referenced by computeQpResidual().

◆ _mass_fractions

const ADMaterialProperty<std::vector<std::vector<Real> > >& FVPorousFlowDispersiveFlux::_mass_fractions
protected

Mass fraction of fluid components in fluid phases.

Definition at line 49 of file FVPorousFlowDispersiveFlux.h.

Referenced by computeQpResidual().

◆ _mass_fractions_neighbor

const ADMaterialProperty<std::vector<std::vector<Real> > >& FVPorousFlowDispersiveFlux::_mass_fractions_neighbor
protected

Definition at line 50 of file FVPorousFlowDispersiveFlux.h.

Referenced by computeQpResidual().

◆ _num_phases

const unsigned int FVPorousFlowDispersiveFlux::_num_phases
protected

Number of fluid phases present.

Definition at line 33 of file FVPorousFlowDispersiveFlux.h.

Referenced by computeQpResidual(), and FVPorousFlowDispersiveFlux().

◆ _permeability

const ADMaterialProperty<RealTensorValue>& FVPorousFlowDispersiveFlux::_permeability
protected

Permeability.

Definition at line 54 of file FVPorousFlowDispersiveFlux.h.

Referenced by computeQpResidual().

◆ _permeability_neighbor

const ADMaterialProperty<RealTensorValue>& FVPorousFlowDispersiveFlux::_permeability_neighbor
protected

Definition at line 55 of file FVPorousFlowDispersiveFlux.h.

Referenced by computeQpResidual().

◆ _porosity

const ADMaterialProperty<Real>& FVPorousFlowDispersiveFlux::_porosity
protected

Porosity.

Definition at line 63 of file FVPorousFlowDispersiveFlux.h.

Referenced by computeQpResidual().

◆ _porosity_neighbor

const ADMaterialProperty<Real>& FVPorousFlowDispersiveFlux::_porosity_neighbor
protected

Definition at line 64 of file FVPorousFlowDispersiveFlux.h.

Referenced by computeQpResidual().

◆ _pressure

const ADMaterialProperty<std::vector<Real> >& FVPorousFlowDispersiveFlux::_pressure
protected

Fluid pressure.

Definition at line 58 of file FVPorousFlowDispersiveFlux.h.

Referenced by computeQpResidual().

◆ _pressure_neighbor

const ADMaterialProperty<std::vector<Real> >& FVPorousFlowDispersiveFlux::_pressure_neighbor
protected

Definition at line 59 of file FVPorousFlowDispersiveFlux.h.

Referenced by computeQpResidual().

◆ _relperm

const ADMaterialProperty<std::vector<Real> >& FVPorousFlowDispersiveFlux::_relperm
protected

Relative permeability.

Definition at line 45 of file FVPorousFlowDispersiveFlux.h.

Referenced by computeQpResidual().

◆ _relperm_neighbor

const ADMaterialProperty<std::vector<Real> >& FVPorousFlowDispersiveFlux::_relperm_neighbor
protected

Definition at line 46 of file FVPorousFlowDispersiveFlux.h.

Referenced by computeQpResidual().

◆ _tortuosity

const ADMaterialProperty<std::vector<Real> >& FVPorousFlowDispersiveFlux::_tortuosity
protected

Tortuosity tau_0 * tau_{alpha} for fluid phase alpha.

Definition at line 67 of file FVPorousFlowDispersiveFlux.h.

Referenced by computeQpResidual().

◆ _tortuosity_neighbor

const ADMaterialProperty<std::vector<Real> >& FVPorousFlowDispersiveFlux::_tortuosity_neighbor
protected

Definition at line 68 of file FVPorousFlowDispersiveFlux.h.

Referenced by computeQpResidual().

◆ _viscosity

const ADMaterialProperty<std::vector<Real> >& FVPorousFlowDispersiveFlux::_viscosity
protected

Fluid viscosity.

Definition at line 41 of file FVPorousFlowDispersiveFlux.h.

Referenced by computeQpResidual().

◆ _viscosity_neighbor

const ADMaterialProperty<std::vector<Real> >& FVPorousFlowDispersiveFlux::_viscosity_neighbor
protected

Definition at line 42 of file FVPorousFlowDispersiveFlux.h.

Referenced by computeQpResidual().

The documentation for this class was generated from the following files:
Generated on Tue Apr 15 2025 16:24:54 for https://mooseframework.inl.gov by   doxygen 1.8.14