https://mooseframework.inl.gov
Loading...
Searching...
No Matches
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 | Static Private Member Functions | Private Attributes | List of all members
HeatConductionFV Class Reference

Creates all the objects needed to solve the heat conduction equations with a finite volume discretization. More...

#include <HeatConductionFV.h>

Inheritance diagram for HeatConductionFV:
[legend]

Public Types

typedef DataFileName DataFileParameterType
 

Public Member Functions

 HeatConductionFV (const InputParameters &parameters)
 
virtual void addFVBCs () override
 
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
 
bool hasBlocks (const std::vector< SubdomainName > &blocks) 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
 
virtual std::vector< UserObjectName > getSuppliedUserObjects () 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
 
const std::string & name () const
 
std::string typeAndName () const
 
MooseObjectParameterName uniqueParameterName (const std::string &parameter_name) const
 
MooseObjectName uniqueName () const
 
const InputParameters & parameters () const
 
const hit::Node * getHitNode () const
 
bool hasBase () const
 
const std::string & getBase () 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 &name) const
 
void connectControllableParams (const std::string &parameter, const std::string &object_type, const std::string &object_name, const std::string &object_parameter) const
 
void paramError (const std::string &param, Args... args) const
 
void paramWarning (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
 
std::string messagePrefix (const bool hit_prefix=true) const
 
std::string errorPrefix (const std::string &) const
 
void mooseError (Args &&... args) const
 
void mooseDocumentedError (const std::string &repo_name, const unsigned int issue_num, Args &&... args) const
 
void mooseErrorNonPrefixed (Args &&... args) const
 
void mooseWarning (Args &&... args) const
 
void mooseWarning (Args &&... args) const
 
void mooseWarningNonPrefixed (Args &&... args) const
 
void mooseWarningNonPrefixed (Args &&... args) const
 
void mooseDeprecated (Args &&... args) const
 
void mooseDeprecated (Args &&... args) const
 
void mooseDeprecatedNoTrace (Args &&... args) const
 
void mooseInfo (Args &&... args) const
 
void callMooseError (std::string msg, const bool with_prefix, const hit::Node *node=nullptr, const bool show_trace=true) 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 ()
 
static void callMooseError (MooseApp *const app, const InputParameters &params, std::string msg, const bool with_prefix, const hit::Node *node, const bool show_trace=true)
 

Public Attributes

 usingCombinedWarningSolutionWarnings
 
const ConsoleStream _console
 

Static Public Attributes

static const std::string unique_action_name_param
 
static const std::string type_param
 
static const std::string name_param
 
static const std::string unique_name_param
 
static const std::string app_param
 
static const std::string moose_base_param
 
static const std::string kokkos_object_param
 
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 addUserObject (const std::string &uo_type, const std::string &uo_name, InputParameters &params)
 
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 std::string &object_name="") const
 
virtual void checkIntegrity () const
 
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 flagInvalidSolutionInternal (const InvalidSolutionID invalid_solution_id) const
 
InvalidSolutionID registerInvalidSolutionInternal (const std::string &message, const bool warning) 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.
 
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
 
Factory & _factory
 
ActionFactory & _action_factory
 
const std::string & _type
 
const std::string & _name
 
const InputParameters & _pars
 
MooseApp & _pg_moose_app
 
const std::string _prefix
 
const Parallel::Communicator & _communicator
 

Private Member Functions

virtual void initializePhysicsAdditional () override
 
virtual void addSolverVariables () override
 
virtual void addFVKernels () override
 
virtual void addPreconditioning () override
 
virtual void addInitialConditions () override
 
virtual void addRelationshipManagers (Moose::RelationshipManagerType input_rm_type) override
 
bool addRelationshipManagers (Moose::RelationshipManagerType when_type, const InputParameters &moose_object_pars)
 
virtual void addRelationshipManagers (Moose::RelationshipManagerType when_type)
 
void initializePhysics ()
 
virtual void checkIntegrityEarly () const
 
virtual void addAuxiliaryVariables ()
 
virtual void addFEKernels ()
 
virtual void addFVInterpolationMethods ()
 
virtual void addNodalKernels ()
 
virtual void addDiracKernels ()
 
virtual void addDGKernels ()
 
virtual void addScalarKernels ()
 
virtual void addInterfaceKernels ()
 
virtual void addFVInterfaceKernels ()
 
virtual void addFEBCs ()
 
virtual void addNodalBCs ()
 
virtual void addPeriodicBCs ()
 
virtual void addFunctions ()
 
virtual void addAuxiliaryKernels ()
 
virtual void addMaterials ()
 
virtual void addFunctorMaterials ()
 
virtual void addUserObjects ()
 
virtual void addCorrectors ()
 
virtual void addMultiApps ()
 
virtual void addTransfers ()
 
virtual void addPostprocessors ()
 
virtual void addVectorPostprocessors ()
 
virtual void addReporters ()
 
virtual void addOutputs ()
 
virtual void addExecutioner ()
 
virtual void addExecutors ()
 
void checkRequiredTasks () const
 
bool addRelationshipManager (Moose::RelationshipManagerType input_rm_type, const InputParameters &moose_object_pars, std::string rm_name, Moose::RelationshipManagerType rm_type, Moose::RelationshipManagerInputParameterCallback rm_input_parameter_func, Moose::RMSystemType sys_type=Moose::RMSystemType::NONE)
 
virtual std::string meshPropertyPrefix (const std::string &data_name) const
 
const RestartableDataValue & getMeshPropertyInternal (const std::string &data_name, const std::string &prefix) const
 
void mooseErrorInternal (Args &&... args) const
 
const T & forwardGetParam (const std::string &param_name) const
 
const InputParameters & forwardParameters () const
 
bool forwardIsParamSetByUser (const std::string &param_name) const
 
bool forwardIsParamValid (const std::string &param_name) const
 
void forwardParamError (Args &&... args) const
 
void forwardMooseError (Args &&... args) const
 
void forwardMooseWarning (Args &&... args) const
 
const std::string & forwardType () const
 
virtual const std::string & forwardName () const
 
const std::vector< SubdomainName > & forwardBlocks () const
 

Static Private Member Functions

static const hit::Node * getHitNode (const InputParameters &params)
 
static std::string messagePrefix (const InputParameters &params, const bool hit_prefix)
 

Private Attributes

MooseEnum _is_transient
 
std::vector< VariableName > _solver_var_names
 
std::vector< VariableName > _aux_var_names
 
unsigned int _dim
 
std::set< std::string > _required_tasks
 
const ParallelParamObject & _parent
 
MooseApp & _meta_data_app
 
const MooseObject *const _meta_data_object
 
const MooseBase & _si_moose_base
 
const FEProblemBase * _si_problem
 
const PhysicsBase *const _customer_class
 

Detailed Description

Creates all the objects needed to solve the heat conduction equations with a finite volume discretization.

Definition at line 18 of file HeatConductionFV.h.

Constructor & Destructor Documentation

◆ HeatConductionFV()

HeatConductionFV::HeatConductionFV ( const InputParameters &  parameters)

Definition at line 46 of file HeatConductionFV.C.

47 : HeatConductionPhysicsBase(parameters)
48{
49 // Not compatible
50 // TODO: we could bake this into a single call
51 checkParamsBothSetOrNotSet("specific_heat_functor", "density_functor");
52 checkParamsBothSetOrNotSet("specific_heat", "density");
53 checkSecondParamNotSetIfFirstOneSet("specific_heat", "density_functor");
54 checkSecondParamNotSetIfFirstOneSet("specific_heat", "specific_heat_functor");
55 checkSecondParamNotSetIfFirstOneSet("specific_heat_functor", "specific_heat");
56 checkSecondParamNotSetIfFirstOneSet("specific_heat_functor", "density");
57}
HeatConductionPhysicsBase
Base class to host common parameters and attributes to all Physics solving the heat conduction equati...
Definition HeatConductionPhysicsBase.h:19
PhysicsBase::checkSecondParamNotSetIfFirstOneSet
void checkSecondParamNotSetIfFirstOneSet(const std::string &param1, const std::string &param2) const
PhysicsBase::checkParamsBothSetOrNotSet
void checkParamsBothSetOrNotSet(const std::string &param1, const std::string &param2) const
PhysicsBase::parameters
const InputParameters & parameters() const

Member Function Documentation

◆ addFVBCs()

void HeatConductionFV::addFVBCs ( )
overridevirtual

Reimplemented from PhysicsBase.

Definition at line 137 of file HeatConductionFV.C.

138{
139 // We dont need to add anything for insulated boundaries, 0 flux is the default boundary condition
140 if (isParamValid("heat_flux_boundaries"))
141 {
142 const std::string bc_type = "FVFunctorNeumannBC";
143 InputParameters params = getFactory().getValidParams(bc_type);
144 params.set<NonlinearVariableName>("variable") = _temperature_name;
145
146 const auto & heat_flux_boundaries = getParam<std::vector<BoundaryName>>("heat_flux_boundaries");
147 const auto & boundary_heat_fluxes =
148 getParam<std::vector<MooseFunctorName>>("boundary_heat_fluxes");
149 // Optimization if all the same
150 if (std::set<MooseFunctorName>(boundary_heat_fluxes.begin(), boundary_heat_fluxes.end())
151 .size() == 1 &&
152 heat_flux_boundaries.size() > 1)
153 {
154 params.set<std::vector<BoundaryName>>("boundary") = heat_flux_boundaries;
155 params.set<MooseFunctorName>("functor") = boundary_heat_fluxes[0];
156 getProblem().addFVBC(bc_type, prefix() + _temperature_name + "_heat_flux_bc_all", params);
157 }
158 else
159 {
160 for (const auto i : index_range(heat_flux_boundaries))
161 {
162 params.set<std::vector<BoundaryName>>("boundary") = {heat_flux_boundaries[i]};
163 params.set<MooseFunctorName>("functor") = boundary_heat_fluxes[i];
164 getProblem().addFVBC(bc_type,
165 prefix() + _temperature_name + "_heat_flux_bc_" +
166 heat_flux_boundaries[i],
167 params);
168 }
169 }
170 }
171 if (isParamValid("fixed_temperature_boundaries"))
172 {
173 const std::string bc_type = "FVFunctorDirichletBC";
174 InputParameters params = getFactory().getValidParams(bc_type);
175 params.set<NonlinearVariableName>("variable") = _temperature_name;
176
177 const auto & temperature_boundaries =
178 getParam<std::vector<BoundaryName>>("fixed_temperature_boundaries");
179 const auto & boundary_temperatures =
180 getParam<std::vector<MooseFunctorName>>("boundary_temperatures");
181 // Optimization if all the same
182 if (std::set<MooseFunctorName>(boundary_temperatures.begin(), boundary_temperatures.end())
183 .size() == 1 &&
184 temperature_boundaries.size() > 1)
185 {
186 params.set<std::vector<BoundaryName>>("boundary") = temperature_boundaries;
187 params.set<MooseFunctorName>("functor") = boundary_temperatures[0];
188 getProblem().addFVBC(bc_type, prefix() + _temperature_name + "_dirichlet_bc_all", params);
189 }
190 else
191 {
192 for (const auto i : index_range(temperature_boundaries))
193 {
194 params.set<std::vector<BoundaryName>>("boundary") = {temperature_boundaries[i]};
195 params.set<MooseFunctorName>("functor") = boundary_temperatures[i];
196 getProblem().addFVBC(bc_type,
197 prefix() + _temperature_name + "_dirichlet_bc_" +
198 temperature_boundaries[i],
199 params);
200 }
201 }
202 }
203 if (isParamValid("fixed_convection_boundaries"))
204 {
205 const std::string bc_type = "FVFunctorConvectiveHeatFluxBC";
206 InputParameters params = getFactory().getValidParams(bc_type);
207 params.set<NonlinearVariableName>("variable") = _temperature_name;
208 params.set<bool>("is_solid") = true;
209 params.set<MooseFunctorName>("T_solid") = _temperature_name;
210
211 const auto & convective_boundaries =
212 getParam<std::vector<BoundaryName>>("fixed_convection_boundaries");
213 const auto & boundary_T_fluid =
214 getParam<std::vector<MooseFunctorName>>("fixed_convection_T_fluid");
215 const auto & boundary_htc = getParam<std::vector<MooseFunctorName>>("fixed_convection_htc");
216 // Optimization if all the same
217 if (std::set<MooseFunctorName>(boundary_T_fluid.begin(), boundary_T_fluid.end()).size() == 1 &&
218 std::set<MooseFunctorName>(boundary_htc.begin(), boundary_htc.end()).size() == 1 &&
219 convective_boundaries.size() > 1)
220 {
221 params.set<std::vector<BoundaryName>>("boundary") = convective_boundaries;
222 params.set<MooseFunctorName>("T_bulk") = boundary_T_fluid[0];
223 params.set<MooseFunctorName>("heat_transfer_coefficient") = boundary_htc[0];
224 getProblem().addFVBC(
225 bc_type, prefix() + _temperature_name + "_fixed_convection_bc_all", params);
226 }
227 else
228 {
229 for (const auto i : index_range(convective_boundaries))
230 {
231 params.set<std::vector<BoundaryName>>("boundary") = {convective_boundaries[i]};
232 params.set<MooseFunctorName>("T_bulk") = boundary_T_fluid[i];
233 params.set<MooseFunctorName>("heat_transfer_coefficient") = boundary_htc[i];
234 getProblem().addFVBC(bc_type,
235 prefix() + _temperature_name + "_fixed_convection_bc_" +
236 convective_boundaries[i],
237 params);
238 }
239 }
240 }
241}
FEProblemBase::addFVBC
virtual void addFVBC(const std::string &fv_bc_name, const std::string &name, InputParameters &parameters)
Factory::getValidParams
InputParameters getValidParams(const std::string &name) const
HeatConductionPhysicsBase::_temperature_name
const VariableName & _temperature_name
Name of the temperature variable.
Definition HeatConductionPhysicsBase.h:27
InputParameters::set
T & set(const std::string &name, bool quiet_mode=false)
PhysicsBase::isParamValid
bool isParamValid(const std::string &name) const
PhysicsBase::getProblem
virtual FEProblemBase & getProblem()
PhysicsBase::getFactory
Factory & getFactory()
PhysicsBase::prefix
std::string prefix() const
libMesh::index_range
auto index_range(const T &sizable)

◆ addFVKernels()

void HeatConductionFV::addFVKernels ( )
overrideprivatevirtual

Reimplemented from PhysicsBase.

Reimplemented in PNSFVSolidHeatTransferPhysics.

Definition at line 66 of file HeatConductionFV.C.

67{
68 {
69 const std::string kernel_type = "FVDiffusion";
70 InputParameters params = getFactory().getValidParams(kernel_type);
71 assignBlocks(params, _blocks);
72 params.set<NonlinearVariableName>("variable") = _temperature_name;
73 params.set<MooseFunctorName>("coeff") =
74 getParam<MooseFunctorName>("thermal_conductivity_functor");
75 getProblem().addFVKernel(kernel_type, prefix() + _temperature_name + "_conduction", params);
76 }
77 if (isParamValid("heat_source_var"))
78 {
79 const std::string kernel_type = "FVCoupledForce";
80 InputParameters params = getFactory().getValidParams(kernel_type);
81 params.set<NonlinearVariableName>("variable") = _temperature_name;
82 params.set<MooseFunctorName>("v") = getParam<VariableName>("heat_source_var");
83 if (isParamValid("heat_source_blocks"))
84 params.set<std::vector<SubdomainName>>("block") =
85 getParam<std::vector<SubdomainName>>("heat_source_blocks");
86 else
87 assignBlocks(params, _blocks);
88 getProblem().addFVKernel(kernel_type, prefix() + _temperature_name + "_source", params);
89 }
90 if (isParamValid("heat_source_functor"))
91 {
92 const std::string kernel_type = "FVBodyForce";
93 InputParameters params = getFactory().getValidParams(kernel_type);
94 if (isParamValid("heat_source_blocks"))
95 params.set<std::vector<SubdomainName>>("block") =
96 getParam<std::vector<SubdomainName>>("heat_source_blocks");
97 else
98 assignBlocks(params, _blocks);
99 params.set<NonlinearVariableName>("variable") = _temperature_name;
100 const auto & functor_name = getParam<MooseFunctorName>("heat_source_functor");
101 if (MooseUtils::parsesToReal(functor_name))
102 params.set<Real>("value") = std::stod(functor_name);
103 else if (getProblem().hasFunction(functor_name))
104 params.set<FunctionName>("function") = functor_name;
105 else if (getProblem().hasPostprocessorValueByName(functor_name))
106 params.set<PostprocessorName>("postprocessor") = functor_name;
107 else
108 paramError("heat_source_functor",
109 "Unsupported functor type. Consider using 'heat_source_var'.");
110 getProblem().addFVKernel(kernel_type, prefix() + _temperature_name + "_source_functor", params);
111 }
112 if (shouldCreateTimeDerivative(_temperature_name, _blocks, /*error if already defined*/ false))
113 {
114 const bool use_functors =
115 isParamValid("density_functor") || isParamValid("specific_heat_functor");
116 const std::string kernel_type =
117 use_functors ? "FVFunctorHeatConductionTimeDerivative" : "FVHeatConductionTimeDerivative";
118 InputParameters params = getFactory().getValidParams(kernel_type);
119 assignBlocks(params, _blocks);
120 params.set<NonlinearVariableName>("variable") = _temperature_name;
121 if (use_functors)
122 {
123 params.set<MooseFunctorName>("specific_heat") =
124 getParam<MooseFunctorName>("specific_heat_functor");
125 params.set<MooseFunctorName>("density") = getParam<MooseFunctorName>("density_functor");
126 }
127 else
128 {
129 params.applyParameter(parameters(), "specific_heat");
130 params.set<MaterialPropertyName>("density_name") = getParam<MaterialPropertyName>("density");
131 }
132 getProblem().addFVKernel(kernel_type, prefix() + _temperature_name + "_time", params);
133 }
134}
FEProblemBase::hasPostprocessorValueByName
bool hasPostprocessorValueByName(const PostprocessorName &name) const
FEProblemBase::addFVKernel
virtual void addFVKernel(const std::string &kernel_name, const std::string &name, InputParameters &parameters)
InputParameters::applyParameter
void applyParameter(const InputParameters &common, const std::string &common_name, bool allow_private=false)
PhysicsBase::paramError
void paramError(const std::string &param, Args... args) const
PhysicsBase::getParam
const T & getParam(const std::string &name) const
PhysicsBase::shouldCreateTimeDerivative
bool shouldCreateTimeDerivative(const VariableName &var_name, const std::vector< SubdomainName > &blocks, const bool error_if_already_defined) const
PhysicsBase::assignBlocks
void assignBlocks(InputParameters &params, const std::vector< SubdomainName > &blocks) const
PhysicsBase::_blocks
std::vector< SubdomainName > _blocks
MooseUtils::parsesToReal
bool parsesToReal(const std::string &input, Real *parsed_real)
libMesh::Real
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real

◆ addInitialConditions()

void HeatConductionPhysicsBase::addInitialConditions ( )
overrideprivatevirtualinherited

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}
FEProblemBase::addInitialCondition
virtual void addInitialCondition(const std::string &ic_name, const std::string &name, InputParameters &parameters)
PhysicsBase::isParamSetByUser
bool isParamSetByUser(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

◆ addPreconditioning()

void HeatConductionPhysicsBase::addPreconditioning ( )
overrideprivatevirtualinherited

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

◆ addSolverVariables()

void HeatConductionFV::addSolverVariables ( )
overrideprivatevirtual

Reimplemented from PhysicsBase.

Reimplemented in PNSFVSolidHeatTransferPhysics.

Definition at line 244 of file HeatConductionFV.C.

245{
246 if (!shouldCreateVariable(_temperature_name, _blocks, /*error if aux*/ true))
247 {
248 reportPotentiallyMissedParameters({"system_names", "temperature_scaling"},
249 "MooseVariableFVReal");
250 return;
251 }
252
253 const std::string variable_type = "MooseVariableFVReal";
254 InputParameters params = getFactory().getValidParams(variable_type);
255 assignBlocks(params, _blocks);
256 params.set<std::vector<Real>>("scaling") = {getParam<Real>("temperature_scaling")};
257 params.set<SolverSystemName>("solver_sys") = getSolverSystem(_temperature_name);
258
259 getProblem().addVariable(variable_type, _temperature_name, params);
260}
FEProblemBase::addVariable
virtual void addVariable(const std::string &var_type, const std::string &var_name, InputParameters &params)
PhysicsBase::reportPotentiallyMissedParameters
void reportPotentiallyMissedParameters(const std::vector< std::string > &param_names, const std::string &object_type, const std::string &object_name="") const
PhysicsBase::getSolverSystem
const SolverSystemName & getSolverSystem(unsigned int variable_index) const
PhysicsBase::shouldCreateVariable
bool shouldCreateVariable(const VariableName &var_name, const std::vector< SubdomainName > &blocks, const bool error_if_aux)

◆ initializePhysicsAdditional()

void HeatConductionFV::initializePhysicsAdditional ( )
overrideprivatevirtual

Reimplemented from PhysicsBase.

Definition at line 60 of file HeatConductionFV.C.

61{
62 getProblem().needFV();
63}
FEProblemBase::needFV
virtual void needFV() override

◆ validParams()

InputParameters HeatConductionFV::validParams ( )
static

Definition at line 21 of file HeatConductionFV.C.

22{
23 InputParameters params = HeatConductionPhysicsBase::validParams();
24 params.addClassDescription(
25 "Creates the heat conduction equation discretized with nonlinear finite volume");
26
27 // Material properties
28 params.addRequiredParam<MooseFunctorName>("thermal_conductivity_functor",
29 "Thermal conductivity functor material property");
30 params.addParam<MaterialPropertyName>("specific_heat", "Specific heat material property");
31 params.addParam<MooseFunctorName>("specific_heat_functor", "Specific heat functor");
32 params.addParam<MaterialPropertyName>("density", "Density material property");
33 params.addParam<MooseFunctorName>("density_functor", "Density functor");
34 params.addParamNamesToGroup(
35 "thermal_conductivity_functor specific_heat specific_heat_functor density density_functor",
36 "Thermal properties");
37
38 params.addRangeCheckedParam<Real>("temperature_scaling",
39 1,
40 "temperature_scaling > 0",
41 "Scaling factor for the heat conduction equation");
42
43 return params;
44}
HeatConductionPhysicsBase::validParams
static InputParameters validParams()
Definition HeatConductionPhysicsBase.C:13
InputParameters::addParamNamesToGroup
void addParamNamesToGroup(const std::string &space_delim_names, const std::string group_name)
InputParameters::addRequiredParam
void addRequiredParam(const std::string &name, const std::string &doc_string)
InputParameters::addParam
void addParam(const std::string &name, const std::initializer_list< typename T::value_type > &value, const std::string &doc_string)
InputParameters::addClassDescription
void addClassDescription(const std::string &doc_string)
InputParameters::addRangeCheckedParam
void addRangeCheckedParam(const std::string &name, const T &value, const std::string &parsed_function, const std::string &doc_string)

Referenced by PNSFVSolidHeatTransferPhysics::validParams().

Member Data Documentation

◆ _temperature_name

const VariableName& HeatConductionPhysicsBase::_temperature_name
protectedinherited

Name of the temperature variable.

Definition at line 27 of file HeatConductionPhysicsBase.h.

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

The documentation for this class was generated from the following files:
Generated on Fri Aug 21 2026 13:42:54 for https://mooseframework.inl.gov by doxygen 1.9.8