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

Object for tracking what kernels have been added to an INSAD simulation. More...

#include <INSADObjectTracker.h>

Inheritance diagram for INSADObjectTracker:
[legend]

Public Types

typedef DataFileName DataFileParameterType
 

Public Member Functions

 INSADObjectTracker (const InputParameters &parameters)
 
template<typename T >
void set (const std::string &name, const T &value, SubdomainID sub_id)
 Set the internal parameter name to value. More...
 
template<typename T >
const T & get (const std::string &name, SubdomainID sub_id) const
 Get the internal parameter name. More...
 
virtual void initialize () final
 
virtual void execute () final
 
virtual void finalize () final
 
bool isTrackerParamValid (const std::string &name, SubdomainID sub_id) const
 
void addBlockIDs (const std::set< SubdomainID > &additional_block_ids)
 Add additional block coverage to this. More...
 
template<>
bool notEqual (const MooseEnum &val1, const MooseEnum &val2)
 
SubProblem & getSubProblem () const
 
bool shouldDuplicateInitialExecution () const
 
virtual Real spatialValue (const Point &) const
 
virtual const std::vector< Point > spatialPoints () const
 
void gatherSum (T &value)
 
void gatherMax (T &value)
 
void gatherMin (T &value)
 
void gatherProxyValueMax (T1 &proxy, T2 &value)
 
void gatherProxyValueMin (T1 &proxy, T2 &value)
 
void setPrimaryThreadCopy (UserObject *primary)
 
UserObject * primaryThreadCopy ()
 
std::set< UserObjectName > getDependObjects () const
 
virtual bool needThreadedCopy () const
 
const std::set< std::string > & getRequestedItems () override
 
const std::set< std::string > & getSuppliedItems () override
 
unsigned int systemNumber () 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
 
virtual void initialSetup ()
 
virtual void timestepSetup ()
 
virtual void jacobianSetup ()
 
virtual void residualSetup ()
 
virtual void customSetup (const ExecFlagType &)
 
const ExecFlagEnum & getExecuteOnEnum () 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
 
const std::vector< MooseVariableScalar *> & getCoupledMooseScalarVars ()
 
const std::set< TagID > & getScalarVariableCoupleableVectorTags () const
 
const std::set< TagID > & getScalarVariableCoupleableMatrixTags () const
 
const GenericMaterialProperty< T, is_ad > & getGenericMaterialProperty (const std::string &name, MaterialData &material_data, const unsigned int state=0)
 
const GenericMaterialProperty< T, is_ad > & getGenericMaterialProperty (const std::string &name, const unsigned int state=0)
 
const GenericMaterialProperty< T, is_ad > & getGenericMaterialProperty (const std::string &name, const unsigned int state=0)
 
const MaterialProperty< T > & getMaterialProperty (const std::string &name, MaterialData &material_data, const unsigned int state=0)
 
const MaterialProperty< T > & getMaterialProperty (const std::string &name, const unsigned int state=0)
 
const MaterialProperty< T > & getMaterialProperty (const std::string &name, const unsigned int state=0)
 
const ADMaterialProperty< T > & getADMaterialProperty (const std::string &name, MaterialData &material_data)
 
const ADMaterialProperty< T > & getADMaterialProperty (const std::string &name)
 
const ADMaterialProperty< T > & getADMaterialProperty (const std::string &name)
 
const MaterialProperty< T > & getMaterialPropertyOld (const std::string &name, MaterialData &material_data)
 
const MaterialProperty< T > & getMaterialPropertyOld (const std::string &name)
 
const MaterialProperty< T > & getMaterialPropertyOld (const std::string &name)
 
const MaterialProperty< T > & getMaterialPropertyOlder (const std::string &name, MaterialData &material_data)
 
const MaterialProperty< T > & getMaterialPropertyOlder (const std::string &name)
 
const MaterialProperty< T > & getMaterialPropertyOlder (const std::string &name)
 
const GenericMaterialProperty< T, is_ad > & getGenericMaterialPropertyByName (const MaterialPropertyName &name, MaterialData &material_data, const unsigned int state)
 
const GenericMaterialProperty< T, is_ad > & getGenericMaterialPropertyByName (const MaterialPropertyName &name, const unsigned int state=0)
 
const GenericMaterialProperty< T, is_ad > & getGenericMaterialPropertyByName (const MaterialPropertyName &name, const unsigned int state=0)
 
const MaterialProperty< T > & getMaterialPropertyByName (const MaterialPropertyName &name, MaterialData &material_data, const unsigned int state=0)
 
const MaterialProperty< T > & getMaterialPropertyByName (const MaterialPropertyName &name, const unsigned int state=0)
 
const MaterialProperty< T > & getMaterialPropertyByName (const MaterialPropertyName &name, const unsigned int state=0)
 
const ADMaterialProperty< T > & getADMaterialPropertyByName (const MaterialPropertyName &name, MaterialData &material_data)
 
const ADMaterialProperty< T > & getADMaterialPropertyByName (const MaterialPropertyName &name)
 
const ADMaterialProperty< T > & getADMaterialPropertyByName (const MaterialPropertyName &name)
 
const MaterialProperty< T > & getMaterialPropertyOldByName (const MaterialPropertyName &name, MaterialData &material_data)
 
const MaterialProperty< T > & getMaterialPropertyOldByName (const MaterialPropertyName &name)
 
const MaterialProperty< T > & getMaterialPropertyOldByName (const MaterialPropertyName &name)
 
const MaterialProperty< T > & getMaterialPropertyOlderByName (const MaterialPropertyName &name, MaterialData &material_data)
 
const MaterialProperty< T > & getMaterialPropertyOlderByName (const MaterialPropertyName &name)
 
const MaterialProperty< T > & getMaterialPropertyOlderByName (const MaterialPropertyName &name)
 
std::pair< const MaterialProperty< T > *, std::set< SubdomainID > > getBlockMaterialProperty (const MaterialPropertyName &name)
 
const GenericMaterialProperty< T, is_ad > & getGenericZeroMaterialProperty (const std::string &name)
 
const GenericMaterialProperty< T, is_ad > & getGenericZeroMaterialProperty ()
 
const GenericMaterialProperty< T, is_ad > & getGenericZeroMaterialPropertyByName (const std::string &prop_name)
 
const MaterialProperty< T > & getZeroMaterialProperty (Ts... args)
 
std::set< SubdomainID > getMaterialPropertyBlocks (const std::string &name)
 
std::vector< SubdomainName > getMaterialPropertyBlockNames (const std::string &name)
 
std::set< BoundaryID > getMaterialPropertyBoundaryIDs (const std::string &name)
 
std::vector< BoundaryName > getMaterialPropertyBoundaryNames (const std::string &name)
 
void checkBlockAndBoundaryCompatibility (std::shared_ptr< MaterialBase > discrete)
 
std::unordered_map< SubdomainID, std::vector< MaterialBase *> > buildRequiredMaterials (bool allow_stateful=true)
 
void statefulPropertiesAllowed (bool)
 
bool getMaterialPropertyCalled () const
 
virtual const std::unordered_set< unsigned int > & getMatPropDependencies () const
 
virtual void resolveOptionalProperties ()
 
const GenericMaterialProperty< T, is_ad > & getPossiblyConstantGenericMaterialPropertyByName (const MaterialPropertyName &prop_name, MaterialData &material_data, const unsigned int state)
 
bool isImplicit ()
 
Moose::StateArg determineState () const
 
virtual void threadJoin (const UserObject &) override
 
virtual void threadJoin (const UserObject &) override
 
virtual void subdomainSetup () override
 
virtual void subdomainSetup () override
 
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 GenericOptionalMaterialProperty< T, is_ad > & getGenericOptionalMaterialProperty (const std::string &name, const unsigned int state=0)
 
const GenericOptionalMaterialProperty< T, is_ad > & getGenericOptionalMaterialProperty (const std::string &name, const unsigned int state=0)
 
const OptionalMaterialProperty< T > & getOptionalMaterialProperty (const std::string &name, const unsigned int state=0)
 
const OptionalMaterialProperty< T > & getOptionalMaterialProperty (const std::string &name, const unsigned int state=0)
 
const OptionalADMaterialProperty< T > & getOptionalADMaterialProperty (const std::string &name)
 
const OptionalADMaterialProperty< T > & getOptionalADMaterialProperty (const std::string &name)
 
const OptionalMaterialProperty< T > & getOptionalMaterialPropertyOld (const std::string &name)
 
const OptionalMaterialProperty< T > & getOptionalMaterialPropertyOld (const std::string &name)
 
const OptionalMaterialProperty< T > & getOptionalMaterialPropertyOlder (const std::string &name)
 
const OptionalMaterialProperty< T > & getOptionalMaterialPropertyOlder (const std::string &name)
 
MaterialBase & getMaterial (const std::string &name)
 
MaterialBase & getMaterial (const std::string &name)
 
MaterialBase & getMaterialByName (const std::string &name, bool no_warn=false)
 
MaterialBase & getMaterialByName (const std::string &name, bool no_warn=false)
 
bool hasMaterialProperty (const std::string &name)
 
bool hasMaterialProperty (const std::string &name)
 
bool hasMaterialPropertyByName (const std::string &name)
 
bool hasMaterialPropertyByName (const std::string &name)
 
bool hasADMaterialProperty (const std::string &name)
 
bool hasADMaterialProperty (const std::string &name)
 
bool hasADMaterialPropertyByName (const std::string &name)
 
bool hasADMaterialPropertyByName (const std::string &name)
 
bool hasGenericMaterialProperty (const std::string &name)
 
bool hasGenericMaterialProperty (const std::string &name)
 
bool hasGenericMaterialPropertyByName (const std::string &name)
 
bool hasGenericMaterialPropertyByName (const std::string &name)
 
const 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
 
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
 
T & getSampler (const std::string &name)
 
Sampler & getSampler (const std::string &name)
 
T & getSamplerByName (const SamplerName &name)
 
Sampler & getSamplerByName (const SamplerName &name)
 
virtual void meshChanged ()
 
virtual void meshDisplaced ()
 
PerfGraph & perfGraph ()
 
const PostprocessorValue & getPostprocessorValue (const std::string &param_name, const unsigned int index=0) const
 
const PostprocessorValue & getPostprocessorValue (const std::string &param_name, const unsigned int index=0) const
 
const PostprocessorValue & getPostprocessorValueOld (const std::string &param_name, const unsigned int index=0) const
 
const PostprocessorValue & getPostprocessorValueOld (const std::string &param_name, const unsigned int index=0) const
 
const PostprocessorValue & getPostprocessorValueOlder (const std::string &param_name, const unsigned int index=0) const
 
const PostprocessorValue & getPostprocessorValueOlder (const std::string &param_name, const unsigned int index=0) const
 
virtual const PostprocessorValue & getPostprocessorValueByName (const PostprocessorName &name) const
 
virtual const PostprocessorValue & getPostprocessorValueByName (const PostprocessorName &name) const
 
const PostprocessorValue & getPostprocessorValueOldByName (const PostprocessorName &name) const
 
const PostprocessorValue & getPostprocessorValueOldByName (const PostprocessorName &name) const
 
const PostprocessorValue & getPostprocessorValueOlderByName (const PostprocessorName &name) const
 
const PostprocessorValue & getPostprocessorValueOlderByName (const PostprocessorName &name) const
 
bool isVectorPostprocessorDistributed (const std::string &param_name) const
 
bool isVectorPostprocessorDistributed (const std::string &param_name) const
 
bool isVectorPostprocessorDistributedByName (const VectorPostprocessorName &name) const
 
bool isVectorPostprocessorDistributedByName (const VectorPostprocessorName &name) const
 
const 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
 
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 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)
 

Public Attributes

const ConsoleStream _console
 

Static Public Attributes

static constexpr PropertyValue::id_type default_property_id
 
static constexpr PropertyValue::id_type zero_property_id
 
static constexpr auto SYSTEM
 
static constexpr auto NAME
 

Protected Member Functions

virtual void addPostprocessorDependencyHelper (const PostprocessorName &name) const override
 
virtual void addVectorPostprocessorDependencyHelper (const VectorPostprocessorName &name) const override
 
virtual void addUserObjectDependencyHelper (const UserObject &uo) const override
 
void addReporterDependencyHelper (const ReporterName &reporter_name) override
 
const ReporterName & getReporterName (const std::string &param_name) 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
 
const T & getMeshProperty (const std::string &data_name, const std::string &prefix)
 
const T & getMeshProperty (const std::string &data_name)
 
bool hasMeshProperty (const std::string &data_name, const std::string &prefix) const
 
bool hasMeshProperty (const std::string &data_name, const std::string &prefix) const
 
bool hasMeshProperty (const std::string &data_name) const
 
bool hasMeshProperty (const std::string &data_name) const
 
std::string meshPropertyName (const std::string &data_name) const
 
PerfID registerTimedSection (const std::string &section_name, const unsigned int level) const
 
PerfID registerTimedSection (const std::string &section_name, const unsigned int level, const std::string &live_message, const bool print_dots=true) const
 
std::string timedSectionName (const std::string &section_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
 
virtual void checkMaterialProperty (const std::string &name, const unsigned int state)
 
void markMatPropRequested (const std::string &)
 
MaterialPropertyName getMaterialPropertyName (const std::string &name) const
 
void checkExecutionStage ()
 
const T & getReporterValue (const std::string &param_name, const std::size_t time_index=0)
 
const T & getReporterValue (const std::string &param_name, ReporterMode mode, const std::size_t time_index=0)
 
const T & getReporterValue (const std::string &param_name, const std::size_t time_index=0)
 
const T & getReporterValue (const std::string &param_name, ReporterMode mode, const std::size_t time_index=0)
 
const T & getReporterValueByName (const ReporterName &reporter_name, const std::size_t time_index=0)
 
const T & getReporterValueByName (const ReporterName &reporter_name, ReporterMode mode, const std::size_t time_index=0)
 
const T & getReporterValueByName (const ReporterName &reporter_name, const std::size_t time_index=0)
 
const T & getReporterValueByName (const ReporterName &reporter_name, ReporterMode mode, const std::size_t time_index=0)
 
bool hasReporterValue (const std::string &param_name) const
 
bool hasReporterValue (const std::string &param_name) const
 
bool hasReporterValue (const std::string &param_name) const
 
bool hasReporterValue (const std::string &param_name) const
 
bool hasReporterValueByName (const ReporterName &reporter_name) const
 
bool hasReporterValueByName (const ReporterName &reporter_name) const
 
bool hasReporterValueByName (const ReporterName &reporter_name) const
 
bool hasReporterValueByName (const ReporterName &reporter_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)
 

Static Protected Member Functions

static std::string meshPropertyName (const std::string &data_name, const std::string &prefix)
 

Protected Attributes

SubProblem & _subproblem
 
FEProblemBase & _fe_problem
 
SystemBase & _sys
 
const THREAD_ID _tid
 
Assembly & _assembly
 
const Moose::CoordinateSystemType & _coord_sys
 
const bool _duplicate_initial_execution
 
std::set< std::string > _depend_uo
 
const bool & _enabled
 
MooseApp & _app
 
const std::string _type
 
const std::string _name
 
const InputParameters & _pars
 
Factory & _factory
 
ActionFactory & _action_factory
 
const ExecFlagEnum & _execute_enum
 
const ExecFlagType & _current_execute_flag
 
MooseApp & _restartable_app
 
const std::string _restartable_system_name
 
const THREAD_ID _restartable_tid
 
const bool _restartable_read_only
 
FEProblemBase & _mci_feproblem
 
FEProblemBase & _mdi_feproblem
 
MooseApp & _pg_moose_app
 
const std::string _prefix
 
FEProblemBase & _sc_fe_problem
 
const THREAD_ID _sc_tid
 
const Real & _real_zero
 
const VariableValue & _scalar_zero
 
const Point & _point_zero
 
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 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
 
const Parallel::Communicator & _communicator
 

Static Protected Attributes

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

Private Member Functions

const InputParameters & getParams (SubdomainID sub_id) const
 

Static Private Member Functions

template<typename T >
static bool notEqual (const T &val1, const T &val2)
 
static InputParameters validTrackerParams ()
 
template<typename T >
static void set (const std::string &name, const T &value, InputParameters &params)
 

Private Attributes

std::unordered_map< SubdomainID, InputParameters > _block_id_to_params
 

Detailed Description

Object for tracking what kernels have been added to an INSAD simulation.

This is used to determine what properties to calculate in the INSADMaterial, which is important particularly for ensuring that we have consistenly included all the strong terms for stabilization methods like PSPG and SUPG

Definition at line 39 of file INSADObjectTracker.h.

Constructor & Destructor Documentation

◆ INSADObjectTracker()

INSADObjectTracker::INSADObjectTracker ( const InputParameters &  parameters)

Definition at line 76 of file INSADObjectTracker.C.

77  : GeneralUserObject(parameters)
78 {
79 }
GeneralUserObject::GeneralUserObject
GeneralUserObject(const InputParameters &parameters)
GeneralUserObject::parameters
const InputParameters & parameters() const

Member Function Documentation

◆ addBlockIDs()

void INSADObjectTracker::addBlockIDs ( const std::set< SubdomainID > &  additional_block_ids)

Add additional block coverage to this.

Definition at line 102 of file INSADObjectTracker.C.

103 {
104  for (const auto sub_id : additional_block_ids)
105  _block_id_to_params.emplace(sub_id, validTrackerParams());
106 }
INSADObjectTracker::validTrackerParams
static InputParameters validTrackerParams()
Definition: INSADObjectTracker.C:24
INSADObjectTracker::_block_id_to_params
std::unordered_map< SubdomainID, InputParameters > _block_id_to_params
Definition: INSADObjectTracker.h:76

◆ execute()

virtual void INSADObjectTracker::execute ( )
inlinefinalvirtual

Implements GeneralUserObject.

Definition at line 62 of file INSADObjectTracker.h.

62 {}

◆ finalize()

virtual void INSADObjectTracker::finalize ( )
inlinefinalvirtual

Implements GeneralUserObject.

Definition at line 63 of file INSADObjectTracker.h.

63 {}

◆ get()

template<typename T >
const T & INSADObjectTracker::get ( const std::string &  name,
SubdomainID  sub_id 
) const

Get the internal parameter name.

This will check whether name has already been set by the user. If it has not, then we will error

Definition at line 121 of file INSADObjectTracker.h.

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

122 {
123  const InputParameters & params = getParams(sub_id);
124 
125  if (!params.isParamValid(name))
126  mooseError("The parameter ", name, " is being retrieved before being set");
127 
128  return params.get<T>(name);
129 }
InputParameters::get
std::vector< std::pair< R1, R2 > > get(const std::string &param1, const std::string &param2) const
INSADObjectTracker::getParams
const InputParameters & getParams(SubdomainID sub_id) const
Definition: INSADObjectTracker.C:115
GeneralUserObject::name
virtual const std::string & name() const
GeneralUserObject::mooseError
void mooseError(Args &&... args) const
InputParameters::isParamValid
bool isParamValid(const std::string &name) const

◆ getParams()

const InputParameters & INSADObjectTracker::getParams ( SubdomainID  sub_id) const
private

Definition at line 115 of file INSADObjectTracker.C.

Referenced by get(), isTrackerParamValid(), and set().

116 {
117  auto map_it = _block_id_to_params.find(sub_id);
118  if (map_it == _block_id_to_params.end())
119  mooseError("The requested sub_id is not a key in INSADObjectTracker::_block_id_to_params. Make "
120  "sure that your INSAD residual objects have block restrictions that are covered by "
121  "INSADMaterial (and derived) material objects");
122 
123  return map_it->second;
124 }
INSADObjectTracker::_block_id_to_params
std::unordered_map< SubdomainID, InputParameters > _block_id_to_params
Definition: INSADObjectTracker.h:76
GeneralUserObject::mooseError
void mooseError(Args &&... args) const

◆ initialize()

virtual void INSADObjectTracker::initialize ( )
inlinefinalvirtual

Implements GeneralUserObject.

Definition at line 61 of file INSADObjectTracker.h.

61 {}

◆ isTrackerParamValid()

bool INSADObjectTracker::isTrackerParamValid ( const std::string &  name,
SubdomainID  sub_id 
) const

Definition at line 109 of file INSADObjectTracker.C.

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

110 {
111  return getParams(sub_id).isParamValid(name);
112 }
INSADObjectTracker::getParams
const InputParameters & getParams(SubdomainID sub_id) const
Definition: INSADObjectTracker.C:115
GeneralUserObject::name
virtual const std::string & name() const
InputParameters::isParamValid
bool isParamValid(const std::string &name) const

◆ notEqual() [1/2]

template<typename T >
bool INSADObjectTracker::notEqual ( const T &  val1,
const T &  val2 
)
staticprivate

Definition at line 88 of file INSADObjectTracker.h.

Referenced by set().

89 {
90  return val1 != val2;
91 }

◆ notEqual() [2/2]

bool INSADObjectTracker::notEqual ( const MooseEnum &  val1,
const MooseEnum &  val2 
)

Definition at line 96 of file INSADObjectTracker.C.

97 {
98  return !val1.compareCurrent(val2);
99 }
MooseEnum::compareCurrent
bool compareCurrent(const MooseEnum &other, CompareMode mode=CompareMode::COMPARE_NAME) const

◆ set() [1/2]

template<typename T >
void INSADObjectTracker::set ( const std::string &  name,
const T &  value,
SubdomainID  sub_id 
)

Set the internal parameter name to value.

This will check whether name has already been set and if so, it will whether the old and new values are consistent. If they are not, then we will error

Definition at line 114 of file INSADObjectTracker.h.

Referenced by INSADEnergyAmbientConvection::INSADEnergyAmbientConvection(), INSADEnergySource::INSADEnergySource(), INSADGravityForce::INSADGravityForce(), INSADHeatConductionTimeDerivative::INSADHeatConductionTimeDerivative(), INSADMomentumCoupledForce::INSADMomentumCoupledForce(), INSADMomentumNoBCBC::INSADMomentumNoBCBC(), INSADMomentumPressure::INSADMomentumPressure(), INSADMomentumTimeDerivative::INSADMomentumTimeDerivative(), and INSADMomentumViscous::INSADMomentumViscous().

115 {
116  INSADObjectTracker::set(name, value, const_cast<InputParameters &>(getParams(sub_id)));
117 }
INSADObjectTracker::set
void set(const std::string &name, const T &value, SubdomainID sub_id)
Set the internal parameter name to value.
Definition: INSADObjectTracker.h:114
INSADObjectTracker::getParams
const InputParameters & getParams(SubdomainID sub_id) const
Definition: INSADObjectTracker.C:115
GeneralUserObject::name
virtual const std::string & name() const

◆ set() [2/2]

template<typename T >
void INSADObjectTracker::set ( const std::string &  name,
const T &  value,
InputParameters &  params 
)
staticprivate

Definition at line 98 of file INSADObjectTracker.h.

99 {
100  if (params.isParamSetByUser(name))
101  {
102  const T & current_value = params.get<T>(name);
103  if (INSADObjectTracker::notEqual(current_value, value))
104  ::mooseError("Two INSADObjects set different values for the parameter ", name);
105  }
106  else if (!params.have_parameter<T>(name))
107  ::mooseError("Attempting to set parameter ", name, " that is not a valid param");
108  else
109  params.set<T>(name) = value;
110 }
InputParameters::get
std::vector< std::pair< R1, R2 > > get(const std::string &param1, const std::string &param2) const
InputParameters::set
T & set(const std::string &name, bool quiet_mode=false)
GeneralUserObject::name
virtual const std::string & name() const
INSADObjectTracker::notEqual
static bool notEqual(const T &val1, const T &val2)
Definition: INSADObjectTracker.h:88
InputParameters::have_parameter
bool have_parameter(std::string_view name) const
InputParameters::isParamSetByUser
bool isParamSetByUser(const std::string &name) const
GeneralUserObject::mooseError
void mooseError(Args &&... args) const

◆ validParams()

InputParameters INSADObjectTracker::validParams ( )
static

Definition at line 15 of file INSADObjectTracker.C.

Referenced by INSADMaterial::INSADMaterial().

16 {
17  InputParameters params = GeneralUserObject::validParams();
18  params.addClassDescription("User object used to track the kernels added to an INS simulation "
19  "and determine what properties to calculate in INSADMaterial");
20  return params;
21 }
GeneralUserObject::validParams
static InputParameters validParams()
InputParameters::addClassDescription
void addClassDescription(const std::string &doc_string)

◆ validTrackerParams()

InputParameters INSADObjectTracker::validTrackerParams ( )
staticprivate

Definition at line 24 of file INSADObjectTracker.C.

Referenced by addBlockIDs().

25 {
26  InputParameters params = emptyInputParameters();
27  params.addParam<bool>("integrate_p_by_parts", "Whether to integrate the pressure by parts");
28  MooseEnum viscous_form("traction laplace", "laplace");
29  params.addParam<MooseEnum>("viscous_form",
30  viscous_form,
31  "The form of the viscous term. Options are 'traction' or 'laplace'");
32  params.addParam<bool>(
33  "has_boussinesq", false, "Whether the simulation has the boussinesq approximation");
34  params.addParam<MaterialPropertyName>(
35  "alpha", "The alpha material property for the boussinesq approximation");
36  params.addParam<MaterialPropertyName>("ref_temp", "The reference temperature material property");
37  params.addParam<std::string>("temperature", "The temperature variable");
38  params.addParam<RealVectorValue>("gravity", "Direction of the gravity vector");
39  params.addParam<bool>(
40  "has_gravity",
41  false,
42  "Whether the simulation has a gravity force imposed on the momentum equation");
43  params.addParam<bool>("has_transient", false, "Whether the momentum equations are transient");
44  params.addParam<bool>("has_energy_transient", false, "Whether the energy equation is transient");
45 
46  addAmbientConvectionParams(params);
47 
48  params.addParam<bool>(
49  "has_heat_source", false, "Whether there is a heat source function object in the simulation");
50  params.addParam<FunctionName>("heat_source_function", "The function describing the heat source");
51  params.addParam<std::string>(
52  "heat_source_var",
53  "Variable describing the volumetric heat source. Note that if this variable evaluates to a "
54  "negative number, then this object will be an energy sink");
55 
56  params.addParam<bool>(
57  "has_coupled_force",
58  false,
59  "Whether the simulation has a force due to a coupled vector variable/vector function");
60  params.addParam<std::vector<VariableName>>("coupled_force_var",
61  "Variables imposing coupled forces");
62  params.addParam<std::vector<FunctionName>>("coupled_force_vector_function",
63  "The function(s) standing in as a coupled force(s)");
64 
65  params.addParam<bool>("has_advected_mesh",
66  false,
67  "Whether the fluid domain is undergoing displacement in which case we must "
68  "add an advecting mesh term to correct the material velocity.");
69  params.addParam<VariableName>("disp_x", "The x displacement");
70  params.addParam<VariableName>("disp_y", "The y displacement");
71  params.addParam<VariableName>("disp_z", "The z displacement");
72  params.addParamNamesToGroup("has_advected_mesh disp_x disp_y disp_z", "Moving mesh");
73  return params;
74 }
InputParameters::addParam
void addParam(const std::string &name, const std::initializer_list< typename T::value_type > &value, const std::string &doc_string)
emptyInputParameters
InputParameters emptyInputParameters()
addAmbientConvectionParams
void addAmbientConvectionParams(InputParameters &params)
Global for adding ambient convection parameters.
Definition: INSADObjectTracker.C:82
InputParameters::addParamNamesToGroup
void addParamNamesToGroup(const std::string &space_delim_names, const std::string group_name)

Member Data Documentation

◆ _block_id_to_params

std::unordered_map<SubdomainID, InputParameters> INSADObjectTracker::_block_id_to_params
private

Definition at line 76 of file INSADObjectTracker.h.

Referenced by addBlockIDs(), and getParams().

The documentation for this class was generated from the following files:
Generated on Fri Jul 18 2025 13:47:53 for https://mooseframework.inl.gov by   doxygen 1.8.14