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 | Private Member Functions | List of all members
HeatConductionPhysicsBase Class Reference

Base class to host common parameters and attributes to all Physics solving the heat conduction equation. More...

#include <HeatConductionPhysicsBase.h>

Inheritance diagram for HeatConductionPhysicsBase:
[legend]

Public Types

typedef DataFileName DataFileParameterType
 

Public Member Functions

 HeatConductionPhysicsBase (const InputParameters &parameters)
 
virtual InputParameters getAdditionalRMParams () const
 
virtual void act () override final
 
virtual void actOnAdditionalTasks ()
 
void addBlocks (const std::vector< SubdomainName > &blocks)
 
void addBlocksById (const std::vector< SubdomainID > &block_ids)
 
const std::vector< SubdomainName > & blocks () const
 
bool checkBlockRestrictionIdentical (const std::string &object_name, const std::vector< SubdomainName > &blocks, const bool error_if_not_identical=true) const
 
const T * getCoupledPhysics (const PhysicsName &phys_name, const bool allow_fail=false) const
 
const std::vector< T *> getCoupledPhysics (const bool allow_fail=false) const
 
unsigned int dimension () const
 
const ActionComponent & getActionComponent (const ComponentName &comp_name) const
 
void checkComponentType (const ActionComponent &component) const
 
virtual void addComponent (const ActionComponent &component)
 
const std::vector< VariableName > & solverVariableNames () const
 
const std::vector< VariableName > & auxVariableNames () const
 
void timedAct ()
 
MooseObjectName uniqueActionName () const
 
const std::string & specificTaskName () const
 
const std::set< std::string > & getAllTasks () const
 
void appendTask (const std::string &task)
 
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
 
PerfGraph & perfGraph ()
 
void assertParamDefined (const std::string &libmesh_dbg_var(param)) 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 ()
 

Public Attributes

const ConsoleStream _console
 

Static Public Attributes

static constexpr auto SYSTEM
 
static constexpr auto NAME
 

Protected Member Functions

void assertParamDefined (const std::string &param) const
 
bool isTransient () const
 
Factory & getFactory ()
 
Factory & getFactory () const
 
virtual FEProblemBase & getProblem ()
 
virtual const FEProblemBase & getProblem () const
 
void prepareCopyVariablesFromMesh () const
 
void copyVariablesFromMesh (const std::vector< VariableName > &variables_to_copy, bool are_nonlinear=true)
 
std::string prefix () const
 
void saveSolverVariableName (const VariableName &var_name)
 
void saveAuxVariableName (const VariableName &var_name)
 
bool variableExists (const VariableName &var_name, bool error_if_aux) const
 
bool solverVariableExists (const VariableName &var_name) const
 
const SolverSystemName & getSolverSystem (unsigned int variable_index) const
 
const SolverSystemName & getSolverSystem (const VariableName &variable_name) const
 
void addRequiredPhysicsTask (const std::string &task)
 
void assignBlocks (InputParameters &params, const std::vector< SubdomainName > &blocks) const
 
bool allMeshBlocks (const std::vector< SubdomainName > &blocks) const
 
bool allMeshBlocks (const std::set< SubdomainName > &blocks) const
 
std::set< SubdomainID > getSubdomainIDs (const std::set< SubdomainName > &blocks) const
 
std::vector< std::string > getSubdomainNamesAndIDs (const std::set< SubdomainID > &blocks) const
 
void addPetscPairsToPetscOptions (const std::vector< std::pair< MooseEnumItem, std::string >> &petsc_pair_options)
 
bool isVariableFV (const VariableName &var_name) const
 
bool isVariableScalar (const VariableName &var_name) const
 
bool shouldCreateVariable (const VariableName &var_name, const std::vector< SubdomainName > &blocks, const bool error_if_aux)
 
bool shouldCreateIC (const VariableName &var_name, const std::vector< SubdomainName > &blocks, const bool ic_is_default_ic, const bool error_if_already_defined) const
 
bool shouldCreateTimeDerivative (const VariableName &var_name, const std::vector< SubdomainName > &blocks, const bool error_if_already_defined) const
 
void reportPotentiallyMissedParameters (const std::vector< std::string > &param_names, const std::string &object_type) const
 
bool addRelationshipManagers (Moose::RelationshipManagerType when_type, const InputParameters &moose_object_pars)
 
void associateWithParameter (const std::string &param_name, InputParameters &params) const
 
void associateWithParameter (const InputParameters &from_params, const std::string &param_name, InputParameters &params) 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
 
void checkParamsBothSetOrNotSet (const std::string &param1, const std::string &param2) const
 
void checkSecondParamSetOnlyIfFirstOneTrue (const std::string &param1, const std::string &param2) const
 
void checkSecondParamSetOnlyIfFirstOneSet (const std::string &param1, const std::string &param2) const
 
void checkSecondParamNotSetIfFirstOneSet (const std::string &param1, const std::string &param2) const
 
void checkVectorParamsSameLength (const std::string &param1, const std::string &param2) const
 
void checkVectorParamAndMultiMooseEnumLength (const std::string &param1, const std::string &param2) const
 
void checkTwoDVectorParamsSameLength (const std::string &param1, const std::string &param2) const
 
void checkVectorParamsNoOverlap (const std::vector< std::string > &param_vecs) const
 
void checkTwoDVectorParamsNoRespectiveOverlap (const std::vector< std::string > &param_vecs) const
 
void checkTwoDVectorParamInnerSameLengthAsOneDVector (const std::string &param1, const std::string &param2) const
 
void checkTwoDVectorParamMultiMooseEnumSameLength (const std::string &param1, const std::string &param2, const bool error_for_param2) const
 
void checkVectorParamNotEmpty (const std::string &param1) const
 
void checkVectorParamsSameLengthIfSet (const std::string &param1, const std::string &param2, const bool ignore_empty_default_param2=false) const
 
void checkVectorParamLengthSameAsCombinedOthers (const std::string &param1, const std::string &param2, const std::string &param3) const
 
void checkBlockwiseConsistency (const std::string &block_param_name, const std::vector< std::string > &parameter_names) const
 
bool parameterConsistent (const InputParameters &other_param, const std::string &param_name) const
 
void warnInconsistent (const InputParameters &parameters, const std::string &param_name) const
 
void errorDependentParameter (const std::string &param1, const std::string &value_not_set, const std::vector< std::string > &dependent_params) const
 
void errorInconsistentDependentParameter (const std::string &param1, const std::string &value_set, const std::vector< std::string > &dependent_params) const
 

Static Protected Member Functions

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

Protected Attributes

const VariableName & _temperature_name
 Name of the temperature variable. More...
 
std::vector< SolverSystemName > _system_names
 
std::vector< unsigned int > _system_numbers
 
const bool _verbose
 
const MooseEnum & _preconditioning
 
std::vector< SubdomainName > _blocks
 
std::string _registered_identifier
 
std::string _specific_task_name
 
std::set< std::string > _all_tasks
 
ActionWarehouse & _awh
 
const std::string & _current_task
 
std::shared_ptr< MooseMesh > & _mesh
 
std::shared_ptr< MooseMesh > & _displaced_mesh
 
std::shared_ptr< FEProblemBase > & _problem
 
PerfID _act_timer
 
MooseApp & _app
 
const std::string _type
 
const std::string _name
 
const InputParameters & _pars
 
Factory & _factory
 
ActionFactory & _action_factory
 
MooseApp & _pg_moose_app
 
const std::string _prefix
 
const Parallel::Communicator & _communicator
 

Private Member Functions

virtual void addPreconditioning () override
 
virtual void addInitialConditions () override
 

Detailed Description

Base class to host common parameters and attributes to all Physics solving the heat conduction equation.

Definition at line 18 of file HeatConductionPhysicsBase.h.

Constructor & Destructor Documentation

◆ HeatConductionPhysicsBase()

HeatConductionPhysicsBase::HeatConductionPhysicsBase ( const InputParameters &  parameters)

Definition at line 67 of file HeatConductionPhysicsBase.C.

68  : PhysicsBase(parameters), _temperature_name(getParam<VariableName>("temperature_name"))
69 {
70  // Save variables (for initialization from file for example)
71  saveSolverVariableName(_temperature_name);
72 
73  // Parameter checking
74  checkVectorParamsSameLength<BoundaryName, MooseFunctorName>("heat_flux_boundaries",
75  "boundary_heat_fluxes");
76  checkVectorParamsSameLength<BoundaryName, MooseFunctorName>("fixed_temperature_boundaries",
77  "boundary_temperatures");
78  checkVectorParamsNoOverlap<BoundaryName>({"heat_flux_boundaries",
79  "insulated_boundaries",
80  "fixed_temperature_boundaries",
81  "fixed_convection_boundaries"});
82 
83  addRequiredPhysicsTask("add_preconditioning");
84 }
PhysicsBase::addRequiredPhysicsTask
void addRequiredPhysicsTask(const std::string &task)
PhysicsBase::PhysicsBase
PhysicsBase(const InputParameters &parameters)
PhysicsBase::parameters
const InputParameters & parameters() const
HeatConductionPhysicsBase::_temperature_name
const VariableName & _temperature_name
Name of the temperature variable.
Definition: HeatConductionPhysicsBase.h:27
PhysicsBase::saveSolverVariableName
void saveSolverVariableName(const VariableName &var_name)

Member Function Documentation

◆ addInitialConditions()

void HeatConductionPhysicsBase::addInitialConditions ( )
overrideprivatevirtual

Reimplemented from PhysicsBase.

Definition at line 87 of file HeatConductionPhysicsBase.C.

88 {
89  // error on inconsistent user selections
90  if (getParam<bool>("initialize_variables_from_mesh_file") &&
91  isParamSetByUser("initial_temperature"))
92  paramError("initial_temperature",
93  "Initial temperature should not be set if the variables should be initialized from "
94  "the mesh file");
95  // do not set initial conditions if we load from file
96  if (getParam<bool>("initialize_variables_from_mesh_file"))
97  return;
98 
99  // Always obey the user, but dont set a hidden default when restarting
100  if (shouldCreateIC(_temperature_name,
101  _blocks,
102  /*whether IC is a default*/ !isParamSetByUser("initial_temperature"),
103  /*error if already an IC*/ isParamSetByUser("initial_temperature")))
104  {
105  InputParameters params = getFactory().getValidParams("FunctionIC");
106  assignBlocks(params, _blocks);
107  params.set<VariableName>("variable") = _temperature_name;
108  params.set<FunctionName>("function") = getParam<FunctionName>("initial_temperature");
109  getProblem().addInitialCondition("FunctionIC", prefix() + _temperature_name + "_ic", params);
110  }
111 }
PhysicsBase::prefix
std::string prefix() const
PhysicsBase::assignBlocks
void assignBlocks(InputParameters &params, const std::vector< SubdomainName > &blocks) const
PhysicsBase::getFactory
Factory & getFactory()
InputParameters::set
T & set(const std::string &name, bool quiet_mode=false)
Factory::getValidParams
InputParameters getValidParams(const std::string &name) const
PhysicsBase::shouldCreateIC
bool shouldCreateIC(const VariableName &var_name, const std::vector< SubdomainName > &blocks, const bool ic_is_default_ic, const bool error_if_already_defined) const
PhysicsBase::_blocks
std::vector< SubdomainName > _blocks
FEProblemBase::addInitialCondition
virtual void addInitialCondition(const std::string &ic_name, const std::string &name, InputParameters &parameters)
PhysicsBase::getProblem
virtual FEProblemBase & getProblem()
PhysicsBase::paramError
void paramError(const std::string &param, Args... args) const
PhysicsBase::isParamSetByUser
bool isParamSetByUser(const std::string &nm) const
HeatConductionPhysicsBase::_temperature_name
const VariableName & _temperature_name
Name of the temperature variable.
Definition: HeatConductionPhysicsBase.h:27

◆ addPreconditioning()

void HeatConductionPhysicsBase::addPreconditioning ( )
overrideprivatevirtual

Reimplemented from PhysicsBase.

Definition at line 114 of file HeatConductionPhysicsBase.C.

115 {
116  // Use a multigrid method, known to work for elliptic problems such as diffusion
117  if (_preconditioning == "default")
118  {
119  // We only pass petsc options as that's all that's needed to set up the preconditioner
120  const auto option_pair1 =
121  std::make_pair<MooseEnumItem, std::string>(MooseEnumItem("-pc_type"), "hypre");
122  const auto option_pair2 =
123  std::make_pair<MooseEnumItem, std::string>(MooseEnumItem("-pc_hypre_type"), "boomeramg");
124  addPetscPairsToPetscOptions({option_pair1, option_pair2});
125  }
126 }
PhysicsBase::addPetscPairsToPetscOptions
void addPetscPairsToPetscOptions(const std::vector< std::pair< MooseEnumItem, std::string >> &petsc_pair_options)
PhysicsBase::_preconditioning
const MooseEnum & _preconditioning

◆ validParams()

InputParameters HeatConductionPhysicsBase::validParams ( )
static

Definition at line 13 of file HeatConductionPhysicsBase.C.

Referenced by HeatConductionCG::validParams(), and HeatConductionFV::validParams().

14 {
15  InputParameters params = PhysicsBase::validParams();
16  params.addClassDescription("Add the heat conduction physics");
17 
18  params.addParam<VariableName>("temperature_name", "T", "Variable name for the temperature");
19  params.addParam<VariableName>("heat_source_var", "Variable providing the heat source");
20  params.addParam<std::vector<SubdomainName>>("heat_source_blocks",
21  "Block restriction of the heat source");
22  params.addParam<MooseFunctorName>("heat_source_functor", "Functor providing the heat source");
23 
24  params.addParam<FunctionName>(
25  "initial_temperature", 300, "Initial value of the temperature variable");
26 
27  // Boundary conditions
28  params.addParam<std::vector<BoundaryName>>(
29  "heat_flux_boundaries", {}, "Boundaries on which to apply a heat flux");
30  params.addParam<std::vector<MooseFunctorName>>(
31  "boundary_heat_fluxes",
32  {},
33  "Functors to compute the heat flux on each boundary in 'heat_flux_boundaries'");
34  params.addParam<std::vector<BoundaryName>>(
35  "insulated_boundaries", {}, "Boundaries on which to apply a zero heat flux");
36  params.addParam<std::vector<BoundaryName>>(
37  "fixed_temperature_boundaries", {}, "Boundaries on which to apply a fixed temperature");
38  params.addParam<std::vector<MooseFunctorName>>(
39  "boundary_temperatures",
40  {},
41  "Functors to compute the heat flux on each boundary in 'fixed_temperature_boundaries'");
42  params.addParam<std::vector<BoundaryName>>(
43  "fixed_convection_boundaries",
44  {},
45  "Boundaries on which to apply convection with a neighboring fluid");
46  params.addParam<std::vector<MooseFunctorName>>(
47  "fixed_convection_T_fluid",
48  {},
49  "Temperature of the convecting fluid. The user should note that numerous heat transfer "
50  "coefficient correlation will require this fluid temperature to be the bulk fluid "
51  "temperature / fluid temperature at an infinite distance.");
52  params.addParam<std::vector<MooseFunctorName>>(
53  "fixed_convection_htc", {}, "Heat transfer coefficient for convection with a fluid");
54  params.addParamNamesToGroup(
55  "heat_flux_boundaries insulated_boundaries fixed_temperature_boundaries boundary_heat_fluxes "
56  "boundary_temperatures",
57  "Thermal boundaries");
58 
59  // Preconditioning is implemented so let's use it by default
60  MooseEnum pc_options("default defer", "default");
61  params.addParam<MooseEnum>(
62  "preconditioning", pc_options, "Which preconditioning to use for this Physics");
63 
64  return params;
65 }
InputParameters::addParam
void addParam(const std::string &name, const std::initializer_list< typename T::value_type > &value, const std::string &doc_string)
PhysicsBase::validParams
static InputParameters validParams()
InputParameters::addClassDescription
void addClassDescription(const std::string &doc_string)
InputParameters::addParamNamesToGroup
void addParamNamesToGroup(const std::string &space_delim_names, const std::string group_name)

Member Data Documentation

◆ _temperature_name

const VariableName& HeatConductionPhysicsBase::_temperature_name
protected

Name of the temperature variable.

Definition at line 27 of file HeatConductionPhysicsBase.h.

Referenced by HeatConductionCG::addFEBCs(), HeatConductionCG::addFEKernels(), HeatConductionFV::addFVBCs(), HeatConductionFV::addFVKernels(), addInitialConditions(), HeatConductionFV::addSolverVariables(), HeatConductionCG::addSolverVariables(), and HeatConductionPhysicsBase().

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