www.mooseframework.org
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
INSADMaterial Class Reference

#include <INSADMaterial.h>

Inheritance diagram for INSADMaterial:
[legend]

Public Types

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

Public Member Functions

 INSADMaterial (const InputParameters &parameters)
 
virtual void subdomainSetup () override
 
virtual void resolveOptionalProperties () override
 
virtual const dof_id_typegetElementID (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_typegetElementIDNeighbor (const std::string &id_parameter_name, unsigned int comp=0) const override
 
virtual const dof_id_typegetElementIDByName (const std::string &id_parameter_name) const override
 
virtual const dof_id_typegetElementIDNeighborByName (const std::string &id_parameter_name) const override
 
virtual void computeProperties () override
 
MaterialBasegetMaterial (const std::string &name)
 
MaterialBasegetMaterialByName (const std::string &name, bool no_warn=false, bool no_dep=false)
 
MaterialBasegetMaterialByName (const std::string &name, bool no_warn=false)
 
MaterialBasegetMaterialByName (const std::string &name, bool no_warn=false)
 
virtual bool isBoundaryMaterial () const override
 
virtual const std::unordered_set< unsigned int > & getMatPropDependencies () const override
 
bool ghostable () const override final
 
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)
 
void setActiveProperties (const std::unordered_set< unsigned int > &needed_props)
 
bool forceStatefulInit () const
 
virtual bool enabled () const
 
MooseAppgetMooseApp () 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 InputParametersparameters () const
 
MooseObjectName uniqueName () const
 
const T & getParam (const std::string &name) const
 
std::vector< std::pair< T1, T2 > > getParam (const std::string &param1, const std::string &param2) const
 
const T & getRenamedParam (const std::string &old_name, const std::string &new_name) const
 
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 &name, const std::string *param=nullptr) const
 
const std::vector< SubdomainName > & blocks () const
 
unsigned int numBlocks () const
 
virtual const std::set< SubdomainID > & blockIDs () const
 
unsigned int blocksMaxDimension () const
 
bool hasBlocks (const SubdomainName &name) const
 
bool hasBlocks (const std::vector< SubdomainName > &names) const
 
bool hasBlocks (SubdomainID id) const
 
bool hasBlocks (const std::vector< SubdomainID > &ids) const
 
bool hasBlocks (const std::set< SubdomainID > &ids) const
 
bool isBlockSubset (const std::set< SubdomainID > &ids) const
 
bool isBlockSubset (const std::vector< SubdomainID > &ids) const
 
bool hasBlockMaterialProperty (const std::string &prop_name)
 
const std::set< SubdomainID > & meshBlockIDs () const
 
virtual bool blockRestricted () const
 
virtual void checkVariable (const MooseVariableFieldBase &variable) const
 
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 ExecFlagEnumgetExecuteOnEnum () 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)
 
const std::vector< MooseVariableScalar *> & getCoupledMooseScalarVars ()
 
const std::set< TagID > & getScalarVariableCoupleableVectorTags () const
 
const std::set< TagID > & getScalarVariableCoupleableMatrixTags () const
 
const FunctiongetFunction (const std::string &name) const
 
const FunctiongetFunctionByName (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 UserObjectgetUserObjectBase (const std::string &param_name, bool is_dependency=true) const
 
const UserObjectgetUserObjectBaseByName (const UserObjectName &object_name, bool is_dependency=true) const
 
bool isImplicit ()
 
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 VectorPostprocessorValuegetVectorPostprocessorValue (const std::string &param_name, const std::string &vector_name) const
 
const VectorPostprocessorValuegetVectorPostprocessorValue (const std::string &param_name, const std::string &vector_name, bool needs_broadcast) const
 
const VectorPostprocessorValuegetVectorPostprocessorValueByName (const VectorPostprocessorName &name, const std::string &vector_name) const
 
const VectorPostprocessorValuegetVectorPostprocessorValueByName (const VectorPostprocessorName &name, const std::string &vector_name, bool needs_broadcast) const
 
const VectorPostprocessorValuegetVectorPostprocessorValueOld (const std::string &param_name, const std::string &vector_name) const
 
const VectorPostprocessorValuegetVectorPostprocessorValueOld (const std::string &param_name, const std::string &vector_name, bool needs_broadcast) const
 
const VectorPostprocessorValuegetVectorPostprocessorValueOldByName (const VectorPostprocessorName &name, const std::string &vector_name) const
 
const VectorPostprocessorValuegetVectorPostprocessorValueOldByName (const VectorPostprocessorName &name, const std::string &vector_name, bool needs_broadcast) const
 
const ScatterVectorPostprocessorValuegetScatterVectorPostprocessorValue (const std::string &param_name, const std::string &vector_name) const
 
const ScatterVectorPostprocessorValuegetScatterVectorPostprocessorValueByName (const VectorPostprocessorName &name, const std::string &vector_name) const
 
const ScatterVectorPostprocessorValuegetScatterVectorPostprocessorValueOld (const std::string &param_name, const std::string &vector_name) const
 
const ScatterVectorPostprocessorValuegetScatterVectorPostprocessorValueOldByName (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_typegetAllElemIDs (unsigned int elem_id_index) const
 
std::set< dof_id_typegetElemIDsOnBlocks (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 ADVariableValuegetADDefaultValue (const std::string &var_name) const
 
const ADVectorVariableValuegetADDefaultVectorValue (const std::string &var_name) const
 
const ADVariableGradientgetADDefaultGradient () const
 
const ADVectorVariableGradientgetADDefaultVectorGradient () const
 
const ADVariableSecondgetADDefaultSecond () const
 
const GenericMaterialProperty< T, is_ad > & getGenericMaterialProperty (const std::string &name, MaterialData &material_data, const unsigned int state=0)
 
const GenericMaterialProperty< T, is_ad > & getGenericMaterialProperty (const std::string &name, const unsigned int state=0)
 
const GenericMaterialProperty< T, is_ad > & getGenericMaterialProperty (const std::string &name, const unsigned int state=0)
 
const MaterialProperty< T > & getMaterialProperty (const std::string &name, MaterialData &material_data, const unsigned int state=0)
 
const MaterialProperty< T > & getMaterialProperty (const std::string &name, const unsigned int state=0)
 
const MaterialProperty< T > & getMaterialProperty (const std::string &name, const unsigned int state=0)
 
const ADMaterialProperty< T > & getADMaterialProperty (const std::string &name, MaterialData &material_data)
 
const ADMaterialProperty< T > & getADMaterialProperty (const std::string &name)
 
const ADMaterialProperty< T > & getADMaterialProperty (const std::string &name)
 
const MaterialProperty< T > & getMaterialPropertyOld (const std::string &name, MaterialData &material_data)
 
const MaterialProperty< T > & getMaterialPropertyOld (const std::string &name)
 
const MaterialProperty< T > & getMaterialPropertyOld (const std::string &name)
 
const MaterialProperty< T > & getMaterialPropertyOlder (const std::string &name, MaterialData &material_data)
 
const MaterialProperty< T > & getMaterialPropertyOlder (const std::string &name)
 
const MaterialProperty< T > & getMaterialPropertyOlder (const std::string &name)
 
const GenericMaterialProperty< T, is_ad > & getGenericMaterialPropertyByName (const MaterialPropertyName &name, MaterialData &material_data, const unsigned int state)
 
const GenericMaterialProperty< T, is_ad > & getGenericMaterialPropertyByName (const 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)
 
std::pair< const MaterialProperty< T > *, std::set< SubdomainID > > getBlockMaterialProperty (const MaterialPropertyName &name)
 
std::set< SubdomainIDgetMaterialPropertyBlocks (const std::string &name)
 
std::vector< SubdomainName > getMaterialPropertyBlockNames (const std::string &name)
 
std::set< BoundaryIDgetMaterialPropertyBoundaryIDs (const std::string &name)
 
std::vector< BoundaryName > getMaterialPropertyBoundaryNames (const std::string &name)
 
void checkBlockAndBoundaryCompatibility (std::shared_ptr< MaterialBase > discrete)
 
std::unordered_map< SubdomainID, std::vector< MaterialBase *> > buildRequiredMaterials (bool allow_stateful=true)
 
void statefulPropertiesAllowed (bool)
 
bool getMaterialPropertyCalled () const
 
const 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 DistributiongetDistribution (const std::string &name) const
 
const T & getDistribution (const std::string &name) const
 
const DistributiongetDistribution (const std::string &name) const
 
const T & getDistribution (const std::string &name) const
 
const DistributiongetDistributionByName (const DistributionName &name) const
 
const T & getDistributionByName (const std::string &name) const
 
const DistributiongetDistributionByName (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 PostprocessorValuegetPostprocessorValue (const std::string &param_name, const unsigned int index=0) const
 
const PostprocessorValuegetPostprocessorValue (const std::string &param_name, const unsigned int index=0) const
 
const PostprocessorValuegetPostprocessorValueOld (const std::string &param_name, const unsigned int index=0) const
 
const PostprocessorValuegetPostprocessorValueOld (const std::string &param_name, const unsigned int index=0) const
 
const PostprocessorValuegetPostprocessorValueOlder (const std::string &param_name, const unsigned int index=0) const
 
const PostprocessorValuegetPostprocessorValueOlder (const std::string &param_name, const unsigned int index=0) const
 
virtual const PostprocessorValuegetPostprocessorValueByName (const PostprocessorName &name) const
 
virtual const PostprocessorValuegetPostprocessorValueByName (const PostprocessorName &name) const
 
const PostprocessorValuegetPostprocessorValueOldByName (const PostprocessorName &name) const
 
const PostprocessorValuegetPostprocessorValueOldByName (const PostprocessorName &name) const
 
const PostprocessorValuegetPostprocessorValueOlderByName (const PostprocessorName &name) const
 
const PostprocessorValuegetPostprocessorValueOlderByName (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)
 
PenetrationLocatorgetPenetrationLocator (const BoundaryName &primary, const BoundaryName &secondary, Order order)
 
PenetrationLocatorgetQuadraturePenetrationLocator (const BoundaryName &primary, const BoundaryName &secondary, Order order)
 
NearestNodeLocatorgetNearestNodeLocator (const BoundaryName &primary, const BoundaryName &secondary)
 
NearestNodeLocatorgetQuadratureNearestNodeLocator (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
 

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

virtual void computeQpProperties () override
 
virtual void checkMaterialProperty (const std::string &name, const unsigned int state) override
 
virtual const MaterialDatamaterialData () const override
 
virtual MaterialDatamaterialData () override
 
virtual const QBase & qRule () const override
 
virtual void resetQpProperties ()
 
virtual void initQpStatefulProperties ()
 
virtual const FEProblemBasemiProblem () const
 
virtual FEProblemBasemiProblem ()
 
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 ()
 
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
 
void addMooseVariableDependency (MooseVariableFieldBase *var)
 
void addMooseVariableDependency (const std::vector< MooseVariableFieldBase * > &vars)
 
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
 
Order coupledScalarOrder (const std::string &var_name, unsigned int comp=0) const
 
const VariableValuecoupledScalarValue (const std::string &var_name, unsigned int comp=0) const
 
const ADVariableValueadCoupledScalarValue (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 VariableValuecoupledVectorTagScalarValue (const std::string &var_name, TagID tag, unsigned int comp=0) const
 
const VariableValuecoupledMatrixTagScalarValue (const std::string &var_name, TagID tag, unsigned int comp=0) const
 
const VariableValuecoupledScalarValueOld (const std::string &var_name, unsigned int comp=0) const
 
const VariableValuecoupledScalarValueOlder (const std::string &var_name, unsigned int comp=0) const
 
const VariableValuecoupledScalarDot (const std::string &var_name, unsigned int comp=0) const
 
const ADVariableValueadCoupledScalarDot (const std::string &var_name, unsigned int comp=0) const
 
const VariableValuecoupledScalarDotDot (const std::string &var_name, unsigned int comp=0) const
 
const VariableValuecoupledScalarDotOld (const std::string &var_name, unsigned int comp=0) const
 
const VariableValuecoupledScalarDotDotOld (const std::string &var_name, unsigned int comp=0) const
 
const VariableValuecoupledScalarDotDu (const std::string &var_name, unsigned int comp=0) const
 
const VariableValuecoupledScalarDotDotDu (const std::string &var_name, unsigned int comp=0) const
 
const MooseVariableScalargetScalarVar (const std::string &var_name, unsigned int comp) const
 
virtual void addUserObjectDependencyHelper (const UserObject &) const
 
Moose::StateArg determineState () 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 (InvalidSolutionID _invalid_solution_id) const
 
InvalidSolutionID registerInvalidSolutionInternal (const std::string &message) 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 intcoupledIndices (const std::string &var_name) const
 
virtual const VariableValuecoupledValue (const std::string &var_name, unsigned int comp=0) const
 
std::vector< const VariableValue *> coupledValues (const std::string &var_name) const
 
std::vector< const VectorVariableValue *> coupledVectorValues (const std::string &var_name) const
 
const GenericVariableValue< is_ad > & coupledGenericValue (const std::string &var_name, unsigned int comp=0) const
 
const GenericVariableValue< false > & coupledGenericValue (const std::string &var_name, unsigned int comp) const
 
const GenericVariableValue< true > & coupledGenericValue (const std::string &var_name, unsigned int comp) const
 
std::vector< const GenericVariableValue< is_ad > *> coupledGenericValues (const std::string &var_name) const
 
std::vector< const GenericVariableValue< false > *> coupledGenericValues (const std::string &var_name) const
 
std::vector< const GenericVariableValue< true > *> coupledGenericValues (const std::string &var_name) const
 
const GenericVariableValue< is_ad > & coupledGenericDofValue (const std::string &var_name, unsigned int comp=0) const
 
const GenericVariableValue< false > & coupledGenericDofValue (const std::string &var_name, unsigned int comp) const
 
const GenericVariableValue< true > & coupledGenericDofValue (const std::string &var_name, unsigned int comp) const
 
virtual const VariableValuecoupledValueLower (const std::string &var_name, unsigned int comp=0) const
 
const ADVariableValueadCoupledValue (const std::string &var_name, unsigned int comp=0) const
 
std::vector< const ADVariableValue *> adCoupledValues (const std::string &var_name) const
 
const ADVariableValueadCoupledLowerValue (const std::string &var_name, unsigned int comp=0) const
 
const ADVectorVariableValueadCoupledVectorValue (const std::string &var_name, unsigned int comp=0) const
 
std::vector< const ADVectorVariableValue *> adCoupledVectorValues (const std::string &var_name) const
 
virtual const VariableValuecoupledVectorTagValue (const std::string &var_names, TagID tag, unsigned int index=0) const
 
virtual const VariableValuecoupledVectorTagValue (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 ArrayVariableValuecoupledVectorTagArrayValue (const std::string &var_names, TagID tag, unsigned int index=0) const
 
virtual const ArrayVariableValuecoupledVectorTagArrayValue (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 VariableGradientcoupledVectorTagGradient (const std::string &var_names, TagID tag, unsigned int index=0) const
 
virtual const VariableGradientcoupledVectorTagGradient (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 ArrayVariableGradientcoupledVectorTagArrayGradient (const std::string &var_names, TagID tag, unsigned int index=0) const
 
virtual const ArrayVariableGradientcoupledVectorTagArrayGradient (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 VariableValuecoupledVectorTagDofValue (const std::string &var_name, TagID tag, unsigned int index=0) const
 
virtual const VariableValuecoupledVectorTagDofValue (const std::string &var_names, const std::string &tag_name, unsigned int index=0) const
 
const ArrayVariableValuecoupledVectorTagArrayDofValue (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 VariableValuecoupledMatrixTagValue (const std::string &var_names, TagID tag, unsigned int index=0) const
 
virtual const VariableValuecoupledMatrixTagValue (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 VectorVariableValuecoupledVectorValue (const std::string &var_name, unsigned int comp=0) const
 
virtual const ArrayVariableValuecoupledArrayValue (const std::string &var_name, unsigned int comp=0) const
 
std::vector< const ArrayVariableValue *> coupledArrayValues (const std::string &var_name) const
 
MooseWritableVariablewritableVariable (const std::string &var_name, unsigned int comp=0)
 
virtual VariableValuewritableCoupledValue (const std::string &var_name, unsigned int comp=0)
 
void checkWritableVar (MooseWritableVariable *var)
 
virtual const VariableValuecoupledValueOld (const std::string &var_name, unsigned int comp=0) const
 
std::vector< const VariableValue *> coupledValuesOld (const std::string &var_name) const
 
virtual const VariableValuecoupledValueOlder (const std::string &var_name, unsigned int comp=0) const
 
std::vector< const VariableValue *> coupledValuesOlder (const std::string &var_name) const
 
virtual const VariableValuecoupledValuePreviousNL (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableValuecoupledVectorValueOld (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableValuecoupledVectorValueOlder (const std::string &var_name, unsigned int comp=0) const
 
virtual const ArrayVariableValuecoupledArrayValueOld (const std::string &var_name, unsigned int comp=0) const
 
virtual const ArrayVariableValuecoupledArrayValueOlder (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableGradientcoupledGradient (const std::string &var_name, unsigned int comp=0) const
 
std::vector< const VariableGradient *> coupledGradients (const std::string &var_name) const
 
const ADVariableGradientadCoupledGradient (const std::string &var_name, unsigned int comp=0) const
 
const ADVariableGradientadCoupledGradientDot (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 ADVectorVariableGradientadCoupledVectorGradient (const std::string &var_name, unsigned int comp=0) const
 
const ADVariableSecondadCoupledSecond (const std::string &var_name, unsigned int comp=0) const
 
const ADVectorVariableSecondadCoupledVectorSecond (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableGradientcoupledGradientOld (const std::string &var_name, unsigned int comp=0) const
 
std::vector< const VariableGradient *> coupledGradientsOld (const std::string &var_name) const
 
virtual const VariableGradientcoupledGradientOlder (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableGradientcoupledGradientPreviousNL (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableGradientcoupledGradientDot (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableGradientcoupledGradientDotDot (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableGradientcoupledVectorGradient (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableGradientcoupledVectorGradientOld (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableGradientcoupledVectorGradientOlder (const std::string &var_name, unsigned int comp=0) const
 
virtual const ArrayVariableGradientcoupledArrayGradient (const std::string &var_name, unsigned int comp=0) const
 
virtual const ArrayVariableGradientcoupledArrayGradientOld (const std::string &var_name, unsigned int comp=0) const
 
virtual const ArrayVariableGradientcoupledArrayGradientOlder (const std::string &var_name, unsigned int comp=0) const
 
virtual const ArrayVariableGradientcoupledArrayGradientDot (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableCurlcoupledCurl (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableCurlcoupledCurlOld (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableCurlcoupledCurlOlder (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableSecondcoupledSecond (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableSecondcoupledSecondOld (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableSecondcoupledSecondOlder (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableSecondcoupledSecondPreviousNL (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableValuecoupledDot (const std::string &var_name, unsigned int comp=0) const
 
std::vector< const VariableValue *> coupledDots (const std::string &var_name) const
 
virtual const VariableValuecoupledDotDot (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableValuecoupledDotOld (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableValuecoupledDotDotOld (const std::string &var_name, unsigned int comp=0) const
 
const ADVariableValueadCoupledDot (const std::string &var_name, unsigned int comp=0) const
 
std::vector< const ADVariableValue *> adCoupledDots (const std::string &var_name) const
 
const ADVariableValueadCoupledDotDot (const std::string &var_name, unsigned int comp=0) const
 
const ADVectorVariableValueadCoupledVectorDot (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableValuecoupledVectorDot (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableValuecoupledVectorDotDot (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableValuecoupledVectorDotOld (const std::string &var_name, unsigned int comp=0) const
 
virtual const VectorVariableValuecoupledVectorDotDotOld (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableValuecoupledVectorDotDu (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableValuecoupledVectorDotDotDu (const std::string &var_name, unsigned int comp=0) const
 
virtual const ArrayVariableValuecoupledArrayDot (const std::string &var_name, unsigned int comp=0) const
 
virtual const ArrayVariableValuecoupledArrayDotDot (const std::string &var_name, unsigned int comp=0) const
 
virtual const ArrayVariableValuecoupledArrayDotOld (const std::string &var_name, unsigned int comp=0) const
 
virtual const ArrayVariableValuecoupledArrayDotDotOld (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableValuecoupledDotDu (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableValuecoupledDotDotDu (const std::string &var_name, unsigned int comp=0) const
 
const VariableValuecoupledArrayDotDu (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 >::typeadCoupledNodalValue (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 VariableValuecoupledNodalDotDot (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableValuecoupledNodalDotOld (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableValuecoupledNodalDotDotOld (const std::string &var_name, unsigned int comp=0) const
 
virtual const VariableValuecoupledDofValues (const std::string &var_name, unsigned int comp=0) const
 
std::vector< const VariableValue *> coupledAllDofValues (const std::string &var_name) const
 
virtual const VariableValuecoupledDofValuesOld (const std::string &var_name, unsigned int comp=0) const
 
std::vector< const VariableValue *> coupledAllDofValuesOld (const std::string &var_name) const
 
virtual const VariableValuecoupledDofValuesOlder (const std::string &var_name, unsigned int comp=0) const
 
std::vector< const VariableValue *> coupledAllDofValuesOlder (const std::string &var_name) const
 
virtual const ArrayVariableValuecoupledArrayDofValues (const std::string &var_name, unsigned int comp=0) const
 
virtual const ADVariableValueadCoupledDofValues (const std::string &var_name, unsigned int comp=0) const
 
const ADVariableValueadZeroValue () const
 
const ADVariableGradientadZeroGradient () const
 
const ADVariableSecondadZeroSecond () const
 
const GenericVariableValue< is_ad > & genericZeroValue ()
 
const GenericVariableValue< false > & genericZeroValue ()
 
const GenericVariableValue< true > & genericZeroValue ()
 
const GenericVariableGradient< is_ad > & genericZeroGradient ()
 
const GenericVariableGradient< false > & genericZeroGradient ()
 
const GenericVariableGradient< true > & genericZeroGradient ()
 
const GenericVariableSecond< is_ad > & genericZeroSecond ()
 
const GenericVariableSecond< false > & genericZeroSecond ()
 
const GenericVariableSecond< true > & genericZeroSecond ()
 
bool checkVar (const std::string &var_name, unsigned int comp=0, unsigned int comp_bound=0) const
 
const MooseVariableFieldBasegetFEVar (const std::string &var_name, unsigned int comp) const
 
const MooseVariableFieldBasegetFieldVar (const std::string &var_name, unsigned int comp) const
 
MooseVariableFieldBasegetFieldVar (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)
 
MooseVariablegetVar (const std::string &var_name, unsigned int comp)
 
const MooseVariablegetVar (const std::string &var_name, unsigned int comp) const
 
VectorMooseVariablegetVectorVar (const std::string &var_name, unsigned int comp)
 
const VectorMooseVariablegetVectorVar (const std::string &var_name, unsigned int comp) const
 
ArrayMooseVariablegetArrayVar (const std::string &var_name, unsigned int comp)
 
const ArrayMooseVariablegetArrayVar (const std::string &var_name, unsigned int comp) const
 
void validateExecutionerType (const std::string &name, const std::string &fn_name) const
 
std::vector< T > coupledVectorHelper (const std::string &var_name, const Func &func) const
 
void markMatPropRequested (const std::string &)
 
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 ADVectorVariableValue_velocity
 velocity More...
 
const ADVectorVariableGradient_grad_velocity
 gradient of velocity More...
 
const ADVariableGradient_grad_p
 gradient of the pressure More...
 
const ADMaterialProperty< Real > & _mu
 viscosity More...
 
const ADMaterialProperty< Real > & _rho
 density More...
 
const ADVectorVariableValue_velocity_dot
 Time derivative of the velocity, e.g. the acceleration. More...
 
ADMaterialProperty< Real > & _mass_strong_residual
 The strong residual of the mass continuity equation. More...
 
ADMaterialProperty< RealVectorValue > & _advective_strong_residual
 Strong residual corresponding to the momentum advective term. More...
 
ADMaterialProperty< RealVectorValue > & _td_strong_residual
 Strong residual corresponding to the momentum transient term. More...
 
ADMaterialProperty< RealVectorValue > & _gravity_strong_residual
 Strong residual corresponding to the momentum gravity term. More...
 
ADMaterialProperty< RealVectorValue > & _boussinesq_strong_residual
 Strong residual corresponding to the momentum boussinesq term. More...
 
ADMaterialProperty< RealVectorValue > & _coupled_force_strong_residual
 Strong residual corresponding to coupled force term. More...
 
ADMaterialProperty< RealVectorValue > & _mesh_velocity
 The mesh velocity. More...
 
ADMaterialProperty< RealVectorValue > & _relative_velocity
 The relative velocity, e.g. velocity - mesh_velocity. More...
 
ADMaterialProperty< RealVectorValue > & _advected_mesh_strong_residual
 Strong residual corresponding to advected mesh term. More...
 
const bool _use_displaced_mesh
 Whether we are on the displaced mesh. More...
 
const MooseArray< ADPoint > & _ad_q_point
 The quadrature points with potential partial derivatives with respect to displacement degrees of freedom. More...
 
const unsigned int _rz_radial_coord
 The radial coordinate index for RZ coordinate systems. More...
 
const unsigned int _rz_axial_coord
 The axial coordinate index for RZ coordinate systems. More...
 
const INSADObjectTracker_object_tracker
 A user object that consumes information from INSAD residual objects and feeds it into this material. More...
 
bool _has_transient
 Whether the momentum equations are transient. More...
 
bool _has_gravity
 Whether there is a gravity force in the momentum equation. More...
 
bool _has_boussinesq
 Whether natural convection forces via the Boussinesq approximation are added to the momentum equation. More...
 
bool _has_coupled_force
 Whether there is a force from a coupled vector variable or vector function. More...
 
std::unordered_map< SubdomainID, const ADMaterialProperty< Real > * > _boussinesq_alphas
 The Boussinesq coefficient. More...
 
const ADMaterialProperty< Real > * _boussinesq_alpha
 
const ADVariableValue_temperature
 The temperature. More...
 
std::unordered_map< SubdomainID, const MaterialProperty< Real > * > _ref_temps
 The reference temperature. More...
 
const MaterialProperty< Real > * _ref_temp
 
NS::ViscousForm _viscous_form
 The viscous form of the equations. This is either "laplace" or "traction". More...
 
RealVectorValue _gravity_vector
 The gravity vector. More...
 
std::vector< const ADVectorVariableValue * > _coupled_force_var
 optionally copuled vector var(s) More...
 
std::vector< const Function * > _coupled_force_vector_function
 optional vector function(s) More...
 
bool _has_advected_mesh
 Whether we have mesh convection. More...
 
const ADVariableValue_disp_x_dot
 The time derivative with respect to x-displacement. More...
 
const ADVariableValue_disp_y_dot
 The time derivative with respect to y-displacement. More...
 
const ADVariableValue_disp_z_dot
 The time derivative with respect to z-displacement. More...
 
unsigned int _disp_x_num = libMesh::invalid_uint
 
unsigned int _disp_y_num = libMesh::invalid_uint
 
unsigned int _disp_z_num = libMesh::invalid_uint
 
unsigned int _disp_x_sys_num = libMesh::invalid_uint
 
unsigned int _disp_y_sys_num = libMesh::invalid_uint
 
unsigned int _disp_z_sys_num = libMesh::invalid_uint
 
 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
 
const InputParameters_ti_params
 
FEProblemBase_ti_feproblem
 
bool _is_implicit
 
Real_t
 
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::vector< std::unique_ptr< VariableValue > > > _default_value
 
std::unordered_map< std::string, std::unique_ptr< MooseArray< DualReal > > > _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
 
const VariableValue_zero
 
const VariablePhiValue_phi_zero
 
const MooseArray< DualReal > & _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
 
ArrayVariableValue _default_array_value_zero
 
ArrayVariableGradient _default_array_gradient
 
ArrayVariableCurl _default_array_curl
 
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

Definition at line 17 of file INSADMaterial.h.

Constructor & Destructor Documentation

◆ INSADMaterial()

INSADMaterial::INSADMaterial ( const InputParameters parameters)

Definition at line 34 of file INSADMaterial.C.

36  _velocity(adCoupledVectorValue("velocity")),
39  _mu(getADMaterialProperty<Real>("mu_name")),
40  _rho(getADMaterialProperty<Real>("rho_name")),
41  _velocity_dot(nullptr),
42  _mass_strong_residual(declareADProperty<Real>("mass_strong_residual")),
43  _advective_strong_residual(declareADProperty<RealVectorValue>("advective_strong_residual")),
44  // We have to declare the below strong residuals for integrity check purposes even though we may
45  // not compute them. This may incur some unnecessary cost for a non-sparse derivative container
46  // since when the properties are resized the entire non-sparse derivative containers will be
47  // initialized to zero
48  _td_strong_residual(declareADProperty<RealVectorValue>("td_strong_residual")),
49  _gravity_strong_residual(declareADProperty<RealVectorValue>("gravity_strong_residual")),
50  _boussinesq_strong_residual(declareADProperty<RealVectorValue>("boussinesq_strong_residual")),
52  declareADProperty<RealVectorValue>("coupled_force_strong_residual")),
53  _mesh_velocity(declareADProperty<RealVectorValue>("mesh_velocity")),
54  _relative_velocity(declareADProperty<RealVectorValue>("relative_velocity")),
56  declareADProperty<RealVectorValue>("advected_mesh_strong_residual")),
57  // _mms_function_strong_residual(declareProperty<RealVectorValue>("mms_function_strong_residual")),
58  _use_displaced_mesh(getParam<bool>("use_displaced_mesh")),
61  _rz_axial_coord(_rz_radial_coord == 0 ? 1 : 0)
62 {
63  if (!_fe_problem.hasUserObject("ins_ad_object_tracker"))
64  {
66  tracker_params.addPrivateParam("_moose_app", &_app);
67 
68  _fe_problem.addUserObject("INSADObjectTracker", "ins_ad_object_tracker", tracker_params);
69  }
70 
71  // Bypass the UserObjectInterface method because it requires a UserObjectName param which we
72  // don't need
73  _object_tracker = &_fe_problem.getUserObject<INSADObjectTracker>("ins_ad_object_tracker");
74  const_cast<INSADObjectTracker *>(_object_tracker)->addBlockIDs(this->blockIDs());
75 }
const ADVectorVariableGradient & _grad_velocity
gradient of velocity
Definition: INSADMaterial.h:34
ADMaterialProperty< RealVectorValue > & _gravity_strong_residual
Strong residual corresponding to the momentum gravity term.
Definition: INSADMaterial.h:58
FEProblemBase & _fe_problem
const MooseArray< ADPoint > & adQPointsFace() const
T & getUserObject(const std::string &name, unsigned int tid=0) const
ADMaterialProperty< RealVectorValue > & _advected_mesh_strong_residual
Strong residual corresponding to advected mesh term.
Definition: INSADMaterial.h:73
void addPrivateParam(const std::string &name, const T &value)
ADMaterialProperty< RealVectorValue > & _coupled_force_strong_residual
Strong residual corresponding to coupled force term.
Definition: INSADMaterial.h:64
static InputParameters validParams()
const MooseArray< ADPoint > & adQPoints() const
const ADVariableGradient & adCoupledGradient(const std::string &var_name, unsigned int comp=0) const
const INSADObjectTracker * _object_tracker
A user object that consumes information from INSAD residual objects and feeds it into this material...
Definition: INSADMaterial.h:94
virtual const std::set< SubdomainID > & blockIDs() const
bool hasUserObject(const std::string &name) const
ADMaterialProperty< RealVectorValue > & _td_strong_residual
Strong residual corresponding to the momentum transient term.
Definition: INSADMaterial.h:55
ADMaterialProperty< RealVectorValue > & _relative_velocity
The relative velocity, e.g. velocity - mesh_velocity.
Definition: INSADMaterial.h:70
const MooseArray< ADPoint > & _ad_q_point
The quadrature points with potential partial derivatives with respect to displacement degrees of free...
Definition: INSADMaterial.h:84
ADMaterialProperty< RealVectorValue > & _advective_strong_residual
Strong residual corresponding to the momentum advective term.
Definition: INSADMaterial.h:52
const bool _use_displaced_mesh
Whether we are on the displaced mesh.
Definition: INSADMaterial.h:80
MooseMesh & _mesh
Assembly & _assembly
unsigned int getAxisymmetricRadialCoord() const
const ADMaterialProperty< Real > & _mu
viscosity
Definition: INSADMaterial.h:40
const unsigned int _rz_axial_coord
The axial coordinate index for RZ coordinate systems.
Definition: INSADMaterial.h:90
const ADVectorVariableValue & _velocity
velocity
Definition: INSADMaterial.h:31
const ADVectorVariableValue * _velocity_dot
Time derivative of the velocity, e.g. the acceleration.
Definition: INSADMaterial.h:46
ADMaterialProperty< RealVectorValue > & _boussinesq_strong_residual
Strong residual corresponding to the momentum boussinesq term.
Definition: INSADMaterial.h:61
MooseApp & _app
virtual std::vector< std::shared_ptr< UserObject > > addUserObject(const std::string &user_object_name, const std::string &name, InputParameters &parameters)
static const std::string pressure
Definition: NS.h:56
const ADVectorVariableGradient & adCoupledVectorGradient(const std::string &var_name, unsigned int comp=0) const
const InputParameters & parameters() const
const ADMaterialProperty< Real > & _rho
density
Definition: INSADMaterial.h:43
const unsigned int _rz_radial_coord
The radial coordinate index for RZ coordinate systems.
Definition: INSADMaterial.h:87
Object for tracking what kernels have been added to an INSAD simulation.
ADMaterialProperty< RealVectorValue > & _mesh_velocity
The mesh velocity.
Definition: INSADMaterial.h:67
const ADVectorVariableValue & adCoupledVectorValue(const std::string &var_name, unsigned int comp=0) const
Material(const InputParameters &parameters)
const ADVariableGradient & _grad_p
gradient of the pressure
Definition: INSADMaterial.h:37
ADMaterialProperty< Real > & _mass_strong_residual
The strong residual of the mass continuity equation.
Definition: INSADMaterial.h:49

Member Function Documentation

◆ computeQpProperties()

void INSADMaterial::computeQpProperties ( )
overrideprotectedvirtual

Reimplemented from Material.

Reimplemented in INSADTauMaterialTempl< INSAD3Eqn >, INSAD3Eqn, and INSADStabilized3Eqn.

Definition at line 208 of file INSADMaterial.C.

Referenced by INSAD3Eqn::computeQpProperties().

209 {
212 
214  if (_has_transient)
215  _td_strong_residual[_qp] = _rho[_qp] * (*_velocity_dot)[_qp];
216  if (_has_gravity)
218  if (_has_boussinesq)
219  _boussinesq_strong_residual[_qp] = (*_boussinesq_alpha)[_qp] * _gravity_vector * _rho[_qp] *
220  ((*_temperature)[_qp] - (*_ref_temp)[_qp]);
222 
223  if (_has_advected_mesh)
224  {
225  _mesh_velocity[_qp](0) = (*_disp_x_dot)[_qp];
226  if (_disp_y_dot)
227  _mesh_velocity[_qp](1) = (*_disp_y_dot)[_qp];
228  if (_disp_z_dot)
229  _mesh_velocity[_qp](2) = (*_disp_z_dot)[_qp];
232  }
233 
234  if (_has_coupled_force)
235  {
237  mooseAssert(!(_coupled_force_var.empty() && _coupled_force_vector_function.empty()),
238  "Either the coupled force var or the coupled force vector function must be "
239  "non-empty in 'INSADMaterial'");
240  for (const auto * var : _coupled_force_var)
241  {
242  mooseAssert(var, "null coupled variable in INSADMaterial");
244  }
245  for (const auto * fn : _coupled_force_vector_function)
246  {
247  mooseAssert(fn, "null coupled function in INSADMaterial");
248  _coupled_force_strong_residual[_qp] -= fn->vectorValue(_t, _q_point[_qp]);
249  }
250  }
251 
252  // // Future Addition
253  // _mms_function_strong_residual[_qp] = -RealVectorValue(_x_vel_fn.value(_t, _q_point[_qp]),
254  // _y_vel_fn.value(_t, _q_point[_qp]),
255  // _z_vel_fn.value(_t, _q_point[_qp]));
256 }
const MooseArray< Point > & _q_point
const ADVectorVariableGradient & _grad_velocity
gradient of velocity
Definition: INSADMaterial.h:34
ADMaterialProperty< RealVectorValue > & _gravity_strong_residual
Strong residual corresponding to the momentum gravity term.
Definition: INSADMaterial.h:58
RealVectorValue _gravity_vector
The gravity vector.
ADMaterialProperty< RealVectorValue > & _advected_mesh_strong_residual
Strong residual corresponding to advected mesh term.
Definition: INSADMaterial.h:73
T divergence(const TensorValue< T > &gradient, const VectorType &value, const PointType &point, const Moose::CoordinateSystemType &coord_sys, const unsigned int rz_radial_coord)
Compute the divergence of a vector given its matrix of derivatives.
ADMaterialProperty< RealVectorValue > & _coupled_force_strong_residual
Strong residual corresponding to coupled force term.
Definition: INSADMaterial.h:64
std::vector< const Function * > _coupled_force_vector_function
optional vector function(s)
const Moose::CoordinateSystemType & _coord_sys
ADMaterialProperty< RealVectorValue > & _td_strong_residual
Strong residual corresponding to the momentum transient term.
Definition: INSADMaterial.h:55
bool _has_gravity
Whether there is a gravity force in the momentum equation.
const ADVariableValue * _disp_x_dot
The time derivative with respect to x-displacement.
ADMaterialProperty< RealVectorValue > & _relative_velocity
The relative velocity, e.g. velocity - mesh_velocity.
Definition: INSADMaterial.h:70
const MooseArray< ADPoint > & _ad_q_point
The quadrature points with potential partial derivatives with respect to displacement degrees of free...
Definition: INSADMaterial.h:84
ADMaterialProperty< RealVectorValue > & _advective_strong_residual
Strong residual corresponding to the momentum advective term.
Definition: INSADMaterial.h:52
unsigned int _qp
const ADVariableValue * _disp_z_dot
The time derivative with respect to z-displacement.
Real & _t
const ADVariableValue * _disp_y_dot
The time derivative with respect to y-displacement.
const ADVectorVariableValue & _velocity
velocity
Definition: INSADMaterial.h:31
bool _has_transient
Whether the momentum equations are transient.
Definition: INSADMaterial.h:97
ADMaterialProperty< RealVectorValue > & _boussinesq_strong_residual
Strong residual corresponding to the momentum boussinesq term.
Definition: INSADMaterial.h:61
std::vector< const ADVectorVariableValue * > _coupled_force_var
optionally copuled vector var(s)
bool _has_coupled_force
Whether there is a force from a coupled vector variable or vector function.
bool _has_boussinesq
Whether natural convection forces via the Boussinesq approximation are added to the momentum equation...
bool _has_advected_mesh
Whether we have mesh convection.
const ADMaterialProperty< Real > & _rho
density
Definition: INSADMaterial.h:43
const unsigned int _rz_radial_coord
The radial coordinate index for RZ coordinate systems.
Definition: INSADMaterial.h:87
ADMaterialProperty< RealVectorValue > & _mesh_velocity
The mesh velocity.
Definition: INSADMaterial.h:67
ADMaterialProperty< Real > & _mass_strong_residual
The strong residual of the mass continuity equation.
Definition: INSADMaterial.h:49

◆ resolveOptionalProperties()

void INSADMaterial::resolveOptionalProperties ( )
overridevirtual

Reimplemented from Material.

Definition at line 78 of file INSADMaterial.C.

79 {
81 
82  for (const auto sub_id : this->blockIDs())
83  if ((_object_tracker->get<bool>("has_boussinesq", sub_id)))
84  {
85  _boussinesq_alphas[sub_id] = &getPossiblyConstantGenericMaterialPropertyByName<Real, true>(
86  _object_tracker->get<MaterialPropertyName>("alpha", sub_id), _material_data, 0);
87  _ref_temps[sub_id] = &getPossiblyConstantGenericMaterialPropertyByName<Real, false>(
88  _object_tracker->get<MaterialPropertyName>("ref_temp", sub_id), _material_data, 0);
89  }
90 }
const INSADObjectTracker * _object_tracker
A user object that consumes information from INSAD residual objects and feeds it into this material...
Definition: INSADMaterial.h:94
virtual const std::set< SubdomainID > & blockIDs() const
MaterialData & _material_data
const T & get(const std::string &name, SubdomainID sub_id) const
Get the internal parameter name.
std::unordered_map< SubdomainID, const MaterialProperty< Real > * > _ref_temps
The reference temperature.
std::unordered_map< SubdomainID, const ADMaterialProperty< Real > * > _boussinesq_alphas
The Boussinesq coefficient.
virtual void resolveOptionalProperties() override

◆ subdomainSetup()

void INSADMaterial::subdomainSetup ( )
overridevirtual

Reimplemented from Material.

Reimplemented in INSAD3Eqn.

Definition at line 93 of file INSADMaterial.C.

Referenced by INSAD3Eqn::subdomainSetup().

94 {
95  if ((_has_transient = _object_tracker->get<bool>("has_transient", _current_subdomain_id)))
96  _velocity_dot = &adCoupledVectorDot("velocity");
97  else
98  _velocity_dot = nullptr;
99 
100  if (auto alpha_it = _boussinesq_alphas.find(_current_subdomain_id);
101  alpha_it != _boussinesq_alphas.end())
102  {
103  _has_boussinesq = true;
104  _boussinesq_alpha = alpha_it->second;
105  auto & temp_var = _subproblem.getStandardVariable(
106  _tid, _object_tracker->get<std::string>("temperature", _current_subdomain_id));
107  addMooseVariableDependency(&temp_var);
108  _temperature = &temp_var.adSln();
109  _ref_temp = libmesh_map_find(_ref_temps, _current_subdomain_id);
110  }
111  else
112  {
113  _has_boussinesq = false;
114  _boussinesq_alpha = nullptr;
115  _temperature = nullptr;
116  _ref_temp = nullptr;
117  }
118 
119  _has_gravity = _object_tracker->get<bool>("has_gravity", _current_subdomain_id);
122  else
123  _gravity_vector = 0;
124 
125  // Setup data for Arbitrary Lagrangian Eulerian (ALE) simulations in which the simulation domain
126  // is displacing. We will need to subtract the mesh velocity from the velocity solution in order
127  // to get the correct material velocity for the momentum convection term.
128  if ((_has_advected_mesh = _object_tracker->get<bool>("has_advected_mesh", _current_subdomain_id)))
129  {
130  auto & disp_x = _subproblem.getStandardVariable(
131  _tid, _object_tracker->get<VariableName>("disp_x", _current_subdomain_id));
133  _disp_x_dot = &disp_x.adUDot();
134  _disp_x_sys_num = disp_x.sys().number();
135  _disp_x_num = (disp_x.kind() == Moose::VarKindType::VAR_SOLVER) &&
137  ? disp_x.number()
140  {
141  auto & disp_y = _subproblem.getStandardVariable(
142  _tid, _object_tracker->get<VariableName>("disp_y", _current_subdomain_id));
144  _disp_y_dot = &disp_y.adUDot();
145  _disp_y_sys_num = disp_y.sys().number();
146  _disp_y_num =
147  disp_y.kind() == (Moose::VarKindType::VAR_SOLVER &&
149  ? disp_y.number()
151  }
152  else
153  {
154  _disp_y_dot = nullptr;
157  }
159  {
160  auto & disp_z = _subproblem.getStandardVariable(
161  _tid, _object_tracker->get<VariableName>("disp_z", _current_subdomain_id));
163  _disp_z_dot = &disp_z.adUDot();
164  _disp_z_sys_num = disp_z.sys().number();
165  _disp_z_num =
166  disp_z.kind() == (Moose::VarKindType::VAR_SOLVER &&
168  ? disp_z.number()
170  }
171  else
172  {
173  _disp_z_dot = nullptr;
176  }
177  }
178  else
179  _disp_x_dot = _disp_y_dot = _disp_z_dot = nullptr;
180 
181  _viscous_form = static_cast<NS::ViscousForm>(
183 
184  if ((_has_coupled_force = _object_tracker->get<bool>("has_coupled_force", _current_subdomain_id)))
185  {
186  _coupled_force_var.clear();
188  if (_object_tracker->isTrackerParamValid("coupled_force_var", _current_subdomain_id))
189  {
190  const auto & var_names = _object_tracker->get<std::vector<VariableName>>(
191  "coupled_force_var", _current_subdomain_id);
192  for (const auto & var_name : var_names)
193  _coupled_force_var.push_back(&_subproblem.getVectorVariable(_tid, var_name).adSln());
194  }
195 
196  if (_object_tracker->isTrackerParamValid("coupled_force_vector_function",
198  {
199  const auto & func_names = _object_tracker->get<std::vector<FunctionName>>(
200  "coupled_force_vector_function", _current_subdomain_id);
201  for (const auto & func_name : func_names)
203  }
204  }
205 }
const ADMaterialProperty< Real > * _boussinesq_alpha
FEProblemBase & _fe_problem
RealVectorValue _gravity_vector
The gravity vector.
virtual VectorMooseVariable & getVectorVariable(const THREAD_ID tid, const std::string &var_name)=0
const unsigned int invalid_uint
NS::ViscousForm _viscous_form
The viscous form of the equations. This is either "laplace" or "traction".
std::vector< const Function * > _coupled_force_vector_function
optional vector function(s)
SubProblem & _subproblem
unsigned int _disp_x_num
const MaterialProperty< Real > * _ref_temp
const INSADObjectTracker * _object_tracker
A user object that consumes information from INSAD residual objects and feeds it into this material...
Definition: INSADMaterial.h:94
ViscousForm
Definition: NSEnums.h:20
unsigned int _disp_z_sys_num
bool _has_gravity
Whether there is a gravity force in the momentum equation.
const ADVariableValue * _disp_x_dot
The time derivative with respect to x-displacement.
virtual Function & getFunction(const std::string &name, const THREAD_ID tid=0)
unsigned int _disp_y_sys_num
const T & get(const std::string &name, SubdomainID sub_id) const
Get the internal parameter name.
const ADVariableValue * _disp_z_dot
The time derivative with respect to z-displacement.
THREAD_ID _tid
NonlinearSystemBase & currentNonlinearSystem()
const ADTemplateVariableValue< OutputType > & adSln() const override
virtual MooseVariable & getStandardVariable(const THREAD_ID tid, const std::string &var_name)=0
bool isTrackerParamValid(const std::string &name, SubdomainID sub_id) const
const ADVariableValue * _disp_y_dot
The time derivative with respect to y-displacement.
unsigned int number() const
std::unordered_map< SubdomainID, const MaterialProperty< Real > * > _ref_temps
The reference temperature.
const ADVectorVariableValue & adCoupledVectorDot(const std::string &var_name, unsigned int comp=0) const
const ADVectorVariableValue * _velocity_dot
Time derivative of the velocity, e.g. the acceleration.
Definition: INSADMaterial.h:46
bool _has_transient
Whether the momentum equations are transient.
Definition: INSADMaterial.h:97
void addMooseVariableDependency(MooseVariableFieldBase *var)
const ADVariableValue * _temperature
The temperature.
unsigned int _disp_x_sys_num
std::vector< const ADVectorVariableValue * > _coupled_force_var
optionally copuled vector var(s)
unsigned int _disp_y_num
bool _has_coupled_force
Whether there is a force from a coupled vector variable or vector function.
bool _has_boussinesq
Whether natural convection forces via the Boussinesq approximation are added to the momentum equation...
std::unordered_map< SubdomainID, const ADMaterialProperty< Real > * > _boussinesq_alphas
The Boussinesq coefficient.
unsigned int _disp_z_num
bool _has_advected_mesh
Whether we have mesh convection.
const SubdomainID & _current_subdomain_id
void ErrorVector unsigned int

◆ validParams()

InputParameters INSADMaterial::validParams ( )
static

Definition at line 22 of file INSADMaterial.C.

Referenced by INSAD3Eqn::validParams().

23 {
25  params.addClassDescription("This is the material class used to compute some of the strong "
26  "residuals for the INS equations.");
27  params.addRequiredCoupledVar("velocity", "The velocity");
28  params.addRequiredCoupledVar(NS::pressure, "The pressure");
29  params.addParam<MaterialPropertyName>("mu_name", "mu", "The name of the dynamic viscosity");
30  params.addParam<MaterialPropertyName>("rho_name", "rho", "The name of the density");
31  return params;
32 }
void addParam(const std::string &name, const std::initializer_list< typename T::value_type > &value, const std::string &doc_string)
static InputParameters validParams()
void addRequiredCoupledVar(const std::string &name, const std::string &doc_string)
static const std::string pressure
Definition: NS.h:56
void addClassDescription(const std::string &doc_string)

Member Data Documentation

◆ _ad_q_point

const MooseArray<ADPoint>& INSADMaterial::_ad_q_point
protected

The quadrature points with potential partial derivatives with respect to displacement degrees of freedom.

Definition at line 84 of file INSADMaterial.h.

Referenced by computeQpProperties().

◆ _advected_mesh_strong_residual

ADMaterialProperty<RealVectorValue>& INSADMaterial::_advected_mesh_strong_residual
protected

Strong residual corresponding to advected mesh term.

Definition at line 73 of file INSADMaterial.h.

Referenced by computeQpProperties().

◆ _advective_strong_residual

ADMaterialProperty<RealVectorValue>& INSADMaterial::_advective_strong_residual
protected

Strong residual corresponding to the momentum advective term.

Definition at line 52 of file INSADMaterial.h.

Referenced by computeQpProperties().

◆ _boussinesq_alpha

const ADMaterialProperty<Real>* INSADMaterial::_boussinesq_alpha
protected

Definition at line 111 of file INSADMaterial.h.

Referenced by subdomainSetup().

◆ _boussinesq_alphas

std::unordered_map<SubdomainID, const ADMaterialProperty<Real> *> INSADMaterial::_boussinesq_alphas
protected

The Boussinesq coefficient.

Definition at line 110 of file INSADMaterial.h.

Referenced by resolveOptionalProperties(), and subdomainSetup().

◆ _boussinesq_strong_residual

ADMaterialProperty<RealVectorValue>& INSADMaterial::_boussinesq_strong_residual
protected

Strong residual corresponding to the momentum boussinesq term.

Definition at line 61 of file INSADMaterial.h.

Referenced by computeQpProperties().

◆ _coupled_force_strong_residual

ADMaterialProperty<RealVectorValue>& INSADMaterial::_coupled_force_strong_residual
protected

Strong residual corresponding to coupled force term.

Definition at line 64 of file INSADMaterial.h.

Referenced by computeQpProperties().

◆ _coupled_force_var

std::vector<const ADVectorVariableValue *> INSADMaterial::_coupled_force_var
protected

optionally copuled vector var(s)

Definition at line 127 of file INSADMaterial.h.

Referenced by computeQpProperties(), and subdomainSetup().

◆ _coupled_force_vector_function

std::vector<const Function *> INSADMaterial::_coupled_force_vector_function
protected

optional vector function(s)

Definition at line 130 of file INSADMaterial.h.

Referenced by computeQpProperties(), and subdomainSetup().

◆ _disp_x_dot

const ADVariableValue* INSADMaterial::_disp_x_dot
protected

The time derivative with respect to x-displacement.

Definition at line 136 of file INSADMaterial.h.

Referenced by computeQpProperties(), and subdomainSetup().

◆ _disp_x_num

unsigned int INSADMaterial::_disp_x_num = libMesh::invalid_uint
protected

Definition at line 144 of file INSADMaterial.h.

Referenced by subdomainSetup().

◆ _disp_x_sys_num

unsigned int INSADMaterial::_disp_x_sys_num = libMesh::invalid_uint
protected

Definition at line 147 of file INSADMaterial.h.

Referenced by subdomainSetup().

◆ _disp_y_dot

const ADVariableValue* INSADMaterial::_disp_y_dot
protected

The time derivative with respect to y-displacement.

Definition at line 139 of file INSADMaterial.h.

Referenced by computeQpProperties(), and subdomainSetup().

◆ _disp_y_num

unsigned int INSADMaterial::_disp_y_num = libMesh::invalid_uint
protected

Definition at line 145 of file INSADMaterial.h.

Referenced by subdomainSetup().

◆ _disp_y_sys_num

unsigned int INSADMaterial::_disp_y_sys_num = libMesh::invalid_uint
protected

Definition at line 148 of file INSADMaterial.h.

Referenced by subdomainSetup().

◆ _disp_z_dot

const ADVariableValue* INSADMaterial::_disp_z_dot
protected

The time derivative with respect to z-displacement.

Definition at line 142 of file INSADMaterial.h.

Referenced by computeQpProperties(), and subdomainSetup().

◆ _disp_z_num

unsigned int INSADMaterial::_disp_z_num = libMesh::invalid_uint
protected

Definition at line 146 of file INSADMaterial.h.

Referenced by subdomainSetup().

◆ _disp_z_sys_num

unsigned int INSADMaterial::_disp_z_sys_num = libMesh::invalid_uint
protected

Definition at line 149 of file INSADMaterial.h.

Referenced by subdomainSetup().

◆ _grad_p

const ADVariableGradient& INSADMaterial::_grad_p
protected

gradient of the pressure

Definition at line 37 of file INSADMaterial.h.

◆ _grad_velocity

const ADVectorVariableGradient& INSADMaterial::_grad_velocity
protected

gradient of velocity

Definition at line 34 of file INSADMaterial.h.

Referenced by computeQpProperties().

◆ _gravity_strong_residual

ADMaterialProperty<RealVectorValue>& INSADMaterial::_gravity_strong_residual
protected

Strong residual corresponding to the momentum gravity term.

Definition at line 58 of file INSADMaterial.h.

Referenced by computeQpProperties().

◆ _gravity_vector

RealVectorValue INSADMaterial::_gravity_vector
protected

The gravity vector.

Definition at line 124 of file INSADMaterial.h.

Referenced by computeQpProperties(), and subdomainSetup().

◆ _has_advected_mesh

bool INSADMaterial::_has_advected_mesh
protected

Whether we have mesh convection.

Definition at line 133 of file INSADMaterial.h.

Referenced by INSADStabilized3Eqn::computeQpProperties(), INSAD3Eqn::computeQpProperties(), computeQpProperties(), and subdomainSetup().

◆ _has_boussinesq

bool INSADMaterial::_has_boussinesq
protected

Whether natural convection forces via the Boussinesq approximation are added to the momentum equation.

Definition at line 104 of file INSADMaterial.h.

Referenced by computeQpProperties(), and subdomainSetup().

◆ _has_coupled_force

bool INSADMaterial::_has_coupled_force
protected

Whether there is a force from a coupled vector variable or vector function.

Definition at line 107 of file INSADMaterial.h.

Referenced by computeQpProperties(), and subdomainSetup().

◆ _has_gravity

bool INSADMaterial::_has_gravity
protected

Whether there is a gravity force in the momentum equation.

Definition at line 100 of file INSADMaterial.h.

Referenced by computeQpProperties(), and subdomainSetup().

◆ _has_transient

bool INSADMaterial::_has_transient
protected

Whether the momentum equations are transient.

Definition at line 97 of file INSADMaterial.h.

Referenced by computeQpProperties(), and subdomainSetup().

◆ _mass_strong_residual

ADMaterialProperty<Real>& INSADMaterial::_mass_strong_residual
protected

The strong residual of the mass continuity equation.

Definition at line 49 of file INSADMaterial.h.

Referenced by computeQpProperties().

◆ _mesh_velocity

ADMaterialProperty<RealVectorValue>& INSADMaterial::_mesh_velocity
protected

The mesh velocity.

Definition at line 67 of file INSADMaterial.h.

Referenced by INSAD3Eqn::computeQpProperties(), and computeQpProperties().

◆ _mu

const ADMaterialProperty<Real>& INSADMaterial::_mu
protected

viscosity

Definition at line 40 of file INSADMaterial.h.

◆ _object_tracker

const INSADObjectTracker* INSADMaterial::_object_tracker
protected

A user object that consumes information from INSAD residual objects and feeds it into this material.

Definition at line 94 of file INSADMaterial.h.

Referenced by INSADMaterial(), resolveOptionalProperties(), subdomainSetup(), and INSAD3Eqn::subdomainSetup().

◆ _ref_temp

const MaterialProperty<Real>* INSADMaterial::_ref_temp
protected

Definition at line 118 of file INSADMaterial.h.

Referenced by subdomainSetup().

◆ _ref_temps

std::unordered_map<SubdomainID, const MaterialProperty<Real> *> INSADMaterial::_ref_temps
protected

The reference temperature.

Definition at line 117 of file INSADMaterial.h.

Referenced by resolveOptionalProperties(), and subdomainSetup().

◆ _relative_velocity

ADMaterialProperty<RealVectorValue>& INSADMaterial::_relative_velocity
protected

The relative velocity, e.g. velocity - mesh_velocity.

Definition at line 70 of file INSADMaterial.h.

Referenced by computeQpProperties().

◆ _rho

const ADMaterialProperty<Real>& INSADMaterial::_rho
protected

◆ _rz_axial_coord

const unsigned int INSADMaterial::_rz_axial_coord
protected

The axial coordinate index for RZ coordinate systems.

Definition at line 90 of file INSADMaterial.h.

◆ _rz_radial_coord

const unsigned int INSADMaterial::_rz_radial_coord
protected

The radial coordinate index for RZ coordinate systems.

Definition at line 87 of file INSADMaterial.h.

Referenced by computeQpProperties().

◆ _td_strong_residual

ADMaterialProperty<RealVectorValue>& INSADMaterial::_td_strong_residual
protected

Strong residual corresponding to the momentum transient term.

Definition at line 55 of file INSADMaterial.h.

Referenced by computeQpProperties().

◆ _temperature

const ADVariableValue* INSADMaterial::_temperature
protected

The temperature.

Definition at line 114 of file INSADMaterial.h.

Referenced by subdomainSetup().

◆ _use_displaced_mesh

const bool INSADMaterial::_use_displaced_mesh
protected

Whether we are on the displaced mesh.

Definition at line 80 of file INSADMaterial.h.

◆ _velocity

const ADVectorVariableValue& INSADMaterial::_velocity
protected

velocity

Definition at line 31 of file INSADMaterial.h.

Referenced by INSAD3Eqn::computeQpProperties(), and computeQpProperties().

◆ _velocity_dot

const ADVectorVariableValue* INSADMaterial::_velocity_dot
protected

Time derivative of the velocity, e.g. the acceleration.

Definition at line 46 of file INSADMaterial.h.

Referenced by subdomainSetup().

◆ _viscous_form

NS::ViscousForm INSADMaterial::_viscous_form
protected

The viscous form of the equations. This is either "laplace" or "traction".

Definition at line 121 of file INSADMaterial.h.

Referenced by subdomainSetup().


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