Creates all the objects needed to add a turbulence model to an incompressible / weakly-compressible Navier Stokes finite volume flow simulation. More...

#include <WCNSFVTurbulencePhysics.h>

Inheritance diagram for WCNSFVTurbulencePhysics:

[legend]

Public Types
typedef DataFileName	DataFileParameterType

Public Member Functions
	WCNSFVTurbulencePhysics (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	initializePhysicsAdditional () override

unsigned short	getNumberAlgebraicGhostingLayersNeeded () const override
	Return the number of ghosting layers needed.

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	addInitialConditions () 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.

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

bool	isTransient () const

Factory &	getFactory ()

Factory &	getFactory () const

virtual FEProblemBase &	getProblem ()

virtual const FEProblemBase &	getProblem () const

void	prepareCopyVariablesFromMesh () const

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

std::string	prefix () const

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

void	saveSolverVariableName (const VariableName &var_name)

void	saveAuxVariableName (const VariableName &var_name)

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

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

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

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

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

bool	solverVariableExists (const VariableName &var_name) const

const SolverSystemName &	getSolverSystem (unsigned int variable_index) const

const SolverSystemName &	getSolverSystem (const VariableName &variable_name) const

void	addRequiredPhysicsTask (const std::string &task)

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

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

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

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

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

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

bool	isVariableFV (const VariableName &var_name) const

bool	isVariableScalar (const VariableName &var_name) const

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

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

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

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

virtual void	checkIntegrity () const

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

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

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

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

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

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

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

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

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

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

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

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

void	flagInvalidSolutionInternal (const InvalidSolutionID invalid_solution_id) const

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

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

void	checkAtMostOneParamSetByUser (const std::vector< std::string > &params) const

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Protected Attributes
const 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	addSolverVariables () override

virtual void	addAuxiliaryVariables () override

virtual void	addFVKernels () override

virtual void	addFVBCs () override

virtual void	addAuxiliaryKernels () override

virtual void	addMaterials () override

void	addFlowTurbulenceKernels ()
	Functions adding kernels for turbulence in the other equation(s)

void	addFluidEnergyTurbulenceKernels ()

void	addScalarAdvectionTurbulenceKernels ()

void	addAxisymmetricTurbulentViscousSource ()

void	addKEpsilonTimeDerivatives ()
	Functions adding kernels for the k-epsilon to the k-epsilon equations.

void	addKEpsilonAdvection ()

void	addKEpsilonDiffusion ()

void	addKEpsilonSink ()

virtual void	addRelationshipManagers (Moose::RelationshipManagerType input_rm_type) override

bool	addRelationshipManagers (Moose::RelationshipManagerType when_type, const InputParameters &moose_object_pars)

virtual void	addRelationshipManagers (Moose::RelationshipManagerType when_type)

void	initializePhysics ()

virtual void	checkIntegrityEarly () const

virtual void	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
const VariableName	_mixing_length_name
	Name of the mixing length auxiliary variable.

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 add a turbulence model to an incompressible / weakly-compressible Navier Stokes finite volume flow simulation.

Definition at line 19 of file WCNSFVTurbulencePhysics.h.

Constructor & Destructor Documentation

◆ WCNSFVTurbulencePhysics()

WCNSFVTurbulencePhysics::WCNSFVTurbulencePhysics ( const InputParameters & parameters )

Definition at line 66 of file WCNSFVTurbulencePhysics.C.

  : WCNSFVTurbulencePhysicsBase(parameters),
    _mixing_length_name(getParam<AuxVariableName>("mixing_length_name"))
{
  // Keep track of the variable names, for loading variables from files notably
  if (_turbulence_model == "mixing-length")
    saveAuxVariableName(_mixing_length_name);
 
  // Parameter checks
  if (_turbulence_model != "mixing-length")
    errorDependentParameter("turbulence_handling",
                            "mixing-length",
                            {"mixing_length_delta",
                             "mixing_length_aux_execute_on",
                             "von_karman_const",
                             "von_karman_const_0",
                             "mixing_length_two_term_bc_expansion"});
}

Member Function Documentation

◆ actOnAdditionalTasks()

void WCNSFVTurbulencePhysicsBase::actOnAdditionalTasks ( )

overrideprotectedvirtualinherited

Reimplemented from PhysicsBase.

Definition at line 205 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 WCNSFVTurbulencePhysics::addAuxiliaryKernels ( )

overrideprivatevirtual

Reimplemented from WCNSFVTurbulencePhysicsBase.

Definition at line 508 of file WCNSFVTurbulencePhysics.C.

{
  WCNSFVTurbulencePhysicsBase::addAuxiliaryKernels();
 
  // Note that if we are restarting this will overwrite the restarted mixing-length
  if (_turbulence_model == "mixing-length")
  {
    const std::string ml_kernel_type = "WallDistanceMixingLengthAux";
    InputParameters ml_params = getFactory().getValidParams(ml_kernel_type);
    assignBlocks(ml_params, _blocks);
    ml_params.set<AuxVariableName>("variable") = _mixing_length_name;
    ml_params.set<std::vector<BoundaryName>>("walls") = _turbulence_walls;
    if (parameters().isParamValid("mixing_length_aux_execute_on"))
      ml_params.set<ExecFlagEnum>("execute_on") =
          getParam<ExecFlagEnum>("mixing_length_aux_execute_on");
    else
      ml_params.set<ExecFlagEnum>("execute_on") = {EXEC_INITIAL, EXEC_TIMESTEP_END};
    ml_params.set<MooseFunctorName>("von_karman_const") =
        getParam<MooseFunctorName>("von_karman_const");
    ml_params.set<MooseFunctorName>("von_karman_const_0") =
        getParam<MooseFunctorName>("von_karman_const_0");
    ml_params.set<MooseFunctorName>("delta") = getParam<MooseFunctorName>("mixing_length_delta");
 
    getProblem().addAuxKernel(ml_kernel_type, prefix() + "mixing_length_aux ", ml_params);
  }
}

◆ addAuxiliaryVariables()

void WCNSFVTurbulencePhysics::addAuxiliaryVariables ( )

overrideprivatevirtual

Reimplemented from WCNSFVTurbulencePhysicsBase.

Definition at line 141 of file WCNSFVTurbulencePhysics.C.

{
  if (_turbulence_model == "mixing-length" && _define_variables)
  {
    auto params = getFactory().getValidParams("MooseVariableFVReal");
    if (isParamValid("mixing_length_two_term_bc_expansion"))
      params.set<bool>("two_term_boundary_expansion") =
          getParam<bool>("mixing_length_two_term_bc_expansion");
    if (!shouldCreateVariable(_mixing_length_name, _blocks, /*error if aux*/ false))
      reportPotentiallyMissedParameters({"mixing_length_two_term_bc_expansion"},
                                        "MooseVariableFVReal");
    else
      addSharedAuxVariable("MooseVariableFVReal", _mixing_length_name, params);
  }
  WCNSFVTurbulencePhysicsBase::addAuxiliaryVariables();
}

◆ addAxisymmetricTurbulentViscousSource()

void WCNSFVTurbulencePhysics::addAxisymmetricTurbulentViscousSource ( )

private

Definition at line 260 of file WCNSFVTurbulencePhysics.C.

{
  if (_turbulence_model == "none")
    return;
  if (!_flow_equations_physics)
    return;
  if (!_flow_equations_physics->addAxisymmetricViscousSourceEnabled())
    return;
 
  const auto rz_blocks = _flow_equations_physics->getAxisymmetricRZBlocks();
  if (rz_blocks.empty())
    return;
 
  const auto radial_index =
      _flow_equations_physics->getProblem().mesh().getAxisymmetricRadialCoord();
 
  InputParameters params = getFactory().getValidParams("INSFVMomentumViscousSourceRZ");
  assignBlocks(params, rz_blocks);
  params.set<MooseFunctorName>(NS::mu) = _turbulent_viscosity_name;
  params.set<UserObjectName>("rhie_chow_user_object") = _flow_equations_physics->rhieChowUOName();
  params.set<MooseEnum>("momentum_component") = NS::directions[radial_index];
  params.set<bool>("complete_expansion") =
      _flow_equations_physics->includeSymmetrizedViscousStress();
  params.set<NonlinearVariableName>("variable") =
      _flow_equations_physics->getVelocityNames()[radial_index];
 
  getProblem().addFVKernel("INSFVMomentumViscousSourceRZ",
                           prefix() + "ins_momentum_turbulent_viscous_source_rz_" +
                               NS::directions[radial_index],
                           params);
}

Referenced by addFlowTurbulenceKernels().

◆ addFlowTurbulenceKernels()

void WCNSFVTurbulencePhysics::addFlowTurbulenceKernels ( )

private

Functions adding kernels for turbulence in the other equation(s)

Definition at line 184 of file WCNSFVTurbulencePhysics.C.

{
  if (_turbulence_model == "mixing-length")
  {
    const std::string u_names[3] = {"u", "v", "w"};
    const std::string kernel_type = "INSFVMixingLengthReynoldsStress";
    InputParameters params = getFactory().getValidParams(kernel_type);
    assignBlocks(params, _blocks);
    params.set<MooseFunctorName>(NS::density) = _density_name;
    params.set<MooseFunctorName>(NS::mixing_length) = _mixing_length_name;
 
    std::string kernel_name = prefix() + "ins_momentum_mixing_length_reynolds_stress_";
    if (_porous_medium_treatment)
      kernel_name = prefix() + "pins_momentum_mixing_length_reynolds_stress_";
 
    params.set<UserObjectName>("rhie_chow_user_object") = _flow_equations_physics->rhieChowUOName();
    for (const auto dim_i : make_range(dimension()))
      params.set<MooseFunctorName>(u_names[dim_i]) = _velocity_names[dim_i];
 
    for (const auto d : make_range(dimension()))
    {
      params.set<NonlinearVariableName>("variable") = _velocity_names[d];
      params.set<MooseEnum>("momentum_component") = NS::directions[d];
 
      getProblem().addFVKernel(kernel_type, kernel_name + NS::directions[d], params);
    }
  }
  else if (_turbulence_model == "k-epsilon")
  {
    // We rely on using the turbulent viscosity in the flow equation
    // This check is rudimentary, we should think of a better way
    // We could also check for the use of 'mu_t' with the right parameters already
    if (_flow_equations_physics->dynamicViscosityName() != "mu" &&
        !MooseUtils::isFloat(_flow_equations_physics->dynamicViscosityName()))
      mooseError(
          "Regular fluid viscosity 'mu' should be used for the momentum diffusion term. You are "
          "currently using: " +
          _flow_equations_physics->dynamicViscosityName());
 
    const std::string u_names[3] = {"u", "v", "w"};
    const std::string kernel_type = "INSFVMomentumDiffusion";
    InputParameters params = getFactory().getValidParams(kernel_type);
    assignBlocks(params, _blocks);
    params.set<MooseFunctorName>("mu") = _turbulent_viscosity_name;
    params.set<MooseEnum>("mu_interp_method") =
        getParam<MooseEnum>("turbulent_viscosity_interp_method");
    params.set<MooseEnum>("variable_interp_method") =
        _flow_equations_physics->getMomentumFaceInterpolationMethod();
    params.set<bool>("complete_expansion") = true;
    if (_flow_equations_physics->includeIsotropicStress())
      params.set<bool>("include_isotropic_viscous_stress") = true;
 
    std::string kernel_name = prefix() + "ins_momentum_k_epsilon_reynolds_stress_";
    if (_porous_medium_treatment)
      kernel_name = prefix() + "pins_momentum_k_epsilon_reynolds_stress_";
 
    params.set<UserObjectName>("rhie_chow_user_object") = _flow_equations_physics->rhieChowUOName();
    for (const auto dim_i : make_range(dimension()))
      params.set<MooseFunctorName>(u_names[dim_i]) = _velocity_names[dim_i];
 
    for (const auto d : make_range(dimension()))
    {
      params.set<NonlinearVariableName>("variable") = _velocity_names[d];
      params.set<MooseEnum>("momentum_component") = NS::directions[d];
 
      getProblem().addFVKernel(kernel_type, kernel_name + NS::directions[d], params);
    }
 
    // We only add it here because the mixing length kernels deal with this
    // withn the kernel. For mixing length see issue: #32112
    if (_flow_equations_physics && _flow_equations_physics->hasFlowEquations())
      addAxisymmetricTurbulentViscousSource();
  }
}

Referenced by addFVKernels().

◆ addFluidEnergyTurbulenceKernels()

void WCNSFVTurbulencePhysics::addFluidEnergyTurbulenceKernels ( )

private

Definition at line 293 of file WCNSFVTurbulencePhysics.C.

{
  if (_turbulence_model == "mixing-length")
  {
    const std::string u_names[3] = {"u", "v", "w"};
    const std::string kernel_type = "WCNSFVMixingLengthEnergyDiffusion";
    InputParameters params = getFactory().getValidParams(kernel_type);
    assignBlocks(params, _blocks);
    params.set<MooseFunctorName>(NS::density) = _density_name;
    params.set<MooseFunctorName>(NS::cp) = _fluid_energy_physics->getSpecificHeatName();
    params.set<MooseFunctorName>(NS::mixing_length) = _mixing_length_name;
    params.set<Real>("schmidt_number") = getParam<Real>("turbulent_prandtl");
    params.set<NonlinearVariableName>("variable") =
        _flow_equations_physics->getFluidTemperatureName();
 
    for (const auto dim_i : make_range(dimension()))
      params.set<MooseFunctorName>(u_names[dim_i]) = _velocity_names[dim_i];
 
    if (_porous_medium_treatment)
      getProblem().addFVKernel(
          kernel_type, prefix() + "pins_energy_mixing_length_diffusion", params);
    else
      getProblem().addFVKernel(
          kernel_type, prefix() + "ins_energy_mixing_length_diffusion", params);
  }
  else if (_turbulence_model == "k-epsilon")
  {
    const std::string kernel_type = "FVDiffusion";
    const auto T_fluid_name = _flow_equations_physics->getFluidTemperatureName();
    InputParameters params = getFactory().getValidParams(kernel_type);
    assignBlocks(params, _blocks);
    params.set<NonlinearVariableName>("variable") = T_fluid_name;
    params.set<MooseFunctorName>("coeff") = NS::k_eff_t;
    getProblem().addFVKernel(kernel_type, prefix() + T_fluid_name + "_turbulent_diffusion", params);
  }
}

Referenced by addFVKernels().

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

void WCNSFVTurbulencePhysics::addFVBCs ( )

overrideprivatevirtual

Implements WCNSFVTurbulencePhysicsBase.

Definition at line 536 of file WCNSFVTurbulencePhysics.C.

{
  const std::string u_names[3] = {"u", "v", "w"};
 
  if (_turbulence_model == "k-epsilon" && getParam<bool>("mu_t_as_aux_variable"))
  {
    mooseAssert(_flow_equations_physics, "Should have a flow equation physics");
    const std::string bc_type = "INSFVTurbulentViscosityWallFunction";
    InputParameters params = getFactory().getValidParams(bc_type);
    params.set<std::vector<BoundaryName>>("boundary") = _turbulence_walls;
    params.set<NonlinearVariableName>("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::mu_t) = _turbulent_viscosity_name;
    params.set<MooseFunctorName>(NS::TKE) = _tke_name;
    params.set<Real>("C_mu") = getParam<Real>("C_mu");
    params.set<MooseEnum>("wall_treatment") = _wall_treatment_eps;
    for (const auto d : make_range(dimension()))
      params.set<MooseFunctorName>(u_names[d]) = _velocity_names[d];
 
    getProblem().addFVBC(bc_type, prefix() + "turbulence_walls", params);
    // Energy wall function boundary conditions are added in the WCNSFVFluidEnergyPhysics
    // because it facilitates counting the number of walls, specifying energy wall functors
    // the same way as for boundary conditions
  }
}

◆ addFVKernels()

void WCNSFVTurbulencePhysics::addFVKernels ( )

overrideprivatevirtual

Implements WCNSFVTurbulencePhysicsBase.

Definition at line 159 of file WCNSFVTurbulencePhysics.C.

{
  if (_turbulence_model == "none")
    return;
 
  // Turbulence terms in other equations
  if (_has_flow_equations)
    addFlowTurbulenceKernels();
  if (_has_energy_equation)
    addFluidEnergyTurbulenceKernels();
  if (_has_scalar_equations)
    addScalarAdvectionTurbulenceKernels();
 
  // Turbulence models with their own set of equations
  if (_turbulence_model == "k-epsilon")
  {
    if (isTransient())
      addKEpsilonTimeDerivatives();
    addKEpsilonAdvection();
    addKEpsilonDiffusion();
    addKEpsilonSink();
  }
}

◆ addInitialConditions()

void WCNSFVTurbulencePhysicsBase::addInitialConditions ( )

overrideprotectedvirtualinherited

Reimplemented from PhysicsBase.

Definition at line 285 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);
}

◆ addKEpsilonAdvection()

void WCNSFVTurbulencePhysics::addKEpsilonAdvection ( )

private

Definition at line 398 of file WCNSFVTurbulencePhysics.C.

{
  const std::string kernel_type = "INSFVTurbulentAdvection";
  InputParameters params = getFactory().getValidParams(kernel_type);
 
  assignBlocks(params, _blocks);
 
  params.set<MooseEnum>("velocity_interp_method") = _velocity_interpolation;
  params.set<UserObjectName>("rhie_chow_user_object") = _flow_equations_physics->rhieChowUOName();
  params.set<MooseFunctorName>(NS::density) = _flow_equations_physics->densityName();
  params.set<bool>("neglect_advection_derivatives") =
      getParam<bool>("neglect_advection_derivatives");
 
  params.set<MooseEnum>("advected_interp_method") =
      getParam<MooseEnum>("tke_advection_interpolation");
  params.set<NonlinearVariableName>("variable") = _tke_name;
  getProblem().addFVKernel(kernel_type, prefix() + "tke_advection", params);
  params.set<NonlinearVariableName>("variable") = _tked_name;
  params.set<std::vector<BoundaryName>>("walls") = _turbulence_walls;
  params.set<MooseEnum>("advected_interp_method") =
      getParam<MooseEnum>("tked_advection_interpolation");
  getProblem().addFVKernel(kernel_type, prefix() + "tked_advection", params);
}

Referenced by addFVKernels().

◆ addKEpsilonDiffusion()

void WCNSFVTurbulencePhysics::addKEpsilonDiffusion ( )

private

Definition at line 423 of file WCNSFVTurbulencePhysics.C.

{
  {
    const std::string kernel_type = "INSFVTurbulentDiffusion";
    InputParameters params = getFactory().getValidParams(kernel_type);
    assignBlocks(params, _blocks);
 
    params.set<NonlinearVariableName>("variable") = _tke_name;
    params.set<MooseFunctorName>("coeff") = _flow_equations_physics->dynamicViscosityName();
    getProblem().addFVKernel(kernel_type, prefix() + "tke_diffusion_mu", params);
 
    params.set<std::vector<BoundaryName>>("walls") = _turbulence_walls;
    params.set<NonlinearVariableName>("variable") = _tked_name;
    getProblem().addFVKernel(kernel_type, prefix() + "tked_diffusion_mu", params);
  }
 
  {
    const std::string kernel_type = "INSFVTurbulentDiffusion";
    InputParameters params = getFactory().getValidParams(kernel_type);
    assignBlocks(params, _blocks);
 
    params.set<NonlinearVariableName>("variable") = _tke_name;
    params.set<MooseFunctorName>("coeff") = _turbulent_viscosity_name;
    params.set<MooseFunctorName>("scaling_coef") = getParam<MooseFunctorName>("sigma_k");
    params.set<MooseEnum>("coeff_interp_method") =
        getParam<MooseEnum>("turbulent_viscosity_interp_method");
    getProblem().addFVKernel(kernel_type, prefix() + "tke_diffusion_mu_turb", params);
 
    params.set<std::vector<BoundaryName>>("walls") = _turbulence_walls;
    params.set<NonlinearVariableName>("variable") = _tked_name;
    params.set<MooseFunctorName>("scaling_coef") = getParam<MooseFunctorName>("sigma_eps");
    getProblem().addFVKernel(kernel_type, prefix() + "tked_diffusion_mu_turb", params);
  }
}

Referenced by addFVKernels().

◆ addKEpsilonSink()

void WCNSFVTurbulencePhysics::addKEpsilonSink ( )

private

Definition at line 459 of file WCNSFVTurbulencePhysics.C.

{
  const std::string u_names[3] = {"u", "v", "w"};
  {
    const std::string kernel_type = "INSFVTKESourceSink";
    InputParameters params = getFactory().getValidParams(kernel_type);
    assignBlocks(params, _blocks);
    params.set<NonlinearVariableName>("variable") = _tke_name;
    params.set<MooseFunctorName>(NS::TKED) = _tked_name;
    params.set<MooseFunctorName>(NS::density) = _flow_equations_physics->densityName();
    params.set<MooseFunctorName>(NS::mu) = _flow_equations_physics->dynamicViscosityName();
    params.set<MooseFunctorName>(NS::mu_t) = _turbulent_viscosity_name;
    params.set<Real>("C_mu") = getParam<Real>("C_mu");
    params.set<Real>("C_pl") = getParam<Real>("C_pl");
    params.set<bool>("linearized_model") = getParam<bool>("linearize_sink_sources");
    params.set<std::vector<BoundaryName>>("walls") = _turbulence_walls;
    params.set<MooseEnum>("wall_treatment") = _wall_treatment_eps;
    // Currently only Newton method for WCNSFVTurbulencePhysics
    params.set<bool>("newton_solve") = true;
    for (const auto d : make_range(dimension()))
      params.set<MooseFunctorName>(u_names[d]) = _velocity_names[d];
    getProblem().addFVKernel(kernel_type, prefix() + "tke_source_sink", params);
  }
 
  {
    const std::string kernel_type = "INSFVTKEDSourceSink";
    InputParameters params = getFactory().getValidParams(kernel_type);
    assignBlocks(params, _blocks);
    params.set<NonlinearVariableName>("variable") = _tked_name;
    params.set<MooseFunctorName>(NS::TKE) = _tke_name;
    params.set<MooseFunctorName>(NS::density) = _flow_equations_physics->densityName();
    params.set<MooseFunctorName>(NS::mu) = _flow_equations_physics->dynamicViscosityName();
    params.set<MooseFunctorName>(NS::mu_t) = _turbulent_viscosity_name;
    params.set<Real>("C_mu") = getParam<Real>("C_mu");
    params.set<Real>("C_pl") = getParam<Real>("C_pl");
    params.set<bool>("linearized_model") = getParam<bool>("linearize_sink_sources");
    params.set<std::vector<BoundaryName>>("walls") = _turbulence_walls;
    params.set<MooseEnum>("wall_treatment") = _wall_treatment_eps;
    params.set<MooseFunctorName>("C1_eps") = getParam<MooseFunctorName>("C1_eps");
    params.set<MooseFunctorName>("C2_eps") = getParam<MooseFunctorName>("C2_eps");
    // Currently only Newton method for WCNSFVTurbulencePhysics
    params.set<bool>("newton_solve") = true;
    for (const auto d : make_range(dimension()))
      params.set<MooseFunctorName>(u_names[d]) = _velocity_names[d];
    getProblem().addFVKernel(kernel_type, prefix() + "tked_source_sink", params);
  }
}

Referenced by addFVKernels().

◆ addKEpsilonTimeDerivatives()

void WCNSFVTurbulencePhysics::addKEpsilonTimeDerivatives ( )

private

Functions adding kernels for the k-epsilon to the k-epsilon equations.

Definition at line 383 of file WCNSFVTurbulencePhysics.C.

{
  const std::string kernel_type = "FVFunctorTimeKernel";
  InputParameters params = getFactory().getValidParams(kernel_type);
  assignBlocks(params, _blocks);
 
  params.set<NonlinearVariableName>("variable") = _tke_name;
  if (shouldCreateTimeDerivative(_tke_name, _blocks, /*error if already defined*/ false))
    getProblem().addFVKernel(kernel_type, prefix() + "tke_time", params);
  params.set<NonlinearVariableName>("variable") = _tked_name;
  if (shouldCreateTimeDerivative(_tked_name, _blocks, /*error if already defined*/ false))
    getProblem().addFVKernel(kernel_type, prefix() + "tked_time", params);
}

Referenced by addFVKernels().

◆ addMaterials()

void WCNSFVTurbulencePhysics::addMaterials ( )

overrideprivatevirtual

Reimplemented from WCNSFVTurbulencePhysicsBase.

Definition at line 564 of file WCNSFVTurbulencePhysics.C.

{
  if (_turbulence_model == "mixing-length")
  {
    const std::string u_names[3] = {"u", "v", "w"};
    InputParameters params =
        getFactory().getValidParams("MixingLengthTurbulentViscosityFunctorMaterial");
    assignBlocks(params, _blocks);
 
    for (const auto d : make_range(dimension()))
      params.set<MooseFunctorName>(u_names[d]) = _velocity_names[d];
 
    params.set<MooseFunctorName>(NS::mixing_length) = _mixing_length_name;
    params.set<MooseFunctorName>(NS::density) = _density_name;
    params.set<MooseFunctorName>(NS::mu) = _dynamic_viscosity_name;
 
    getProblem().addMaterial("MixingLengthTurbulentViscosityFunctorMaterial",
                             prefix() + "mixing_length_material",
                             params);
  }
  WCNSFVTurbulencePhysicsBase::addMaterials();
}

◆ addScalarAdvectionTurbulenceKernels()

void WCNSFVTurbulencePhysics::addScalarAdvectionTurbulenceKernels ( )

private

Definition at line 331 of file WCNSFVTurbulencePhysics.C.

{
  const auto & passive_scalar_names = _scalar_transport_physics->getAdvectedScalarNames();
  const auto & passive_scalar_schmidt_number = getParam<std::vector<Real>>("Sc_t");
  if (passive_scalar_schmidt_number.size() != passive_scalar_names.size() &&
      passive_scalar_schmidt_number.size() != 1)
    paramError(
        "Sc_t",
        "The number of turbulent Schmidt numbers defined is not equal to the number of passive "
        "scalar fields!");
 
  if (_turbulence_model == "mixing-length")
  {
    const std::string u_names[3] = {"u", "v", "w"};
    const std::string kernel_type = "INSFVMixingLengthScalarDiffusion";
    InputParameters params = getFactory().getValidParams(kernel_type);
    assignBlocks(params, _blocks);
    params.set<MooseFunctorName>(NS::mixing_length) = _mixing_length_name;
    for (const auto dim_i : make_range(dimension()))
      params.set<MooseFunctorName>(u_names[dim_i]) = _velocity_names[dim_i];
 
    for (const auto & name_i : index_range(passive_scalar_names))
    {
      params.set<NonlinearVariableName>("variable") = passive_scalar_names[name_i];
      if (passive_scalar_schmidt_number.size() > 1)
        params.set<Real>("schmidt_number") = passive_scalar_schmidt_number[name_i];
      else if (passive_scalar_schmidt_number.size() == 1)
        params.set<Real>("schmidt_number") = passive_scalar_schmidt_number[0];
      else
        params.set<Real>("schmidt_number") = 1.0;
 
      getProblem().addFVKernel(
          kernel_type, prefix() + passive_scalar_names[name_i] + "_mixing_length", params);
    }
  }
  else if (_turbulence_model == "k-epsilon")
  {
    const std::string kernel_type = "FVDiffusion";
    InputParameters params = getFactory().getValidParams(kernel_type);
    assignBlocks(params, _blocks);
 
    for (const auto & name_i : index_range(passive_scalar_names))
    {
      params.set<NonlinearVariableName>("variable") = passive_scalar_names[name_i];
      params.set<MooseFunctorName>("coeff") = NS::mu_t_passive_scalar;
      getProblem().addFVKernel(
          kernel_type, prefix() + passive_scalar_names[name_i] + "_turbulent_diffusion", params);
    }
  }
}

Referenced by addFVKernels().

◆ addSolverVariables()

void WCNSFVTurbulencePhysics::addSolverVariables ( )

overrideprivatevirtual

Implements WCNSFVTurbulencePhysicsBase.

Definition at line 93 of file WCNSFVTurbulencePhysics.C.

{
  if (_turbulence_model == "mixing-length" || _turbulence_model == "none")
    return;
  else if (_turbulence_model == "k-epsilon")
  {
    // Dont add if the user already defined the variable
    // Add turbulent kinetic energy variable
    if (!shouldCreateVariable(_tke_name, _blocks, /*error if aux*/ true))
      reportPotentiallyMissedParameters(
          {"system_names", "tke_scaling", "tke_face_interpolation", "tke_two_term_bc_expansion"},
          "INSFVEnergyVariable");
    else if (_define_variables)
    {
      auto params = getFactory().getValidParams("INSFVEnergyVariable");
      params.set<std::vector<Real>>("scaling") = {getParam<Real>("tke_scaling")};
      params.set<MooseEnum>("face_interp_method") = getParam<MooseEnum>("tke_face_interpolation");
      params.set<bool>("two_term_boundary_expansion") = getParam<bool>("tke_two_term_bc_expansion");
 
      addSharedSolverVariable("INSFVEnergyVariable", _tke_name, params);
    }
    else
      paramError("turbulence_kinetic_energy_variable",
                 "Variable (" + _tke_name +
                     ") supplied to the WCNSFVTurbulencePhysics does not exist!");
 
    // Add turbulent kinetic energy dissipation variable
    if (!shouldCreateVariable(_tked_name, _blocks, /*error if aux*/ true))
      reportPotentiallyMissedParameters(
          {"system_names", "tked_scaling", "tked_face_interpolation", "tked_two_term_bc_expansion"},
          "INSFVEnergyVariable");
    else if (_define_variables)
    {
      auto params = getFactory().getValidParams("INSFVEnergyVariable");
      params.set<std::vector<Real>>("scaling") = {getParam<Real>("tked_scaling")};
      params.set<MooseEnum>("face_interp_method") = getParam<MooseEnum>("tked_face_interpolation");
      params.set<bool>("two_term_boundary_expansion") =
          getParam<bool>("tked_two_term_bc_expansion");
      addSharedSolverVariable("INSFVEnergyVariable", _tked_name, params);
    }
    else
      paramError("turbulence_kinetic_energy_dissipation_variable",
                 "Variable (" + _tked_name +
                     ") supplied to the WCNSFVTurbulencePhysics does not exist!");
  }
}

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

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

unsigned short WCNSFVTurbulencePhysics::getNumberAlgebraicGhostingLayersNeeded ( ) const

overrideprotectedvirtual

Return the number of ghosting layers needed.

Implements NavierStokesPhysicsBase.

Definition at line 588 of file WCNSFVTurbulencePhysics.C.

{
  unsigned short ghost_layers = _flow_equations_physics->getNumberAlgebraicGhostingLayersNeeded();
  // due to the computation of the eddy-diffusivity from the strain tensor
  if (_turbulence_model == "mixing-length")
    ghost_layers = std::max(ghost_layers, (unsigned short)3);
  return ghost_layers;
}

◆ 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

inlineinherited

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

◆ initializePhysicsAdditional()

void WCNSFVTurbulencePhysics::initializePhysicsAdditional ( )

overrideprotectedvirtual

Reimplemented from PhysicsBase.

Definition at line 86 of file WCNSFVTurbulencePhysics.C.

{
  if (_turbulence_model == "k-epsilon")
    getProblem().needSolutionState(2, Moose::SolutionIterationType::Nonlinear);
}

◆ retrieveCoupledPhysics()

void WCNSFVTurbulencePhysicsBase::retrieveCoupledPhysics ( )

protectedinherited

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

Definition at line 214 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 WCNSFVTurbulencePhysicsBase::actOnAdditionalTasks().

◆ tkeName()

MooseFunctorName WCNSFVTurbulencePhysicsBase::tkeName ( ) const

inlineinherited

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

inlineinherited

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

inlineinherited

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

Definition at line 49 of file WCNSFVTurbulencePhysicsBase.h.

49{ return _wall_treatment_temp; }

WCNSFVTurbulencePhysicsBase::_wall_treatment_temp

MooseEnum _wall_treatment_temp

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

Definition WCNSFVTurbulencePhysicsBase.h:84

Referenced by WCNSFVFluidHeatTransferPhysics::addEnergyWallBC().

◆ turbulenceWalls()

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

inlineinherited

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 WCNSFVTurbulencePhysics::validParams ( )

static

Definition at line 23 of file WCNSFVTurbulencePhysics.C.

{
  InputParameters params = WCNSFVTurbulencePhysicsBase::validParams();
  params.addClassDescription(
      "Define a turbulence model for a incompressible or weakly-compressible Navier Stokes "
      "flow with a finite volume discretization");
 
  // TODO Added to facilitate transition, remove default once NavierStokesFV action is removed
  params.addParam<AuxVariableName>(
      "mixing_length_name", "mixing_length", "Name of the mixing length auxiliary variable");
  params.transferParam<bool>(NSFVBase::validParams(), "mixing_length_two_term_bc_expansion");
 
  // K-Epsilon numerical scheme parameters
  params.addRangeCheckedParam<Real>(
      "tke_scaling",
      1.0,
      "tke_scaling > 0.0",
      "The scaling factor for the turbulent kinetic energy equation.");
  params.addRangeCheckedParam<Real>(
      "tked_scaling",
      1.0,
      "tked_scaling > 0.0",
      "The scaling factor for the turbulent kinetic energy dissipation equation.");
 
  // Better Jacobian if not linearizing sink and sources
  params.addParam<bool>("linearize_sink_sources", false, "Whether to linearize the source term");
  // Better convergence on some cases when neglecting advection derivatives
  params.addParam<bool>(
      "neglect_advection_derivatives",
      false,
      "Whether to remove the off-diagonal velocity term in the TKE and TKED advection term");
  MooseEnum coeff_interp_method("average harmonic", "harmonic");
  params.addParam<MooseEnum>("turbulent_viscosity_interp_method",
                             coeff_interp_method,
                             "Face interpolation method for the turbulent viscosity");
 
  params.addParamNamesToGroup("tke_scaling tked_scaling "
                              "turbulent_viscosity_interp_method linearize_sink_sources",
                              "K-Epsilon model numerical");
 
  return params;
}

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 addAuxiliaryVariables(), WCNSLinearFVFluidHeatTransferPhysics::addAuxiliaryVariables(), WCNSFVFlowPhysicsBase::addInitialConditions(), WCNSFVFluidHeatTransferPhysicsBase::addInitialConditions(), WCNSFVScalarTransportPhysicsBase::addInitialConditions(), WCNSFVTurbulencePhysicsBase::addInitialConditions(), WCNSFVFlowPhysics::addSolverVariables(), WCNSFVFluidHeatTransferPhysics::addSolverVariables(), 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(), addFlowTurbulenceKernels(), addFluidEnergyTurbulenceKernels(), WCNSFVFluidHeatTransferPhysics::addMaterials(), addMaterials(), WCNSFVTurbulencePhysicsBase::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(), 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

protectedinherited

The heat advection physics to add turbulent mixing for.

Definition at line 75 of file WCNSFVTurbulencePhysicsBase.h.

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

◆ _has_energy_equation

bool WCNSFVTurbulencePhysicsBase::_has_energy_equation

protectedinherited

Definition at line 71 of file WCNSFVTurbulencePhysicsBase.h.

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

◆ _has_flow_equations

bool WCNSFVTurbulencePhysicsBase::_has_flow_equations

protectedinherited

Definition at line 70 of file WCNSFVTurbulencePhysicsBase.h.

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

◆ _has_scalar_equations

bool WCNSFVTurbulencePhysicsBase::_has_scalar_equations

protectedinherited

Definition at line 72 of file WCNSFVTurbulencePhysicsBase.h.

Referenced by addFVKernels(), WCNSFVTurbulencePhysicsBase::addMaterials(), and WCNSFVTurbulencePhysicsBase::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().