https://mooseframework.inl.gov
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Types | Protected Member Functions | Protected Attributes | Static Protected Attributes | List of all members
GeneralFunctorFluidPropsTempl< is_ad > Class Template Reference

Computes fluid properties in (P, T) formulation using functor material properties. More...

#include <GeneralFunctorFluidProps.h>

Inheritance diagram for GeneralFunctorFluidPropsTempl< is_ad >:
[legend]

Public Types

enum  ConstantTypeEnum { ConstantTypeEnum::NONE, ConstantTypeEnum::ELEMENT, ConstantTypeEnum::SUBDOMAIN }
 
enum  TEST_TYPE
 
typedef DataFileName DataFileParameterType
 
typedef std::string SymbolName
 

Public Member Functions

 GeneralFunctorFluidPropsTempl (const InputParameters &parameters)
 
void computeProperties () override final
 
const std::set< std::string > & getSuppliedFunctors () const
 
virtual const dof_id_type & getElementID (const std::string &id_parameter_name, unsigned int comp=0) const override
 
dof_id_type getElementID (const Elem *elem, unsigned int elem_id_index) const
 
virtual const dof_id_type & getElementIDNeighbor (const std::string &id_parameter_name, unsigned int comp=0) const override
 
virtual const dof_id_type & getElementIDByName (const std::string &id_parameter_name) const override
 
virtual const dof_id_type & getElementIDNeighborByName (const std::string &id_parameter_name) const override
 
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 std::string &name, const unsigned int state=0)
 
const GenericMaterialProperty< T, is_ad > & getGenericMaterialPropertyByName (const MaterialPropertyName &name, const unsigned int state=0)
 
const GenericMaterialProperty< T, is_ad > & getGenericMaterialPropertyByName (const std::string &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 std::string &prop_name, const unsigned int state=0)
 
const MaterialProperty< T > & getMaterialPropertyByName (const MaterialPropertyName &name, const unsigned int state=0)
 
const MaterialProperty< T > & getMaterialPropertyByName (const std::string &prop_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 std::string &prop_name)
 
const ADMaterialProperty< T > & getADMaterialPropertyByName (const MaterialPropertyName &name)
 
const ADMaterialProperty< T > & getADMaterialPropertyByName (const std::string &prop_name)
 
const ADMaterialProperty< T > & getADMaterialPropertyByName (const MaterialPropertyName &name)
 
const MaterialProperty< T > & getMaterialPropertyOldByName (const MaterialPropertyName &name, MaterialData &material_data)
 
const MaterialProperty< T > & getMaterialPropertyOldByName (const std::string &prop_name)
 
const MaterialProperty< T > & getMaterialPropertyOldByName (const MaterialPropertyName &name)
 
const MaterialProperty< T > & getMaterialPropertyOldByName (const std::string &prop_name)
 
const MaterialProperty< T > & getMaterialPropertyOldByName (const MaterialPropertyName &name)
 
const MaterialProperty< T > & getMaterialPropertyOlderByName (const MaterialPropertyName &name, MaterialData &material_data)
 
const MaterialProperty< T > & getMaterialPropertyOlderByName (const std::string &prop_name)
 
const MaterialProperty< T > & getMaterialPropertyOlderByName (const MaterialPropertyName &name)
 
const MaterialProperty< T > & getMaterialPropertyOlderByName (const std::string &prop_name)
 
const MaterialProperty< T > & getMaterialPropertyOlderByName (const MaterialPropertyName &name)
 
MaterialBase & getMaterial (const std::string &name)
 
MaterialBase & getMaterialByName (const std::string &name, bool no_warn=false, bool no_dep=false)
 
MaterialBase & getMaterialByName (const std::string &name, bool no_warn=false)
 
MaterialBase & getMaterialByName (const std::string &name, bool no_warn=false)
 
virtual bool isBoundaryMaterial () const override
 
virtual const std::unordered_set< unsigned int > & getMatPropDependencies () const override
 
virtual void subdomainSetup () override
 
bool ghostable () const override final
 
virtual void resolveOptionalProperties () override
 
const GenericMaterialProperty< T, is_ad > & getGenericZeroMaterialProperty (const std::string &name)
 
const GenericMaterialProperty< T, is_ad > & getGenericZeroMaterialProperty ()
 
const GenericMaterialProperty< T, is_ad > & getGenericZeroMaterialProperty (const std::string &name)
 
const GenericMaterialProperty< T, is_ad > & getGenericZeroMaterialProperty ()
 
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 GenericMaterialProperty< T, is_ad > & getGenericZeroMaterialPropertyByName (const std::string &prop_name)
 
const GenericMaterialProperty< T, is_ad > & getGenericZeroMaterialPropertyByName (const std::string &prop_name)
 
const MaterialProperty< T > & getZeroMaterialProperty (Ts... args)
 
const MaterialProperty< T > & getZeroMaterialProperty (Ts... args)
 
const MaterialProperty< T > & getZeroMaterialProperty (Ts... args)
 
virtual void initStatefulProperties (unsigned int n_points)
 
virtual bool isInterfaceMaterial ()
 
virtual void resetProperties ()
 
virtual void computePropertiesAtQp (unsigned int qp)
 
const MaterialProperty< T > & getZeroMaterialPropertyByName (Ts... args)
 
virtual const std::set< std::string > & getRequestedItems () override
 
virtual const std::set< std::string > & getSuppliedItems () override
 
const std::set< unsigned int > & getSuppliedPropIDs ()
 
void checkStatefulSanity () const
 
std::set< OutputName > getOutputs ()
 
bool hasStatefulProperties () const
 
void setFaceInfo (const FaceInfo &fi)
 
std::unordered_map< SubdomainID, std::vector< MaterialBase *> > buildRequiredMaterials (bool allow_stateful=true)
 
void setActiveProperties (const std::unordered_set< unsigned int > &needed_props)
 
bool forceStatefulInit () const
 
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 * 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 &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
 
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
 
virtual const std::set< BoundaryID > & boundaryIDs () const
 
const std::vector< BoundaryName > & boundaryNames () const
 
unsigned int numBoundaryIDs () const
 
bool hasBoundary (const BoundaryName &name) const
 
bool hasBoundary (const std::vector< BoundaryName > &names) const
 
bool hasBoundary (const BoundaryID &id) const
 
bool hasBoundary (const std::vector< BoundaryID > &ids, TEST_TYPE type=ALL) const
 
bool hasBoundary (const std::set< BoundaryID > &ids, TEST_TYPE type=ALL) const
 
bool isBoundarySubset (const std::set< BoundaryID > &ids) const
 
bool isBoundarySubset (const std::vector< BoundaryID > &ids) const
 
bool hasBoundaryMaterialProperty (const std::string &prop_name) const
 
virtual bool boundaryRestricted () const
 
const std::set< BoundaryID > & meshBoundaryIDs () const
 
virtual bool checkVariableBoundaryIntegrity () const
 
virtual void initialSetup ()
 
virtual void timestepSetup ()
 
virtual void jacobianSetup ()
 
virtual void residualSetup ()
 
virtual void customSetup (const ExecFlagType &)
 
const ExecFlagEnum & getExecuteOnEnum () 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)
 
void addMooseVariableDependency (MooseVariableFieldBase *var)
 
void addMooseVariableDependency (const std::vector< MooseVariableFieldBase * > &vars)
 
const std::vector< MooseVariableScalar *> & getCoupledMooseScalarVars ()
 
const std::set< TagID > & getScalarVariableCoupleableVectorTags () const
 
const std::set< TagID > & getScalarVariableCoupleableMatrixTags () const
 
const ADVariableValue * getADDefaultValue (const std::string &var_name) 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
 
virtual void meshChanged ()
 
void buildOutputHideVariableList (std::set< std::string > variable_names)
 
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 unsigned int getElementIDIndex (const std::string &id_parameter_name, unsigned int comp=0) const
 
virtual unsigned int getElementIDIndexByName (const std::string &id_name) const
 
bool hasElementID (const std::string &id_name) const
 
dof_id_type maxElementID (unsigned int elem_id_index) const
 
dof_id_type minElementID (unsigned int elem_id_index) const
 
bool areElemIDsIdentical (const std::string &id_name1, const std::string &id_name2) const
 
std::unordered_map< dof_id_type, std::set< dof_id_type > > getElemIDMapping (const std::string &id_name1, const std::string &id_name2) const
 
std::set< dof_id_type > getAllElemIDs (unsigned int elem_id_index) const
 
std::set< dof_id_type > getElemIDsOnBlocks (unsigned int elem_id_index, const std::set< SubdomainID > &blks) 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 ADVectorVariableValue * getADDefaultVectorValue (const std::string &var_name) const
 
const ADVariableGradient & getADDefaultGradient () const
 
const ADVectorVariableGradient & getADDefaultVectorGradient () const
 
const ADVariableSecond & getADDefaultSecond () const
 
const ADVectorVariableCurl & getADDefaultCurl () const
 
std::pair< const MaterialProperty< T > *, std::set< SubdomainID > > getBlockMaterialProperty (const MaterialPropertyName &name)
 
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)
 
void statefulPropertiesAllowed (bool)
 
bool getMaterialPropertyCalled () const
 
const GenericMaterialProperty< T, is_ad > & getPossiblyConstantGenericMaterialPropertyByName (const MaterialPropertyName &prop_name, MaterialData &material_data, const unsigned int state)
 
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)
 
MaterialProperty< T > & declarePropertyByName (const std::string &prop_name)
 
MaterialProperty< T > & declarePropertyByName (const std::string &prop_name)
 
MaterialProperty< T > & declareProperty (const std::string &name)
 
MaterialProperty< T > & declareProperty (const std::string &name)
 
ADMaterialProperty< T > & declareADPropertyByName (const std::string &prop_name)
 
ADMaterialProperty< T > & declareADPropertyByName (const std::string &prop_name)
 
ADMaterialProperty< T > & declareADProperty (const std::string &name)
 
ADMaterialProperty< T > & declareADProperty (const std::string &name)
 
auto & declareGenericProperty (const std::string &prop_name)
 
auto & declareGenericProperty (const std::string &prop_name)
 
GenericMaterialProperty< T, is_ad > & declareGenericPropertyByName (const std::string &prop_name)
 
GenericMaterialProperty< T, is_ad > & declareGenericPropertyByName (const std::string &prop_name)
 
const Distribution & getDistribution (const std::string &name) const
 
const T & getDistribution (const std::string &name) const
 
const Distribution & getDistribution (const std::string &name) const
 
const T & getDistribution (const std::string &name) const
 
const Distribution & getDistributionByName (const DistributionName &name) const
 
const T & getDistributionByName (const std::string &name) const
 
const Distribution & getDistributionByName (const DistributionName &name) const
 
const T & getDistributionByName (const std::string &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 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
 
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)
 
PenetrationLocator & getPenetrationLocator (const BoundaryName &primary, const BoundaryName &secondary, Order order)
 
PenetrationLocator & getQuadraturePenetrationLocator (const BoundaryName &primary, const BoundaryName &secondary, Order order)
 
NearestNodeLocator & getNearestNodeLocator (const BoundaryName &primary, const BoundaryName &secondary)
 
NearestNodeLocator & getQuadratureNearestNodeLocator (const BoundaryName &primary, const BoundaryName &secondary)
 
bool requiresGeometricSearch () const
 
const Parallel::Communicator & comm () const
 
processor_id_type n_processors () const
 
processor_id_type processor_id () const
 
const MaterialPropertyName derivativePropertyName (const MaterialPropertyName &base, const std::vector< SymbolName > &c) const
 
const MaterialPropertyName derivativePropertyNameFirst (const MaterialPropertyName &base, const SymbolName &c1) const
 
const MaterialPropertyName derivativePropertyNameSecond (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2) const
 
const MaterialPropertyName derivativePropertyNameThird (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2, const SymbolName &c3) const
 
const MaterialPropertyName propertyName (const MaterialPropertyName &base, const std::vector< SymbolName > &c) const
 
const MaterialPropertyName propertyName (const MaterialPropertyName &base, const std::vector< SymbolName > &c) const
 
const MaterialPropertyName propertyNameFirst (const MaterialPropertyName &base, const SymbolName &c1) const
 
const MaterialPropertyName propertyNameFirst (const MaterialPropertyName &base, const SymbolName &c1) const
 
const MaterialPropertyName propertyNameSecond (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2) const
 
const MaterialPropertyName propertyNameSecond (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2) const
 
const MaterialPropertyName propertyNameThird (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2, const SymbolName &c3) const
 
const MaterialPropertyName propertyNameThird (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2, const SymbolName &c3) const
 

Static Public Member Functions

static InputParameters validParams ()
 
static std::deque< MaterialBase *> buildRequiredMaterials (const Consumers &mat_consumers, const std::vector< std::shared_ptr< MaterialBase >> &mats, const bool allow_stateful)
 
static bool restricted (const std::set< BoundaryID > &ids)
 
static void sort (typename std::vector< T > &vector)
 
static void sortDFS (typename std::vector< T > &vector)
 
static void cyclicDependencyError (CyclicDependencyException< T2 > &e, const std::string &header)
 
static std::string deduceFunctorName (const std::string &name, const InputParameters &params)
 

Public Attributes

 ALL
 
 ANY
 
const ConsoleStream _console
 

Static Public Attributes

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

Protected Types

enum  QP_Data_Type
 

Protected Member Functions

const MaterialPropertyName derivativePropertyNameFirst (const MaterialPropertyName &base, const SymbolName &c1) const
 
const T & getUserObject (const std::string &param_name, bool is_dependency=true) const
 
void computeQpProperties () override final
 
const Moose::FunctorBase< T > & addFunctorProperty (const std::string &name, PolymorphicLambda my_lammy, const std::set< ExecFlagType > &clearance_schedule={EXEC_ALWAYS})
 
const Moose::FunctorBase< T > & addFunctorPropertyByBlocks (const std::string &name, PolymorphicLambda my_lammy, const std::set< SubdomainID > &sub_ids, const std::set< ExecFlagType > &clearance_schedule={EXEC_ALWAYS})
 
virtual void checkMaterialProperty (const std::string &name, const unsigned int state) override
 
virtual const MaterialData & materialData () const override
 
virtual MaterialData & materialData () override
 
virtual const QBase & qRule () const override
 
virtual void resetQpProperties ()
 
virtual void initQpStatefulProperties ()
 
virtual const FEProblemBase & miProblem () const
 
virtual FEProblemBase & miProblem ()
 
bool isPropertyActive (const unsigned int prop_id) const
 
void registerPropName (const std::string &prop_name, bool is_get, const unsigned int state)
 
void checkExecutionStage ()
 
void checkExecutionStage ()
 
void markMatPropRequested (const std::string &)
 
virtual bool hasBlockMaterialPropertyHelper (const std::string &prop_name)
 
void initializeBlockRestrictable (const MooseObject *moose_object)
 
Moose::CoordinateSystemType getBlockCoordSystem ()
 
bool hasBoundaryMaterialPropertyHelper (const std::string &prop_name) 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
 
bool checkVar (const std::string &var_name, unsigned int comp=0, unsigned int comp_bound=0) const
 
void validateExecutionerType (const std::string &name, const std::string &fn_name) 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
 
std::string deduceFunctorName (const std::string &name) 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)
 
void flagInvalidSolutionInternal (const InvalidSolutionID invalid_solution_id) const
 
InvalidSolutionID registerInvalidSolutionInternal (const std::string &message, const bool warning) const
 
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
 
const GenericVectorVariableValue< is_ad > & coupledGenericVectorValue (const std::string &var_name, unsigned int comp=0) const
 
const GenericVectorVariableValue< false > & coupledGenericVectorValue (const std::string &var_name, unsigned int comp) const
 
const GenericVectorVariableValue< true > & coupledGenericVectorValue (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
 
std::vector< const VectorVariableValue *> coupledVectorValuesOld (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 ()
 
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
 
std::vector< T > coupledVectorHelper (const std::string &var_name, const Func &func) const
 
MaterialPropertyName getMaterialPropertyName (const std::string &name) const
 
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 SinglePhaseFluidProperties & _fluid
 
const Moose::Functor< GenericReal< is_ad > > & _eps
 Porosity. More...
 
const Moose::Functor< Real > & _d
 Characteristic length $d$ used in computing the Reynolds number $Re=/$. More...
 
const bool _pressure_is_dynamic
 Whether the input pressure is the dynamic pressure. More...
 
const Point _reference_pressure_point
 Where the static pressure rho*g*(z-z0) term is 0. More...
 
const Real _reference_pressure_value
 The value of pressure at that point. More...
 
const Point _gravity_vec
 The gravity vector. More...
 
const Moose::Functor< GenericReal< is_ad > > & _pressure
 variables More...
 
const Moose::Functor< GenericReal< is_ad > > & _T_fluid
 
const Moose::Functor< GenericReal< is_ad > > & _speed
 
const bool _force_define_density
 A parameter to force definition of a functor material property for density. More...
 
const Moose::Functor< GenericReal< is_ad > > & _rho
 Density as a functor, which could be from the variable set or the property. More...
 
const Function & _mu_rampdown
 Function to ramp down the viscosity, useful for relaxation transient. More...
 
const bool _neglect_derivatives_of_density_time_derivative
 Whether to neglect the contributions to the Jacobian of the density time derivative. More...
 
const MooseFunctorName & _density_name
 Name to use for density functor. More...
 
const MooseFunctorName & _dynamic_viscosity_name
 Name to use for the dynamic viscosity functor. More...
 
const MooseFunctorName & _specific_heat_name
 Name to use for the specific heat functor. More...
 
const MooseFunctorName & _thermal_conductivity_name
 Name to use for the thermal conductivity functor. More...
 
 CURR
 
 PREV
 
bool _bnd
 
bool _neighbor
 
const MooseArray< Point > & _q_point
 
const QBase *const & _qrule
 
const MooseArray< Real > & _JxW
 
const Elem *const & _current_elem
 
const SubdomainID & _current_subdomain_id
 
const unsigned int & _current_side
 
const ConstantTypeEnum _constant_option
 
SubProblem & _subproblem
 
FEProblemBase & _fe_problem
 
THREAD_ID _tid
 
Assembly & _assembly
 
unsigned int _qp
 
const MooseArray< Real > & _coord
 
const MooseArray< Point > & _normals
 
MooseMesh & _mesh
 
const Moose::CoordinateSystemType & _coord_sys
 
std::set< std::string > _requested_props
 
std::set< std::string > _supplied_props
 
std::set< unsigned int > _supplied_prop_ids
 
std::unordered_set< unsigned int > _active_prop_ids
 
const bool _compute
 
std::unordered_map< unsigned int, unsigned int > _props_to_min_states
 
std::vector< unsigned int > _displacements
 
bool _has_stateful_property
 
bool _overrides_init_stateful_props
 
const FaceInfo * _face_info
 
const bool & _enabled
 
MooseApp & _app
 
const std::string _type
 
const std::string _name
 
const InputParameters & _pars
 
Factory & _factory
 
ActionFactory & _action_factory
 
const MaterialData * _blk_material_data
 
const ExecFlagEnum & _execute_enum
 
const ExecFlagType & _current_execute_flag
 
FEProblemBase & _sc_fe_problem
 
const THREAD_ID _sc_tid
 
const Real & _real_zero
 
const VariableValue & _scalar_zero
 
const Point & _point_zero
 
std::unordered_map< std::string, std::vector< std::unique_ptr< VariableValue > > > _default_value
 
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
 
GeometricSearchData & _geometric_search_data
 
bool _requires_geometric_search
 
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::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
 
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
 
const Parallel::Communicator & _communicator
 

Static Protected Attributes

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

Detailed Description

template<bool is_ad>
class GeneralFunctorFluidPropsTempl< is_ad >

Computes fluid properties in (P, T) formulation using functor material properties.

Definition at line 23 of file GeneralFunctorFluidProps.h.

Constructor & Destructor Documentation

◆ GeneralFunctorFluidPropsTempl()

template<bool is_ad>
GeneralFunctorFluidPropsTempl< is_ad >::GeneralFunctorFluidPropsTempl ( const InputParameters &  parameters)

Definition at line 76 of file GeneralFunctorFluidProps.C.

78  : FunctorMaterial(parameters),
79  _fluid(UserObjectInterface::getUserObject<SinglePhaseFluidProperties>(NS::fluid)),
80  _eps(getFunctor<GenericReal<is_ad>>(NS::porosity)),
81  _d(getFunctor<Real>("characteristic_length")),
82 
83  _pressure_is_dynamic(getParam<bool>("solving_for_dynamic_pressure")),
84  _reference_pressure_point(getParam<Point>("reference_pressure_point")),
85  _reference_pressure_value(getParam<Real>("reference_pressure")),
86  _gravity_vec(getParam<Point>("gravity")),
87 
88  _pressure(getFunctor<GenericReal<is_ad>>(NS::pressure)),
89  _T_fluid(getFunctor<GenericReal<is_ad>>(NS::T_fluid)),
90  _speed(getFunctor<GenericReal<is_ad>>(NS::speed)),
91  _force_define_density(getParam<bool>("force_define_density")),
92  _rho(getFunctor<GenericReal<is_ad>>(NS::density)),
93  _mu_rampdown(getFunction("mu_rampdown")),
94  _neglect_derivatives_of_density_time_derivative(
95  getParam<bool>("neglect_derivatives_of_density_time_derivative")),
96 
97  _density_name(getParam<MooseFunctorName>("density_name")),
98  _dynamic_viscosity_name(getParam<MooseFunctorName>("dynamic_viscosity_name")),
99  _specific_heat_name(getParam<MooseFunctorName>("specific_heat_name")),
100  _thermal_conductivity_name(getParam<MooseFunctorName>("thermal_conductivity_name"))
101 {
102  // Check parameters
103  if (!_pressure_is_dynamic &&
104  (isParamSetByUser("reference_pressure_point") || isParamSetByUser("reference_pressure")))
105  paramError("solving_for_dynamic_pressure",
106  "'reference_pressure_point' and 'reference_pressure' should not be set unless "
107  "solving for the dynamic pressure");
108 
109  //
110  // Set material properties functors
111  //
112 
113  // If pressure is dynamic (else case), we must obtain the total pressure
114  // We duplicate all this code. An alternative would be to redefine the pressure functor.
115  // The issue with that is that you need the density functor to define the pressure,
116  // and the pressure functor to define the density.
117  // This could be solved by keeping a pointer to the pressure functor as an attribute and set
118  // the pressure functor after the density functor has been defined.
119  if (!_pressure_is_dynamic)
120  {
121  if (!isParamValid(NS::density) || _force_define_density)
122  addFunctorProperty<GenericReal<is_ad>>(
123  _density_name,
124  [this](const auto & r, const auto & t) -> GenericReal<is_ad>
125  { return _fluid.rho_from_p_T(_pressure(r, t), _T_fluid(r, t)); });
126 
127  addFunctorProperty<GenericReal<is_ad>>(
128  NS::cv,
129  [this](const auto & r, const auto & t) -> GenericReal<is_ad>
130  { return _fluid.cv_from_p_T(_pressure(r, t), _T_fluid(r, t)); });
131 
132  const auto & cp = addFunctorProperty<GenericReal<is_ad>>(
133  _specific_heat_name,
134  [this](const auto & r, const auto & t) -> GenericReal<is_ad>
135  { return _fluid.cp_from_p_T(_pressure(r, t), _T_fluid(r, t)); });
136 
137  const auto & mu = addFunctorProperty<GenericReal<is_ad>>(
138  _dynamic_viscosity_name,
139  [this](const auto & r, const auto & t) -> GenericReal<is_ad>
140  { return _mu_rampdown(r, t) * _fluid.mu_from_p_T(_pressure(r, t), _T_fluid(r, t)); });
141 
142  const auto & k = addFunctorProperty<GenericReal<is_ad>>(
143  _thermal_conductivity_name,
144  [this](const auto & r, const auto & t) -> GenericReal<is_ad>
145  { return _fluid.k_from_p_T(_pressure(r, t), _T_fluid(r, t)); });
146 
147  //
148  // Time derivatives of fluid properties
149  //
150  if (_neglect_derivatives_of_density_time_derivative)
151  {
152  addFunctorProperty<GenericReal<is_ad>>(
153  NS::time_deriv(_density_name),
154  [this](const auto & r, const auto & t) -> GenericReal<is_ad>
155  {
156  Real rho, drho_dp, drho_dT;
157  _fluid.rho_from_p_T(MetaPhysicL::raw_value(_pressure(r, t)),
158  MetaPhysicL::raw_value(_T_fluid(r, t)),
159  rho,
160  drho_dp,
161  drho_dT);
162  return drho_dp * _pressure.dot(r, t) + drho_dT * _T_fluid.dot(r, t);
163  });
164  }
165  else
166  {
167  addFunctorProperty<GenericReal<is_ad>>(
168  NS::time_deriv(_density_name),
169  [this](const auto & r, const auto & t) -> GenericReal<is_ad>
170  {
171  GenericReal<is_ad> rho, drho_dp, drho_dT;
172  _fluid.rho_from_p_T(_pressure(r, t), _T_fluid(r, t), rho, drho_dp, drho_dT);
173  return drho_dp * _pressure.dot(r, t) + drho_dT * _T_fluid.dot(r, t);
174  });
175  }
176 
177  addFunctorProperty<GenericReal<is_ad>>(
178  NS::time_deriv(_specific_heat_name),
179  [this](const auto & r, const auto & t) -> GenericReal<is_ad>
180  {
181  Real dcp_dp, dcp_dT, dummy;
182  const auto raw_pressure = MetaPhysicL::raw_value(_pressure(r, t));
183  const auto raw_T_fluid = MetaPhysicL::raw_value(_T_fluid(r, t));
184  _fluid.cp_from_p_T(raw_pressure, raw_T_fluid, dummy, dcp_dp, dcp_dT);
185 
186  return dcp_dp * _pressure.dot(r, t) + dcp_dT * _T_fluid.dot(r, t);
187  });
188 
189  //
190  // Temperature and pressure derivatives, to help with computing time derivatives
191  //
192 
193  const auto & drho_dp = addFunctorProperty<Real>(
194  derivativePropertyNameFirst(_density_name, NS::pressure),
195  [this](const auto & r, const auto & t) -> Real
196  {
197  Real drho_dp, drho_dT, dummy;
198  auto raw_pressure = MetaPhysicL::raw_value(_pressure(r, t));
199  auto raw_T_fluid = MetaPhysicL::raw_value(_T_fluid(r, t));
200 
201  _fluid.rho_from_p_T(raw_pressure, raw_T_fluid, dummy, drho_dp, drho_dT);
202  return drho_dp;
203  });
204 
205  const auto & drho_dT = addFunctorProperty<Real>(
206  derivativePropertyNameFirst(_density_name, NS::T_fluid),
207  [this](const auto & r, const auto & t) -> Real
208  {
209  Real drho_dp, drho_dT, dummy;
210  auto raw_pressure = MetaPhysicL::raw_value(_pressure(r, t));
211  auto raw_T_fluid = MetaPhysicL::raw_value(_T_fluid(r, t));
212 
213  _fluid.rho_from_p_T(raw_pressure, raw_T_fluid, dummy, drho_dp, drho_dT);
214  return drho_dT;
215  });
216 
217  const auto & dcp_dp = addFunctorProperty<Real>(
218  derivativePropertyNameFirst(_specific_heat_name, NS::pressure),
219  [this](const auto & r, const auto & t) -> Real
220  {
221  Real dcp_dp, dcp_dT, dummy;
222  auto raw_pressure = MetaPhysicL::raw_value(_pressure(r, t));
223  auto raw_T_fluid = MetaPhysicL::raw_value(_T_fluid(r, t));
224 
225  _fluid.cp_from_p_T(raw_pressure, raw_T_fluid, dummy, dcp_dp, dcp_dT);
226  return dcp_dp;
227  });
228 
229  const auto & dcp_dT = addFunctorProperty<Real>(
230  derivativePropertyNameFirst(_specific_heat_name, NS::T_fluid),
231  [this](const auto & r, const auto & t) -> Real
232  {
233  Real dcp_dp, dcp_dT, dummy;
234  auto raw_pressure = MetaPhysicL::raw_value(_pressure(r, t));
235  auto raw_T_fluid = MetaPhysicL::raw_value(_T_fluid(r, t));
236 
237  _fluid.cp_from_p_T(raw_pressure, raw_T_fluid, dummy, dcp_dp, dcp_dT);
238  return dcp_dT;
239  });
240 
241  const auto & dmu_dp = addFunctorProperty<Real>(
242  derivativePropertyNameFirst(_dynamic_viscosity_name, NS::pressure),
243  [this](const auto & r, const auto & t) -> Real
244  {
245  Real dmu_dp, dmu_dT, dummy;
246  auto raw_pressure = MetaPhysicL::raw_value(_pressure(r, t));
247  auto raw_T_fluid = MetaPhysicL::raw_value(_T_fluid(r, t));
248 
249  _fluid.mu_from_p_T(raw_pressure, raw_T_fluid, dummy, dmu_dp, dmu_dT);
250  return _mu_rampdown(r, t) * dmu_dp;
251  });
252 
253  const auto & dmu_dT = addFunctorProperty<Real>(
254  derivativePropertyNameFirst(_dynamic_viscosity_name, NS::T_fluid),
255  [this](const auto & r, const auto & t) -> Real
256  {
257  Real dmu_dp, dmu_dT, dummy;
258  auto raw_pressure = MetaPhysicL::raw_value(_pressure(r, t));
259  auto raw_T_fluid = MetaPhysicL::raw_value(_T_fluid(r, t));
260 
261  _fluid.mu_from_p_T(raw_pressure, raw_T_fluid, dummy, dmu_dp, dmu_dT);
262  return _mu_rampdown(r, t) * dmu_dT;
263  });
264 
265  const auto & dk_dp = addFunctorProperty<Real>(
266  derivativePropertyNameFirst(_thermal_conductivity_name, NS::pressure),
267  [this](const auto & r, const auto & t) -> Real
268  {
269  Real dk_dp, dk_dT, dummy;
270  auto raw_pressure = MetaPhysicL::raw_value(_pressure(r, t));
271  auto raw_T_fluid = MetaPhysicL::raw_value(_T_fluid(r, t));
272 
273  _fluid.k_from_p_T(raw_pressure, raw_T_fluid, dummy, dk_dp, dk_dT);
274  return dk_dp;
275  });
276 
277  const auto & dk_dT = addFunctorProperty<Real>(
278  derivativePropertyNameFirst(_thermal_conductivity_name, NS::T_fluid),
279  [this](const auto & r, const auto & t) -> Real
280  {
281  Real dk_dp, dk_dT, dummy;
282  auto raw_pressure = MetaPhysicL::raw_value(_pressure(r, t));
283  auto raw_T_fluid = MetaPhysicL::raw_value(_T_fluid(r, t));
284 
285  _fluid.k_from_p_T(raw_pressure, raw_T_fluid, dummy, dk_dp, dk_dT);
286  return dk_dT;
287  });
288 
289  //
290  // Fluid adimensional quantities, used in numerous correlations
291  //
292 
293  addFunctorProperty<GenericReal<is_ad>>(
294  NS::Prandtl,
295  [&cp, &mu, &k](const auto & r, const auto & t) -> GenericReal<is_ad>
296  {
297  static constexpr Real small_number = 1e-8;
298 
299  return HeatTransferUtils::prandtl(cp(r, t), mu(r, t), std::max(k(r, t), small_number));
300  });
301 
302  addFunctorProperty<Real>(
303  derivativePropertyNameFirst(NS::Prandtl, NS::pressure),
304  [&mu, &cp, &k, &dmu_dp, &dcp_dp, &dk_dp](const auto & r, const auto & t) -> Real
305  {
306  return NS::prandtlPropertyDerivative(MetaPhysicL::raw_value(mu(r, t)),
307  MetaPhysicL::raw_value(cp(r, t)),
308  MetaPhysicL::raw_value(k(r, t)),
309  dmu_dp(r, t),
310  dcp_dp(r, t),
311  dk_dp(r, t));
312  });
313 
314  addFunctorProperty<Real>(
315  derivativePropertyNameFirst(NS::Prandtl, NS::T_fluid),
316  [&mu, &cp, &k, &dmu_dT, &dcp_dT, &dk_dT](const auto & r, const auto & t) -> Real
317  {
318  return NS::prandtlPropertyDerivative(MetaPhysicL::raw_value(mu(r, t)),
319  MetaPhysicL::raw_value(cp(r, t)),
320  MetaPhysicL::raw_value(k(r, t)),
321  dmu_dT(r, t),
322  dcp_dT(r, t),
323  dk_dT(r, t));
324  });
325 
326  //
327  // (pore / particle) Reynolds number based on superficial velocity and
328  // characteristic length. Only call Reynolds() one time to compute all three so that
329  // we don't redundantly check that viscosity is not too close to zero.
330  //
331 
332  const auto & Re = addFunctorProperty<GenericReal<is_ad>>(
333  NS::Reynolds,
334  [this, &mu](const auto & r, const auto & t) -> GenericReal<is_ad>
335  {
336  static constexpr Real small_number = 1e-8;
337  return std::max(HeatTransferUtils::reynolds(_rho(r, t),
338  _eps(r, t) * _speed(r, t),
339  _d(r, t),
340  std::max(mu(r, t), small_number)),
341  small_number);
342  });
343 
344  addFunctorProperty<Real>(
345  derivativePropertyNameFirst(NS::Reynolds, NS::pressure),
346  [this, &Re, &mu, &drho_dp, &dmu_dp](const auto & r, const auto & t) -> Real
347  {
348  return NS::reynoldsPropertyDerivative(MetaPhysicL::raw_value(Re(r, t)),
349  MetaPhysicL::raw_value(_rho(r, t)),
350  MetaPhysicL::raw_value(mu(r, t)),
351  drho_dp(r, t),
352  dmu_dp(r, t));
353  });
354 
355  addFunctorProperty<Real>(
356  derivativePropertyNameFirst(NS::Reynolds, NS::T_fluid),
357  [this, &Re, &mu, &drho_dT, &dmu_dT](const auto & r, const auto & t) -> Real
358  {
359  return NS::reynoldsPropertyDerivative(MetaPhysicL::raw_value(Re(r, t)),
360  MetaPhysicL::raw_value(_rho(r, t)),
361  MetaPhysicL::raw_value(mu(r, t)),
362  drho_dT(r, t),
363  dmu_dT(r, t));
364  });
365 
366  // (hydraulic) Reynolds number
367  addFunctorProperty<GenericReal<is_ad>>(
368  NS::Reynolds_hydraulic,
369  [this, &Re](const auto & r, const auto & t) -> GenericReal<is_ad>
370  {
371  static constexpr Real small_number = 1e-8;
372  return Re(r, t) / std::max(1 - _eps(r, t), small_number);
373  });
374 
375  // (interstitial) Reynolds number
376  addFunctorProperty<GenericReal<is_ad>>(
377  NS::Reynolds_interstitial,
378  [this, &Re](const auto & r, const auto & t) -> GenericReal<is_ad>
379  { return Re(r, t) / _eps(r, t); });
380  }
381  else
382  {
383 
384  const auto & rho =
385  (!isParamValid(NS::density) || _force_define_density)
386  ? addFunctorProperty<GenericReal<is_ad>>(
387  _density_name,
388  [this](const auto & r, const auto & t) -> GenericReal<is_ad>
389  {
390  auto total_pressure = _pressure(r, t) + _reference_pressure_value;
391  // TODO: we should be integrating this term
392  const auto rho_approx = _fluid.rho_from_p_T(total_pressure, _T_fluid(r, t));
393  total_pressure +=
394  rho_approx * _gravity_vec * (r.getPoint() - _reference_pressure_point);
395  return _fluid.rho_from_p_T(total_pressure, _T_fluid(r, t));
396  })
397  : getFunctor<GenericReal<is_ad>>(_density_name);
398 
399  addFunctorProperty<GenericReal<is_ad>>(
400  NS::cv,
401  [this, &rho](const auto & r, const auto & t) -> GenericReal<is_ad>
402  {
403  const auto total_pressure =
404  _pressure(r, t) + _reference_pressure_value +
405  rho(r, t) * _gravity_vec * (r.getPoint() - _reference_pressure_point);
406  return _fluid.cv_from_p_T(total_pressure, _T_fluid(r, t));
407  });
408 
409  const auto & cp = addFunctorProperty<GenericReal<is_ad>>(
410  _specific_heat_name,
411  [this, &rho](const auto & r, const auto & t) -> GenericReal<is_ad>
412  {
413  const auto total_pressure =
414  _pressure(r, t) + _reference_pressure_value +
415  rho(r, t) * _gravity_vec * (r.getPoint() - _reference_pressure_point);
416  return _fluid.cp_from_p_T(total_pressure, _T_fluid(r, t));
417  });
418 
419  const auto & mu = addFunctorProperty<GenericReal<is_ad>>(
420  _dynamic_viscosity_name,
421  [this, &rho](const auto & r, const auto & t) -> GenericReal<is_ad>
422  {
423  const auto total_pressure =
424  _pressure(r, t) + _reference_pressure_value +
425  rho(r, t) * _gravity_vec * (r.getPoint() - _reference_pressure_point);
426  return _mu_rampdown(r, t) * _fluid.mu_from_p_T(total_pressure, _T_fluid(r, t));
427  });
428 
429  const auto & k = addFunctorProperty<GenericReal<is_ad>>(
430  _thermal_conductivity_name,
431  [this, &rho](const auto & r, const auto & t) -> GenericReal<is_ad>
432  {
433  const auto total_pressure =
434  _pressure(r, t) + _reference_pressure_value +
435  rho(r, t) * _gravity_vec * (r.getPoint() - _reference_pressure_point);
436  return _fluid.k_from_p_T(total_pressure, _T_fluid(r, t));
437  });
438 
439  //
440  // Time derivatives of fluid properties
441  //
442  if (_neglect_derivatives_of_density_time_derivative)
443  {
444  addFunctorProperty<GenericReal<is_ad>>(
445  NS::time_deriv(_density_name),
446  [this, &rho](const auto & r, const auto & t) -> GenericReal<is_ad>
447  {
448  const auto total_pressure =
449  _pressure(r, t) + _reference_pressure_value +
450  rho(r, t) * _gravity_vec * (r.getPoint() - _reference_pressure_point);
451  Real rho, drho_dp, drho_dT;
452  _fluid.rho_from_p_T(MetaPhysicL::raw_value(total_pressure),
453  MetaPhysicL::raw_value(_T_fluid(r, t)),
454  rho,
455  drho_dp,
456  drho_dT);
457  return drho_dp * _pressure.dot(r, t) + drho_dT * _T_fluid.dot(r, t);
458  });
459  }
460  else
461  {
462  addFunctorProperty<GenericReal<is_ad>>(
463  NS::time_deriv(_density_name),
464  [this, &rho](const auto & r, const auto & t) -> GenericReal<is_ad>
465  {
466  const auto total_pressure =
467  _pressure(r, t) + _reference_pressure_value +
468  rho(r, t) * _gravity_vec * (r.getPoint() - _reference_pressure_point);
469  GenericReal<is_ad> rho, drho_dp, drho_dT;
470  _fluid.rho_from_p_T(total_pressure, _T_fluid(r, t), rho, drho_dp, drho_dT);
471  return drho_dp * _pressure.dot(r, t) + drho_dT * _T_fluid.dot(r, t);
472  });
473  }
474 
475  addFunctorProperty<GenericReal<is_ad>>(
476  NS::time_deriv(_specific_heat_name),
477  [this, &rho](const auto & r, const auto & t) -> GenericReal<is_ad>
478  {
479  const auto total_pressure =
480  _pressure(r, t) + _reference_pressure_value +
481  rho(r, t) * _gravity_vec * (r.getPoint() - _reference_pressure_point);
482  Real dcp_dp, dcp_dT, dummy;
483  auto raw_pressure = MetaPhysicL::raw_value(total_pressure);
484  auto raw_T_fluid = MetaPhysicL::raw_value(_T_fluid(r, t));
485  _fluid.cp_from_p_T(raw_pressure, raw_T_fluid, dummy, dcp_dp, dcp_dT);
486 
487  return dcp_dp * _pressure.dot(r, t) + dcp_dT * _T_fluid.dot(r, t);
488  });
489 
490  //
491  // Temperature and pressure derivatives, to help with computing time derivatives
492  //
493 
494  const auto & drho_dp = addFunctorProperty<Real>(
495  derivativePropertyNameFirst(_density_name, NS::pressure),
496  [this, &rho](const auto & r, const auto & t) -> Real
497  {
498  const auto total_pressure =
499  _pressure(r, t) + _reference_pressure_value +
500  rho(r, t) * _gravity_vec * (r.getPoint() - _reference_pressure_point);
501  Real drho_dp, drho_dT, dummy;
502  auto raw_pressure = MetaPhysicL::raw_value(total_pressure);
503  auto raw_T_fluid = MetaPhysicL::raw_value(_T_fluid(r, t));
504 
505  _fluid.rho_from_p_T(raw_pressure, raw_T_fluid, dummy, drho_dp, drho_dT);
506  return drho_dp;
507  });
508 
509  const auto & drho_dT = addFunctorProperty<Real>(
510  derivativePropertyNameFirst(_density_name, NS::T_fluid),
511  [this, &rho](const auto & r, const auto & t) -> Real
512  {
513  const auto total_pressure =
514  _pressure(r, t) + _reference_pressure_value +
515  rho(r, t) * _gravity_vec * (r.getPoint() - _reference_pressure_point);
516  Real drho_dp, drho_dT, dummy;
517  auto raw_pressure = MetaPhysicL::raw_value(total_pressure);
518  auto raw_T_fluid = MetaPhysicL::raw_value(_T_fluid(r, t));
519 
520  _fluid.rho_from_p_T(raw_pressure, raw_T_fluid, dummy, drho_dp, drho_dT);
521  return drho_dT;
522  });
523 
524  const auto & dcp_dp = addFunctorProperty<Real>(
525  derivativePropertyNameFirst(_specific_heat_name, NS::pressure),
526  [this, &rho](const auto & r, const auto & t) -> Real
527  {
528  const auto total_pressure =
529  _pressure(r, t) + _reference_pressure_value +
530  rho(r, t) * _gravity_vec * (r.getPoint() - _reference_pressure_point);
531  Real dcp_dp, dcp_dT, dummy;
532  auto raw_pressure = MetaPhysicL::raw_value(total_pressure);
533  auto raw_T_fluid = MetaPhysicL::raw_value(_T_fluid(r, t));
534 
535  _fluid.cp_from_p_T(raw_pressure, raw_T_fluid, dummy, dcp_dp, dcp_dT);
536  return dcp_dp;
537  });
538 
539  const auto & dcp_dT = addFunctorProperty<Real>(
540  derivativePropertyNameFirst(_specific_heat_name, NS::T_fluid),
541  [this, &rho](const auto & r, const auto & t) -> Real
542  {
543  const auto total_pressure =
544  _pressure(r, t) + _reference_pressure_value +
545  rho(r, t) * _gravity_vec * (r.getPoint() - _reference_pressure_point);
546  Real dcp_dp, dcp_dT, dummy;
547  auto raw_pressure = MetaPhysicL::raw_value(total_pressure);
548  auto raw_T_fluid = MetaPhysicL::raw_value(_T_fluid(r, t));
549 
550  _fluid.cp_from_p_T(raw_pressure, raw_T_fluid, dummy, dcp_dp, dcp_dT);
551  return dcp_dT;
552  });
553 
554  const auto & dmu_dp = addFunctorProperty<Real>(
555  derivativePropertyNameFirst(_dynamic_viscosity_name, NS::pressure),
556  [this, &rho](const auto & r, const auto & t) -> Real
557  {
558  const auto total_pressure =
559  _pressure(r, t) + _reference_pressure_value +
560  rho(r, t) * _gravity_vec * (r.getPoint() - _reference_pressure_point);
561  Real dmu_dp, dmu_dT, dummy;
562  auto raw_pressure = MetaPhysicL::raw_value(total_pressure);
563  auto raw_T_fluid = MetaPhysicL::raw_value(_T_fluid(r, t));
564 
565  _fluid.mu_from_p_T(raw_pressure, raw_T_fluid, dummy, dmu_dp, dmu_dT);
566  return _mu_rampdown(r, t) * dmu_dp;
567  });
568 
569  const auto & dmu_dT = addFunctorProperty<Real>(
570  derivativePropertyNameFirst(_dynamic_viscosity_name, NS::T_fluid),
571  [this, &rho](const auto & r, const auto & t) -> Real
572  {
573  const auto total_pressure =
574  _pressure(r, t) + _reference_pressure_value +
575  rho(r, t) * _gravity_vec * (r.getPoint() - _reference_pressure_point);
576  Real dmu_dp, dmu_dT, dummy;
577  auto raw_pressure = MetaPhysicL::raw_value(total_pressure);
578  auto raw_T_fluid = MetaPhysicL::raw_value(_T_fluid(r, t));
579 
580  _fluid.mu_from_p_T(raw_pressure, raw_T_fluid, dummy, dmu_dp, dmu_dT);
581  return _mu_rampdown(r, t) * dmu_dT;
582  });
583 
584  const auto & dk_dp = addFunctorProperty<Real>(
585  derivativePropertyNameFirst(_thermal_conductivity_name, NS::pressure),
586  [this, &rho](const auto & r, const auto & t) -> Real
587  {
588  const auto total_pressure =
589  _pressure(r, t) + _reference_pressure_value +
590  rho(r, t) * _gravity_vec * (r.getPoint() - _reference_pressure_point);
591  Real dk_dp, dk_dT, dummy;
592  auto raw_pressure = MetaPhysicL::raw_value(total_pressure);
593  auto raw_T_fluid = MetaPhysicL::raw_value(_T_fluid(r, t));
594 
595  _fluid.k_from_p_T(raw_pressure, raw_T_fluid, dummy, dk_dp, dk_dT);
596  return dk_dp;
597  });
598 
599  const auto & dk_dT = addFunctorProperty<Real>(
600  derivativePropertyNameFirst(_thermal_conductivity_name, NS::T_fluid),
601  [this, &rho](const auto & r, const auto & t) -> Real
602  {
603  const auto total_pressure =
604  _pressure(r, t) + _reference_pressure_value +
605  rho(r, t) * _gravity_vec * (r.getPoint() - _reference_pressure_point);
606  Real dk_dp, dk_dT, dummy;
607  auto raw_pressure = MetaPhysicL::raw_value(total_pressure);
608  auto raw_T_fluid = MetaPhysicL::raw_value(_T_fluid(r, t));
609 
610  _fluid.k_from_p_T(raw_pressure, raw_T_fluid, dummy, dk_dp, dk_dT);
611  return dk_dT;
612  });
613 
614  //
615  // Fluid adimensional quantities, used in numerous correlations
616  //
617 
618  addFunctorProperty<GenericReal<is_ad>>(
619  NS::Prandtl,
620  [&cp, &mu, &k](const auto & r, const auto & t) -> GenericReal<is_ad>
621  {
622  static constexpr Real small_number = 1e-8;
623 
624  return HeatTransferUtils::prandtl(cp(r, t), mu(r, t), std::max(k(r, t), small_number));
625  });
626 
627  addFunctorProperty<Real>(
628  derivativePropertyNameFirst(NS::Prandtl, NS::pressure),
629  [&mu, &cp, &k, &dmu_dp, &dcp_dp, &dk_dp](const auto & r, const auto & t) -> Real
630  {
631  return NS::prandtlPropertyDerivative(MetaPhysicL::raw_value(mu(r, t)),
632  MetaPhysicL::raw_value(cp(r, t)),
633  MetaPhysicL::raw_value(k(r, t)),
634  dmu_dp(r, t),
635  dcp_dp(r, t),
636  dk_dp(r, t));
637  });
638 
639  addFunctorProperty<Real>(
640  derivativePropertyNameFirst(NS::Prandtl, NS::T_fluid),
641  [&mu, &cp, &k, &dmu_dT, &dcp_dT, &dk_dT](const auto & r, const auto & t) -> Real
642  {
643  return NS::prandtlPropertyDerivative(MetaPhysicL::raw_value(mu(r, t)),
644  MetaPhysicL::raw_value(cp(r, t)),
645  MetaPhysicL::raw_value(k(r, t)),
646  dmu_dT(r, t),
647  dcp_dT(r, t),
648  dk_dT(r, t));
649  });
650 
651  //
652  // (pore / particle) Reynolds number based on superficial velocity and
653  // characteristic length. Only call Reynolds() one time to compute all three so that
654  // we don't redundantly check that viscosity is not too close to zero.
655  //
656 
657  const auto & Re = addFunctorProperty<GenericReal<is_ad>>(
658  NS::Reynolds,
659  [this, &mu](const auto & r, const auto & t) -> GenericReal<is_ad>
660  {
661  static constexpr Real small_number = 1e-8;
662  return std::max(HeatTransferUtils::reynolds(_rho(r, t),
663  _eps(r, t) * _speed(r, t),
664  _d(r, t),
665  std::max(mu(r, t), small_number)),
666  small_number);
667  });
668 
669  addFunctorProperty<Real>(
670  derivativePropertyNameFirst(NS::Reynolds, NS::pressure),
671  [this, &Re, &mu, &drho_dp, &dmu_dp](const auto & r, const auto & t) -> Real
672  {
673  return NS::reynoldsPropertyDerivative(MetaPhysicL::raw_value(Re(r, t)),
674  MetaPhysicL::raw_value(_rho(r, t)),
675  MetaPhysicL::raw_value(mu(r, t)),
676  drho_dp(r, t),
677  dmu_dp(r, t));
678  });
679 
680  addFunctorProperty<Real>(
681  derivativePropertyNameFirst(NS::Reynolds, NS::T_fluid),
682  [this, &Re, &mu, &drho_dT, &dmu_dT](const auto & r, const auto & t) -> Real
683  {
684  return NS::reynoldsPropertyDerivative(MetaPhysicL::raw_value(Re(r, t)),
685  MetaPhysicL::raw_value(_rho(r, t)),
686  MetaPhysicL::raw_value(mu(r, t)),
687  drho_dT(r, t),
688  dmu_dT(r, t));
689  });
690 
691  // (hydraulic) Reynolds number
692  addFunctorProperty<GenericReal<is_ad>>(
693  NS::Reynolds_hydraulic,
694  [this, &Re](const auto & r, const auto & t) -> GenericReal<is_ad>
695  {
696  static constexpr Real small_number = 1e-8;
697  return Re(r, t) / std::max(1 - _eps(r, t), small_number);
698  });
699 
700  // (interstitial) Reynolds number
701  addFunctorProperty<GenericReal<is_ad>>(
702  NS::Reynolds_interstitial,
703  [this, &Re](const auto & r, const auto & t) -> GenericReal<is_ad>
704  { return Re(r, t) / _eps(r, t); });
705  }
706 }
GenericReal
Moose::GenericType< Real, is_ad > GenericReal
NS::cv
static const std::string cv
Definition: NS.h:122
GeneralFunctorFluidPropsTempl::_reference_pressure_value
const Real _reference_pressure_value
The value of pressure at that point.
Definition: GeneralFunctorFluidProps.h:47
GeneralFunctorFluidPropsTempl::_rho
const Moose::Functor< GenericReal< is_ad > > & _rho
Density as a functor, which could be from the variable set or the property.
Definition: GeneralFunctorFluidProps.h:60
NS::speed
static const std::string speed
Definition: NS.h:143
FunctorMaterial::getFunction
const Function & getFunction(const std::string &name) const
NS::Reynolds
static const std::string Reynolds
Definition: NS.h:139
NS::prandtlPropertyDerivative
Real prandtlPropertyDerivative(const Real &mu, const Real &cp, const Real &k, const Real &dmu, const Real &dcp, const Real &dk)
Computes the derivative of the Prandtl number, $Pr{ C_p}{k}$, with respect to an arbitrary variale $$...
Definition: NavierStokesMethods.C:53
GeneralFunctorFluidPropsTempl::_neglect_derivatives_of_density_time_derivative
const bool _neglect_derivatives_of_density_time_derivative
Whether to neglect the contributions to the Jacobian of the density time derivative.
Definition: GeneralFunctorFluidProps.h:66
GeneralFunctorFluidPropsTempl::_d
const Moose::Functor< Real > & _d
Characteristic length $d$ used in computing the Reynolds number $Re=/$.
Definition: GeneralFunctorFluidProps.h:40
MaterialBase::FunctorMaterial
friend friend class FunctorMaterial
NS::density
static const std::string density
Definition: NS.h:33
MetaPhysicL::raw_value
auto raw_value(const Eigen::Map< T > &in)
NS::fluid
static const std::string fluid
Definition: NS.h:87
DerivativeMaterialPropertyNameInterface::derivativePropertyNameFirst
const MaterialPropertyName derivativePropertyNameFirst(const MaterialPropertyName &base, const SymbolName &c1) const
GeneralFunctorFluidPropsTempl::_pressure
const Moose::Functor< GenericReal< is_ad > > & _pressure
variables
Definition: GeneralFunctorFluidProps.h:52
NS::total_pressure
static const std::string total_pressure
Definition: NS.h:58
GeneralFunctorFluidPropsTempl::_force_define_density
const bool _force_define_density
A parameter to force definition of a functor material property for density.
Definition: GeneralFunctorFluidProps.h:57
GeneralFunctorFluidPropsTempl::_fluid
const SinglePhaseFluidProperties & _fluid
Definition: GeneralFunctorFluidProps.h:31
FunctorMaterial::isParamValid
bool isParamValid(const std::string &name) const
NS::porosity
static const std::string porosity
Definition: NS.h:104
NS::Prandtl
static const std::string Prandtl
Definition: NS.h:137
NS::cp
static const std::string cp
Definition: NS.h:121
GeneralFunctorFluidPropsTempl::_specific_heat_name
const MooseFunctorName & _specific_heat_name
Name to use for the specific heat functor.
Definition: GeneralFunctorFluidProps.h:73
NS::T_fluid
static const std::string T_fluid
Definition: NS.h:106
GeneralFunctorFluidPropsTempl::_reference_pressure_point
const Point _reference_pressure_point
Where the static pressure rho*g*(z-z0) term is 0.
Definition: GeneralFunctorFluidProps.h:45
GeneralFunctorFluidPropsTempl::_pressure_is_dynamic
const bool _pressure_is_dynamic
Whether the input pressure is the dynamic pressure.
Definition: GeneralFunctorFluidProps.h:43
NS::mu
static const std::string mu
Definition: NS.h:123
NS::Reynolds_hydraulic
static const std::string Reynolds_hydraulic
Definition: NS.h:140
NS::reynoldsPropertyDerivative
Real reynoldsPropertyDerivative(const Real &Re, const Real &rho, const Real &mu, const Real &drho, const Real &dmu)
Computes the derivative of the Reynolds number, $Re { Vd}{}$, with respect to an arbitrary variable $...
Definition: NavierStokesMethods.C:46
FunctorMaterial::paramError
void paramError(const std::string &param, Args... args) const
HeatTransferUtils::reynolds
auto reynolds(const T1 &rho, const T2 &vel, const T3 &L, const T4 &mu)
Compute Reynolds number.
Definition: HeatTransferUtils.h:28
GeneralFunctorFluidPropsTempl::_thermal_conductivity_name
const MooseFunctorName & _thermal_conductivity_name
Name to use for the thermal conductivity functor.
Definition: GeneralFunctorFluidProps.h:75
HeatTransferUtils::prandtl
auto prandtl(const T1 &cp, const T2 &mu, const T3 &k)
Compute Prandtl number.
Definition: HeatTransferUtils.h:43
GeneralFunctorFluidPropsTempl::_mu_rampdown
const Function & _mu_rampdown
Function to ramp down the viscosity, useful for relaxation transient.
Definition: GeneralFunctorFluidProps.h:63
GeneralFunctorFluidPropsTempl::_speed
const Moose::Functor< GenericReal< is_ad > > & _speed
Definition: GeneralFunctorFluidProps.h:54
FunctorMaterial::isParamSetByUser
bool isParamSetByUser(const std::string &nm) const
Real
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
FunctorMaterial::getFunctor
const Moose::Functor< T > & getFunctor(const std::string &name)
GeneralFunctorFluidPropsTempl::_density_name
const MooseFunctorName & _density_name
Name to use for density functor.
Definition: GeneralFunctorFluidProps.h:69
FunctorMaterial::addFunctorProperty
const Moose::FunctorBase< T > & addFunctorProperty(const std::string &name, PolymorphicLambda my_lammy, const std::set< ExecFlagType > &clearance_schedule={EXEC_ALWAYS})
NS::pressure
static const std::string pressure
Definition: NS.h:56
GeneralFunctorFluidPropsTempl::_T_fluid
const Moose::Functor< GenericReal< is_ad > > & _T_fluid
Definition: GeneralFunctorFluidProps.h:53
FunctorMaterial::parameters
const InputParameters & parameters() const
GeneralFunctorFluidPropsTempl::_dynamic_viscosity_name
const MooseFunctorName & _dynamic_viscosity_name
Name to use for the dynamic viscosity functor.
Definition: GeneralFunctorFluidProps.h:71
NS::k
static const std::string k
Definition: NS.h:130
NS::Reynolds_interstitial
static const std::string Reynolds_interstitial
Definition: NS.h:141
GeneralFunctorFluidPropsTempl::_gravity_vec
const Point _gravity_vec
The gravity vector.
Definition: GeneralFunctorFluidProps.h:49
NS::time_deriv
std::string time_deriv(const std::string &var)
Definition: NS.h:97
GeneralFunctorFluidPropsTempl::_eps
const Moose::Functor< GenericReal< is_ad > > & _eps
Porosity.
Definition: GeneralFunctorFluidProps.h:34

Member Function Documentation

◆ derivativePropertyNameFirst()

template<bool is_ad>
const MaterialPropertyName DerivativeMaterialPropertyNameInterface::derivativePropertyNameFirst
protected

◆ getUserObject()

template<bool is_ad>
const T & UserObjectInterface::getUserObject
protected

◆ validParams()

template<bool is_ad>
InputParameters GeneralFunctorFluidPropsTempl< is_ad >::validParams ( )
static

Definition at line 21 of file GeneralFunctorFluidProps.C.

22 {
23  auto params = FunctorMaterial::validParams();
24  params.addRequiredParam<UserObjectName>(NS::fluid, "Fluid properties functor userobject");
25  params.addClassDescription("Creates functor fluid properties using a (P, T) formulation");
26 
27  params.addRequiredParam<MooseFunctorName>(NS::pressure, "Pressure");
28  params.addRequiredParam<MooseFunctorName>(NS::T_fluid, "Fluid temperature");
29  params.addRequiredParam<MooseFunctorName>(NS::speed, "Velocity norm");
30  params.addParam<MooseFunctorName>(NS::density, "Density");
31  params.addParam<bool>(
32  "force_define_density",
33  false,
34  "Whether to force the definition of a density functor from the fluid properties");
35  params.addParam<bool>("neglect_derivatives_of_density_time_derivative",
36  true,
37  "Whether to neglect the derivatives with regards to nonlinear variables "
38  "of the density time derivatives");
39 
40  params.addParam<FunctionName>(
41  "mu_rampdown", 1, "A function describing a ramp down of viscosity over time");
42  params.addRequiredParam<MooseFunctorName>(NS::porosity, "porosity");
43  params.addRequiredParam<MooseFunctorName>(
44  "characteristic_length", "characteristic length for Reynolds number calculation");
45 
46  // Dynamic pressure
47  params.addParam<bool>("solving_for_dynamic_pressure",
48  false,
49  "Whether to solve for the dynamic pressure instead of the total pressure");
50  params.addParam<Point>("reference_pressure_point",
51  Point(0, 0, 0),
52  "Point at which the gravity term for the static pressure is zero");
53  params.addParam<Real>("reference_pressure", 1e5, "Total pressure at the reference point");
54  params.addParam<Point>("gravity", Point(0, 0, -9.81), "Gravity vector");
55 
56  params.addParamNamesToGroup(
57  "solving_for_dynamic_pressure reference_pressure_point reference_pressure",
58  "Dynamic pressure");
59 
60  // Property names
61  params.addParam<MooseFunctorName>(
62  "density_name", NS::density, "Name to give to the density functor");
63  params.addParam<MooseFunctorName>(
64  "dynamic_viscosity_name", NS::mu, "Name to give to the dynamic viscosity functor");
65  params.addParam<MooseFunctorName>(
66  "specific_heat_name", NS::cp, "Name to give to the specific heat (cp) functor");
67  params.addParam<MooseFunctorName>(
68  "thermal_conductivity_name", NS::k, "Name to give to the thermal conductivity functor");
69  params.addParamNamesToGroup(
70  "density_name dynamic_viscosity_name specific_heat_name thermal_conductivity_name",
71  "Functor property names");
72  return params;
73 }
NS::speed
static const std::string speed
Definition: NS.h:143
FunctorMaterial::validParams
static InputParameters validParams()
NS::density
static const std::string density
Definition: NS.h:33
NS::fluid
static const std::string fluid
Definition: NS.h:87
NS::porosity
static const std::string porosity
Definition: NS.h:104
NS::cp
static const std::string cp
Definition: NS.h:121
NS::T_fluid
static const std::string T_fluid
Definition: NS.h:106
NS::mu
static const std::string mu
Definition: NS.h:123
Real
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
NS::pressure
static const std::string pressure
Definition: NS.h:56
NS::k
static const std::string k
Definition: NS.h:130

Member Data Documentation

◆ _d

template<bool is_ad>
const Moose::Functor<Real>& GeneralFunctorFluidPropsTempl< is_ad >::_d
protected

Characteristic length $d$ used in computing the Reynolds number $Re=/$.

Definition at line 40 of file GeneralFunctorFluidProps.h.

Referenced by GeneralFunctorFluidPropsTempl< is_ad >::GeneralFunctorFluidPropsTempl().

◆ _density_name

template<bool is_ad>
const MooseFunctorName& GeneralFunctorFluidPropsTempl< is_ad >::_density_name
protected

Name to use for density functor.

Definition at line 69 of file GeneralFunctorFluidProps.h.

Referenced by GeneralFunctorFluidPropsTempl< is_ad >::GeneralFunctorFluidPropsTempl().

◆ _dynamic_viscosity_name

template<bool is_ad>
const MooseFunctorName& GeneralFunctorFluidPropsTempl< is_ad >::_dynamic_viscosity_name
protected

Name to use for the dynamic viscosity functor.

Definition at line 71 of file GeneralFunctorFluidProps.h.

Referenced by GeneralFunctorFluidPropsTempl< is_ad >::GeneralFunctorFluidPropsTempl().

◆ _eps

template<bool is_ad>
const Moose::Functor<GenericReal<is_ad> >& GeneralFunctorFluidPropsTempl< is_ad >::_eps
protected

Porosity.

Definition at line 34 of file GeneralFunctorFluidProps.h.

Referenced by GeneralFunctorFluidPropsTempl< is_ad >::GeneralFunctorFluidPropsTempl().

◆ _fluid

template<bool is_ad>
const SinglePhaseFluidProperties& GeneralFunctorFluidPropsTempl< is_ad >::_fluid
protected

Definition at line 31 of file GeneralFunctorFluidProps.h.

Referenced by GeneralFunctorFluidPropsTempl< is_ad >::GeneralFunctorFluidPropsTempl().

◆ _force_define_density

template<bool is_ad>
const bool GeneralFunctorFluidPropsTempl< is_ad >::_force_define_density
protected

A parameter to force definition of a functor material property for density.

Definition at line 57 of file GeneralFunctorFluidProps.h.

Referenced by GeneralFunctorFluidPropsTempl< is_ad >::GeneralFunctorFluidPropsTempl().

◆ _gravity_vec

template<bool is_ad>
const Point GeneralFunctorFluidPropsTempl< is_ad >::_gravity_vec
protected

The gravity vector.

Definition at line 49 of file GeneralFunctorFluidProps.h.

Referenced by GeneralFunctorFluidPropsTempl< is_ad >::GeneralFunctorFluidPropsTempl().

◆ _mu_rampdown

template<bool is_ad>
const Function& GeneralFunctorFluidPropsTempl< is_ad >::_mu_rampdown
protected

Function to ramp down the viscosity, useful for relaxation transient.

Definition at line 63 of file GeneralFunctorFluidProps.h.

Referenced by GeneralFunctorFluidPropsTempl< is_ad >::GeneralFunctorFluidPropsTempl().

◆ _neglect_derivatives_of_density_time_derivative

template<bool is_ad>
const bool GeneralFunctorFluidPropsTempl< is_ad >::_neglect_derivatives_of_density_time_derivative
protected

Whether to neglect the contributions to the Jacobian of the density time derivative.

Definition at line 66 of file GeneralFunctorFluidProps.h.

Referenced by GeneralFunctorFluidPropsTempl< is_ad >::GeneralFunctorFluidPropsTempl().

◆ _pressure

template<bool is_ad>
const Moose::Functor<GenericReal<is_ad> >& GeneralFunctorFluidPropsTempl< is_ad >::_pressure
protected

variables

Definition at line 52 of file GeneralFunctorFluidProps.h.

Referenced by GeneralFunctorFluidPropsTempl< is_ad >::GeneralFunctorFluidPropsTempl().

◆ _pressure_is_dynamic

template<bool is_ad>
const bool GeneralFunctorFluidPropsTempl< is_ad >::_pressure_is_dynamic
protected

Whether the input pressure is the dynamic pressure.

Definition at line 43 of file GeneralFunctorFluidProps.h.

Referenced by GeneralFunctorFluidPropsTempl< is_ad >::GeneralFunctorFluidPropsTempl().

◆ _reference_pressure_point

template<bool is_ad>
const Point GeneralFunctorFluidPropsTempl< is_ad >::_reference_pressure_point
protected

Where the static pressure rho*g*(z-z0) term is 0.

Definition at line 45 of file GeneralFunctorFluidProps.h.

Referenced by GeneralFunctorFluidPropsTempl< is_ad >::GeneralFunctorFluidPropsTempl().

◆ _reference_pressure_value

template<bool is_ad>
const Real GeneralFunctorFluidPropsTempl< is_ad >::_reference_pressure_value
protected

The value of pressure at that point.

Definition at line 47 of file GeneralFunctorFluidProps.h.

Referenced by GeneralFunctorFluidPropsTempl< is_ad >::GeneralFunctorFluidPropsTempl().

◆ _rho

template<bool is_ad>
const Moose::Functor<GenericReal<is_ad> >& GeneralFunctorFluidPropsTempl< is_ad >::_rho
protected

Density as a functor, which could be from the variable set or the property.

Definition at line 60 of file GeneralFunctorFluidProps.h.

Referenced by GeneralFunctorFluidPropsTempl< is_ad >::GeneralFunctorFluidPropsTempl().

◆ _specific_heat_name

template<bool is_ad>
const MooseFunctorName& GeneralFunctorFluidPropsTempl< is_ad >::_specific_heat_name
protected

Name to use for the specific heat functor.

Definition at line 73 of file GeneralFunctorFluidProps.h.

Referenced by GeneralFunctorFluidPropsTempl< is_ad >::GeneralFunctorFluidPropsTempl().

◆ _speed

template<bool is_ad>
const Moose::Functor<GenericReal<is_ad> >& GeneralFunctorFluidPropsTempl< is_ad >::_speed
protected

Definition at line 54 of file GeneralFunctorFluidProps.h.

Referenced by GeneralFunctorFluidPropsTempl< is_ad >::GeneralFunctorFluidPropsTempl().

◆ _T_fluid

template<bool is_ad>
const Moose::Functor<GenericReal<is_ad> >& GeneralFunctorFluidPropsTempl< is_ad >::_T_fluid
protected

Definition at line 53 of file GeneralFunctorFluidProps.h.

Referenced by GeneralFunctorFluidPropsTempl< is_ad >::GeneralFunctorFluidPropsTempl().

◆ _thermal_conductivity_name

template<bool is_ad>
const MooseFunctorName& GeneralFunctorFluidPropsTempl< is_ad >::_thermal_conductivity_name
protected

Name to use for the thermal conductivity functor.

Definition at line 75 of file GeneralFunctorFluidProps.h.

Referenced by GeneralFunctorFluidPropsTempl< is_ad >::GeneralFunctorFluidPropsTempl().

The documentation for this class was generated from the following files:
Generated on Thu Jul 17 2025 01:47:52 for https://mooseframework.inl.gov by   doxygen 1.8.14