https://mooseframework.inl.gov
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Static Protected Member Functions | Protected Attributes | Private Member Functions | Static Private Member Functions | Private Attributes | List of all members
WCNSFVFluidHeatTransferPhysicsBase Class Referenceabstract

Creates all the objects needed to solve the Navier Stokes energy equation. More...

#include <WCNSFVFluidHeatTransferPhysicsBase.h>

Inheritance diagram for WCNSFVFluidHeatTransferPhysicsBase:
[legend]

Public Types

typedef DataFileName DataFileParameterType
 

Public Member Functions

 WCNSFVFluidHeatTransferPhysicsBase (const InputParameters &parameters)
 
const VariableName & getFluidTemperatureName () const
 Get the name of the fluid temperature variable.
 
const MooseFunctorName & getSpecificHeatName () const
 Get the name of the specific heat material property.
 
MooseFunctorName getSpecificEnthalpyName () const
 
const std::vector< MooseFunctorName > & getThermalConductivityName () const
 
const std::vector< std::vector< SubdomainName > > & getAmbientConvectionBlocks () const
 Get the ambient convection parameters for parameter checking.
 
const std::vector< MooseFunctorName > & getAmbientConvectionHTCs () const
 Name of the ambient convection heat transfer coefficients for each block-group.
 
bool hasEnergyEquation () const
 Whether the physics is actually creating the heat equation.
 
virtual void act () override final
 
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 TgetCoupledPhysics (const PhysicsName &phys_name, const bool allow_fail=false) const
 
const std::vector< T * > getCoupledPhysics (const bool allow_fail=false) const
 
unsigned int dimension () const
 
const ActionComponentgetActionComponent (const ComponentName &comp_name) const
 
void checkComponentType (const ActionComponent &component) const
 
virtual void addComponent (const ActionComponent &component)
 
const std::vector< VariableName > & solverVariableNames () const
 
const std::vector< VariableName > & auxVariableNames () const
 
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)
 
MooseAppgetMooseApp () 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 InputParametersparameters () const
 
const hit::Node * getHitNode () const
 
bool hasBase () const
 
const std::string & getBase () const
 
const TgetParam (const std::string &name) const
 
std::vector< std::pair< T1, T2 > > getParam (const std::string &param1, const std::string &param2) const
 
const TqueryParam (const std::string &name) const
 
const TgetRenamedParam (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
 
PerfGraphperfGraph ()
 
void assertParamDefined (const std::string &libmesh_dbg_var(param)) const
 
const Parallel::Communicator & comm () const
 
processor_id_type n_processors () const
 
processor_id_type processor_id () const
 
const WCNSFVFlowPhysicsBasegetCoupledFlowPhysics () const
 
const WCNSFVTurbulencePhysicsBasegetCoupledTurbulencePhysics () const
 
MooseFunctorName getPorosityFunctorName (bool smoothed) const
 Return the porosity functor name.
 
const MooseFunctorName & densityName () const
 
const MooseFunctorName & dynamicViscosityName () 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 actOnAdditionalTasks () override
 
void addInitialConditions () override
 
void addFVKernels () override
 
void addFVBCs () override
 
unsigned short getNumberAlgebraicGhostingLayersNeeded () const override
 Return the number of ghosting layers needed.
 
virtual void addEnergyTimeKernels ()=0
 Functions adding kernels for the incompressible / weakly compressible energy equation.
 
virtual void addEnergyHeatConductionKernels ()=0
 
virtual void addEnergyAdvectionKernels ()=0
 
virtual void addEnergyAmbientConvection ()=0
 
virtual void addEnergyExternalHeatSource ()=0
 
virtual void addEnergyInletBC ()=0
 Functions adding boundary conditions for the fluid heat transfer equation.
 
virtual void addEnergyWallBC ()=0
 
virtual void addEnergyOutletBC ()=0
 
virtual void addEnergySeparatorBC ()=0
 
bool processThermalConductivity ()
 Process thermal conductivity (multiple functor input options are available).
 
void defineEffectiveThermalDiffusionCoeffFunctors (const bool use_ad)
 Define the effective diffusion coefficient when:
 
bool usingNavierStokesFVSyntax () const
 Detects if we are using the new Physics syntax or the old NavierStokesFV action.
 
InputParameters getAdditionalRMParams () const override
 Parameters to change or add relationship managers.
 
void addFVAdvectedInterpolationMethod (const MooseEnum &interpolation_method)
 Add the FVInterpolationMethod object for an advected interpolation method if absent.
 
void assertParamDefined (const std::string &param) const
 
bool isTransient () const
 
FactorygetFactory ()
 
FactorygetFactory () const
 
virtual FEProblemBasegetProblem ()
 
virtual const FEProblemBasegetProblem () const
 
void prepareCopyVariablesFromMesh () const
 
void copyVariablesFromMesh (const std::vector< VariableName > &variables_to_copy, bool are_nonlinear=true)
 
std::string prefix () const
 
void 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< SubdomainIDgetSubdomainIDs (const std::set< SubdomainName > &blocks) const
 
std::vector< std::string > getSubdomainNamesAndIDs (const std::set< SubdomainID > &blocks) const
 
void addPetscPairsToPetscOptions (const std::vector< std::pair< MooseEnumItem, std::string > > &petsc_pair_options)
 
bool isVariableFV (const VariableName &var_name) const
 
bool isVariableScalar (const VariableName &var_name) const
 
bool shouldCreateVariable (const VariableName &var_name, const std::vector< SubdomainName > &blocks, const bool error_if_aux)
 
bool shouldCreateIC (const VariableName &var_name, const std::vector< SubdomainName > &blocks, const bool ic_is_default_ic, const bool error_if_already_defined) const
 
bool shouldCreateTimeDerivative (const VariableName &var_name, const std::vector< SubdomainName > &blocks, const bool error_if_already_defined) const
 
void reportPotentiallyMissedParameters (const std::vector< std::string > &param_names, const std::string &object_type, const 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 TgetMeshProperty (const std::string &data_name, const std::string &prefix)
 
const TgetMeshProperty (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 _has_energy_equation
 A boolean to help compatibility with the old Modules/NavierStokesFV syntax.
 
const bool _solve_for_enthalpy
 User-selected option to solve for enthalpy.
 
const VariableName _fluid_enthalpy_name
 Name of the fluid specific enthalpy.
 
VariableName _fluid_temperature_name
 Fluid temperature name.
 
MooseFunctorName _specific_heat_name
 Name of the specific heat 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.
 
MultiMooseEnum _energy_inlet_types
 Energy inlet boundary types.
 
std::vector< MooseFunctorName > _energy_inlet_functors
 Functors describing the inlet boundary values. See energy_inlet_types for what the functors actually represent.
 
MultiMooseEnum _energy_wall_types
 Energy wall boundary types.
 
std::vector< MooseFunctorName > _energy_wall_functors
 Functors describing the wall boundary values. See energy_wall_types for what the functors actually represent.
 
bool _define_variables
 Whether to define variables if they do not exist.
 
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
 
const NavierStokesPhysicsBase_advection_physics
 The Physics class using this helper.
 
const WCNSFVFlowPhysicsBase_flow_equations_physics
 Flow physics.
 
const WCNSFVTurbulencePhysicsBase_turbulence_physics
 Turbulence.
 
bool _has_turbulence_model
 Because of the Modules/navierStokesFV syntax, a turbulence physics often exists without a model we save (_turbulence_physics && _turbulence_physics->hasTurbulenceModel()) in this attribute.
 
const MooseEnum _compressibility
 Compressibility type, can be compressible, incompressible or weakly-compressible.
 
const bool _porous_medium_treatment
 Switch to show if porous medium treatment is requested or not.
 
const std::vector< std::string > _velocity_names
 Velocity names.
 
const NonlinearVariableName _pressure_name
 Pressure name.
 
const MooseFunctorName _density_name
 Name of the density material property.
 
const MooseFunctorName _dynamic_viscosity_name
 Name of the dynamic viscosity material property.
 
const MooseEnum _velocity_interpolation
 The velocity / momentum face interpolation method for advecting other quantities.
 

Private Member Functions

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 addFVInterpolationMethods ()
 
virtual void addNodalKernels ()
 
virtual void addDiracKernels ()
 
virtual void addDGKernels ()
 
virtual void addScalarKernels ()
 
virtual void addInterfaceKernels ()
 
virtual void addFVInterfaceKernels ()
 
virtual void addFEBCs ()
 
virtual void addNodalBCs ()
 
virtual void addPeriodicBCs ()
 
virtual void addFunctions ()
 
virtual void addAuxiliaryKernels ()
 
virtual void addMaterials ()
 
virtual void addFunctorMaterials ()
 
virtual void addUserObjects ()
 
virtual void addCorrectors ()
 
virtual void addMultiApps ()
 
virtual void addTransfers ()
 
virtual void addPostprocessors ()
 
virtual void addVectorPostprocessors ()
 
virtual void addReporters ()
 
virtual void addOutputs ()
 
virtual void addPreconditioning ()
 
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 RestartableDataValuegetMeshPropertyInternal (const std::string &data_name, const std::string &prefix) const
 
void mooseErrorInternal (Args &&... args) const
 
const TforwardGetParam (const std::string &param_name) const
 
const InputParametersforwardParameters () const
 
bool forwardIsParamSetByUser (const std::string &param_name) const
 
bool forwardIsParamValid (const std::string &param_name) const
 
void forwardParamError (Args &&... args) const
 
void forwardMooseError (Args &&... args) const
 
void forwardMooseWarning (Args &&... args) const
 
const std::string & forwardType () const
 
virtual const std::string & forwardName () const
 
const std::vector< SubdomainName > & forwardBlocks () const
 

Static Private Member Functions

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

Private Attributes

MooseEnum _is_transient
 
std::vector< VariableName > _solver_var_names
 
std::vector< VariableName > _aux_var_names
 
unsigned int _dim
 
std::set< std::string > _required_tasks
 
const ParallelParamObject_parent
 
MooseApp_meta_data_app
 
const MooseObject *const _meta_data_object
 
const MooseBase_si_moose_base
 
const FEProblemBase_si_problem
 
const PhysicsBase *const _customer_class
 

Detailed Description

Creates all the objects needed to solve the Navier Stokes energy equation.

Definition at line 27 of file WCNSFVFluidHeatTransferPhysicsBase.h.

Constructor & Destructor Documentation

◆ WCNSFVFluidHeatTransferPhysicsBase()

WCNSFVFluidHeatTransferPhysicsBase::WCNSFVFluidHeatTransferPhysicsBase ( const InputParameters parameters)

Definition at line 65 of file WCNSFVFluidHeatTransferPhysicsBase.C.

70 isParamValid("add_energy_equation")
71 ? getParam<bool>("add_energy_equation")
72 : (usingNavierStokesFVSyntax() ? isParamSetByUser("energy_inlet_functors") : true)),
73 _solve_for_enthalpy(getParam<bool>("solve_for_enthalpy")),
75 _fluid_temperature_name(getParam<NonlinearVariableName>("fluid_temperature_variable")),
76 _specific_heat_name(getParam<MooseFunctorName>("specific_heat")),
78 parameters.isParamValid("thermal_conductivity_blocks")
79 ? getParam<std::vector<std::vector<SubdomainName>>>("thermal_conductivity_blocks")
80 : std::vector<std::vector<SubdomainName>>()),
81 _thermal_conductivity_name(getParam<std::vector<MooseFunctorName>>("thermal_conductivity")),
83 getParam<std::vector<std::vector<SubdomainName>>>("ambient_convection_blocks")),
84 _ambient_convection_alpha(getParam<std::vector<MooseFunctorName>>("ambient_convection_alpha")),
85 _ambient_temperature(getParam<std::vector<MooseFunctorName>>("ambient_temperature")),
86 _energy_inlet_types(getParam<MultiMooseEnum>("energy_inlet_types")),
87 _energy_inlet_functors(getParam<std::vector<MooseFunctorName>>("energy_inlet_functors")),
88 _energy_wall_types(getParam<MultiMooseEnum>("energy_wall_types")),
89 _energy_wall_functors(getParam<std::vector<MooseFunctorName>>("energy_wall_functors"))
90{
91 // For compatibility with Modules/NavierStokesFV syntax
93 return;
94
97 else
99
100 // set block restrictions if not set by user
101 // This should probably be done for all the coupled physics, tbd
102 if (!isParamSetByUser("block"))
104
105 // Parameter checks
106 checkSecondParamSetOnlyIfFirstOneTrue("solve_for_enthalpy", "initial_enthalpy");
107 checkVectorParamsSameLengthIfSet<MooseFunctorName, MooseFunctorName>("ambient_convection_alpha",
108 "ambient_temperature");
109 checkSecondParamSetOnlyIfFirstOneSet("external_heat_source", "external_heat_source_coeff");
110
111 // Check boundary parameters if provided.
112 // The boundaries are checked again when the boundary conditions are added as we want
113 // to be able to more boundary conditions to a Physics dynamically
114 if (isParamValid("energy_inlet_types"))
115 checkVectorParamAndMultiMooseEnumLength<MooseFunctorName>("energy_inlet_functors",
116 "energy_inlet_types");
117 if (isParamSetByUser("energy_wall_boundaries"))
118 checkVectorParamsSameLengthIfSet<BoundaryName, MooseFunctorName>(
119 "energy_wall_boundaries", "energy_wall_functors", false);
120 if (isParamValid("energy_wall_types"))
121 checkVectorParamAndMultiMooseEnumLength<MooseFunctorName>("energy_wall_functors",
122 "energy_wall_types");
123
124 addRequiredPhysicsTask("get_turbulence_physics");
125 addRequiredPhysicsTask("add_variables_physics");
126 addRequiredPhysicsTask("add_ics_physics");
127 addRequiredPhysicsTask("add_fv_kernel");
128 addRequiredPhysicsTask("add_fv_bc");
129 addRequiredPhysicsTask("add_materials_physics");
130}
void checkSecondParamSetOnlyIfFirstOneTrue(const std::string &param1, const std::string &param2) const
void checkSecondParamSetOnlyIfFirstOneSet(const std::string &param1, const std::string &param2) const
const InputParameters & parameters() const
bool isParamSetByUser(const std::string &name) const
const T & getParam(const std::string &name) const
bool isParamValid(const std::string &name) const
Base class to hold common parameters and utilities between all the weakly compressible Navier Stokes-...
bool usingNavierStokesFVSyntax() const
Detects if we are using the new Physics syntax or the old NavierStokesFV action.
void saveSolverVariableName(const VariableName &var_name)
std::vector< SubdomainName > _blocks
const std::vector< SubdomainName > & blocks() const
void addRequiredPhysicsTask(const std::string &task)
Helper class to interact with a flow and turbulence physics for a Physics that solves an advection pr...
const WCNSFVFlowPhysicsBase * _flow_equations_physics
Flow physics.
std::vector< MooseFunctorName > _energy_inlet_functors
Functors describing the inlet boundary values. See energy_inlet_types for what the functors actually ...
std::vector< MooseFunctorName > _energy_wall_functors
Functors describing the wall boundary values. See energy_wall_types for what the functors actually re...
MooseFunctorName _specific_heat_name
Name of the specific heat material property.
std::vector< MooseFunctorName > _ambient_convection_alpha
Name of the ambient convection heat transfer coefficients for each block-group.
const VariableName _fluid_enthalpy_name
Name of the fluid specific enthalpy.
std::vector< std::vector< SubdomainName > > _ambient_convection_blocks
Vector of subdomain groups where we want to have different ambient convection.
VariableName _fluid_temperature_name
Fluid temperature name.
const bool _has_energy_equation
A boolean to help compatibility with the old Modules/NavierStokesFV syntax.
const bool _solve_for_enthalpy
User-selected option to solve for enthalpy.
std::vector< MooseFunctorName > _thermal_conductivity_name
Name of the thermal conductivity functor for each block-group.
std::vector< std::vector< SubdomainName > > _thermal_conductivity_blocks
Vector of subdomain groups where we want to have different thermal conduction.
MultiMooseEnum _energy_wall_types
Energy wall boundary types.
MultiMooseEnum _energy_inlet_types
Energy inlet boundary types.
std::vector< MooseFunctorName > _ambient_temperature
Name of the solid domain temperature for each block-group.

Member Function Documentation

◆ actOnAdditionalTasks()

void WCNSFVFluidHeatTransferPhysicsBase::actOnAdditionalTasks ( )
overrideprotectedvirtual

Reimplemented from PhysicsBase.

Definition at line 167 of file WCNSFVFluidHeatTransferPhysicsBase.C.

168{
169 // Turbulence physics would not be initialized before this task
170 if (_current_task == "get_turbulence_physics")
171 {
174 }
175}
const std::string & _current_task
const WCNSFVTurbulencePhysicsBase * _turbulence_physics
Turbulence.
const WCNSFVTurbulencePhysicsBase * getCoupledTurbulencePhysics() const
bool _has_turbulence_model
Because of the Modules/navierStokesFV syntax, a turbulence physics often exists without a model we sa...
bool hasTurbulenceModel() const
Whether a turbulence model is in use.

◆ addEnergyAdvectionKernels()

virtual void WCNSFVFluidHeatTransferPhysicsBase::addEnergyAdvectionKernels ( )
protectedpure virtual

◆ addEnergyAmbientConvection()

virtual void WCNSFVFluidHeatTransferPhysicsBase::addEnergyAmbientConvection ( )
protectedpure virtual

◆ addEnergyExternalHeatSource()

virtual void WCNSFVFluidHeatTransferPhysicsBase::addEnergyExternalHeatSource ( )
protectedpure virtual

◆ addEnergyHeatConductionKernels()

virtual void WCNSFVFluidHeatTransferPhysicsBase::addEnergyHeatConductionKernels ( )
protectedpure virtual

◆ addEnergyInletBC()

virtual void WCNSFVFluidHeatTransferPhysicsBase::addEnergyInletBC ( )
protectedpure virtual

Functions adding boundary conditions for the fluid heat transfer equation.

Implemented in WCNSFVFluidHeatTransferPhysics, and WCNSLinearFVFluidHeatTransferPhysics.

Referenced by addFVBCs().

◆ addEnergyOutletBC()

virtual void WCNSFVFluidHeatTransferPhysicsBase::addEnergyOutletBC ( )
protectedpure virtual

◆ addEnergySeparatorBC()

virtual void WCNSFVFluidHeatTransferPhysicsBase::addEnergySeparatorBC ( )
protectedpure virtual

◆ addEnergyTimeKernels()

virtual void WCNSFVFluidHeatTransferPhysicsBase::addEnergyTimeKernels ( )
protectedpure virtual

Functions adding kernels for the incompressible / weakly compressible energy equation.

Implemented in WCNSFVFluidHeatTransferPhysics, and WCNSLinearFVFluidHeatTransferPhysics.

Referenced by addFVKernels().

◆ addEnergyWallBC()

virtual void WCNSFVFluidHeatTransferPhysicsBase::addEnergyWallBC ( )
protectedpure virtual

◆ addFVAdvectedInterpolationMethod()

void NavierStokesPhysicsBase::addFVAdvectedInterpolationMethod ( const MooseEnum interpolation_method)
protectedinherited

Add the FVInterpolationMethod object for an advected interpolation method if absent.

Definition at line 43 of file NavierStokesPhysicsBase.C.

44{
45 const std::string method_name = interpolation_method;
46 if (getProblem().hasFVInterpolationMethod(method_name))
47 return;
48
49 const auto method_type = NS::fvAdvectedInterpolationMethodType(interpolation_method);
50
51 InputParameters params = getFactory().getValidParams(method_type);
52 getProblem().addFVInterpolationMethod(method_type, method_name, params);
53}
virtual void addFVInterpolationMethod(const std::string &method_type, const std::string &name, InputParameters &parameters)
InputParameters getValidParams(const std::string &name) const
virtual FEProblemBase & getProblem()
Factory & getFactory()
std::string fvAdvectedInterpolationMethodType(const MooseEnum &interpolation_method)
Gets the FVInterpolationMethod object type for an advected interpolation method.
Definition NSFVUtils.C:67

Referenced by WCNSLinearFVFlowPhysics::addFVInterpolationMethods(), WCNSLinearFVScalarTransportPhysics::addFVInterpolationMethods(), and WCNSLinearFVTurbulencePhysics::addFVInterpolationMethods().

◆ addFVBCs()

void WCNSFVFluidHeatTransferPhysicsBase::addFVBCs ( )
overrideprotectedvirtual

Reimplemented from PhysicsBase.

Definition at line 154 of file WCNSFVFluidHeatTransferPhysicsBase.C.

155{
156 // For compatibility with Modules/NavierStokesFV syntax
158 return;
159
164}
virtual void addEnergyInletBC()=0
Functions adding boundary conditions for the fluid heat transfer equation.

◆ addFVKernels()

void WCNSFVFluidHeatTransferPhysicsBase::addFVKernels ( )
overrideprotectedvirtual

Reimplemented from PhysicsBase.

Definition at line 133 of file WCNSFVFluidHeatTransferPhysicsBase.C.

134{
135 // For compatibility with Modules/NavierStokesFV syntax
137 return;
138
141 _blocks,
142 /*error if already defined*/ false))
144
147 if (getParam<std::vector<MooseFunctorName>>("ambient_temperature").size())
149 if (isParamValid("external_heat_source"))
151}
bool shouldCreateTimeDerivative(const VariableName &var_name, const std::vector< SubdomainName > &blocks, const bool error_if_already_defined) const
virtual void addEnergyExternalHeatSource()=0
virtual void addEnergyAmbientConvection()=0
virtual void addEnergyTimeKernels()=0
Functions adding kernels for the incompressible / weakly compressible energy equation.
virtual void addEnergyHeatConductionKernels()=0
virtual void addEnergyAdvectionKernels()=0

◆ addInitialConditions()

void WCNSFVFluidHeatTransferPhysicsBase::addInitialConditions ( )
overrideprotectedvirtual

Reimplemented from PhysicsBase.

Definition at line 230 of file WCNSFVFluidHeatTransferPhysicsBase.C.

231{
232 // For compatibility with Modules/NavierStokesFV syntax
234 return;
235 if (!_define_variables && isParamSetByUser("initial_temperature"))
237 "initial_temperature",
238 "T_fluid is defined externally of WCNSFVFluidHeatTransferPhysicsBase, so should the inital "
239 "condition");
240 // do not set initial conditions if we are not defining variables
242 {
243 reportPotentiallyMissedParameters({"initial_temperature", "initial_enthalpy"}, "FunctionIC");
244 return;
245 }
246
247 InputParameters params = getFactory().getValidParams("FVFunctionIC");
248 assignBlocks(params, _blocks);
249
250 // initial_temperature has a default so we should almost always set it (see shouldCreateIC logic)
251 {
252 bool temperature_ic_used = false;
255 _blocks,
256 /*whether IC is a default*/ !isParamSetByUser("initial_temperature"),
257 /*error if already an IC*/ isParamSetByUser("initial_temperature")))
258 {
259 params.set<VariableName>("variable") = _fluid_temperature_name;
260 params.set<FunctionName>("function") = getParam<FunctionName>("initial_temperature");
261
262 getProblem().addFVInitialCondition("FVFunctionIC", _fluid_temperature_name + "_ic", params);
263 temperature_ic_used = true;
264 }
265 // Needed to solve for enthalpy: an initial condition on enthalpy based on the initial
266 // temperature
267 if (isParamValid(NS::fluid) && _solve_for_enthalpy && !isParamValid("initial_enthalpy") &&
269 _blocks,
270 /*whether IC is a default*/ !isParamSetByUser("initial_temperature"),
271 /*error if already an IC*/ isParamSetByUser("initial_temperature")))
272 {
273 // from the FluidProperties module
274 InputParameters params =
275 getFactory().getValidParams("SpecificEnthalpyFromPressureTemperatureIC");
276 assignBlocks(params, _blocks);
277 params.set<VariableName>("variable") = _fluid_enthalpy_name;
278 params.set<UserObjectName>(NS::fluid) = getParam<UserObjectName>(NS::fluid);
279 params.set<std::vector<VariableName>>("p") = {_flow_equations_physics->getPressureName()};
280 Real temp;
281 if (MooseUtils::parsesToReal(getParam<FunctionName>("initial_temperature"), &temp))
282 {
283 params.defaultCoupledValue("T", temp, 0);
284 params.set<std::vector<VariableName>>("T") = {};
285 }
286 else
287 paramError("initial_temperature", "Only Real values supported when solving for enthalpy");
289 "SpecificEnthalpyFromPressureTemperatureIC", _fluid_enthalpy_name + "_ic", params);
290 temperature_ic_used = true;
291 }
292
293 if (!temperature_ic_used && isParamSetByUser("initial_temperature"))
294 reportPotentiallyMissedParameters({"initial_temperature"}, "FunctionIC");
295 }
296 if (isParamValid("initial_enthalpy") && _solve_for_enthalpy &&
298 _blocks,
299 /*whether IC is a default*/ false,
300 /*error if already an IC*/ false))
301 {
302 params.set<VariableName>("variable") = _fluid_enthalpy_name;
303 params.set<FunctionName>("function") = getParam<FunctionName>("initial_enthalpy");
304
305 getProblem().addFVInitialCondition("FVFunctionIC", _fluid_enthalpy_name + "_ic", params);
306 }
307 else if (isParamValid("initial_enthalpy"))
308 reportPotentiallyMissedParameters({"initial_enthalpy"}, "FunctionIC");
309}
virtual void addInitialCondition(const std::string &ic_name, const std::string &name, InputParameters &parameters)
virtual void addFVInitialCondition(const std::string &ic_name, const std::string &name, InputParameters &parameters)
T & set(const std::string &name, bool quiet_mode=false)
Real defaultCoupledValue(const std::string &coupling_name, unsigned int i=0) const
void paramError(const std::string &param, Args... args) const
bool _define_variables
Whether to define variables if they do not exist.
bool shouldCreateIC(const VariableName &var_name, const std::vector< SubdomainName > &blocks, const bool ic_is_default_ic, const bool error_if_already_defined) const
void assignBlocks(InputParameters &params, const std::vector< SubdomainName > &blocks) const
void reportPotentiallyMissedParameters(const std::vector< std::string > &param_names, const std::string &object_type, const std::string &object_name="") const
bool variableExists(const VariableName &var_name, bool error_if_aux) const
const NonlinearVariableName & getPressureName() const
bool parsesToReal(const std::string &input, Real *parsed_real)
static const std::string fluid
Definition NS.h:88
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real

◆ defineEffectiveThermalDiffusionCoeffFunctors()

void WCNSFVFluidHeatTransferPhysicsBase::defineEffectiveThermalDiffusionCoeffFunctors ( const bool  use_ad)
protected

Define the effective diffusion coefficient when:

  • solving with a turbulence model: k <- k+kt
  • solving for enthalpy: k / cp

Definition at line 312 of file WCNSFVFluidHeatTransferPhysicsBase.C.

313{
314 // Define alpha, the diffusion coefficient when solving for enthalpy, on each block
315 for (unsigned int i = 0; i < _thermal_conductivity_name.size(); ++i)
316 {
317 const auto object_type = use_ad ? "ADParsedFunctorMaterial" : "ParsedFunctorMaterial";
318 InputParameters params = getFactory().getValidParams(object_type);
319 assignBlocks(params, _blocks);
320 std::vector<std::string> f_names;
322 f_names.push_back(_thermal_conductivity_name[i]);
324 f_names.push_back(getSpecificHeatName());
325 const auto th_cond_name =
326 _thermal_conductivity_name[i] + (_has_turbulence_model ? "_plus_kt" : "");
328 params.set<std::string>("expression") =
330 (_solve_for_enthalpy ? ("/" + getSpecificHeatName()) : "");
331 else
332 {
333 f_names.push_back("k_t");
334 params.set<std::string>("expression") =
335 "(" + _thermal_conductivity_name[i] + " + k_t) " +
336 (_solve_for_enthalpy ? ("/" + getSpecificHeatName()) : "");
337 }
338 params.set<std::vector<std::string>>("functor_names") = f_names;
339 params.set<std::string>("property_name") = th_cond_name + (_solve_for_enthalpy ? "_by_cp" : "");
341 object_type, prefix() + "rho_alpha_from_" + _thermal_conductivity_name[i], params);
342 }
343}
virtual void addMaterial(const std::string &material_name, const std::string &name, InputParameters &parameters)
std::string prefix() const
const MooseFunctorName & getSpecificHeatName() const
Get the name of the specific heat material property.

Referenced by WCNSFVFluidHeatTransferPhysics::addMaterials(), and WCNSLinearFVFluidHeatTransferPhysics::addMaterials().

◆ densityName()

const MooseFunctorName & WCNSFVCoupledAdvectionPhysicsHelper::densityName ( ) const
inlineinherited

◆ dynamicViscosityName()

const MooseFunctorName & WCNSFVCoupledAdvectionPhysicsHelper::dynamicViscosityName ( ) const
inlineinherited

Definition at line 37 of file WCNSFVCoupledAdvectionPhysicsHelper.h.

const MooseFunctorName _dynamic_viscosity_name
Name of the dynamic viscosity material property.

◆ getAdditionalRMParams()

InputParameters NavierStokesPhysicsBase::getAdditionalRMParams ( ) const
overrideprotectedvirtualinherited

Parameters to change or add relationship managers.

Reimplemented from PhysicsBase.

Definition at line 56 of file NavierStokesPhysicsBase.C.

57{
58 unsigned short necessary_layers = getParam<unsigned short>("ghost_layers");
59 necessary_layers = std::max(necessary_layers, getNumberAlgebraicGhostingLayersNeeded());
60
61 // Just an object that has a ghost_layers parameter
62 const std::string kernel_type = "INSFVMixingLengthReynoldsStress";
63 InputParameters params = getFactory().getValidParams(kernel_type);
64 params.template set<unsigned short>("ghost_layers") = necessary_layers;
65
66 return params;
67}
virtual unsigned short getNumberAlgebraicGhostingLayersNeeded() const =0
Return the number of ghosting layers needed.

◆ getAmbientConvectionBlocks()

const std::vector< std::vector< SubdomainName > > & WCNSFVFluidHeatTransferPhysicsBase::getAmbientConvectionBlocks ( ) const
inline

Get the ambient convection parameters for parameter checking.

Definition at line 47 of file WCNSFVFluidHeatTransferPhysicsBase.h.

48 {
50 }

Referenced by PNSFVSolidHeatTransferPhysics::checkFluidAndSolidHeatTransferPhysicsParameters().

◆ getAmbientConvectionHTCs()

const std::vector< MooseFunctorName > & WCNSFVFluidHeatTransferPhysicsBase::getAmbientConvectionHTCs ( ) const
inline

Name of the ambient convection heat transfer coefficients for each block-group.

Definition at line 52 of file WCNSFVFluidHeatTransferPhysicsBase.h.

53 {
55 }

Referenced by PNSFVSolidHeatTransferPhysics::checkFluidAndSolidHeatTransferPhysicsParameters().

◆ getCoupledFlowPhysics()

const WCNSFVFlowPhysicsBase * WCNSFVCoupledAdvectionPhysicsHelper::getCoupledFlowPhysics ( ) const
inherited

Definition at line 53 of file WCNSFVCoupledAdvectionPhysicsHelper.C.

54{
55 // User passed it, just use that
56 if (_advection_physics->isParamValid("coupled_flow_physics"))
58 _advection_physics->getParam<PhysicsName>("coupled_flow_physics"));
59 // Look for any physics of the right type, and check the block restriction
60 else
61 {
62 const auto all_flow_physics =
64 for (const auto physics : all_flow_physics)
65 if (_advection_physics->checkBlockRestrictionIdentical(
66 physics->name(), physics->blocks(), /*error_if_not_identical=*/false))
67 {
68 return physics;
69 }
70 }
71 mooseError("No coupled flow Physics found of type derived from 'WCNSFVFlowPhysicsBase'. Use the "
72 "'coupled_flow_physics' parameter to give the name of the desired "
73 "WCNSFVFlowPhysicsBase-derived Physics to couple with");
74}
void mooseError(Args &&... args)
char ** blocks
const std::string name
Definition Setup.h:21
const T * getCoupledPhysics(const PhysicsName &phys_name, const bool allow_fail=false) const
const NavierStokesPhysicsBase * _advection_physics
The Physics class using this helper.
Base class for Physics which create the Navier Stokes flow equations.
if(subdm)

◆ getCoupledTurbulencePhysics()

const WCNSFVTurbulencePhysicsBase * WCNSFVCoupledAdvectionPhysicsHelper::getCoupledTurbulencePhysics ( ) const
inherited

Definition at line 77 of file WCNSFVCoupledAdvectionPhysicsHelper.C.

78{
79 // User passed it, just use that
80 if (_advection_physics->isParamValid("coupled_turbulence_physics"))
82 _advection_physics->getParam<PhysicsName>("coupled_turbulence_physics"));
83 // Look for any physics of the right type, and check the block restriction
84 else
85 {
86 const auto all_turbulence_physics =
88 for (const auto physics : all_turbulence_physics)
89 if (_advection_physics->checkBlockRestrictionIdentical(
90 physics->name(), physics->blocks(), /*error_if_not_identical=*/false))
91 return physics;
92 }
93 // Did not find one
94 return nullptr;
95}
Base class for a Physics that creates all the objects needed to add a turbulence model to an incompre...

Referenced by actOnAdditionalTasks(), and WCNSFVScalarTransportPhysicsBase::actOnAdditionalTasks().

◆ getFluidTemperatureName()

const VariableName & WCNSFVFluidHeatTransferPhysicsBase::getFluidTemperatureName ( ) const
inline

Get the name of the fluid temperature variable.

Definition at line 36 of file WCNSFVFluidHeatTransferPhysicsBase.h.

Referenced by WCNSFVTwoPhaseMixturePhysics::addPhaseChangeEnergySource().

◆ getNumberAlgebraicGhostingLayersNeeded()

unsigned short WCNSFVFluidHeatTransferPhysicsBase::getNumberAlgebraicGhostingLayersNeeded ( ) const
overrideprotectedvirtual

Return the number of ghosting layers needed.

Implements NavierStokesPhysicsBase.

Definition at line 346 of file WCNSFVFluidHeatTransferPhysicsBase.C.

347{
348 unsigned short necessary_layers = getParam<unsigned short>("ghost_layers");
349 necessary_layers =
351 if (getParam<MooseEnum>("energy_face_interpolation") == "skewness-corrected")
352 necessary_layers = std::max(necessary_layers, (unsigned short)3);
353
354 return necessary_layers;
355}
unsigned short getNumberAlgebraicGhostingLayersNeeded() const override
Return the number of algebraic ghosting layers needed.

◆ getPorosityFunctorName()

MooseFunctorName WCNSFVCoupledAdvectionPhysicsHelper::getPorosityFunctorName ( bool  smoothed) const
inherited

Return the porosity functor name.

It is important to forward to the Physics so we do not get the smoothing status wrong

Definition at line 47 of file WCNSFVCoupledAdvectionPhysicsHelper.C.

48{
50}
MooseFunctorName getPorosityFunctorName(const bool smoothed) const

◆ getSpecificEnthalpyName()

MooseFunctorName WCNSFVFluidHeatTransferPhysicsBase::getSpecificEnthalpyName ( ) const
inline

Definition at line 40 of file WCNSFVFluidHeatTransferPhysicsBase.h.

40{ return NS::specific_enthalpy; }
static const std::string specific_enthalpy
Definition NS.h:69

◆ getSpecificHeatName()

const MooseFunctorName & WCNSFVFluidHeatTransferPhysicsBase::getSpecificHeatName ( ) const
inline

◆ getThermalConductivityName()

const std::vector< MooseFunctorName > & WCNSFVFluidHeatTransferPhysicsBase::getThermalConductivityName ( ) const
inline

Definition at line 41 of file WCNSFVFluidHeatTransferPhysicsBase.h.

42 {
44 }

◆ hasEnergyEquation()

bool WCNSFVFluidHeatTransferPhysicsBase::hasEnergyEquation ( ) const
inline

◆ processThermalConductivity()

bool WCNSFVFluidHeatTransferPhysicsBase::processThermalConductivity ( )
protected

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

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

Definition at line 178 of file WCNSFVFluidHeatTransferPhysicsBase.C.

179{
180 checkBlockwiseConsistency<MooseFunctorName>("thermal_conductivity_blocks",
181 {"thermal_conductivity"});
182 bool have_scalar = false;
183 bool have_vector = false;
184
185 for (unsigned int i = 0; i < _thermal_conductivity_name.size(); ++i)
186 {
187 // First, check if the name is just a number (only in case of isotropic conduction)
189 have_scalar = true;
190 // Now we determine what kind of functor we are dealing with
191 else
192 {
193 if (getProblem().hasFunctorWithType<ADReal>(_thermal_conductivity_name[i],
194 /*thread_id=*/0) ||
195 getProblem().hasFunctorWithType<Real>(_thermal_conductivity_name[i],
196 /*thread_id=*/0))
197 have_scalar = true;
198 else
199 {
200 if (getProblem().hasFunctorWithType<ADRealVectorValue>(_thermal_conductivity_name[i],
201 /*thread_id=*/0))
202 have_vector = true;
203 else if (getProblem().hasFunctor(_thermal_conductivity_name[i],
204 /*thread_id=*/0))
205 paramError("thermal_conductivity",
206 "We only allow functor of type Real/ADReal or ADRealVectorValue for thermal "
207 "conductivity! Functor '" +
208 _thermal_conductivity_name[i] + "' is not of the requested type.");
209 else
210 // If another Physics is creating this functor, we could be running into an order of
211 // creation problem
212 paramWarning("thermal_conductivity",
213 "Functor '" + _thermal_conductivity_name[i] +
214 "' was not found in the Problem. Did you mispell it?");
215 }
216 }
217 }
218
219 if (have_vector && !_porous_medium_treatment)
220 paramError("thermal_conductivity", "Cannot use anisotropic diffusion with non-porous flows!");
221
222 if (have_vector && (have_vector == have_scalar))
223 paramError("thermal_conductivity",
224 "The entries on thermal conductivity shall either be scalars of vectors, mixing "
225 "them is not supported!");
226 return have_vector;
227}
void paramWarning(const std::string &param, Args... args) const
const bool _porous_medium_treatment
Switch to show if porous medium treatment is requested or not.

Referenced by WCNSFVFluidHeatTransferPhysics::addEnergyHeatConductionKernels(), and WCNSLinearFVFluidHeatTransferPhysics::addEnergyHeatConductionKernels().

◆ usingNavierStokesFVSyntax()

bool NavierStokesPhysicsBase::usingNavierStokesFVSyntax ( ) const
inlineprotectedinherited

Detects if we are using the new Physics syntax or the old NavierStokesFV action.

Definition at line 33 of file NavierStokesPhysicsBase.h.

34 {
35 return (parameters().get<std::string>("registered_identifier") == "Modules/NavierStokesFV");
36 }

◆ validParams()

InputParameters WCNSFVFluidHeatTransferPhysicsBase::validParams ( )
static

Definition at line 17 of file WCNSFVFluidHeatTransferPhysicsBase.C.

18{
21 params.addClassDescription("Define the Navier Stokes weakly-compressible energy equation");
22
25 "effective_conductivity");
26 params.addParamNamesToGroup("effective_conductivity", "Material properties");
27
28 // TODO Remove the parameter once NavierStokesFV syntax has been removed
29 params.addParam<bool>("add_energy_equation",
30 "Whether to add the energy equation. This parameter is not necessary if "
31 "using the Physics syntax");
32 params.addParam<bool>("solve_for_enthalpy",
33 false,
34 "Whether to solve for the enthalpy or the temperature of the fluid");
35 params.addParam<NonlinearVariableName>(
36 "fluid_temperature_variable", NS::T_fluid, "Name of the fluid temperature variable");
37
38 params.addParam<UserObjectName>(NS::fluid, "Fluid properties userobject");
39 params.addParamNamesToGroup(NS::fluid, "Material properties");
40
41 // Initial conditions
42 params.addParam<FunctionName>(
43 "initial_enthalpy",
44 "Initial value of the enthalpy variable, only to be used when solving for enthalpy");
45
46 // Spatial finite volume discretization scheme
47 params.transferParam<MooseEnum>(NSFVBase::validParams(), "energy_advection_interpolation");
48 params.transferParam<MooseEnum>(NSFVBase::validParams(), "energy_face_interpolation");
49 params.transferParam<bool>(NSFVBase::validParams(), "energy_two_term_bc_expansion");
50
51 params.addParamNamesToGroup("specific_heat thermal_conductivity thermal_conductivity_blocks "
52 "use_external_enthalpy_material",
53 "Material properties");
54 params.addParamNamesToGroup("energy_advection_interpolation energy_face_interpolation "
55 "energy_two_term_bc_expansion",
56 "Numerical scheme");
57 params.addParamNamesToGroup("energy_inlet_types energy_inlet_functors",
58 "Inlet boundary conditions");
59 params.addParamNamesToGroup("energy_wall_boundaries energy_wall_types energy_wall_functors",
60 "Wall boundary conditions");
61
62 return params;
63}
void addParamNamesToGroup(const std::string &space_delim_names, const std::string group_name)
void transferParam(const InputParameters &source_param, const std::string &name, const std::string &new_name="", const std::string &new_description="")
void addParam(const std::string &name, const std::initializer_list< typename T::value_type > &value, const std::string &doc_string)
void addClassDescription(const std::string &doc_string)
static InputParameters commonFluidEnergyEquationParams()
Definition NSFVBase.C:197
static InputParameters validParams()
Definition NSFVBase.C:371
static InputParameters validParams()
static const std::string T_fluid
Definition NS.h:110

Referenced by WCNSFVFluidHeatTransferPhysics::validParams(), and WCNSLinearFVFluidHeatTransferPhysics::validParams().

Member Data Documentation

◆ _advection_physics

const NavierStokesPhysicsBase* WCNSFVCoupledAdvectionPhysicsHelper::_advection_physics
protectedinherited

◆ _ambient_convection_alpha

std::vector<MooseFunctorName> WCNSFVFluidHeatTransferPhysicsBase::_ambient_convection_alpha
protected

Name of the ambient convection heat transfer coefficients for each block-group.

Definition at line 109 of file WCNSFVFluidHeatTransferPhysicsBase.h.

Referenced by WCNSFVFluidHeatTransferPhysics::addEnergyAmbientConvection(), WCNSLinearFVFluidHeatTransferPhysics::addEnergyAmbientConvection(), and getAmbientConvectionHTCs().

◆ _ambient_convection_blocks

std::vector<std::vector<SubdomainName> > WCNSFVFluidHeatTransferPhysicsBase::_ambient_convection_blocks
protected

Vector of subdomain groups where we want to have different ambient convection.

Definition at line 107 of file WCNSFVFluidHeatTransferPhysicsBase.h.

Referenced by WCNSFVFluidHeatTransferPhysics::addEnergyAmbientConvection(), WCNSLinearFVFluidHeatTransferPhysics::addEnergyAmbientConvection(), and getAmbientConvectionBlocks().

◆ _ambient_temperature

std::vector<MooseFunctorName> WCNSFVFluidHeatTransferPhysicsBase::_ambient_temperature
protected

Name of the solid domain temperature for each block-group.

Definition at line 111 of file WCNSFVFluidHeatTransferPhysicsBase.h.

Referenced by WCNSFVFluidHeatTransferPhysics::addEnergyAmbientConvection(), and WCNSLinearFVFluidHeatTransferPhysics::addEnergyAmbientConvection().

◆ _compressibility

const MooseEnum WCNSFVCoupledAdvectionPhysicsHelper::_compressibility
protectedinherited

Compressibility type, can be compressible, incompressible or weakly-compressible.

Definition at line 51 of file WCNSFVCoupledAdvectionPhysicsHelper.h.

Referenced by WCNSFVFluidHeatTransferPhysics::addEnergyTimeKernels().

◆ _define_variables

bool NavierStokesPhysicsBase::_define_variables
protectedinherited

◆ _density_name

const MooseFunctorName WCNSFVCoupledAdvectionPhysicsHelper::_density_name
protectedinherited

◆ _dynamic_viscosity_name

const MooseFunctorName WCNSFVCoupledAdvectionPhysicsHelper::_dynamic_viscosity_name
protectedinherited

◆ _energy_inlet_functors

std::vector<MooseFunctorName> WCNSFVFluidHeatTransferPhysicsBase::_energy_inlet_functors
protected

Functors describing the inlet boundary values. See energy_inlet_types for what the functors actually represent.

Definition at line 116 of file WCNSFVFluidHeatTransferPhysicsBase.h.

Referenced by WCNSFVFluidHeatTransferPhysics::addEnergyInletBC(), and WCNSLinearFVFluidHeatTransferPhysics::addEnergyInletBC().

◆ _energy_inlet_types

MultiMooseEnum WCNSFVFluidHeatTransferPhysicsBase::_energy_inlet_types
protected

◆ _energy_wall_functors

std::vector<MooseFunctorName> WCNSFVFluidHeatTransferPhysicsBase::_energy_wall_functors
protected

Functors describing the wall boundary values. See energy_wall_types for what the functors actually represent.

Definition at line 120 of file WCNSFVFluidHeatTransferPhysicsBase.h.

Referenced by WCNSFVFluidHeatTransferPhysics::addEnergyWallBC(), and WCNSLinearFVFluidHeatTransferPhysics::addEnergyWallBC().

◆ _energy_wall_types

MultiMooseEnum WCNSFVFluidHeatTransferPhysicsBase::_energy_wall_types
protected

◆ _flow_equations_physics

const WCNSFVFlowPhysicsBase* WCNSFVCoupledAdvectionPhysicsHelper::_flow_equations_physics
protectedinherited

Flow physics.

Definition at line 43 of file WCNSFVCoupledAdvectionPhysicsHelper.h.

Referenced by WCNSFVTwoPhaseMixturePhysics::addAdvectionSlipTerm(), WCNSFVTurbulencePhysicsBase::addAuxiliaryKernels(), WCNSFVTurbulencePhysics::addAxisymmetricTurbulentViscousSource(), WCNSFVFluidHeatTransferPhysics::addEnergyAdvectionKernels(), WCNSLinearFVFluidHeatTransferPhysics::addEnergyAdvectionKernels(), WCNSFVFluidHeatTransferPhysics::addEnergyHeatConductionKernels(), WCNSFVFluidHeatTransferPhysics::addEnergyInletBC(), WCNSLinearFVFluidHeatTransferPhysics::addEnergyInletBC(), WCNSLinearFVFluidHeatTransferPhysics::addEnergyOutletBC(), WCNSFVFluidHeatTransferPhysics::addEnergySeparatorBC(), WCNSFVFluidHeatTransferPhysics::addEnergyTimeKernels(), WCNSFVFluidHeatTransferPhysics::addEnergyWallBC(), WCNSLinearFVFluidHeatTransferPhysics::addEnergyWallBC(), WCNSFVTurbulencePhysics::addFlowTurbulenceKernels(), WCNSFVTurbulencePhysics::addFluidEnergyTurbulenceKernels(), WCNSFVTwoPhaseMixturePhysics::addFunctorMaterials(), WCNSLinearFVTurbulencePhysics::addFunctorMaterials(), WCNSFVTurbulencePhysics::addFVBCs(), WCNSLinearFVTurbulencePhysics::addFVBCs(), WCNSFVTwoPhaseMixturePhysics::addFVKernels(), WCNSLinearFVTwoPhaseMixturePhysics::addFVKernels(), addInitialConditions(), WCNSFVTurbulencePhysicsBase::addInitialConditions(), WCNSFVTurbulencePhysics::addKEpsilonAdvection(), WCNSLinearFVTurbulencePhysics::addKEpsilonAdvection(), WCNSFVTurbulencePhysics::addKEpsilonDiffusion(), WCNSFVTurbulencePhysics::addKEpsilonSink(), WCNSLinearFVTurbulencePhysics::addKEpsilonSink(), WCNSLinearFVTurbulencePhysics::addKEpsilonTimeDerivatives(), WCNSFVFluidHeatTransferPhysics::addMaterials(), WCNSFVTurbulencePhysicsBase::addMaterials(), WCNSLinearFVFluidHeatTransferPhysics::addMaterials(), WCNSLinearFVTwoPhaseMixturePhysics::addMaterials(), WCNSFVTwoPhaseMixturePhysics::addPhaseDriftFluxTerm(), WCNSLinearFVTwoPhaseMixturePhysics::addPhaseDriftFluxTerm(), WCNSFVScalarTransportPhysics::addScalarAdvectionKernels(), WCNSLinearFVScalarTransportPhysics::addScalarAdvectionKernels(), WCNSFVScalarTransportPhysics::addScalarInletBC(), WCNSLinearFVScalarTransportPhysics::addScalarInletBC(), WCNSLinearFVScalarTransportPhysics::addScalarOutletBC(), WCNSLinearFVTurbulencePhysics::checkIntegrity(), WCNSLinearFVTwoPhaseMixturePhysics::checkIntegrity(), getNumberAlgebraicGhostingLayersNeeded(), WCNSFVScalarTransportPhysicsBase::getNumberAlgebraicGhostingLayersNeeded(), WCNSFVTurbulencePhysics::getNumberAlgebraicGhostingLayersNeeded(), WCNSLinearFVTurbulencePhysics::getNumberAlgebraicGhostingLayersNeeded(), WCNSFVCoupledAdvectionPhysicsHelper::getPorosityFunctorName(), WCNSFVTurbulencePhysicsBase::retrieveCoupledPhysics(), WCNSFVFluidHeatTransferPhysicsBase(), WCNSFVTwoPhaseMixturePhysics::WCNSFVTwoPhaseMixturePhysics(), WCNSLinearFVScalarTransportPhysics::WCNSLinearFVScalarTransportPhysics(), and WCNSLinearFVTwoPhaseMixturePhysics::WCNSLinearFVTwoPhaseMixturePhysics().

◆ _fluid_enthalpy_name

const VariableName WCNSFVFluidHeatTransferPhysicsBase::_fluid_enthalpy_name
protected

◆ _fluid_temperature_name

VariableName WCNSFVFluidHeatTransferPhysicsBase::_fluid_temperature_name
protected

Fluid temperature name.

Definition at line 98 of file WCNSFVFluidHeatTransferPhysicsBase.h.

Referenced by WCNSLinearFVFluidHeatTransferPhysics::addAuxiliaryKernels(), WCNSLinearFVFluidHeatTransferPhysics::addAuxiliaryVariables(), WCNSFVFluidHeatTransferPhysics::addEnergyAdvectionKernels(), WCNSLinearFVFluidHeatTransferPhysics::addEnergyAdvectionKernels(), WCNSFVFluidHeatTransferPhysics::addEnergyAmbientConvection(), WCNSLinearFVFluidHeatTransferPhysics::addEnergyAmbientConvection(), WCNSFVFluidHeatTransferPhysics::addEnergyExternalHeatSource(), WCNSLinearFVFluidHeatTransferPhysics::addEnergyExternalHeatSource(), WCNSFVFluidHeatTransferPhysics::addEnergyHeatConductionKernels(), WCNSLinearFVFluidHeatTransferPhysics::addEnergyHeatConductionKernels(), WCNSFVFluidHeatTransferPhysics::addEnergyInletBC(), WCNSLinearFVFluidHeatTransferPhysics::addEnergyInletBC(), WCNSLinearFVFluidHeatTransferPhysics::addEnergyOutletBC(), WCNSFVFluidHeatTransferPhysics::addEnergySeparatorBC(), WCNSFVFluidHeatTransferPhysics::addEnergyTimeKernels(), WCNSLinearFVFluidHeatTransferPhysics::addEnergyTimeKernels(), WCNSFVFluidHeatTransferPhysics::addEnergyWallBC(), WCNSLinearFVFluidHeatTransferPhysics::addEnergyWallBC(), addFVKernels(), addInitialConditions(), WCNSFVFluidHeatTransferPhysics::addMaterials(), WCNSLinearFVFluidHeatTransferPhysics::addMaterials(), WCNSFVFluidHeatTransferPhysics::addSolverVariables(), WCNSLinearFVFluidHeatTransferPhysics::addSolverVariables(), getFluidTemperatureName(), and WCNSFVFluidHeatTransferPhysicsBase().

◆ _has_energy_equation

const bool WCNSFVFluidHeatTransferPhysicsBase::_has_energy_equation
protected

◆ _has_turbulence_model

bool WCNSFVCoupledAdvectionPhysicsHelper::_has_turbulence_model
protectedinherited

Because of the Modules/navierStokesFV syntax, a turbulence physics often exists without a model we save (_turbulence_physics && _turbulence_physics->hasTurbulenceModel()) in this attribute.

Definition at line 48 of file WCNSFVCoupledAdvectionPhysicsHelper.h.

Referenced by actOnAdditionalTasks(), WCNSFVScalarTransportPhysicsBase::actOnAdditionalTasks(), WCNSLinearFVFluidHeatTransferPhysics::addEnergyHeatConductionKernels(), WCNSLinearFVFluidHeatTransferPhysics::addMaterials(), WCNSLinearFVScalarTransportPhysics::addScalarDiffusionKernels(), and defineEffectiveThermalDiffusionCoeffFunctors().

◆ _porous_medium_treatment

const bool WCNSFVCoupledAdvectionPhysicsHelper::_porous_medium_treatment
protectedinherited

◆ _pressure_name

const NonlinearVariableName WCNSFVCoupledAdvectionPhysicsHelper::_pressure_name
protectedinherited

Pressure name.

Definition at line 59 of file WCNSFVCoupledAdvectionPhysicsHelper.h.

◆ _solve_for_enthalpy

const bool WCNSFVFluidHeatTransferPhysicsBase::_solve_for_enthalpy
protected

User-selected option to solve for enthalpy.

Definition at line 94 of file WCNSFVFluidHeatTransferPhysicsBase.h.

Referenced by WCNSLinearFVFluidHeatTransferPhysics::addAuxiliaryKernels(), WCNSLinearFVFluidHeatTransferPhysics::addAuxiliaryVariables(), WCNSFVFluidHeatTransferPhysics::addEnergyAdvectionKernels(), WCNSFVFluidHeatTransferPhysics::addEnergyAmbientConvection(), WCNSLinearFVFluidHeatTransferPhysics::addEnergyAmbientConvection(), WCNSFVFluidHeatTransferPhysics::addEnergyExternalHeatSource(), WCNSLinearFVFluidHeatTransferPhysics::addEnergyExternalHeatSource(), WCNSFVFluidHeatTransferPhysics::addEnergyHeatConductionKernels(), WCNSLinearFVFluidHeatTransferPhysics::addEnergyHeatConductionKernels(), WCNSFVFluidHeatTransferPhysics::addEnergyInletBC(), WCNSLinearFVFluidHeatTransferPhysics::addEnergyInletBC(), WCNSLinearFVFluidHeatTransferPhysics::addEnergyOutletBC(), WCNSFVFluidHeatTransferPhysics::addEnergySeparatorBC(), WCNSFVFluidHeatTransferPhysics::addEnergyTimeKernels(), WCNSLinearFVFluidHeatTransferPhysics::addEnergyTimeKernels(), WCNSFVFluidHeatTransferPhysics::addEnergyWallBC(), WCNSLinearFVFluidHeatTransferPhysics::addEnergyWallBC(), addFVKernels(), addInitialConditions(), WCNSFVFluidHeatTransferPhysics::addMaterials(), WCNSLinearFVFluidHeatTransferPhysics::addMaterials(), WCNSFVFluidHeatTransferPhysics::addSolverVariables(), WCNSLinearFVFluidHeatTransferPhysics::addSolverVariables(), defineEffectiveThermalDiffusionCoeffFunctors(), and WCNSFVFluidHeatTransferPhysicsBase().

◆ _specific_heat_name

MooseFunctorName WCNSFVFluidHeatTransferPhysicsBase::_specific_heat_name
protected

◆ _thermal_conductivity_blocks

std::vector<std::vector<SubdomainName> > WCNSFVFluidHeatTransferPhysicsBase::_thermal_conductivity_blocks
protected

Vector of subdomain groups where we want to have different thermal conduction.

Definition at line 102 of file WCNSFVFluidHeatTransferPhysicsBase.h.

Referenced by WCNSFVFluidHeatTransferPhysics::addEnergyHeatConductionKernels(), and WCNSLinearFVFluidHeatTransferPhysics::addEnergyHeatConductionKernels().

◆ _thermal_conductivity_name

std::vector<MooseFunctorName> WCNSFVFluidHeatTransferPhysicsBase::_thermal_conductivity_name
protected

◆ _turbulence_physics

const WCNSFVTurbulencePhysicsBase* WCNSFVCoupledAdvectionPhysicsHelper::_turbulence_physics
protectedinherited

◆ _velocity_interpolation

const MooseEnum WCNSFVCoupledAdvectionPhysicsHelper::_velocity_interpolation
protectedinherited

The velocity / momentum face interpolation method for advecting other quantities.

Definition at line 67 of file WCNSFVCoupledAdvectionPhysicsHelper.h.

Referenced by WCNSFVFluidHeatTransferPhysics::addEnergyAdvectionKernels(), WCNSFVTurbulencePhysics::addKEpsilonAdvection(), and WCNSFVScalarTransportPhysics::addScalarAdvectionKernels().

◆ _velocity_names

const std::vector<std::string> WCNSFVCoupledAdvectionPhysicsHelper::_velocity_names
protectedinherited

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