Creates all the objects needed to solve the porous media solid energy equation. More...

#include <PNSFVSolidHeatTransferPhysics.h>

Inheritance diagram for PNSFVSolidHeatTransferPhysics:

Public Types
typedef DataFileName	DataFileParameterType

Public Member Functions
	PNSFVSolidHeatTransferPhysics (const InputParameters &parameters)

virtual void	addFVBCs () override

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)

void	addSharedSolverVariable (const std::string &var_type, const VariableName &var_name, InputParameters params)

void	addSharedSolverVariable (const VariableName &var_name, const std::string &family, const std::string &order, Real scaling=1.0)

void	addSharedAuxVariable (const std::string &var_type, const VariableName &var_name, const InputParameters &params)

void	addSharedAuxVariable (const VariableName &var_name, const std::string &family, const std::string &order)

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	checkAtMostOneParamSetByUser (const std::vector< std::string > &params) 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	addSolverVariables () override

virtual void	addFVKernels () override

virtual void	addMaterials () override

virtual InputParameters	getAdditionalRMParams () const override

void	addPINSSolidEnergyTimeKernels ()
	Functions adding kernels for the solid energy equation.

void	addPINSSolidEnergyHeatConductionKernels ()

void	addPINSSolidEnergyAmbientConvection ()

void	addPINSSolidEnergyExternalHeatSource ()

bool	processThermalConductivity ()
	Process thermal conductivity (multiple functor input options are available).

void	checkFluidAndSolidHeatTransferPhysicsParameters () const
	Battery of additional checks on parameters.

virtual void	initializePhysicsAdditional () 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	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
const NonlinearVariableName	_solid_temperature_name
	Solid temperature name.

const NonlinearVariableName	_fluid_temperature_name
	Fluid temperature name.

const MooseFunctorName	_porosity_name
	Name of the porosity functor (usually material property)

const MooseFunctorName	_density_name
	Name of the density functor (usually material property)

const MooseFunctorName	_specific_heat_name
	Name of the specific heat functor (usually material property)

std::vector< std::vector< SubdomainName > >	_thermal_conductivity_blocks
	Vector of subdomain groups where we want to have different thermal conduction.

std::vector< MooseFunctorName >	_thermal_conductivity_name
	Name of the thermal conductivity functor for each block-group.

std::vector< std::vector< SubdomainName > >	_ambient_convection_blocks
	Vector of subdomain groups where we want to have different ambient convection.

std::vector< MooseFunctorName >	_ambient_convection_alpha
	Name of the ambient convection heat transfer coefficients for each block-group.

std::vector< MooseFunctorName >	_ambient_temperature
	Name of the solid domain temperature for each block-group.

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 porous media solid energy equation.

Definition at line 18 of file PNSFVSolidHeatTransferPhysics.h.

Constructor & Destructor Documentation

◆ PNSFVSolidHeatTransferPhysics()

PNSFVSolidHeatTransferPhysics::PNSFVSolidHeatTransferPhysics ( const InputParameters & parameters )

Definition at line 125 of file PNSFVSolidHeatTransferPhysics.C.

  : HeatConductionFV(parameters),
    _solid_temperature_name(getParam<VariableName>("solid_temperature_variable")),
    _fluid_temperature_name(getParam<NonlinearVariableName>("fluid_temperature_variable")),
    _porosity_name(getParam<MooseFunctorName>(NS::porosity)),
    _density_name(getParam<MooseFunctorName>("rho_solid")),
    _specific_heat_name(getParam<MooseFunctorName>("cp_solid")),
    _thermal_conductivity_blocks(
        parameters.isParamValid("thermal_conductivity_blocks")
            ? getParam<std::vector<std::vector<SubdomainName>>>("thermal_conductivity_blocks")
            : std::vector<std::vector<SubdomainName>>()),
    _thermal_conductivity_name(
        getParam<std::vector<MooseFunctorName>>("thermal_conductivity_solid")),
    _ambient_convection_blocks(
        getParam<std::vector<std::vector<SubdomainName>>>("ambient_convection_blocks")),
    _ambient_convection_alpha(getParam<std::vector<MooseFunctorName>>("ambient_convection_alpha")),
    _ambient_temperature(getParam<std::vector<MooseFunctorName>>("ambient_convection_temperature"))
{
  saveSolverVariableName(_solid_temperature_name);
 
  // Parameter checks
  if (getParam<std::vector<MooseFunctorName>>("ambient_convection_temperature").size() != 1)
    checkVectorParamsSameLengthIfSet<MooseFunctorName, MooseFunctorName>(
        "ambient_convection_alpha", "ambient_convection_temperature");
  checkSecondParamSetOnlyIfFirstOneSet("external_heat_source", "external_heat_source_coeff");
  if (_solid_temperature_name == _fluid_temperature_name)
    paramError("solid_temperature_variable",
               "Solid and fluid cannot share the same temperature variable");
  // More parameter checks in ambient convection creation
}

Member Function Documentation

◆ addFVBCs()

void HeatConductionFV::addFVBCs ( )

overridevirtualinherited

Reimplemented from PhysicsBase.

Definition at line 137 of file HeatConductionFV.C.

{
  // We dont need to add anything for insulated boundaries, 0 flux is the default boundary condition
  if (isParamValid("heat_flux_boundaries"))
  {
    const std::string bc_type = "FVFunctorNeumannBC";
    InputParameters params = getFactory().getValidParams(bc_type);
    params.set<NonlinearVariableName>("variable") = _temperature_name;
 
    const auto & heat_flux_boundaries = getParam<std::vector<BoundaryName>>("heat_flux_boundaries");
    const auto & boundary_heat_fluxes =
        getParam<std::vector<MooseFunctorName>>("boundary_heat_fluxes");
    // Optimization if all the same
    if (std::set<MooseFunctorName>(boundary_heat_fluxes.begin(), boundary_heat_fluxes.end())
                .size() == 1 &&
        heat_flux_boundaries.size() > 1)
    {
      params.set<std::vector<BoundaryName>>("boundary") = heat_flux_boundaries;
      params.set<MooseFunctorName>("functor") = boundary_heat_fluxes[0];
      getProblem().addFVBC(bc_type, prefix() + _temperature_name + "_heat_flux_bc_all", params);
    }
    else
    {
      for (const auto i : index_range(heat_flux_boundaries))
      {
        params.set<std::vector<BoundaryName>>("boundary") = {heat_flux_boundaries[i]};
        params.set<MooseFunctorName>("functor") = boundary_heat_fluxes[i];
        getProblem().addFVBC(bc_type,
                             prefix() + _temperature_name + "_heat_flux_bc_" +
                                 heat_flux_boundaries[i],
                             params);
      }
    }
  }
  if (isParamValid("fixed_temperature_boundaries"))
  {
    const std::string bc_type = "FVFunctorDirichletBC";
    InputParameters params = getFactory().getValidParams(bc_type);
    params.set<NonlinearVariableName>("variable") = _temperature_name;
 
    const auto & temperature_boundaries =
        getParam<std::vector<BoundaryName>>("fixed_temperature_boundaries");
    const auto & boundary_temperatures =
        getParam<std::vector<MooseFunctorName>>("boundary_temperatures");
    // Optimization if all the same
    if (std::set<MooseFunctorName>(boundary_temperatures.begin(), boundary_temperatures.end())
                .size() == 1 &&
        temperature_boundaries.size() > 1)
    {
      params.set<std::vector<BoundaryName>>("boundary") = temperature_boundaries;
      params.set<MooseFunctorName>("functor") = boundary_temperatures[0];
      getProblem().addFVBC(bc_type, prefix() + _temperature_name + "_dirichlet_bc_all", params);
    }
    else
    {
      for (const auto i : index_range(temperature_boundaries))
      {
        params.set<std::vector<BoundaryName>>("boundary") = {temperature_boundaries[i]};
        params.set<MooseFunctorName>("functor") = boundary_temperatures[i];
        getProblem().addFVBC(bc_type,
                             prefix() + _temperature_name + "_dirichlet_bc_" +
                                 temperature_boundaries[i],
                             params);
      }
    }
  }
  if (isParamValid("fixed_convection_boundaries"))
  {
    const std::string bc_type = "FVFunctorConvectiveHeatFluxBC";
    InputParameters params = getFactory().getValidParams(bc_type);
    params.set<NonlinearVariableName>("variable") = _temperature_name;
    params.set<bool>("is_solid") = true;
    params.set<MooseFunctorName>("T_solid") = _temperature_name;
 
    const auto & convective_boundaries =
        getParam<std::vector<BoundaryName>>("fixed_convection_boundaries");
    const auto & boundary_T_fluid =
        getParam<std::vector<MooseFunctorName>>("fixed_convection_T_fluid");
    const auto & boundary_htc = getParam<std::vector<MooseFunctorName>>("fixed_convection_htc");
    // Optimization if all the same
    if (std::set<MooseFunctorName>(boundary_T_fluid.begin(), boundary_T_fluid.end()).size() == 1 &&
        std::set<MooseFunctorName>(boundary_htc.begin(), boundary_htc.end()).size() == 1 &&
        convective_boundaries.size() > 1)
    {
      params.set<std::vector<BoundaryName>>("boundary") = convective_boundaries;
      params.set<MooseFunctorName>("T_bulk") = boundary_T_fluid[0];
      params.set<MooseFunctorName>("heat_transfer_coefficient") = boundary_htc[0];
      getProblem().addFVBC(
          bc_type, prefix() + _temperature_name + "_fixed_convection_bc_all", params);
    }
    else
    {
      for (const auto i : index_range(convective_boundaries))
      {
        params.set<std::vector<BoundaryName>>("boundary") = {convective_boundaries[i]};
        params.set<MooseFunctorName>("T_bulk") = boundary_T_fluid[i];
        params.set<MooseFunctorName>("heat_transfer_coefficient") = boundary_htc[i];
        getProblem().addFVBC(bc_type,
                             prefix() + _temperature_name + "_fixed_convection_bc_" +
                                 convective_boundaries[i],
                             params);
      }
    }
  }
}

◆ addFVKernels()

void PNSFVSolidHeatTransferPhysics::addFVKernels ( )

overrideprivatevirtual

Reimplemented from HeatConductionFV.

Definition at line 177 of file PNSFVSolidHeatTransferPhysics.C.

{
  // Check this physics against others
  checkFluidAndSolidHeatTransferPhysicsParameters();
 
  if (isTransient())
    addPINSSolidEnergyTimeKernels();
 
  addPINSSolidEnergyHeatConductionKernels();
  if (getParam<std::vector<MooseFunctorName>>("ambient_convection_alpha").size())
    addPINSSolidEnergyAmbientConvection();
  if (isParamValid("external_heat_source"))
    addPINSSolidEnergyExternalHeatSource();
}

◆ addInitialConditions()

void HeatConductionPhysicsBase::addInitialConditions ( )

overrideprivatevirtualinherited

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);
  }
}

◆ addMaterials()

void PNSFVSolidHeatTransferPhysics::addMaterials ( )

overrideprivatevirtual

Reimplemented from PhysicsBase.

Definition at line 370 of file PNSFVSolidHeatTransferPhysics.C.

{
  if (!getParam<bool>("use_external_enthalpy_material"))
  {
    InputParameters params = getFactory().getValidParams("INSFVEnthalpyFunctorMaterial");
    assignBlocks(params, _blocks);
 
    params.set<MooseFunctorName>(NS::density) = _density_name;
    params.set<MooseFunctorName>(NS::cp) = _specific_heat_name;
    params.set<MooseFunctorName>("temperature") = _solid_temperature_name;
    params.set<MaterialPropertyName>("declare_suffix") = "solid";
 
    getProblem().addMaterial(
        "INSFVEnthalpyFunctorMaterial", prefix() + "ins_enthalpy_material", params);
  }
 
  // Combine the functors (combining scalars and vectors is not currently supported)
  if (_thermal_conductivity_name.size() > 1)
  {
    const auto vector_conductivity = processThermalConductivity();
    const auto combiner_functor = vector_conductivity ? "PiecewiseByBlockVectorFunctorMaterial"
                                                      : "PiecewiseByBlockFunctorMaterial";
    InputParameters params = getFactory().getValidParams(combiner_functor);
    params.set<MooseFunctorName>("prop_name") = prefix() + "combined_thermal_conductivity";
    std::vector<SubdomainName> blocks_list;
    std::map<std::string, std::string> blocks_to_functors;
    for (const auto i : index_range(_thermal_conductivity_name))
    {
      for (const auto & block : _thermal_conductivity_blocks[i])
      {
        blocks_list.push_back(block);
        blocks_to_functors.insert(
            std::pair<std::string, std::string>(block, _thermal_conductivity_name[i]));
      }
    }
    params.set<std::vector<SubdomainName>>("block") = blocks_list;
    params.set<std::map<std::string, std::string>>("subdomain_to_prop_value") = blocks_to_functors;
    getProblem().addMaterial(combiner_functor, prefix() + "thermal_conductivity_combiner", params);
  }
}

◆ addPINSSolidEnergyAmbientConvection()

void PNSFVSolidHeatTransferPhysics::addPINSSolidEnergyAmbientConvection ( )

private

Definition at line 260 of file PNSFVSolidHeatTransferPhysics.C.

{
  const auto num_convection_blocks = _ambient_convection_blocks.size();
  const auto num_used_blocks = num_convection_blocks ? num_convection_blocks : 1;
 
  // Check parameter. Late check in case the block was added by a Component
  if (num_used_blocks != _ambient_convection_alpha.size())
    paramError("ambient_convection_alpha",
               "Number of ambient convection heat transfer coefficients (" +
                   std::to_string(_ambient_convection_alpha.size()) +
                   ") should match the number of "
                   "blocks (" +
                   std::to_string(num_convection_blocks) + ") each HTC is defined on.");
 
  const auto kernel_type = "PINSFVEnergyAmbientConvection";
  InputParameters params = getFactory().getValidParams(kernel_type);
  params.set<NonlinearVariableName>("variable") = _solid_temperature_name;
  params.set<MooseFunctorName>(NS::T_solid) = _solid_temperature_name;
  params.set<bool>("is_solid") = true;
 
  for (const auto block_i : make_range(num_used_blocks))
  {
    std::string block_name = "";
    if (num_convection_blocks)
    {
      params.set<std::vector<SubdomainName>>("block") = _ambient_convection_blocks[block_i];
      block_name = Moose::stringify(_ambient_convection_blocks[block_i]);
    }
    else
    {
      assignBlocks(params, _blocks);
      block_name = std::to_string(block_i);
    }
 
    params.set<MooseFunctorName>("h_solid_fluid") = _ambient_convection_alpha[block_i];
    if (_ambient_temperature.size() > 1)
      params.set<MooseFunctorName>(NS::T_fluid) = _ambient_temperature[block_i];
    else
      params.set<MooseFunctorName>(NS::T_fluid) = _ambient_temperature[0];
 
    getProblem().addFVKernel(kernel_type, prefix() + "ambient_convection_" + block_name, params);
  }
}

Referenced by addFVKernels().

◆ addPINSSolidEnergyExternalHeatSource()

void PNSFVSolidHeatTransferPhysics::addPINSSolidEnergyExternalHeatSource ( )

private

Definition at line 305 of file PNSFVSolidHeatTransferPhysics.C.

{
  const std::string kernel_type = "FVCoupledForce";
  InputParameters params = getFactory().getValidParams(kernel_type);
  params.set<NonlinearVariableName>("variable") = _solid_temperature_name;
  const auto & source_blocks = getParam<std::vector<SubdomainName>>("external_heat_source_blocks");
  if (source_blocks.size())
    assignBlocks(params, source_blocks);
  else
    assignBlocks(params, _blocks);
  params.set<MooseFunctorName>("v") = getParam<MooseFunctorName>("external_heat_source");
  params.set<Real>("coef") = getParam<Real>("external_heat_source_coeff");
 
  getProblem().addFVKernel(kernel_type, prefix() + "external_heat_source", params);
}

Referenced by addFVKernels().

◆ addPINSSolidEnergyHeatConductionKernels()

void PNSFVSolidHeatTransferPhysics::addPINSSolidEnergyHeatConductionKernels ( )

private

Definition at line 227 of file PNSFVSolidHeatTransferPhysics.C.

{
  const auto vector_conductivity = processThermalConductivity();
 
  const auto kernel_type =
      vector_conductivity ? "PINSFVEnergyAnisotropicDiffusion" : "PINSFVEnergyDiffusion";
 
  InputParameters params = getFactory().getValidParams(kernel_type);
  params.set<NonlinearVariableName>("variable") = _solid_temperature_name;
  params.set<MooseFunctorName>(NS::porosity) = _porosity_name;
 
  // Set block restrictions
  const bool combined = _thermal_conductivity_blocks.size() > 1;
  std::vector<SubdomainName> thermal_conductivity_blocks;
  for (const auto & block_group : _thermal_conductivity_blocks)
    thermal_conductivity_blocks.insert(thermal_conductivity_blocks.end(),
                                       std::make_move_iterator(block_group.begin()),
                                       std::make_move_iterator(block_group.end()));
  const auto block_names =
      _thermal_conductivity_blocks.size() ? thermal_conductivity_blocks : _blocks;
  assignBlocks(params, block_names);
 
  // Set thermal conductivity
  const auto conductivity_name = vector_conductivity ? NS::kappa : NS::k;
  if (combined)
    params.set<MooseFunctorName>(conductivity_name) = prefix() + "combined_thermal_conductivity";
  else
    params.set<MooseFunctorName>(conductivity_name) = _thermal_conductivity_name[0];
 
  getProblem().addFVKernel(kernel_type, prefix() + "pins_energy_diffusion", params);
}

Referenced by addFVKernels().

◆ addPINSSolidEnergyTimeKernels()

void PNSFVSolidHeatTransferPhysics::addPINSSolidEnergyTimeKernels ( )

private

Functions adding kernels for the solid energy equation.

Definition at line 193 of file PNSFVSolidHeatTransferPhysics.C.

{
  const auto kernel_type = "PINSFVEnergyTimeDerivative";
  const auto kernel_name = prefix() + "pins_solid_energy_time";
 
  InputParameters params = getFactory().getValidParams(kernel_type);
  assignBlocks(params, _blocks);
  params.set<NonlinearVariableName>("variable") = _solid_temperature_name;
  params.set<MooseFunctorName>(NS::density) = _density_name;
 
  // The '_solid' suffix has been declared when creating the INSFVEnthalpyMaterial
  // only for thermal functor material properties
  // Using this derivative we can model non-constant specific heat
  if (getProblem().hasFunctor(NS::time_deriv(NS::specific_enthalpy) + "_solid",
                              /*thread_id=*/0))
    params.set<MooseFunctorName>(NS::time_deriv(NS::specific_enthalpy)) =
        NS::time_deriv(NS::specific_enthalpy) + "_solid";
  else
    params.set<MooseFunctorName>(NS::cp) = _specific_heat_name;
 
  params.set<MooseFunctorName>(NS::porosity) = _porosity_name;
  // If modeling a variable density
  if (getProblem().hasFunctor(NS::time_deriv(_density_name),
                              /*thread_id=*/0))
  {
    params.set<MooseFunctorName>(NS::time_deriv(NS::density)) = NS::time_deriv(_density_name);
    params.set<MooseFunctorName>(NS::specific_enthalpy) = NS::specific_enthalpy + "_solid";
  }
  params.set<bool>("is_solid") = true;
 
  getProblem().addFVKernel(kernel_type, kernel_name, params);
}

Referenced by addFVKernels().

◆ addPreconditioning()

void HeatConductionPhysicsBase::addPreconditioning ( )

overrideprivatevirtualinherited

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});
  }
}

◆ addSolverVariables()

void PNSFVSolidHeatTransferPhysics::addSolverVariables ( )

overrideprivatevirtual

Reimplemented from HeatConductionFV.

Definition at line 157 of file PNSFVSolidHeatTransferPhysics.C.

{
  // Dont add if the user already defined the variable
  if (variableExists(_solid_temperature_name,
                     /*error_if_aux=*/true))
    checkBlockRestrictionIdentical(_solid_temperature_name,
                                   getProblem().getVariable(0, _solid_temperature_name).blocks());
  else
  {
    auto params = getFactory().getValidParams("INSFVEnergyVariable");
    params.set<std::vector<Real>>("scaling") = {getParam<Real>("temperature_scaling")};
    params.set<MooseEnum>("face_interp_method") =
        getParam<MooseEnum>("solid_temperature_face_interpolation");
    params.set<bool>("two_term_boundary_expansion") =
        getParam<bool>("solid_temperature_two_term_bc_expansion");
    addSharedSolverVariable("INSFVEnergyVariable", _solid_temperature_name, params);
  }
}

◆ checkFluidAndSolidHeatTransferPhysicsParameters()

void PNSFVSolidHeatTransferPhysics::checkFluidAndSolidHeatTransferPhysicsParameters ( ) const

private

Battery of additional checks on parameters.

Definition at line 428 of file PNSFVSolidHeatTransferPhysics.C.

{
  // Get a pointer to a flow physics and a heat transfer physics on the same blocks, if it exists
  const WCNSFVFlowPhysics * flow_physics = nullptr;
  const WCNSFVFluidHeatTransferPhysics * fluid_energy_physics = nullptr;
  const auto all_flow_physics = getCoupledPhysics<const WCNSFVFlowPhysics>(/*allow_fail=*/true);
  for (const auto physics : all_flow_physics)
    if (checkBlockRestrictionIdentical(
            physics->name(), physics->blocks(), /*error_if_not_identical=*/false))
    {
      if (flow_physics)
        mooseError("Two Fluid flow physics detected on the same blocks as the solid heat transfer "
                   "physics");
      flow_physics = physics;
    }
  const auto all_fluid_energy_physics =
      getCoupledPhysics<const WCNSFVFluidHeatTransferPhysics>(/*allow_fail=*/true);
  for (const auto physics : all_fluid_energy_physics)
    if (checkBlockRestrictionIdentical(
            physics->name(), physics->blocks(), /*error_if_not_identical=*/false))
    {
      if (fluid_energy_physics)
        mooseError("Two fluid heat transfer physics detected on the same blocks as the solid heat "
                   "transfer physics");
      fluid_energy_physics = physics;
    }
 
  if (!fluid_energy_physics && !flow_physics)
    return;
 
  // Check that the parameters seem reasonable
  // Different material properties
  // TODO: Does this error on numbers?
  if (flow_physics && flow_physics->densityName() == _density_name)
    paramError("rho_solid", "Fluid and solid density should be different");
  if (fluid_energy_physics && fluid_energy_physics->getSpecificHeatName() == _specific_heat_name)
    paramError("cp_solid", "Fluid and solid specific heat should be different");
 
  // Check ambient convection parameters
  if (fluid_energy_physics)
  {
    // The blocks should match
    // We only use a warning in case the blocks are matching, just specified differently
    // in the vector of vectors
    auto fluid_convection_blocks = fluid_energy_physics->getAmbientConvectionBlocks();
    std::sort(fluid_convection_blocks.begin(), fluid_convection_blocks.end());
    std::vector<std::vector<SubdomainName>> copy_solid_blocks = _ambient_convection_blocks;
    std::sort(copy_solid_blocks.begin(), copy_solid_blocks.end());
    if (fluid_convection_blocks != _ambient_convection_blocks)
      paramWarning("Ambient convection blocks in the solid phase :" +
                   Moose::stringify(_ambient_convection_blocks) + " and in the fluid phase " +
                   Moose::stringify(fluid_convection_blocks) + " do not seem to match.");
 
    // The coefficients should also match
    auto fluid_convection_coeffs = fluid_energy_physics->getAmbientConvectionHTCs();
    fluid_convection_blocks = fluid_energy_physics->getAmbientConvectionBlocks();
    for (const auto i : index_range(fluid_energy_physics->getAmbientConvectionBlocks()))
      for (const auto j : index_range(_ambient_convection_blocks))
        if (fluid_convection_blocks[i] == _ambient_convection_blocks[j] &&
            fluid_convection_coeffs[i] != _ambient_convection_alpha[j])
          paramWarning("Ambient convection HTCs in the solid phase :" +
                       Moose::stringify(_ambient_convection_alpha) + " and in the fluid phase " +
                       Moose::stringify(fluid_convection_coeffs) + " do not seem to match.");
  }
}

Referenced by addFVKernels().

◆ getAdditionalRMParams()

InputParameters PNSFVSolidHeatTransferPhysics::getAdditionalRMParams ( ) const

overrideprivatevirtual

Reimplemented from PhysicsBase.

Definition at line 412 of file PNSFVSolidHeatTransferPhysics.C.

{
  unsigned short necessary_layers = getParam<unsigned short>("ghost_layers");
  if (getParam<MooseEnum>("solid_temperature_face_interpolation") == "skewness-corrected")
    necessary_layers = std::max(necessary_layers, (unsigned short)3);
 
  // Just an object that has a ghost_layers parameter and performs geometric, algebraic, and
  // coupling ghosting
  const std::string kernel_type = "INSFVMixingLengthReynoldsStress";
  InputParameters params = getFactory().getValidParams(kernel_type);
  params.template set<unsigned short>("ghost_layers") = necessary_layers;
 
  return params;
}

◆ initializePhysicsAdditional()

void HeatConductionFV::initializePhysicsAdditional ( )

overrideprivatevirtualinherited

Reimplemented from PhysicsBase.

Definition at line 60 of file HeatConductionFV.C.

{
  getProblem().needFV();
}

◆ processThermalConductivity()

bool PNSFVSolidHeatTransferPhysics::processThermalConductivity ( )

private

Process thermal conductivity (multiple functor input options are available).

Return true if we have vector thermal conductivity and false if scalar

Definition at line 322 of file PNSFVSolidHeatTransferPhysics.C.

{
  if (isParamValid("thermal_conductivity_blocks"))
    checkBlockwiseConsistency<MooseFunctorName>("thermal_conductivity_blocks",
                                                {"thermal_conductivity_solid"});
  bool have_scalar = false;
  bool have_vector = false;
 
  for (const auto i : index_range(_thermal_conductivity_name))
  {
    // First, check if the name is just a number (only in case of isotropic conduction)
    if (MooseUtils::parsesToReal(_thermal_conductivity_name[i]))
      have_scalar = true;
    // Now we determine what kind of functor we are dealing with
    else
    {
      if (getProblem().hasFunctorWithType<ADReal>(_thermal_conductivity_name[i],
                                                  /*thread_id=*/0))
        have_scalar = true;
      else
      {
        if (getProblem().hasFunctorWithType<ADRealVectorValue>(_thermal_conductivity_name[i],
                                                               /*thread_id=*/0))
          have_vector = true;
        else if (getProblem().hasFunctor(_thermal_conductivity_name[i],
                                         /*thread_id=*/0))
          paramError("thermal_conductivity_solid",
                     "We only allow functor of type (AD)Real or (AD)RealVectorValue for thermal "
                     "conductivity! Functor '" +
                         _thermal_conductivity_name[i] + "' is not of the requested type.");
        else
          // If another Physics is creating this functor, we could be running into an order of
          // creation problem
          paramWarning("thermal_conductivity_solid",
                       "Functor '" + _thermal_conductivity_name[i] +
                           "' was not found in the Problem. Did you mispell it?");
      }
    }
  }
 
  if (have_vector && (have_vector == have_scalar))
    paramError("thermal_conductivity_solid",
               "The entries on thermal conductivity shall either be scalars or vectors, mixing "
               "them is not supported!");
  return have_vector;
}

Referenced by addMaterials(), and addPINSSolidEnergyHeatConductionKernels().

◆ validParams()

InputParameters PNSFVSolidHeatTransferPhysics::validParams ( )

static

Definition at line 25 of file PNSFVSolidHeatTransferPhysics.C.

{
  InputParameters params = HeatConductionFV::validParams();
  params.addClassDescription("Define the Navier Stokes porous media solid energy equation");
 
  // These boundary conditions parameters are not implemented yet
  params.suppressParameter<std::vector<BoundaryName>>("fixed_convection_boundaries");
  params.suppressParameter<std::vector<MooseFunctorName>>("fixed_convection_T_fluid");
  params.suppressParameter<std::vector<MooseFunctorName>>("fixed_convection_htc");
 
  // Swap out some parameters, base class is not specific to porous media
  // Variables
  params.renameParam("temperature_name",
                     "solid_temperature_variable",
                     "Name of the solid phase temperature variable");
  params.set<VariableName>("solid_temperature_variable") = NS::T_solid;
  params.addParam<NonlinearVariableName>(
      "fluid_temperature_variable", NS::T_fluid, "Name of the fluid temperature variable");
  MooseEnum face_interpol_types("average skewness-corrected", "average");
  params.addParam<MooseEnum>(
      "solid_temperature_face_interpolation",
      face_interpol_types,
      "The numerical scheme to interpolate the temperature/energy to the "
      "face for conduction (separate from the advected quantity interpolation).");
  params.addParam<bool>(
      "solid_temperature_two_term_bc_expansion",
      true,
      "If a two-term Taylor expansion is needed for the determination of the boundary values"
      "of the temperature/energy.");
 
  // Porous media parameters
  // TODO: ensure consistency with fluid energy physics
  params.transferParam<MooseFunctorName>(NSFVBase::validParams(), "porosity");
 
  // Material properties
  params.suppressParameter<MaterialPropertyName>("specific_heat");
  params.addParam<MooseFunctorName>("cp_solid", NS::cp + "_solid", "Specific heat functor");
  params.suppressParameter<MaterialPropertyName>("density");
  params.addParam<MooseFunctorName>("rho_solid", NS::density + "_solid", "Density functor");
  params.addParam<std::vector<std::vector<SubdomainName>>>(
      "thermal_conductivity_blocks", "Blocks which each thermal conductivity is defined");
  params.suppressParameter<MooseFunctorName>("thermal_conductivity_functor");
  params.addRequiredParam<std::vector<MooseFunctorName>>(
      "thermal_conductivity_solid",
      "Thermal conductivity, which may have different names depending on the subdomain");
 
  // Ambient convection with the liquid phase parameters
  params.addParam<std::vector<std::vector<SubdomainName>>>(
      "ambient_convection_blocks", {}, "The blocks where the ambient convection is present.");
  params.addParam<std::vector<MooseFunctorName>>(
      "ambient_convection_alpha",
      {},
      "The heat exchange coefficients for each block in 'ambient_convection_blocks'.");
  params.addParam<std::vector<MooseFunctorName>>(
      "ambient_convection_temperature",
      {NS::T_fluid},
      "The fluid temperature for each block in 'ambient_convection_blocks'.");
 
  // Heat source in solid porous medium parameters
  params.addParam<std::vector<SubdomainName>>("external_heat_source_blocks",
                                              std::vector<SubdomainName>(),
                                              "The blocks where the heat source is present.");
  params.addParam<MooseFunctorName>(
      "external_heat_source",
      "The name of a functor which contains the external heat source for the energy equation.");
  params.addParam<Real>(
      "external_heat_source_coeff", 1.0, "Multiplier for the coupled heat source term.");
  params.addParam<bool>("use_external_enthalpy_material",
                        false,
                        "To indicate if the enthalpy material is set up outside of the action.");
 
  params.suppressParameter<VariableName>("heat_source_var");
  params.suppressParameter<std::vector<SubdomainName>>("heat_source_blocks");
 
  // Numerical scheme
  params.addParam<unsigned short>(
      "ghost_layers", 2, "Number of layers of elements to ghost near process domain boundaries");
  // Preconditioning has not been derived for NSFV + porous heat transfer at this point
  MooseEnum pc_options("default none", "none");
  params.set<MooseEnum>("preconditioning") = pc_options;
  params.suppressParameter<MooseEnum>("preconditioning");
 
  // Parameter groups
  params.addParamNamesToGroup("rho_solid cp_solid thermal_conductivity_solid "
                              "thermal_conductivity_blocks use_external_enthalpy_material",
                              "Material properties");
  params.addParamNamesToGroup("ambient_convection_alpha ambient_convection_blocks "
                              "ambient_convection_temperature",
                              "Ambient convection");
  params.addParamNamesToGroup(
      "external_heat_source_blocks external_heat_source external_heat_source_coeff",
      "Solid porous medium heat source");
  params.addParamNamesToGroup(
      "solid_temperature_face_interpolation solid_temperature_two_term_bc_expansion",
      "Numerical scheme");
  params.addParamNamesToGroup("ghost_layers", "Advanced");
 
  return params;
}