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

#include <HeatConductionPhysicsBase.h>

Inheritance diagram for HeatConductionPhysicsBase:

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

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	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	initializePhysicsAdditional ()

virtual void	checkIntegrityEarly () const

virtual void	addSolverVariables ()

virtual void	addAuxiliaryVariables ()

virtual void	addFEKernels ()

virtual void	addFVKernels ()

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	addFVBCs ()

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

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.

  : PhysicsBase(parameters), _temperature_name(getParam<VariableName>("temperature_name"))
{
  // Save variables (for initialization from file for example)
  saveSolverVariableName(_temperature_name);
 
  // Parameter checking
  checkVectorParamsSameLength<BoundaryName, MooseFunctorName>("heat_flux_boundaries",
                                                              "boundary_heat_fluxes");
  checkVectorParamsSameLength<BoundaryName, MooseFunctorName>("fixed_temperature_boundaries",
                                                              "boundary_temperatures");
  checkVectorParamsNoOverlap<BoundaryName>({"heat_flux_boundaries",
                                            "insulated_boundaries",
                                            "fixed_temperature_boundaries",
                                            "fixed_convection_boundaries"});
 
  addRequiredPhysicsTask("add_preconditioning");
}

Member Function Documentation

◆ addInitialConditions()

void HeatConductionPhysicsBase::addInitialConditions ( )

overrideprivatevirtual

Reimplemented from PhysicsBase.

Definition at line 87 of file HeatConductionPhysicsBase.C.

{
  // error on inconsistent user selections
  if (getParam<bool>("initialize_variables_from_mesh_file") &&
      isParamSetByUser("initial_temperature"))
    paramError("initial_temperature",
               "Initial temperature should not be set if the variables should be initialized from "
               "the mesh file");
  // do not set initial conditions if we load from file
  if (getParam<bool>("initialize_variables_from_mesh_file"))
    return;
 
  // Always obey the user, but dont set a hidden default when restarting
  if (shouldCreateIC(_temperature_name,
                     _blocks,
                     /*whether IC is a default*/ !isParamSetByUser("initial_temperature"),
                     /*error if already an IC*/ isParamSetByUser("initial_temperature")))
  {
    InputParameters params = getFactory().getValidParams("FunctionIC");
    assignBlocks(params, _blocks);
    params.set<VariableName>("variable") = _temperature_name;
    params.set<FunctionName>("function") = getParam<FunctionName>("initial_temperature");
    getProblem().addInitialCondition("FunctionIC", prefix() + _temperature_name + "_ic", params);
  }
}

◆ addPreconditioning()

void HeatConductionPhysicsBase::addPreconditioning ( )

overrideprivatevirtual

Reimplemented from PhysicsBase.

Definition at line 114 of file HeatConductionPhysicsBase.C.

{
  // Use a multigrid method, known to work for elliptic problems such as diffusion
  if (_preconditioning == "default")
  {
    // We only pass petsc options as that's all that's needed to set up the preconditioner
    const auto option_pair1 =
        std::make_pair<MooseEnumItem, std::string>(MooseEnumItem("-pc_type"), "hypre");
    const auto option_pair2 =
        std::make_pair<MooseEnumItem, std::string>(MooseEnumItem("-pc_hypre_type"), "boomeramg");
    addPetscPairsToPetscOptions({option_pair1, option_pair2});
  }
}

◆ validParams()

InputParameters HeatConductionPhysicsBase::validParams ( )

static

Definition at line 13 of file HeatConductionPhysicsBase.C.

{
  InputParameters params = PhysicsBase::validParams();
  params.addClassDescription("Add the heat conduction physics");
 
  params.addParam<VariableName>("temperature_name", "T", "Variable name for the temperature");
  params.addParam<VariableName>("heat_source_var", "Variable providing the heat source");
  params.addParam<std::vector<SubdomainName>>("heat_source_blocks",
                                              "Block restriction of the heat source");
  params.addParam<MooseFunctorName>("heat_source_functor", "Functor providing the heat source");
 
  params.addParam<FunctionName>(
      "initial_temperature", 300, "Initial value of the temperature variable");
 
  // Boundary conditions
  params.addParam<std::vector<BoundaryName>>(
      "heat_flux_boundaries", {}, "Boundaries on which to apply a heat flux");
  params.addParam<std::vector<MooseFunctorName>>(
      "boundary_heat_fluxes",
      {},
      "Functors to compute the heat flux on each boundary in 'heat_flux_boundaries'");
  params.addParam<std::vector<BoundaryName>>(
      "insulated_boundaries", {}, "Boundaries on which to apply a zero heat flux");
  params.addParam<std::vector<BoundaryName>>(
      "fixed_temperature_boundaries", {}, "Boundaries on which to apply a fixed temperature");
  params.addParam<std::vector<MooseFunctorName>>(
      "boundary_temperatures",
      {},
      "Functors to compute the heat flux on each boundary in 'fixed_temperature_boundaries'");
  params.addParam<std::vector<BoundaryName>>(
      "fixed_convection_boundaries",
      {},
      "Boundaries on which to apply convection with a neighboring fluid");
  params.addParam<std::vector<MooseFunctorName>>(
      "fixed_convection_T_fluid",
      {},
      "Temperature of the convecting fluid. The user should note that numerous heat transfer "
      "coefficient correlation will require this fluid temperature to be the bulk fluid "
      "temperature / fluid temperature at an infinite distance.");
  params.addParam<std::vector<MooseFunctorName>>(
      "fixed_convection_htc", {}, "Heat transfer coefficient for convection with a fluid");
  params.addParamNamesToGroup(
      "heat_flux_boundaries insulated_boundaries fixed_temperature_boundaries boundary_heat_fluxes "
      "boundary_temperatures",
      "Thermal boundaries");
 
  // Preconditioning is implemented so let's use it by default
  MooseEnum pc_options("default defer", "default");
  params.addParam<MooseEnum>(
      "preconditioning", pc_options, "Which preconditioning to use for this Physics");
 
  return params;
}

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

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(), HeatConductionCG::addSolverVariables(), HeatConductionFV::addSolverVariables(), and HeatConductionPhysicsBase().

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

heat_transfer/include/physics/HeatConductionPhysicsBase.h
heat_transfer/src/physics/HeatConductionPhysicsBase.C

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