Base class for a Physics that creates all the objects needed to add a turbulence model to an incompressible / weakly-compressible Navier Stokes finite volume flow simulation. More...

#include <WCNSFVTurbulencePhysicsBase.h>

Inheritance diagram for WCNSFVTurbulencePhysicsBase:

[legend]

Public Types
typedef DataFileName	DataFileParameterType

Public Member Functions
	WCNSFVTurbulencePhysicsBase (const InputParameters &parameters)

bool	hasTurbulenceModel () const
	Whether a turbulence model is in use.

std::vector< BoundaryName >	turbulenceWalls () const
	The names of the boundaries with turbulence wall functions.

MooseEnum	turbulenceEpsilonWallTreatment () const
	The turbulence epsilon wall treatment (same for all turbulence walls currently)

MooseEnum	turbulenceTemperatureWallTreatment () const
	The turbulence temperature wall treatment (same for all turbulence walls currently)

MooseFunctorName	tkeName () const
	The name of the turbulent kinetic energy variable.

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 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

const WCNSFVFlowPhysicsBase *	getCoupledFlowPhysics () const

const WCNSFVTurbulencePhysicsBase *	getCoupledTurbulencePhysics () 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
virtual void	actOnAdditionalTasks () override

void	retrieveCoupledPhysics ()
	Retrieve the other WCNSFVPhysics at play in the simulation to be able to add the relevant terms (turbulent diffusion notably)

virtual void	addSolverVariables () override=0

virtual void	addAuxiliaryVariables () override

virtual void	addFVKernels () override=0

virtual void	addFVBCs () override=0

virtual void	addAuxiliaryKernels () override

virtual void	addInitialConditions () override

virtual void	addMaterials () override

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.

virtual unsigned short	getNumberAlgebraicGhostingLayersNeeded () const =0
	Return the number of ghosting layers needed.

void	assertParamDefined (const std::string &param) const

bool	isTransient () const

Factory &	getFactory ()

Factory &	getFactory () const

virtual FEProblemBase &	getProblem ()

virtual const FEProblemBase &	getProblem () const

void	prepareCopyVariablesFromMesh () const

void	copyVariablesFromMesh (const std::vector< VariableName > &variables_to_copy, bool are_nonlinear=true)

std::string	prefix () const

void	addUserObject (const std::string &uo_type, const std::string &uo_name, InputParameters &params)

void	saveSolverVariableName (const VariableName &var_name)

void	saveAuxVariableName (const VariableName &var_name)

bool	variableExists (const VariableName &var_name, bool error_if_aux) const

bool	solverVariableExists (const VariableName &var_name) const

const SolverSystemName &	getSolverSystem (unsigned int variable_index) const

const SolverSystemName &	getSolverSystem (const VariableName &variable_name) const

void	addRequiredPhysicsTask (const std::string &task)

void	assignBlocks (InputParameters &params, const std::vector< SubdomainName > &blocks) const

bool	allMeshBlocks (const std::vector< SubdomainName > &blocks) const

bool	allMeshBlocks (const std::set< SubdomainName > &blocks) const

std::set< SubdomainID >	getSubdomainIDs (const std::set< SubdomainName > &blocks) const

std::vector< std::string >	getSubdomainNamesAndIDs (const std::set< SubdomainID > &blocks) const

void	addPetscPairsToPetscOptions (const std::vector< std::pair< MooseEnumItem, std::string > > &petsc_pair_options)

bool	isVariableFV (const VariableName &var_name) const

bool	isVariableScalar (const VariableName &var_name) const

bool	shouldCreateVariable (const VariableName &var_name, const std::vector< SubdomainName > &blocks, const bool error_if_aux)

bool	shouldCreateIC (const VariableName &var_name, const std::vector< SubdomainName > &blocks, const bool ic_is_default_ic, const bool error_if_already_defined) const

bool	shouldCreateTimeDerivative (const VariableName &var_name, const std::vector< SubdomainName > &blocks, const bool error_if_already_defined) const

void	reportPotentiallyMissedParameters (const std::vector< std::string > &param_names, const std::string &object_type, const std::string &object_name="") const

virtual void	checkIntegrity () const

void	associateWithParameter (const std::string &param_name, InputParameters &params) const

void	associateWithParameter (const InputParameters &from_params, const std::string &param_name, InputParameters &params) const

const T &	getMeshProperty (const std::string &data_name, const std::string &prefix)

const T &	getMeshProperty (const std::string &data_name)

bool	hasMeshProperty (const std::string &data_name, const std::string &prefix) const

bool	hasMeshProperty (const std::string &data_name, const std::string &prefix) const

bool	hasMeshProperty (const std::string &data_name) const

bool	hasMeshProperty (const std::string &data_name) const

std::string	meshPropertyName (const std::string &data_name) const

PerfID	registerTimedSection (const std::string &section_name, const unsigned int level) const

PerfID	registerTimedSection (const std::string &section_name, const unsigned int level, const std::string &live_message, const bool print_dots=true) const

std::string	timedSectionName (const std::string &section_name) const

void	flagInvalidSolutionInternal (const InvalidSolutionID invalid_solution_id) const

InvalidSolutionID	registerInvalidSolutionInternal (const std::string &message, const bool warning) const

void	checkParamsBothSetOrNotSet (const std::string &param1, const std::string &param2) const

void	checkSecondParamSetOnlyIfFirstOneTrue (const std::string &param1, const std::string &param2) const

void	checkSecondParamSetOnlyIfFirstOneSet (const std::string &param1, const std::string &param2) const

void	checkSecondParamNotSetIfFirstOneSet (const std::string &param1, const std::string &param2) const

void	checkVectorParamsSameLength (const std::string &param1, const std::string &param2) const

void	checkVectorParamAndMultiMooseEnumLength (const std::string &param1, const std::string &param2) const

void	checkTwoDVectorParamsSameLength (const std::string &param1, const std::string &param2) const

void	checkVectorParamsNoOverlap (const std::vector< std::string > &param_vecs) const

void	checkTwoDVectorParamsNoRespectiveOverlap (const std::vector< std::string > &param_vecs) const

void	checkTwoDVectorParamInnerSameLengthAsOneDVector (const std::string &param1, const std::string &param2) const

void	checkTwoDVectorParamMultiMooseEnumSameLength (const std::string &param1, const std::string &param2, const bool error_for_param2) const

void	checkVectorParamNotEmpty (const std::string &param1) const

void	checkVectorParamsSameLengthIfSet (const std::string &param1, const std::string &param2, const bool ignore_empty_default_param2=false) const

void	checkVectorParamLengthSameAsCombinedOthers (const std::string &param1, const std::string &param2, const std::string &param3) const

void	checkBlockwiseConsistency (const std::string &block_param_name, const std::vector< std::string > &parameter_names) const

bool	parameterConsistent (const InputParameters &other_param, const std::string &param_name) const

void	warnInconsistent (const InputParameters &parameters, const std::string &param_name) const

void	errorDependentParameter (const std::string &param1, const std::string &value_not_set, const std::vector< std::string > &dependent_params) const

void	errorInconsistentDependentParameter (const std::string &param1, const std::string &value_set, const std::vector< std::string > &dependent_params) const

Static Protected Member Functions
static std::string	meshPropertyName (const std::string &data_name, const std::string &prefix)

Protected Attributes
const MooseEnum	_turbulence_model
	Turbulence model to create the equation(s) for.

bool	_has_flow_equations

bool	_has_energy_equation

bool	_has_scalar_equations

const WCNSFVFluidHeatTransferPhysicsBase *	_fluid_energy_physics
	The heat advection physics to add turbulent mixing for.

const WCNSFVScalarTransportPhysicsBase *	_scalar_transport_physics
	The scalar advection physics to add turbulent mixing for.

std::vector< BoundaryName >	_turbulence_walls
	List of boundaries to act as walls for turbulence models.

MooseEnum	_wall_treatment_eps
	Turbulence wall treatment for epsilon (same for all walls currently)

MooseEnum	_wall_treatment_temp
	Turbulence wall treatment for temperature (same for all walls currently)

const VariableName	_tke_name
	Name of the turbulent kinetic energy.

const VariableName	_tked_name
	Name of the turbulent kinetic energy dissipation.

const VariableName	_turbulent_viscosity_name = NS::mu_t
	Name of the turbulence viscosity auxiliary variable (or property)

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	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	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 RestartableDataValue &	getMeshPropertyInternal (const std::string &data_name, const std::string &prefix) const

void	mooseErrorInternal (Args &&... args) const

const T &	forwardGetParam (const std::string &param_name) const

const InputParameters &	forwardParameters () const

bool	forwardIsParamSetByUser (const std::string &param_name) const

bool	forwardIsParamValid (const std::string &param_name) const

void	forwardParamError (Args &&... args) const

void	forwardMooseError (Args &&... args) const

void	forwardMooseWarning (Args &&... args) const

const std::string &	forwardType () const

virtual const std::string &	forwardName () const

const std::vector< SubdomainName > &	forwardBlocks () const

Static Private Member Functions
static const hit::Node *	getHitNode (const InputParameters &params)

static std::string	messagePrefix (const InputParameters &params, const bool hit_prefix)

Private Attributes
MooseEnum	_is_transient

std::vector< VariableName >	_solver_var_names

std::vector< VariableName >	_aux_var_names

unsigned int	_dim

std::set< std::string >	_required_tasks

const ParallelParamObject &	_parent

MooseApp &	_meta_data_app

const MooseObject *const	_meta_data_object

const MooseBase &	_si_moose_base

const FEProblemBase *	_si_problem

const PhysicsBase *const	_customer_class

Detailed Description

Base class for a Physics that creates all the objects needed to add a turbulence model to an incompressible / weakly-compressible Navier Stokes finite volume flow simulation.

Definition at line 34 of file WCNSFVTurbulencePhysicsBase.h.

Constructor & Destructor Documentation

◆ WCNSFVTurbulencePhysicsBase()

WCNSFVTurbulencePhysicsBase::WCNSFVTurbulencePhysicsBase ( const InputParameters & parameters )

Definition at line 155 of file WCNSFVTurbulencePhysicsBase.C.

  : NavierStokesPhysicsBase(parameters),
    WCNSFVCoupledAdvectionPhysicsHelper(this),
    _turbulence_model(getParam<MooseEnum>("turbulence_handling")),
    _turbulence_walls(getParam<std::vector<BoundaryName>>("turbulence_walls")),
    _wall_treatment_eps(getParam<MooseEnum>("wall_treatment_eps")),
    _wall_treatment_temp(getParam<MooseEnum>("wall_treatment_T")),
    _tke_name(getParam<MooseFunctorName>("tke_name")),
    _tked_name(getParam<MooseFunctorName>("tked_name"))
{
  if (_verbose && _turbulence_model != "none")
    _console << "Creating a " << std::string(_turbulence_model) << " turbulence model."
             << std::endl;
 
  // Keep track of the variable names, for loading variables from files notably
  if (_turbulence_model == "k-epsilon")
  {
    saveSolverVariableName(_tke_name);
    saveSolverVariableName(_tked_name);
    if (getParam<bool>("mu_t_as_aux_variable"))
      saveAuxVariableName(_turbulent_viscosity_name);
    if (getParam<bool>("k_t_as_aux_variable"))
      saveAuxVariableName(NS::k_t);
  }
 
  // Parameter checks
  if (_turbulence_model == "none")
    errorInconsistentDependentParameter("turbulence_handling", "none", {"turbulence_walls"});
  if (_turbulence_model != "k-epsilon")
  {
    errorDependentParameter("turbulence_handling",
                            "k-epsilon",
                            {"C_mu",
                             "C1_eps",
                             "C2_eps",
                             "bulk_wall_treatment",
                             "tke_scaling",
                             "tke_face_interpolation",
                             "tke_two_term_bc_expansion",
                             "tked_scaling",
                             "tked_face_interpolation",
                             "tked_two_term_bc_expansion",
                             "turbulent_viscosity_two_term_bc_expansion"});
    checkSecondParamSetOnlyIfFirstOneTrue("mu_t_as_aux_variable", "initial_mu_t");
  }
}

Member Function Documentation

◆ actOnAdditionalTasks()

void WCNSFVTurbulencePhysicsBase::actOnAdditionalTasks ( )

overrideprotectedvirtual

Reimplemented from PhysicsBase.

Definition at line 203 of file WCNSFVTurbulencePhysicsBase.C.

{
  // Other Physics may not exist or be initialized at construction time, so
  // we retrieve them now, on this task which occurs after 'init_physics'
  if (_current_task == "get_turbulence_physics")
    retrieveCoupledPhysics();
}

◆ addAuxiliaryKernels()

void WCNSFVTurbulencePhysicsBase::addAuxiliaryKernels ( )

overrideprotectedvirtual

Reimplemented from PhysicsBase.

Reimplemented in WCNSFVTurbulencePhysics.

Definition at line 378 of file WCNSFVTurbulencePhysicsBase.C.

{
  const std::string u_names[3] = {"u", "v", "w"};
  // Not future-proof
  const bool is_linear = dynamic_cast<WCNSLinearFVTurbulencePhysics *>(this);
 
  if (_turbulence_model == "k-epsilon" && getParam<bool>("mu_t_as_aux_variable"))
  {
    auto params = getFactory().getValidParams("kEpsilonViscosityAux");
    assignBlocks(params, _blocks);
 
    params.set<AuxVariableName>("variable") = _turbulent_viscosity_name;
    params.set<MooseFunctorName>(NS::density) = _flow_equations_physics->densityName();
    params.set<MooseFunctorName>(NS::mu) = _flow_equations_physics->dynamicViscosityName();
    params.set<MooseFunctorName>(NS::TKE) = _tke_name;
    params.set<MooseFunctorName>(NS::TKED) = _tked_name;
    params.set<std::vector<BoundaryName>>("walls") = _turbulence_walls;
    params.set<MooseEnum>("wall_treatment") = _wall_treatment_eps;
    for (const auto d : make_range(dimension()))
      params.set<MooseFunctorName>(u_names[d]) = _velocity_names[d];
 
    params.set<bool>("newton_solve") = !is_linear;
    params.applySpecificParameters(parameters(), {"C_mu", "bulk_wall_treatment", "mu_t_ratio_max"});
    params.set<ExecFlagEnum>("execute_on") = {EXEC_NONLINEAR};
 
    getProblem().addAuxKernel("kEpsilonViscosityAux", name() + "_viscosity_aux", params);
  }
  if (_turbulence_model == "k-epsilon" && _has_energy_equation &&
      getParam<bool>("k_t_as_aux_variable"))
  {
    auto params = getFactory().getValidParams("TurbulentConductivityAux");
    assignBlocks(params, _blocks);
    params.set<AuxVariableName>("variable") = NS::k_t;
    params.set<MooseFunctorName>(NS::cp) = _fluid_energy_physics->getSpecificHeatName();
    params.set<MooseFunctorName>(NS::mu_t) = _turbulent_viscosity_name;
    params.applySpecificParameters(parameters(), {"Pr_t"});
    getProblem().addAuxKernel(
        "TurbulentConductivityAux", name() + "_thermal_conductivity_aux", params);
  }
}

Referenced by WCNSFVTurbulencePhysics::addAuxiliaryKernels().

◆ addAuxiliaryVariables()

void WCNSFVTurbulencePhysicsBase::addAuxiliaryVariables ( )

overrideprotectedvirtual

Reimplemented from PhysicsBase.

Reimplemented in WCNSFVTurbulencePhysics.

Definition at line 350 of file WCNSFVTurbulencePhysicsBase.C.

{
  // Not future-proof
  const bool is_linear = dynamic_cast<WCNSLinearFVTurbulencePhysics *>(this);
  const auto var_type = is_linear ? "MooseLinearVariableFVReal" : "MooseVariableFVReal";
 
  if (_turbulence_model == "k-epsilon" && getParam<bool>("mu_t_as_aux_variable"))
  {
    auto params = getFactory().getValidParams(var_type);
    assignBlocks(params, _blocks);
    if (!is_linear && isParamValid("turbulent_viscosity_two_term_bc_expansion"))
      params.set<bool>("two_term_boundary_expansion") =
          getParam<bool>("turbulent_viscosity_two_term_bc_expansion");
    if (!shouldCreateVariable(_turbulent_viscosity_name, _blocks, /*error if aux*/ false))
      reportPotentiallyMissedParameters({"turbulent_viscosity_two_term_bc_expansion"}, var_type);
    else
      getProblem().addAuxVariable(var_type, _turbulent_viscosity_name, params);
  }
  if (_turbulence_model == "k-epsilon" && getParam<bool>("k_t_as_aux_variable"))
  {
    auto params = getFactory().getValidParams(var_type);
    assignBlocks(params, _blocks);
    if (shouldCreateVariable(NS::k_t, _blocks, /*error if aux*/ false))
      getProblem().addAuxVariable(var_type, NS::k_t, params);
  }
}

Referenced by WCNSFVTurbulencePhysics::addAuxiliaryVariables().

◆ 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.

{
  const std::string method_name = interpolation_method;
  if (getProblem().hasFVInterpolationMethod(method_name))
    return;
 
  const auto method_type = NS::fvAdvectedInterpolationMethodType(interpolation_method);
 
  InputParameters params = getFactory().getValidParams(method_type);
  getProblem().addFVInterpolationMethod(method_type, method_name, params);
}

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

◆ addFVBCs()

virtual void WCNSFVTurbulencePhysicsBase::addFVBCs ( )

overrideprotectedpure virtual

Reimplemented from PhysicsBase.

Implemented in WCNSFVTurbulencePhysics, and WCNSLinearFVTurbulencePhysics.

◆ addFVKernels()

virtual void WCNSFVTurbulencePhysicsBase::addFVKernels ( )

overrideprotectedpure virtual

Reimplemented from PhysicsBase.

Implemented in WCNSFVTurbulencePhysics, and WCNSLinearFVTurbulencePhysics.

◆ addInitialConditions()

void WCNSFVTurbulencePhysicsBase::addInitialConditions ( )

overrideprotectedvirtual

Reimplemented from PhysicsBase.

Definition at line 283 of file WCNSFVTurbulencePhysicsBase.C.

{
  if (_turbulence_model == "mixing-length" || _turbulence_model == "none")
    return;
  const std::string ic_type = "FVFunctionIC";
  InputParameters params = getFactory().getValidParams(ic_type);
 
  // Parameter checking: error if initial conditions are provided but not going to be used
  if ((getParam<bool>("initialize_variables_from_mesh_file") || !_define_variables) &&
      ((getParam<bool>("mu_t_as_aux_variable") && isParamValid("initial_mu_t")) ||
       isParamSetByUser("initial_tke") || isParamSetByUser("initial_tked")))
    mooseError("inital_mu_t/tke/tked should not be provided if we are restarting from a mesh file "
               "or not defining variables in the Physics");
 
  // do not set initial conditions if we are not defining variables
  if (!_define_variables)
    return;
  // on regular restarts (from checkpoint), we obey the user specification of initial conditions
 
  if (getParam<bool>("mu_t_as_aux_variable"))
  {
    const auto rho_name = _flow_equations_physics->densityName();
    // If the user provided an initial value, we use that
    if (isParamValid("initial_mu_t"))
      params.set<FunctionName>("function") = getParam<FunctionName>("initial_mu_t");
    // If we can compute the initialization value from the user parameters, we do that
    else if (MooseUtils::isFloat(rho_name) &&
             MooseUtils::isFloat(getParam<FunctionName>("initial_tke")) &&
             MooseUtils::isFloat(getParam<FunctionName>("initial_tked")))
      params.set<FunctionName>("function") =
          std::to_string(std::atof(rho_name.c_str()) * getParam<Real>("C_mu") *
                         std::pow(std::atof(getParam<FunctionName>("initial_tke").c_str()), 2) /
                         std::atof(getParam<FunctionName>("initial_tked").c_str()));
    else
      paramError("initial_mu_t",
                 "Initial turbulent viscosity should be provided. A sensible value is "
                 "rho * C_mu TKE_initial^2 / TKED_initial");
 
    params.set<VariableName>("variable") = _turbulent_viscosity_name;
    // Always obey the user specification of an initial condition
    if (shouldCreateIC(_turbulent_viscosity_name,
                       _blocks,
                       /*whether IC is a default*/ !isParamSetByUser("initial_mu_t"),
                       /*error if already an IC*/ isParamSetByUser("initial_mu_t")))
      getProblem().addFVInitialCondition(ic_type, prefix() + "initial_mu_turb", params);
  }
  else if (isParamSetByUser("initial_mu_t"))
    paramError("initial_mu_t",
               "This parameter can only be specified if 'mu_t_as_aux_variable=true'");
 
  params.set<VariableName>("variable") = _tke_name;
  params.set<FunctionName>("function") = getParam<FunctionName>("initial_tke");
  if (shouldCreateIC(_tke_name,
                     _blocks,
                     /*whether IC is a default*/ !isParamSetByUser("initial_tke"),
                     /*error if already an IC*/ isParamSetByUser("initial_tke")))
    getProblem().addFVInitialCondition(ic_type, prefix() + "initial_tke", params);
  params.set<VariableName>("variable") = _tked_name;
  params.set<FunctionName>("function") = getParam<FunctionName>("initial_tked");
  if (shouldCreateIC(_tked_name,
                     _blocks,
                     /*whether IC is a default*/ !isParamSetByUser("initial_tked"),
                     /*error if already an IC*/ isParamSetByUser("initial_tked")))
    getProblem().addFVInitialCondition(ic_type, prefix() + "initial_tked", params);
}

◆ addMaterials()

void WCNSFVTurbulencePhysicsBase::addMaterials ( )

overrideprotectedvirtual

Reimplemented from PhysicsBase.

Reimplemented in WCNSFVTurbulencePhysics.

Definition at line 420 of file WCNSFVTurbulencePhysicsBase.C.

{
  // Not future-proof
  const bool is_linear = dynamic_cast<WCNSLinearFVTurbulencePhysics *>(this);
  if (_turbulence_model == "k-epsilon")
  {
    if (!getProblem().hasFunctor(NS::mu_eff, /*thread_id=*/0))
    {
      const auto mat_type =
          is_linear ? "FunctorEffectiveDynamicViscosity" : "ADFunctorEffectiveDynamicViscosity";
      InputParameters params = getFactory().getValidParams(mat_type);
      assignBlocks(params, _blocks);
      params.set<MooseFunctorName>("property_name") = NS::mu_eff;
      params.set<MooseFunctorName>(NS::mu) = _flow_equations_physics->dynamicViscosityName();
      params.set<MooseFunctorName>(NS::mu_t) = _turbulent_viscosity_name;
      params.set<MooseFunctorName>(NS::mu_t + "_inverse_factor") = "1";
      getProblem().addMaterial(mat_type, prefix() + "effective_viscosity", params);
    }
    if (!getParam<bool>("mu_t_as_aux_variable"))
    {
      InputParameters params = getFactory().getValidParams("INSFVkEpsilonViscosityFunctorMaterial");
      params.set<MooseFunctorName>(NS::TKE) = _tke_name;
      params.set<MooseFunctorName>(NS::TKED) = _tked_name;
      params.set<MooseFunctorName>(NS::density) = _density_name;
      params.set<ExecFlagEnum>("execute_on") = {EXEC_NONLINEAR};
      if (getParam<bool>("output_mu_t"))
        params.set<std::vector<OutputName>>("outputs") = {"all"};
      getProblem().addMaterial(
          "INSFVkEpsilonViscosityFunctorMaterial", prefix() + "compute_mu_t", params);
    }
 
    if (_has_energy_equation && !getProblem().hasFunctor(NS::k_t, /*thread_id=*/0))
    {
      mooseAssert(!getParam<bool>("k_t_as_aux_variable"), "k_t should not exist");
      const auto object_type = is_linear ? "ParsedFunctorMaterial" : "ADParsedFunctorMaterial";
      InputParameters params = getFactory().getValidParams(object_type);
      assignBlocks(params, _blocks);
      const auto mu_t_name = NS::mu_t;
      const auto cp_name = _fluid_energy_physics->getSpecificHeatName();
      const auto Pr_t_name = getParam<MooseFunctorName>("Pr_t");
 
      // Avoid defining floats as functors in the parsed expression
      if (!MooseUtils::isFloat(cp_name) && !MooseUtils::isFloat(Pr_t_name))
        params.set<std::vector<std::string>>("functor_names") = {cp_name, Pr_t_name, mu_t_name};
      else if (MooseUtils::isFloat(cp_name) && !MooseUtils::isFloat(Pr_t_name))
        params.set<std::vector<std::string>>("functor_names") = {Pr_t_name, mu_t_name};
      else if (!MooseUtils::isFloat(cp_name) && MooseUtils::isFloat(Pr_t_name))
        params.set<std::vector<std::string>>("functor_names") = {cp_name, mu_t_name};
      else
        params.set<std::vector<std::string>>("functor_names") = {mu_t_name};
 
      params.set<std::string>("expression") = mu_t_name + "*" + cp_name + "/" + Pr_t_name;
      params.set<std::string>("property_name") = NS::k_t;
      params.set<ExecFlagEnum>("execute_on") = {EXEC_NONLINEAR};
      params.set<std::vector<OutputName>>("outputs") = {"all"};
      getProblem().addMaterial(object_type, prefix() + "turbulent_heat_eff_conductivity", params);
    }
 
    if (_has_scalar_equations)
    {
      const auto scalar_diffs = _scalar_transport_physics->getParam<std::vector<MooseFunctorName>>(
          "passive_scalar_diffusivity");
      const auto mat_type =
          is_linear ? "FunctorEffectiveDynamicViscosity" : "ADFunctorEffectiveDynamicViscosity";
      InputParameters params = getFactory().getValidParams(mat_type);
      params.set<MooseFunctorName>(NS::mu) = _flow_equations_physics->dynamicViscosityName();
      params.set<MooseFunctorName>(NS::mu_t) = _turbulent_viscosity_name;
      const auto & rho_name = _flow_equations_physics->densityName();
      params.set<MooseFunctorName>(NS::mu_t + "_inverse_factor") = rho_name;
      const auto turbulent_schmidt_number = getParam<std::vector<Real>>("Sc_t");
      assignBlocks(params, _blocks);
      // LinearFV can only use 1 diffusion kernel per equation, so we create N_scalars mu_effs
      if (is_linear)
        for (const auto i : index_range(scalar_diffs))
        {
          if (!getProblem().hasFunctor(scalar_diffs[i] + "_eff", /*thread_id=*/0))
          {
            params.set<MooseFunctorName>("property_name") = scalar_diffs[i] + "_plus_mut/Sc_t";
            params.set<bool>("add_dynamic_viscosity") = true;
            params.set<Real>(NS::mu_t + "_extra_inverse_factor") =
                (turbulent_schmidt_number.size() == 1 ? turbulent_schmidt_number[0]
                                                      : turbulent_schmidt_number[i]);
            getProblem().addMaterial(
                mat_type, prefix() + "mu_eff_passive_scalar_" + std::to_string(i), params);
          }
        }
      // WCNSFV can add multiple diffusion kernels
      else
      {
        params.set<MooseFunctorName>("property_name") = "mu_t_passive_scalar";
        params.set<bool>("add_dynamic_viscosity") = false;
        if (turbulent_schmidt_number.size() != 1)
          paramError("passive_scalar_schmidt_number",
                     "A single passive scalar turbulent Schmidt number can and must be specified "
                     "with k-epsilon and the WCNSFV discretization.");
        params.set<Real>(NS::mu_t + "_extra_inverse_factor") = turbulent_schmidt_number[0];
        getProblem().addMaterial(mat_type, prefix() + "mu_t_passive_scalars", params);
      }
    }
  }
}

Referenced by WCNSFVTurbulencePhysics::addMaterials().

◆ addSolverVariables()

virtual void WCNSFVTurbulencePhysicsBase::addSolverVariables ( )

overrideprotectedpure virtual

Reimplemented from PhysicsBase.

Implemented in WCNSFVTurbulencePhysics, and WCNSLinearFVTurbulencePhysics.

◆ densityName()

const MooseFunctorName & WCNSFVCoupledAdvectionPhysicsHelper::densityName ( ) const

inlineinherited

Definition at line 36 of file WCNSFVCoupledAdvectionPhysicsHelper.h.

36{ return _density_name; }

Referenced by WCNSFVTwoPhaseMixturePhysics::WCNSFVTwoPhaseMixturePhysics(), and WCNSLinearFVTwoPhaseMixturePhysics::WCNSLinearFVTwoPhaseMixturePhysics().

◆ dynamicViscosityName()

const MooseFunctorName & WCNSFVCoupledAdvectionPhysicsHelper::dynamicViscosityName ( ) const

inlineinherited

Definition at line 37 of file WCNSFVCoupledAdvectionPhysicsHelper.h.

37{ return _dynamic_viscosity_name; }

WCNSFVCoupledAdvectionPhysicsHelper::_dynamic_viscosity_name

const MooseFunctorName _dynamic_viscosity_name

Name of the dynamic viscosity material property.

Definition WCNSFVCoupledAdvectionPhysicsHelper.h:64

◆ getAdditionalRMParams()

InputParameters NavierStokesPhysicsBase::getAdditionalRMParams ( ) const

overrideprotectedvirtualinherited

Parameters to change or add relationship managers.

Reimplemented from PhysicsBase.

Definition at line 56 of file NavierStokesPhysicsBase.C.

{
  unsigned short necessary_layers = getParam<unsigned short>("ghost_layers");
  necessary_layers = std::max(necessary_layers, getNumberAlgebraicGhostingLayersNeeded());
 
  // Just an object that has a ghost_layers parameter
  const std::string kernel_type = "INSFVMixingLengthReynoldsStress";
  InputParameters params = getFactory().getValidParams(kernel_type);
  params.template set<unsigned short>("ghost_layers") = necessary_layers;
 
  return params;
}

◆ getCoupledFlowPhysics()

const WCNSFVFlowPhysicsBase * WCNSFVCoupledAdvectionPhysicsHelper::getCoupledFlowPhysics ( ) const

inherited

Definition at line 53 of file WCNSFVCoupledAdvectionPhysicsHelper.C.

{
  // User passed it, just use that
  if (_advection_physics->isParamValid("coupled_flow_physics"))
    return _advection_physics->getCoupledPhysics<WCNSFVFlowPhysicsBase>(
        _advection_physics->getParam<PhysicsName>("coupled_flow_physics"));
  // Look for any physics of the right type, and check the block restriction
  else
  {
    const auto all_flow_physics =
        _advection_physics->getCoupledPhysics<const WCNSFVFlowPhysicsBase>();
    for (const auto physics : all_flow_physics)
      if (_advection_physics->checkBlockRestrictionIdentical(
              physics->name(), physics->blocks(), /*error_if_not_identical=*/false))
      {
        return physics;
      }
  }
  mooseError("No coupled flow Physics found of type derived from 'WCNSFVFlowPhysicsBase'. Use the "
             "'coupled_flow_physics' parameter to give the name of the desired "
             "WCNSFVFlowPhysicsBase-derived Physics to couple with");
}

◆ getCoupledTurbulencePhysics()

const WCNSFVTurbulencePhysicsBase * WCNSFVCoupledAdvectionPhysicsHelper::getCoupledTurbulencePhysics ( ) const

inherited

Definition at line 77 of file WCNSFVCoupledAdvectionPhysicsHelper.C.

{
  // User passed it, just use that
  if (_advection_physics->isParamValid("coupled_turbulence_physics"))
    return _advection_physics->getCoupledPhysics<WCNSFVTurbulencePhysicsBase>(
        _advection_physics->getParam<PhysicsName>("coupled_turbulence_physics"));
  // Look for any physics of the right type, and check the block restriction
  else
  {
    const auto all_turbulence_physics =
        _advection_physics->getCoupledPhysics<const WCNSFVTurbulencePhysicsBase>(true);
    for (const auto physics : all_turbulence_physics)
      if (_advection_physics->checkBlockRestrictionIdentical(
              physics->name(), physics->blocks(), /*error_if_not_identical=*/false))
        return physics;
  }
  // Did not find one
  return nullptr;
}

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

◆ getNumberAlgebraicGhostingLayersNeeded()

virtual unsigned short NavierStokesPhysicsBase::getNumberAlgebraicGhostingLayersNeeded ( ) const

protectedpure virtualinherited

Return the number of ghosting layers needed.

Implemented in WCNSFVFlowPhysics, WCNSFVFlowPhysicsBase, WCNSFVFluidHeatTransferPhysicsBase, WCNSFVScalarTransportPhysicsBase, WCNSFVTurbulencePhysics, WCNSLinearFVFlowPhysics, WCNSLinearFVScalarTransportPhysics, and WCNSLinearFVTurbulencePhysics.

Referenced by NavierStokesPhysicsBase::getAdditionalRMParams().

◆ 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.

{
  return _flow_equations_physics->getPorosityFunctorName(smoothed);
}

◆ hasTurbulenceModel()

bool WCNSFVTurbulencePhysicsBase::hasTurbulenceModel ( ) const

inline

Whether a turbulence model is in use.

Definition at line 43 of file WCNSFVTurbulencePhysicsBase.h.

43{ return _turbulence_model != "none"; }

Referenced by WCNSFVFluidHeatTransferPhysicsBase::actOnAdditionalTasks(), WCNSFVScalarTransportPhysicsBase::actOnAdditionalTasks(), and WCNSFVFlowPhysicsBase::hasTurbulencePhysics().

◆ retrieveCoupledPhysics()

void WCNSFVTurbulencePhysicsBase::retrieveCoupledPhysics ( )

protected

Retrieve the other WCNSFVPhysics at play in the simulation to be able to add the relevant terms (turbulent diffusion notably)

Definition at line 212 of file WCNSFVTurbulencePhysicsBase.C.

{
  // _flow_equations_physics is initialized by 'WCNSFVCoupledAdvectionPhysicsHelper'
  if (_flow_equations_physics && _flow_equations_physics->hasFlowEquations())
    _has_flow_equations = true;
  else
    _has_flow_equations = false;
 
  // Sanity check for interaction for fluid heat transfer physics
  if (isParamValid("fluid_heat_transfer_physics") && _turbulence_model != "none")
  {
    _fluid_energy_physics = getCoupledPhysics<WCNSFVFluidHeatTransferPhysicsBase>(
        getParam<PhysicsName>("fluid_heat_transfer_physics"), true);
    // Check for a missing parameter / do not support isolated physics for now
    if (!_fluid_energy_physics &&
        !getCoupledPhysics<const WCNSFVFluidHeatTransferPhysicsBase>(true).empty())
      paramError("fluid_heat_transfer_physics",
                 "We currently do not support creating both turbulence physics and fluid heat "
                 "transfer physics that are not coupled together. Use "
                 "'fluid_heat_transfer_physics' to explicitly specify the coupling");
    if (_fluid_energy_physics && _fluid_energy_physics->hasEnergyEquation())
      _has_energy_equation = true;
    else
      _has_energy_equation = false;
  }
  else
  {
    _has_energy_equation = false;
    _fluid_energy_physics = nullptr;
  }
 
  // Sanity check for interaction with scalar transport physics
  if (isParamValid("scalar_transport_physics") && _turbulence_model != "none")
  {
    _scalar_transport_physics = getCoupledPhysics<WCNSFVScalarTransportPhysicsBase>(
        getParam<PhysicsName>("scalar_transport_physics"), true);
    if (!_scalar_transport_physics &&
        !getCoupledPhysics<const WCNSFVScalarTransportPhysicsBase>(true).empty())
      paramError(
          "scalar_transport_physics",
          "We currently do not support creating both turbulence physics and scalar transport "
          "physics that are not coupled together");
    if (_scalar_transport_physics && _scalar_transport_physics->hasScalarEquations())
      _has_scalar_equations = true;
    else
      _has_scalar_equations = false;
  }
  else
  {
    _has_scalar_equations = false;
    _scalar_transport_physics = nullptr;
  }
 
  // To help remediate the danger of the parameter setup
  if (_verbose)
  {
    if (_has_energy_equation)
      mooseInfoRepeated("Coupling turbulence physics with fluid heat transfer physics " +
                        _fluid_energy_physics->name());
    else
      mooseInfoRepeated("No fluid heat transfer equation considered by this turbulence "
                        "physics.");
    if (_has_scalar_equations)
      mooseInfoRepeated("Coupling turbulence physics with scalar transport physics " +
                        _scalar_transport_physics->name());
    else
      mooseInfoRepeated("No scalar transport equations considered by this turbulence physics.");
  }
}

Referenced by actOnAdditionalTasks().

◆ tkeName()

MooseFunctorName WCNSFVTurbulencePhysicsBase::tkeName ( ) const

inline

The name of the turbulent kinetic energy variable.

Definition at line 51 of file WCNSFVTurbulencePhysicsBase.h.

51{ return _tke_name; }

Referenced by WCNSFVFluidHeatTransferPhysics::addEnergyWallBC().

◆ turbulenceEpsilonWallTreatment()

MooseEnum WCNSFVTurbulencePhysicsBase::turbulenceEpsilonWallTreatment ( ) const

inline

The turbulence epsilon wall treatment (same for all turbulence walls currently)

Definition at line 47 of file WCNSFVTurbulencePhysicsBase.h.

47{ return _wall_treatment_eps; }

◆ turbulenceTemperatureWallTreatment()

MooseEnum WCNSFVTurbulencePhysicsBase::turbulenceTemperatureWallTreatment ( ) const

inline

The turbulence temperature wall treatment (same for all turbulence walls currently)

Definition at line 49 of file WCNSFVTurbulencePhysicsBase.h.

49{ return _wall_treatment_temp; }

Referenced by WCNSFVFluidHeatTransferPhysics::addEnergyWallBC().

◆ turbulenceWalls()

std::vector< BoundaryName > WCNSFVTurbulencePhysicsBase::turbulenceWalls ( ) const

inline

The names of the boundaries with turbulence wall functions.

Definition at line 45 of file WCNSFVTurbulencePhysicsBase.h.

45{ return _turbulence_walls; }

Referenced by WCNSFVFluidHeatTransferPhysics::addEnergyWallBC().

◆ 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.

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

◆ validParams()

InputParameters WCNSFVTurbulencePhysicsBase::validParams ( )

static

Definition at line 23 of file WCNSFVTurbulencePhysicsBase.C.

{
  InputParameters params = NavierStokesPhysicsBase::validParams();
  params += WCNSFVCoupledAdvectionPhysicsHelper::validParams();
  params.addClassDescription(
      "Define a turbulence model for a incompressible or weakly-compressible Navier Stokes "
      "flow with a finite volume discretization");
 
  MooseEnum turbulence_type("mixing-length k-epsilon none", "none");
  params.addParam<MooseEnum>(
      "turbulence_handling",
      turbulence_type,
      "The way turbulent diffusivities are determined in the turbulent regime.");
  params += NSFVBase::commonTurbulenceParams();
 
  params.deprecateParam("mixing_length_walls", "turbulence_walls", "");
 
  // Not implemented, re-enable with k-epsilon
  params.suppressParameter<MooseEnum>("preconditioning");
 
  // K-Epsilon parameters
  params.addParam<MooseFunctorName>(
      "tke_name", NS::TKE, "Name of the turbulent kinetic energy variable");
  params.addParam<MooseFunctorName>(
      "tked_name", NS::TKED, "Name of the turbulent kinetic energy dissipation variable");
  params.addParam<FunctionName>(
      "initial_tke", "0", "Initial value for the turbulence kinetic energy");
  params.addParam<FunctionName>(
      "initial_tked", "0", "Initial value for the turbulence kinetic energy dissipation");
  params.addParam<FunctionName>("initial_mu_t", "Initial value for the turbulence viscosity");
 
  params.addParam<MooseFunctorName>(
      "C1_eps", "C1 coefficient for the turbulent kinetic energy dissipation equation");
  params.addParam<MooseFunctorName>(
      "C2_eps", "C2 coefficient for the turbulent kinetic energy dissipation equation");
  params.addParam<MooseFunctorName>(
      "sigma_k", "Scaling coefficient for the turbulent kinetic energy diffusion term");
  params.addParam<MooseFunctorName>(
      "sigma_eps",
      "Scaling coefficient for the turbulent kinetic energy dissipation diffusion term");
  params.addParam<MooseFunctorName>(
      NS::turbulent_Prandtl, NS::turbulent_Prandtl, "Turbulent Prandtl number");
  params.transferParam<Real>(INSFVTKESourceSink::validParams(), "C_pl");
  params.transferParam<Real>(kEpsilonViscosityAux::validParams(), "mu_t_ratio_max");
 
  // Boundary parameters
  params.addParam<bool>("bulk_wall_treatment", true, "Whether to treat the wall cell as bulk");
  MooseEnum wall_treatment("eq_newton eq_incremental eq_linearized neq", "neq");
  params.addParam<MooseEnum>("wall_treatment_eps",
                             wall_treatment,
                             "The method used for computing the epsilon wall functions and the "
                             "turbulence viscosity wall functions");
  params.addParam<MooseEnum>("wall_treatment_T",
                             wall_treatment,
                             "The method used for computing the temperature wall functions");
  params.transferParam<Real>(INSFVTurbulentViscosityWallFunction::validParams(), "C_mu");
 
  // K-Epsilon numerical scheme parameters
  MooseEnum face_interpol_types("average skewness-corrected", "average");
  MooseEnum adv_interpol_types(NS::fvAdvectedInterpolationMethods());
  params.addParam<MooseEnum>("tke_face_interpolation",
                             face_interpol_types,
                             "The numerical scheme to interpolate the TKE to the "
                             "face (separate from the advected quantity interpolation).");
  params.addParam<MooseEnum>("tke_advection_interpolation",
                             adv_interpol_types,
                             "The numerical scheme to interpolate the TKE to the "
                             "face when in the advection kernel.");
  params.addParam<bool>(
      "tke_two_term_bc_expansion",
      false,
      "If a two-term Taylor expansion is needed for the determination of the boundary values"
      "of the turbulent kinetic energy.");
 
  params.addParam<MooseEnum>("tked_face_interpolation",
                             face_interpol_types,
                             "The numerical scheme to interpolate the TKED to the "
                             "face (separate from the advected quantity interpolation).");
  params.addParam<MooseEnum>("tked_advection_interpolation",
                             adv_interpol_types,
                             "The numerical scheme to interpolate the TKED to the "
                             "face when in the advection kernel.");
  params.addParam<bool>(
      "tked_two_term_bc_expansion",
      false,
      "If a two-term Taylor expansion is needed for the determination of the boundary values"
      "of the turbulent kinetic energy dissipation.");
  params.addParam<bool>(
      "turbulent_viscosity_two_term_bc_expansion",
      true,
      "If a two-term Taylor expansion is needed for the determination of the boundary values"
      "of the turbulent viscosity.");
  params.addParam<bool>("mu_t_as_aux_variable",
                        false,
                        "Whether to use an auxiliary variable instead of a functor material "
                        "property for the turbulent viscosity");
  params.addParam<bool>("output_mu_t", true, "Whether to add mu_t to the field outputs");
  params.addParam<bool>("k_t_as_aux_variable",
                        false,
                        "Whether to use an auxiliary variable for the turbulent conductivity");
 
  // Add the coupled physics
  // TODO Remove the defaults once NavierStokesFV action is removed
  // It is a little risky right now because the user could forget to pass the parameter and
  // be missing the influence of turbulence on either of these physics. There is a check in the
  // constructor to present this from happening
  params.addParam<PhysicsName>(
      "fluid_heat_transfer_physics",
      "NavierStokesFV",
      "WCNS(Linear)FVFluidHeatTransferPhysics generating the heat advection equations");
  params.addParam<PhysicsName>(
      "scalar_transport_physics",
      "NavierStokesFV",
      "WCNS(Linear)FVScalarTransportPhysics generating the scalar advection equations");
 
  // Parameter groups
  params.addParamNamesToGroup("fluid_heat_transfer_physics turbulent_prandtl "
                              "scalar_transport_physics Sc_t",
                              "Coupled Physics");
  params.addParamNamesToGroup("initial_tke initial_tked C1_eps C2_eps sigma_k sigma_eps",
                              "K-Epsilon model");
  params.addParamNamesToGroup("C_mu bulk_wall_treatment wall_treatment_eps wall_treatment_T",
                              "K-Epsilon wall function");
  params.addParamNamesToGroup("tke_face_interpolation tke_two_term_bc_expansion "
                              "tked_face_interpolation tked_two_term_bc_expansion "
                              "turbulent_viscosity_two_term_bc_expansion "
                              "mu_t_as_aux_variable k_t_as_aux_variable",
                              "K-Epsilon model numerical");
 
  return params;
}

Referenced by WCNSFVTurbulencePhysics::validParams(), and WCNSLinearFVTurbulencePhysics::validParams().

Member Data Documentation

◆ _advection_physics

const NavierStokesPhysicsBase* WCNSFVCoupledAdvectionPhysicsHelper::_advection_physics

protectedinherited

The Physics class using this helper.

Definition at line 41 of file WCNSFVCoupledAdvectionPhysicsHelper.h.

Referenced by WCNSFVCoupledAdvectionPhysicsHelper::getCoupledFlowPhysics(), and WCNSFVCoupledAdvectionPhysicsHelper::getCoupledTurbulencePhysics().

◆ _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

Whether to define variables if they do not exist.

Definition at line 48 of file NavierStokesPhysicsBase.h.

Referenced by WCNSFVTurbulencePhysics::addAuxiliaryVariables(), WCNSLinearFVFluidHeatTransferPhysics::addAuxiliaryVariables(), WCNSFVFlowPhysicsBase::addInitialConditions(), WCNSFVFluidHeatTransferPhysicsBase::addInitialConditions(), WCNSFVScalarTransportPhysicsBase::addInitialConditions(), addInitialConditions(), WCNSFVFlowPhysics::addSolverVariables(), WCNSFVFluidHeatTransferPhysics::addSolverVariables(), WCNSFVTurbulencePhysics::addSolverVariables(), WCNSLinearFVFlowPhysics::addSolverVariables(), WCNSLinearFVFluidHeatTransferPhysics::addSolverVariables(), WCNSLinearFVTurbulencePhysics::addSolverVariables(), and WCNSFVFlowPhysicsBase::WCNSFVFlowPhysicsBase().

◆ _density_name

const MooseFunctorName WCNSFVCoupledAdvectionPhysicsHelper::_density_name

protectedinherited

Name of the density material property.

Definition at line 62 of file WCNSFVCoupledAdvectionPhysicsHelper.h.

Referenced by WCNSFVFluidHeatTransferPhysics::addEnergyInletBC(), WCNSFVFluidHeatTransferPhysics::addEnergyTimeKernels(), WCNSLinearFVFluidHeatTransferPhysics::addEnergyTimeKernels(), WCNSFVFluidHeatTransferPhysics::addEnergyWallBC(), WCNSFVTurbulencePhysics::addFlowTurbulenceKernels(), WCNSFVTurbulencePhysics::addFluidEnergyTurbulenceKernels(), WCNSFVFluidHeatTransferPhysics::addMaterials(), WCNSFVTurbulencePhysics::addMaterials(), addMaterials(), WCNSFVScalarTransportPhysics::addScalarInletBC(), and WCNSFVCoupledAdvectionPhysicsHelper::densityName().

◆ _dynamic_viscosity_name

const MooseFunctorName WCNSFVCoupledAdvectionPhysicsHelper::_dynamic_viscosity_name

protectedinherited

Name of the dynamic viscosity material property.

Definition at line 64 of file WCNSFVCoupledAdvectionPhysicsHelper.h.

Referenced by WCNSFVFluidHeatTransferPhysics::addEnergyWallBC(), WCNSFVTurbulencePhysics::addMaterials(), and WCNSFVCoupledAdvectionPhysicsHelper::dynamicViscosityName().

◆ _flow_equations_physics

const WCNSFVFlowPhysicsBase* WCNSFVCoupledAdvectionPhysicsHelper::_flow_equations_physics

protectedinherited

Flow physics.

Definition at line 43 of file WCNSFVCoupledAdvectionPhysicsHelper.h.

◆ _fluid_energy_physics

const WCNSFVFluidHeatTransferPhysicsBase* WCNSFVTurbulencePhysicsBase::_fluid_energy_physics

protected

The heat advection physics to add turbulent mixing for.

Definition at line 75 of file WCNSFVTurbulencePhysicsBase.h.

Referenced by addAuxiliaryKernels(), WCNSFVTurbulencePhysics::addFluidEnergyTurbulenceKernels(), addMaterials(), and retrieveCoupledPhysics().

◆ _has_energy_equation

bool WCNSFVTurbulencePhysicsBase::_has_energy_equation

protected

Definition at line 71 of file WCNSFVTurbulencePhysicsBase.h.

Referenced by addAuxiliaryKernels(), WCNSFVTurbulencePhysics::addFVKernels(), addMaterials(), and retrieveCoupledPhysics().

◆ _has_flow_equations

bool WCNSFVTurbulencePhysicsBase::_has_flow_equations

protected

Definition at line 70 of file WCNSFVTurbulencePhysicsBase.h.

Referenced by WCNSFVTurbulencePhysics::addFVKernels(), and retrieveCoupledPhysics().

◆ _has_scalar_equations

bool WCNSFVTurbulencePhysicsBase::_has_scalar_equations

protected

Definition at line 72 of file WCNSFVTurbulencePhysicsBase.h.

Referenced by WCNSFVTurbulencePhysics::addFVKernels(), addMaterials(), and retrieveCoupledPhysics().

◆ _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 WCNSFVFluidHeatTransferPhysicsBase::actOnAdditionalTasks(), WCNSFVScalarTransportPhysicsBase::actOnAdditionalTasks(), WCNSLinearFVFluidHeatTransferPhysics::addEnergyHeatConductionKernels(), WCNSLinearFVFluidHeatTransferPhysics::addMaterials(), WCNSLinearFVScalarTransportPhysics::addScalarDiffusionKernels(), and WCNSFVFluidHeatTransferPhysicsBase::defineEffectiveThermalDiffusionCoeffFunctors().