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
 
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
 
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 haveParameter (const std::string &name) 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 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
 
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 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 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
 
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

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::HeatConductionPhysicsBase
HeatConductionPhysicsBase(const InputParameters &parameters)
Definition: HeatConductionPhysicsBase.C:67
PhysicsBase::parameters
const InputParameters & parameters() const
HeatConductionCG::_use_ad
const bool _use_ad
Whether to use automatic differentiation.
Definition: HeatConductionCG.h:26

Member Function Documentation

◆ addFEBCs()

void HeatConductionCG::addFEBCs ( )
overrideprivatevirtual

Reimplemented from PhysicsBase.

Definition at line 115 of file HeatConductionCG.C.

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

◆ 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  params.set<NonlinearVariableName>("variable") = _temperature_name;
69  params.set<std::vector<VariableName>>("v") = {getParam<VariableName>("heat_source_var")};
70  if (isParamValid("heat_source_blocks"))
71  params.set<std::vector<SubdomainName>>("block") =
72  getParam<std::vector<SubdomainName>>("heat_source_blocks");
73  else
74  assignBlocks(params, _blocks);
75  getProblem().addKernel(kernel_type, prefix() + _temperature_name + "_source", params);
76  }
77  if (isParamValid("heat_source_functor"))
78  {
79  const std::string kernel_type = "BodyForce";
80  InputParameters params = getFactory().getValidParams(kernel_type);
81  if (isParamValid("heat_source_blocks"))
82  params.set<std::vector<SubdomainName>>("block") =
83  getParam<std::vector<SubdomainName>>("heat_source_blocks");
84  else
85  assignBlocks(params, _blocks);
86  params.set<NonlinearVariableName>("variable") = _temperature_name;
87  const auto & functor_name = getParam<MooseFunctorName>("heat_source_functor");
88  if (MooseUtils::parsesToReal(functor_name))
89  params.set<Real>("value") = std::stod(functor_name);
90  else if (getProblem().hasFunction(functor_name))
91  params.set<FunctionName>("function") = functor_name;
92  else if (getProblem().hasPostprocessorValueByName(functor_name))
93  params.set<PostprocessorName>("postprocessor") = functor_name;
94  else
95  paramError("heat_source_functor", "Unsupported functor type.");
96  getProblem().addKernel(kernel_type, prefix() + _temperature_name + "_source_functor", params);
97  }
98  if (shouldCreateTimeDerivative(_temperature_name, _blocks, /*error if already defined*/ false))
99  {
100  const std::string kernel_type =
101  _use_ad ? "ADHeatConductionTimeDerivative" : "SpecificHeatConductionTimeDerivative";
102  InputParameters params = getFactory().getValidParams(kernel_type);
103  assignBlocks(params, _blocks);
104  params.set<NonlinearVariableName>("variable") = _temperature_name;
105  if (_use_ad)
106  params.set<MaterialPropertyName>("density_name") = getParam<MaterialPropertyName>("density");
107  else
108  params.applyParameter(parameters(), "density");
109  params.applyParameter(parameters(), "specific_heat");
110  getProblem().addKernel(kernel_type, prefix() + _temperature_name + "_time", params);
111  }
112 }
PhysicsBase::prefix
std::string prefix() const
PhysicsBase::assignBlocks
void assignBlocks(InputParameters &params, const std::vector< SubdomainName > &blocks) const
PhysicsBase::getFactory
Factory & getFactory()
PhysicsBase::paramError
void paramError(const std::string &param, Args... args) const
PhysicsBase::getParam
const T & getParam(const std::string &name) const
PhysicsBase::parameters
const InputParameters & parameters() const
InputParameters::set
T & set(const std::string &name, bool quiet_mode=false)
Factory::getValidParams
InputParameters getValidParams(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
FEProblemBase::addKernel
virtual void addKernel(const std::string &kernel_name, const std::string &name, InputParameters &parameters)
PhysicsBase::_blocks
std::vector< SubdomainName > _blocks
PhysicsBase::getProblem
virtual FEProblemBase & getProblem()
HeatConductionCG::_use_ad
const bool _use_ad
Whether to use automatic differentiation.
Definition: HeatConductionCG.h:26
FEProblemBase::hasPostprocessorValueByName
bool hasPostprocessorValueByName(const PostprocessorName &name) const
InputParameters::applyParameter
void applyParameter(const InputParameters &common, const std::string &common_name, bool allow_private=false)
PhysicsBase::isParamValid
bool isParamValid(const std::string &name) const
HeatConductionPhysicsBase::_temperature_name
const VariableName & _temperature_name
Name of the temperature variable.
Definition: HeatConductionPhysicsBase.h:27
MooseUtils::parsesToReal
bool parsesToReal(const std::string &input, Real *parsed_real)

◆ addSolverVariables()

void HeatConductionCG::addSolverVariables ( )
overrideprivatevirtual

Reimplemented from PhysicsBase.

Definition at line 240 of file HeatConductionCG.C.

241 {
242  if (!shouldCreateVariable(_temperature_name, _blocks, /*error if aux*/ true))
243  {
244  reportPotentiallyMissedParameters({"system_names"}, "MooseVariable");
245  return;
246  }
247 
248  const std::string variable_type = "MooseVariable";
249  // defaults to linear lagrange FE family
250  InputParameters params = getFactory().getValidParams(variable_type);
251  params.set<SolverSystemName>("solver_sys") = getSolverSystem(_temperature_name);
252  assignBlocks(params, _blocks);
253 
254  getProblem().addVariable(variable_type, _temperature_name, params);
255 }
PhysicsBase::assignBlocks
void assignBlocks(InputParameters &params, const std::vector< SubdomainName > &blocks) const
PhysicsBase::shouldCreateVariable
bool shouldCreateVariable(const VariableName &var_name, const std::vector< SubdomainName > &blocks, const bool error_if_aux)
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::reportPotentiallyMissedParameters
void reportPotentiallyMissedParameters(const std::vector< std::string > &param_names, const std::string &object_type, const std::string &object_name="") const
PhysicsBase::_blocks
std::vector< SubdomainName > _blocks
PhysicsBase::getProblem
virtual FEProblemBase & getProblem()
PhysicsBase::getSolverSystem
const SolverSystemName & getSolverSystem(unsigned int variable_index) const
FEProblemBase::addVariable
virtual void addVariable(const std::string &var_type, const std::string &var_name, InputParameters &params)
HeatConductionPhysicsBase::_temperature_name
const VariableName & _temperature_name
Name of the temperature variable.
Definition: HeatConductionPhysicsBase.h:27

◆ validParams()

InputParameters HeatConductionCG::validParams ( )
static

Definition at line 23 of file HeatConductionCG.C.

24 {
25  InputParameters params = HeatConductionPhysicsBase::validParams();
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 }
InputParameters::addParam
void addParam(const std::string &name, const std::initializer_list< typename T::value_type > &value, const std::string &doc_string)
HeatConductionPhysicsBase::validParams
static InputParameters validParams()
Definition: HeatConductionPhysicsBase.C:13
ADHeatConduction::validParams
static InputParameters validParams()
Definition: ADHeatConduction.C:15
HeatConductionTimeDerivative::validParams
static InputParameters validParams()
Contructor for Heat Equation time derivative term.
Definition: HeatConductionTimeDerivative.C:15
InputParameters::transferParam
void transferParam(const InputParameters &source_param, const std::string &name, const std::string &new_name="", const std::string &new_description="")
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
protectedinherited

Name of the temperature variable.

Definition at line 27 of file HeatConductionPhysicsBase.h.

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

◆ _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:
Generated on Sun Jun 21 2026 21:45:18 for https://mooseframework.inl.gov by   doxygen 1.8.14