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
HeatConductionCG Class Reference

Creates all the objects needed to solve the heat conduction equations with CG. More...

#include <HeatConductionCG.h>

Inheritance diagram for HeatConductionCG:
[legend]

Public Types

typedef DataFileName DataFileParameterType
 

Public Member Functions

 HeatConductionCG (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 ActionComponentgetActionComponent (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)
 
MooseAppgetMooseApp () const
 
const std::string & type () const
 
virtual const std::string & name () const
 
std::string typeAndName () const
 
std::string errorPrefix (const std::string &error_type) const
 
void callMooseError (std::string msg, const bool with_prefix) const
 
MooseObjectParameterName uniqueParameterName (const std::string &parameter_name) const
 
const InputParametersparameters () const
 
MooseObjectName uniqueName () const
 
const T & getParam (const std::string &name) const
 
std::vector< std::pair< T1, T2 > > getParam (const std::string &param1, const std::string &param2) const
 
const T * queryParam (const std::string &name) const
 
const T & getRenamedParam (const std::string &old_name, const std::string &new_name) const
 
getCheckedPointerParam (const std::string &name, const std::string &error_string="") const
 
bool isParamValid (const std::string &name) const
 
bool isParamSetByUser (const std::string &nm) const
 
void paramError (const std::string &param, Args... args) const
 
void paramWarning (const std::string &param, Args... args) const
 
void paramInfo (const std::string &param, Args... args) const
 
void connectControllableParams (const std::string &parameter, const std::string &object_type, const std::string &object_name, const std::string &object_parameter) const
 
void mooseError (Args &&... args) const
 
void mooseErrorNonPrefixed (Args &&... args) const
 
void mooseDocumentedError (const std::string &repo_name, const unsigned int issue_num, Args &&... args) const
 
void mooseWarning (Args &&... args) const
 
void mooseWarningNonPrefixed (Args &&... args) const
 
void mooseDeprecated (Args &&... args) const
 
void mooseInfo (Args &&... args) const
 
std::string getDataFileName (const std::string &param) const
 
std::string getDataFileNameByName (const std::string &relative_path) const
 
std::string getDataFilePath (const std::string &relative_path) const
 
PerfGraphperfGraph ()
 
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
 
FactorygetFactory ()
 
FactorygetFactory () const
 
virtual FEProblemBasegetProblem ()
 
virtual const FEProblemBasegetProblem () 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< SubdomainIDgetSubdomainIDs (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 bool _use_ad
 Whether to use automatic differentiation. More...
 
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

void addSolverVariables () override
 
void addFEKernels () override
 
void addFEBCs () override
 

Detailed Description

Creates all the objects needed to solve the heat conduction equations with CG.

Definition at line 17 of file HeatConductionCG.h.

Constructor & Destructor Documentation

◆ HeatConductionCG()

HeatConductionCG::HeatConductionCG ( const InputParameters parameters)

Definition at line 44 of file HeatConductionCG.C.

45  : HeatConductionPhysicsBase(parameters), _use_ad(getParam<bool>("use_automatic_differentiation"))
46 {
47 }
HeatConductionPhysicsBase(const InputParameters &parameters)
const bool _use_ad
Whether to use automatic differentiation.
const InputParameters & parameters() const

Member Function Documentation

◆ addFEBCs()

void HeatConductionCG::addFEBCs ( )
overrideprivatevirtual

Reimplemented from PhysicsBase.

Definition at line 110 of file HeatConductionCG.C.

111 {
112  // We dont need to add anything for insulated boundaries, 0 flux is the default boundary condition
113  if (isParamValid("heat_flux_boundaries"))
114  {
115  const std::string bc_type = "FunctorNeumannBC";
116  InputParameters params = getFactory().getValidParams(bc_type);
117  params.set<NonlinearVariableName>("variable") = _temperature_name;
118 
119  const auto & heat_flux_boundaries = getParam<std::vector<BoundaryName>>("heat_flux_boundaries");
120  const auto & boundary_heat_fluxes =
121  getParam<std::vector<MooseFunctorName>>("boundary_heat_fluxes");
122  // Optimization if all the same
123  if (std::set<MooseFunctorName>(boundary_heat_fluxes.begin(), boundary_heat_fluxes.end())
124  .size() == 1 &&
125  heat_flux_boundaries.size() > 1)
126  {
127  params.set<std::vector<BoundaryName>>("boundary") = heat_flux_boundaries;
128  params.set<MooseFunctorName>("functor") = boundary_heat_fluxes[0];
130  bc_type, prefix() + _temperature_name + "_heat_flux_bc_all", params);
131  }
132  else
133  {
134  for (const auto i : index_range(heat_flux_boundaries))
135  {
136  params.set<std::vector<BoundaryName>>("boundary") = {heat_flux_boundaries[i]};
137  params.set<MooseFunctorName>("functor") = boundary_heat_fluxes[i];
139  prefix() + _temperature_name + "_heat_flux_bc_" +
140  heat_flux_boundaries[i],
141  params);
142  }
143  }
144  }
145  if (isParamValid("fixed_temperature_boundaries"))
146  {
147  const std::string bc_type = "FunctorDirichletBC";
148  InputParameters params = getFactory().getValidParams(bc_type);
149  params.set<NonlinearVariableName>("variable") = _temperature_name;
150 
151  const auto & temperature_boundaries =
152  getParam<std::vector<BoundaryName>>("fixed_temperature_boundaries");
153  const auto & boundary_temperatures =
154  getParam<std::vector<MooseFunctorName>>("boundary_temperatures");
155  // Optimization if all the same
156  if (std::set<MooseFunctorName>(boundary_temperatures.begin(), boundary_temperatures.end())
157  .size() == 1 &&
158  temperature_boundaries.size() > 1)
159  {
160  params.set<std::vector<BoundaryName>>("boundary") = temperature_boundaries;
161  params.set<MooseFunctorName>("functor") = boundary_temperatures[0];
163  bc_type, prefix() + _temperature_name + "_dirichlet_bc_all", params);
164  }
165  else
166  {
167  for (const auto i : index_range(temperature_boundaries))
168  {
169  params.set<std::vector<BoundaryName>>("boundary") = {temperature_boundaries[i]};
170  params.set<MooseFunctorName>("functor") = boundary_temperatures[i];
172  prefix() + _temperature_name + "_dirichlet_bc_" +
173  temperature_boundaries[i],
174  params);
175  }
176  }
177  }
178  if (isParamValid("fixed_convection_boundaries"))
179  {
180  const std::string bc_type = "ADConvectiveHeatFluxBC";
181  InputParameters params = getFactory().getValidParams(bc_type);
182  params.set<NonlinearVariableName>("variable") = _temperature_name;
183 
184  const auto & convective_boundaries =
185  getParam<std::vector<BoundaryName>>("fixed_convection_boundaries");
186  const auto & boundary_T_fluid =
187  getParam<std::vector<MooseFunctorName>>("fixed_convection_T_fluid");
188  const auto & boundary_htc = getParam<std::vector<MooseFunctorName>>("fixed_convection_htc");
189 
190  if (!_use_ad && convective_boundaries.size())
191  paramInfo("use_automatic_differentiation",
192  "No-AD is not implemented for convection boundaries");
193 
194  // Optimization if all the same
195  if (std::set<MooseFunctorName>(boundary_T_fluid.begin(), boundary_T_fluid.end()).size() == 1 &&
196  std::set<MooseFunctorName>(boundary_htc.begin(), boundary_htc.end()).size() == 1 &&
197  convective_boundaries.size() > 1)
198  {
199  params.set<std::vector<BoundaryName>>("boundary") = convective_boundaries;
200  params.set<MooseFunctorName>("T_infinity_functor") = boundary_T_fluid[0];
201  params.set<MooseFunctorName>("heat_transfer_coefficient_functor") = boundary_htc[0];
203  bc_type, prefix() + _temperature_name + "_fixed_convection_bc_all", params);
204  }
205  else
206  {
207  // Check sizes
208  if (convective_boundaries.size() != boundary_T_fluid.size())
209  paramError("fixed_convection_T_fluid",
210  "Should be as many convection boundaries (" +
211  std::to_string(convective_boundaries.size()) +
212  ") as fixed convection temperatures (" +
213  std::to_string(boundary_T_fluid.size()) + ")");
214  if (convective_boundaries.size() != boundary_htc.size())
215  paramError("fixed_convection_htc",
216  "Should be as many convection boundaries (" +
217  std::to_string(convective_boundaries.size()) +
218  ") as fixed convection heat exchange coefficients (" +
219  std::to_string(boundary_htc.size()) + ")");
220  for (const auto i : index_range(convective_boundaries))
221  {
222  params.set<std::vector<BoundaryName>>("boundary") = {convective_boundaries[i]};
223  params.set<MooseFunctorName>("T_infinity_functor") = boundary_T_fluid[i];
224  params.set<MooseFunctorName>("heat_transfer_coefficient_functor") = boundary_htc[i];
226  prefix() + _temperature_name + "_fixed_convection_bc_" +
227  convective_boundaries[i],
228  params);
229  }
230  }
231  }
232 }
std::string prefix() const
Factory & getFactory()
T & set(const std::string &name, bool quiet_mode=false)
InputParameters getValidParams(const std::string &name) const
virtual void addBoundaryCondition(const std::string &bc_name, const std::string &name, InputParameters &parameters)
bool isParamValid(const std::string &name) const
virtual FEProblemBase & getProblem()
const bool _use_ad
Whether to use automatic differentiation.
void paramError(const std::string &param, Args... args) const
const VariableName & _temperature_name
Name of the temperature variable.
void paramInfo(const std::string &param, Args... args) const
auto index_range(const T &sizable)

◆ addFEKernels()

void HeatConductionCG::addFEKernels ( )
overrideprivatevirtual

Reimplemented from PhysicsBase.

Definition at line 50 of file HeatConductionCG.C.

51 {
52  {
53  const std::string kernel_type = _use_ad ? "ADHeatConduction" : "HeatConduction";
54  InputParameters params = getFactory().getValidParams(kernel_type);
55  assignBlocks(params, _blocks);
56  params.set<NonlinearVariableName>("variable") = _temperature_name;
57  if (_use_ad)
58  params.applyParameter(parameters(), "thermal_conductivity");
59  else
60  params.set<MaterialPropertyName>("diffusion_coefficient") =
61  getParam<MaterialPropertyName>("thermal_conductivity");
62  getProblem().addKernel(kernel_type, prefix() + _temperature_name + "_conduction", params);
63  }
64  if (isParamValid("heat_source_var"))
65  {
66  const std::string kernel_type = _use_ad ? "ADCoupledForce" : "CoupledForce";
67  InputParameters params = getFactory().getValidParams(kernel_type);
68  assignBlocks(params, _blocks);
69  params.set<NonlinearVariableName>("variable") = _temperature_name;
70  params.set<std::vector<VariableName>>("v") = {getParam<VariableName>("heat_source_var")};
71  if (isParamValid("heat_source_blocks"))
72  params.set<std::vector<SubdomainName>>("block") =
73  getParam<std::vector<SubdomainName>>("heat_source_blocks");
74  getProblem().addKernel(kernel_type, prefix() + _temperature_name + "_source", params);
75  }
76  if (isParamValid("heat_source_functor"))
77  {
78  const std::string kernel_type = "BodyForce";
79  InputParameters params = getFactory().getValidParams(kernel_type);
80  assignBlocks(params, _blocks);
81  params.set<NonlinearVariableName>("variable") = _temperature_name;
82  const auto & functor_name = getParam<MooseFunctorName>("heat_source_functor");
83  if (MooseUtils::parsesToReal(functor_name))
84  params.set<Real>("value") = std::stod(functor_name);
85  else if (getProblem().hasFunction(functor_name))
86  params.set<FunctionName>("function") = functor_name;
87  else if (getProblem().hasPostprocessorValueByName(functor_name))
88  params.set<PostprocessorName>("postprocessor") = functor_name;
89  else
90  paramError("heat_source_functor", "Unsupported functor type.");
91  getProblem().addKernel(kernel_type, prefix() + _temperature_name + "_source_functor", params);
92  }
93  if (shouldCreateTimeDerivative(_temperature_name, _blocks, /*error if already defined*/ false))
94  {
95  const std::string kernel_type =
96  _use_ad ? "ADHeatConductionTimeDerivative" : "SpecificHeatConductionTimeDerivative";
97  InputParameters params = getFactory().getValidParams(kernel_type);
98  assignBlocks(params, _blocks);
99  params.set<NonlinearVariableName>("variable") = _temperature_name;
100  if (_use_ad)
101  params.set<MaterialPropertyName>("density_name") = getParam<MaterialPropertyName>("density");
102  else
103  params.applyParameter(parameters(), "density");
104  params.applyParameter(parameters(), "specific_heat");
105  getProblem().addKernel(kernel_type, prefix() + _temperature_name + "_time", params);
106  }
107 }
std::string prefix() const
bool parsesToReal(const std::string &input)
void assignBlocks(InputParameters &params, const std::vector< SubdomainName > &blocks) const
Factory & getFactory()
T & set(const std::string &name, bool quiet_mode=false)
InputParameters getValidParams(const std::string &name) const
bool shouldCreateTimeDerivative(const VariableName &var_name, const std::vector< SubdomainName > &blocks, const bool error_if_already_defined) const
virtual void addKernel(const std::string &kernel_name, const std::string &name, InputParameters &parameters)
std::vector< SubdomainName > _blocks
bool isParamValid(const std::string &name) const
virtual FEProblemBase & getProblem()
const bool _use_ad
Whether to use automatic differentiation.
bool hasPostprocessorValueByName(const PostprocessorName &name) const
void paramError(const std::string &param, Args... args) const
const InputParameters & parameters() const
const VariableName & _temperature_name
Name of the temperature variable.
void applyParameter(const InputParameters &common, const std::string &common_name, bool allow_private=false, bool override_default=false)

◆ addSolverVariables()

void HeatConductionCG::addSolverVariables ( )
overrideprivatevirtual

Reimplemented from PhysicsBase.

Definition at line 235 of file HeatConductionCG.C.

236 {
237  if (!shouldCreateVariable(_temperature_name, _blocks, /*error if aux*/ true))
238  {
239  reportPotentiallyMissedParameters({"system_names"}, "MooseVariable");
240  return;
241  }
242 
243  const std::string variable_type = "MooseVariable";
244  // defaults to linear lagrange FE family
245  InputParameters params = getFactory().getValidParams(variable_type);
246  params.set<SolverSystemName>("solver_sys") = getSolverSystem(_temperature_name);
247  assignBlocks(params, _blocks);
248 
249  getProblem().addVariable(variable_type, _temperature_name, params);
250 }
void assignBlocks(InputParameters &params, const std::vector< SubdomainName > &blocks) const
bool shouldCreateVariable(const VariableName &var_name, const std::vector< SubdomainName > &blocks, const bool error_if_aux)
Factory & getFactory()
T & set(const std::string &name, bool quiet_mode=false)
InputParameters getValidParams(const std::string &name) const
std::vector< SubdomainName > _blocks
virtual FEProblemBase & getProblem()
const SolverSystemName & getSolverSystem(unsigned int variable_index) const
virtual void addVariable(const std::string &var_type, const std::string &var_name, InputParameters &params)
void reportPotentiallyMissedParameters(const std::vector< std::string > &param_names, const std::string &object_type) const
const VariableName & _temperature_name
Name of the temperature variable.

◆ validParams()

InputParameters HeatConductionCG::validParams ( )
static

Definition at line 23 of file HeatConductionCG.C.

24 {
26  params.addClassDescription("Creates the heat conduction equation discretized with CG");
27 
28  // Material properties
29  params.transferParam<MaterialPropertyName>(ADHeatConduction::validParams(),
30  "thermal_conductivity");
31  params.transferParam<MaterialPropertyName>(HeatConductionTimeDerivative::validParams(),
32  "specific_heat");
33  params.addParam<MaterialPropertyName>("density", "density", "Density material property");
34  params.addParamNamesToGroup("thermal_conductivity specific_heat density", "Thermal properties");
35 
36  params.addParam<bool>(
37  "use_automatic_differentiation",
38  true,
39  "Whether to use automatic differentiation for all the terms in the equation");
40 
41  return params;
42 }
void addParam(const std::string &name, const std::initializer_list< typename T::value_type > &value, const std::string &doc_string)
static InputParameters validParams()
static InputParameters validParams()
static InputParameters validParams()
Contructor for Heat Equation time derivative term.
void transferParam(const InputParameters &source_param, const std::string &name, const std::string &new_name="", const std::string &new_description="")
void addClassDescription(const std::string &doc_string)
void addParamNamesToGroup(const std::string &space_delim_names, const std::string group_name)

Member Data Documentation

◆ _temperature_name

const VariableName& HeatConductionPhysicsBase::_temperature_name
protectedinherited

◆ _use_ad

const bool HeatConductionCG::_use_ad
protected

Whether to use automatic differentiation.

Definition at line 26 of file HeatConductionCG.h.

Referenced by addFEBCs(), and addFEKernels().


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