Creates all the objects needed to solve the Navier Stokes scalar transport equations. More...

#include <WCNSFVScalarTransportPhysicsBase.h>

Inheritance diagram for WCNSFVScalarTransportPhysicsBase:

Public Types
typedef DataFileName	DataFileParameterType

Public Member Functions
	WCNSFVScalarTransportPhysicsBase (const InputParameters &parameters)

const std::vector< NonlinearVariableName > &	getAdvectedScalarNames () const
	Get the names of the advected scalar quantity variables. More...

bool	hasScalarEquations () const
	Whether the physics is actually creating the scalar advection equations. More...

virtual void	act () override final

virtual void	actOnAdditionalTasks ()

void	addBlocks (const std::vector< SubdomainName > &blocks)

void	addBlocksById (const std::vector< SubdomainID > &block_ids)

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

bool	checkBlockRestrictionIdentical (const std::string &object_name, const std::vector< SubdomainName > &blocks, const bool error_if_not_identical=true) const

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

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

virtual const std::string &	name () const

std::string	typeAndName () const

std::string	errorPrefix (const std::string &error_type) const

void	callMooseError (std::string msg, const bool with_prefix) const

MooseObjectParameterName	uniqueParameterName (const std::string &parameter_name) const

const InputParameters &	parameters () const

MooseObjectName	uniqueName () 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 &nm) const

void	paramError (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

void	connectControllableParams (const std::string &parameter, const std::string &object_type, const std::string &object_name, const std::string &object_parameter) const

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

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

void	mooseDocumentedError (const std::string &repo_name, const unsigned int issue_num, Args &&... args) const

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

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

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

void	mooseInfo (Args &&... args) 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 WCNSFVTurbulencePhysics *	getCoupledTurbulencePhysics () const

MooseFunctorName	getPorosityFunctorName (bool smoothed) const
	Return the porosity functor name. More...

const MooseFunctorName &	densityName () const

const MooseFunctorName &	dynamicViscosityName () const

Static Public Member Functions
static InputParameters	validParams ()

Public Attributes
const ConsoleStream	_console

Static Public Attributes
static constexpr auto	SYSTEM

static constexpr auto	NAME

Protected Member Functions
virtual void	addFVKernels () override

virtual void	addFVBCs () override

virtual void	setSlipVelocityParams (InputParameters &) const

bool	usingNavierStokesFVSyntax () const
	Detects if we are using the new Physics syntax or the old NavierStokesFV action. More...

InputParameters	getAdditionalRMParams () const override
	Parameters to change or add relationship managers. More...

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

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

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	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
std::vector< NonlinearVariableName >	_passive_scalar_names
	Names of the passive scalar variables. More...

const bool	_has_scalar_equation
	A boolean to help compatibility with the old Modules/NavierStokesFV syntax or to deliberately skip adding the equations (for example for mixtures with a stationary phase) More...

MultiMooseEnum	_passive_scalar_inlet_types
	Passive scalar inlet boundary types. More...

std::vector< std::vector< MooseFunctorName > >	_passive_scalar_inlet_functors
	Functors describing the inlet boundary values. See passive_scalar_inlet_types for what the functors actually represent. More...

std::vector< MooseFunctorName >	_passive_scalar_sources
	Functors for the passive scalar sources. Indexing is scalar variable index. More...

std::vector< std::vector< MooseFunctorName > >	_passive_scalar_coupled_sources
	Functors for the passive scalar (coupled) sources. Inner indexing is scalar variable index. More...

std::vector< std::vector< Real > >	_passive_scalar_sources_coef
	Coefficients multiplying for the passive scalar sources. Inner indexing is scalar variable index. More...

bool	_define_variables
	Whether to define variables if they do not exist. More...

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

const std::string	_type

const std::string	_name

const InputParameters &	_pars

Factory &	_factory

ActionFactory &	_action_factory

MooseApp &	_pg_moose_app

const std::string	_prefix

const Parallel::Communicator &	_communicator

const NavierStokesPhysicsBase *	_advection_physics
	The Physics class using this helper. More...

const WCNSFVFlowPhysicsBase *	_flow_equations_physics
	Flow physics. More...

const WCNSFVTurbulencePhysics *	_turbulence_physics
	Turbulence. More...

const MooseEnum	_compressibility
	Compressibility type, can be compressible, incompressible or weakly-compressible. More...

const bool	_porous_medium_treatment
	Switch to show if porous medium treatment is requested or not. More...

const std::vector< std::string >	_velocity_names
	Velocity names. More...

const NonlinearVariableName	_pressure_name
	Pressure name. More...

const MooseFunctorName	_density_name
	Name of the density material property. More...

const MooseFunctorName	_dynamic_viscosity_name
	Name of the dynamic viscosity material property. More...

const MooseEnum	_velocity_interpolation
	The velocity / momentum face interpolation method for advecting other quantities. More...

Private Member Functions
virtual void	addInitialConditions () override

virtual void	addScalarTimeKernels ()=0
	Functions adding kernels for the incompressible / weakly-compressible scalar transport equation. More...

virtual void	addScalarDiffusionKernels ()=0

virtual void	addScalarAdvectionKernels ()=0

virtual void	addScalarSourceKernels ()=0
	Equivalent of NSFVAction addScalarCoupledSourceKernels. More...

virtual void	addScalarInletBC ()=0
	Functions adding boundary conditions for the scalar conservation equations. More...

virtual void	addScalarWallBC ()=0

virtual void	addScalarOutletBC ()=0

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

Detailed Description

Creates all the objects needed to solve the Navier Stokes scalar transport equations.

Definition at line 24 of file WCNSFVScalarTransportPhysicsBase.h.

Constructor & Destructor Documentation

◆ WCNSFVScalarTransportPhysicsBase()

WCNSFVScalarTransportPhysicsBase::WCNSFVScalarTransportPhysicsBase ( const InputParameters & parameters )

Definition at line 67 of file WCNSFVScalarTransportPhysicsBase.C.

   : NavierStokesPhysicsBase(parameters),
     WCNSFVCoupledAdvectionPhysicsHelper(this),
     _passive_scalar_names(getParam<std::vector<NonlinearVariableName>>("passive_scalar_names")),
     _has_scalar_equation(isParamValid("add_scalar_equation") ? getParam<bool>("add_scalar_equation")
                                                              : !usingNavierStokesFVSyntax()),
     _passive_scalar_inlet_types(getParam<MultiMooseEnum>("passive_scalar_inlet_types")),
     _passive_scalar_inlet_functors(
         getParam<std::vector<std::vector<MooseFunctorName>>>("passive_scalar_inlet_functors")),
     _passive_scalar_sources(getParam<std::vector<MooseFunctorName>>("passive_scalar_source")),
     _passive_scalar_coupled_sources(
         getParam<std::vector<std::vector<MooseFunctorName>>>("passive_scalar_coupled_source")),
     _passive_scalar_sources_coef(
         getParam<std::vector<std::vector<Real>>>("passive_scalar_coupled_source_coeff"))
 {
   if (_has_scalar_equation)
     for (const auto & scalar_name : _passive_scalar_names)
       saveSolverVariableName(scalar_name);
 
   // For compatibility with Modules/NavierStokesFV syntax
   if (!_has_scalar_equation)
     return;
 
   // These parameters must be passed for every passive scalar at a time
   checkVectorParamsSameLengthIfSet<NonlinearVariableName, MooseFunctorName>(
       "passive_scalar_names", "passive_scalar_diffusivity", true);
   checkVectorParamsSameLengthIfSet<NonlinearVariableName, std::vector<MooseFunctorName>>(
       "passive_scalar_names", "passive_scalar_coupled_source", true);
   checkVectorParamsSameLengthIfSet<NonlinearVariableName, MooseFunctorName>(
       "passive_scalar_names", "passive_scalar_source", true);
   checkVectorParamsSameLengthIfSet<NonlinearVariableName, Real>(
       "passive_scalar_names", "passive_scalar_scaling", true);
   checkVectorParamsSameLengthIfSet<NonlinearVariableName, FunctionName>(
       "passive_scalar_names", "initial_scalar_variables", true);
   checkVectorParamsSameLengthIfSet<NonlinearVariableName, std::vector<MooseFunctorName>>(
       "passive_scalar_names", "passive_scalar_inlet_functors", true);
   if (_passive_scalar_inlet_functors.size())
     checkTwoDVectorParamMultiMooseEnumSameLength<MooseFunctorName>(
         "passive_scalar_inlet_functors", "passive_scalar_inlet_types", false);
 
   if (_passive_scalar_sources_coef.size())
     checkTwoDVectorParamsSameLength<MooseFunctorName, Real>("passive_scalar_coupled_source",
                                                             "passive_scalar_coupled_source_coeff");
 }

Member Function Documentation

◆ addFVBCs()

void WCNSFVScalarTransportPhysicsBase::addFVBCs ( )

overrideprotectedvirtual

Reimplemented from PhysicsBase.

Definition at line 130 of file WCNSFVScalarTransportPhysicsBase.C.

 {
   // For compatibility with Modules/NavierStokesFV syntax
   if (!_has_scalar_equation)
     return;
 
   addScalarInletBC();
   // There is typically no wall flux of passive scalars, similarly we rarely know
   // their concentrations at the outlet at the beginning of the simulation
   // TODO: we will know the outlet values in case of flow reversal. Implement scalar outlet
   addScalarWallBC();
   addScalarOutletBC();
 }

◆ addFVKernels()

void WCNSFVScalarTransportPhysicsBase::addFVKernels ( )

overrideprotectedvirtual

Reimplemented from PhysicsBase.

Reimplemented in WCNSFVTwoPhaseMixturePhysics, and WCNSLinearFVTwoPhaseMixturePhysics.

Definition at line 114 of file WCNSFVScalarTransportPhysicsBase.C.

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

 {
   // For compatibility with Modules/NavierStokesFV syntax
   if (!_has_scalar_equation)
     return;
 
   if (isTransient())
     addScalarTimeKernels();
 
   addScalarAdvectionKernels();
   addScalarDiffusionKernels();
   if (_passive_scalar_sources.size() || _passive_scalar_coupled_sources.size())
     addScalarSourceKernels();
 }

◆ addInitialConditions()

void WCNSFVScalarTransportPhysicsBase::addInitialConditions ( )

overrideprivatevirtual

Reimplemented from PhysicsBase.

Definition at line 145 of file WCNSFVScalarTransportPhysicsBase.C.

 {
   // For compatibility with Modules/NavierStokesFV syntax
   if (!_has_scalar_equation)
     return;
   if (!_define_variables && parameters().isParamSetByUser("initial_scalar_variables"))
     paramError("initial_scalar_variables",
                "Scalar variables are defined externally of NavierStokesFV, so should their inital "
                "conditions");
   // do not set initial conditions if we load from file
   if (getParam<bool>("initialize_variables_from_mesh_file"))
     return;
   // do not set initial conditions if we are not defining variables
   if (!_define_variables)
     return;
 
   InputParameters params = getFactory().getValidParams("FunctionIC");
   assignBlocks(params, _blocks);
 
   // There are no default initial conditions for passive scalar variables, we however
   // must obey the user-defined initial conditions, even if we are restarting
   if (parameters().isParamSetByUser("initial_scalar_variables"))
   {
     for (unsigned int name_i = 0; name_i < _passive_scalar_names.size(); ++name_i)
     {
       params.set<VariableName>("variable") = _passive_scalar_names[name_i];
       params.set<FunctionName>("function") =
           getParam<std::vector<FunctionName>>("initial_scalar_variables")[name_i];
 
       getProblem().addInitialCondition("FunctionIC", _passive_scalar_names[name_i] + "_ic", params);
     }
   }
 }

◆ addScalarAdvectionKernels()

virtual void WCNSFVScalarTransportPhysicsBase::addScalarAdvectionKernels ( )

privatepure virtual

Implemented in WCNSFVScalarTransportPhysics, and WCNSLinearFVScalarTransportPhysics.

Referenced by addFVKernels().

◆ addScalarDiffusionKernels()

virtual void WCNSFVScalarTransportPhysicsBase::addScalarDiffusionKernels ( )

privatepure virtual

Implemented in WCNSFVScalarTransportPhysics, and WCNSLinearFVScalarTransportPhysics.

Referenced by addFVKernels().

◆ addScalarInletBC()

virtual void WCNSFVScalarTransportPhysicsBase::addScalarInletBC ( )

privatepure virtual

Functions adding boundary conditions for the scalar conservation equations.

Implemented in WCNSFVScalarTransportPhysics, and WCNSLinearFVScalarTransportPhysics.

Referenced by addFVBCs().

◆ addScalarOutletBC()

virtual void WCNSFVScalarTransportPhysicsBase::addScalarOutletBC ( )

privatepure virtual

Implemented in WCNSFVScalarTransportPhysics, and WCNSLinearFVScalarTransportPhysics.

Referenced by addFVBCs().

◆ addScalarSourceKernels()

virtual void WCNSFVScalarTransportPhysicsBase::addScalarSourceKernels ( )

privatepure virtual

Equivalent of NSFVAction addScalarCoupledSourceKernels.

Implemented in WCNSFVScalarTransportPhysics, and WCNSLinearFVScalarTransportPhysics.

Referenced by addFVKernels().

◆ addScalarTimeKernels()

virtual void WCNSFVScalarTransportPhysicsBase::addScalarTimeKernels ( )

privatepure virtual

Functions adding kernels for the incompressible / weakly-compressible scalar transport equation.

Implemented in WCNSFVScalarTransportPhysics, and WCNSLinearFVScalarTransportPhysics.

Referenced by addFVKernels().

◆ addScalarWallBC()

virtual void WCNSFVScalarTransportPhysicsBase::addScalarWallBC ( )

privatepure virtual

Implemented in WCNSFVScalarTransportPhysics, and WCNSLinearFVScalarTransportPhysics.

Referenced by addFVBCs().

◆ densityName()

const MooseFunctorName& WCNSFVCoupledAdvectionPhysicsHelper::densityName ( ) const

inlineinherited

Definition at line 36 of file WCNSFVCoupledAdvectionPhysicsHelper.h.

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

36 { return _density_name; }

WCNSFVCoupledAdvectionPhysicsHelper::_density_name

const MooseFunctorName _density_name

Name of the density material property.

Definition: WCNSFVCoupledAdvectionPhysicsHelper.h:59

◆ 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:61

◆ getAdditionalRMParams()

InputParameters NavierStokesPhysicsBase::getAdditionalRMParams ( ) const

overrideprotectedvirtualinherited

Parameters to change or add relationship managers.

Reimplemented from PhysicsBase.

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

◆ getAdvectedScalarNames()

const std::vector<NonlinearVariableName>& WCNSFVScalarTransportPhysicsBase::getAdvectedScalarNames ( ) const

inline

Get the names of the advected scalar quantity variables.

Definition at line 33 of file WCNSFVScalarTransportPhysicsBase.h.

Referenced by WCNSFVTurbulencePhysics::addScalarAdvectionTurbulenceKernels().

   {
     return _passive_scalar_names;
   }

◆ 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 WCNSFVTurbulencePhysics * WCNSFVCoupledAdvectionPhysicsHelper::getCoupledTurbulencePhysics ( ) const

inherited

Definition at line 77 of file WCNSFVCoupledAdvectionPhysicsHelper.C.

Referenced by WCNSFVFluidHeatTransferPhysicsBase::actOnAdditionalTasks().

 {
   // User passed it, just use that
   if (_advection_physics->isParamValid("coupled_turbulence_physics"))
     return _advection_physics->getCoupledPhysics<WCNSFVTurbulencePhysics>(
         _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 WCNSFVTurbulencePhysics>(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;
 }

◆ getNumberAlgebraicGhostingLayersNeeded()

unsigned short WCNSFVScalarTransportPhysicsBase::getNumberAlgebraicGhostingLayersNeeded ( ) const

overrideprivatevirtual

Return the number of ghosting layers needed.

Implements NavierStokesPhysicsBase.

Definition at line 180 of file WCNSFVScalarTransportPhysicsBase.C.

 {
   unsigned short necessary_layers = getParam<unsigned short>("ghost_layers");
   necessary_layers =
       std::max(necessary_layers, _flow_equations_physics->getNumberAlgebraicGhostingLayersNeeded());
   if (getParam<MooseEnum>("passive_scalar_advection_interpolation") == "skewness-corrected")
     necessary_layers = std::max(necessary_layers, (unsigned short)3);
 
   return necessary_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);
 }

◆ hasScalarEquations()

bool WCNSFVScalarTransportPhysicsBase::hasScalarEquations ( ) const

inline

Whether the physics is actually creating the scalar advection equations.

Definition at line 39 of file WCNSFVScalarTransportPhysicsBase.h.

Referenced by WCNSFVTurbulencePhysics::retrieveCoupledPhysics().

39 { return _has_scalar_equation; }

WCNSFVScalarTransportPhysicsBase::_has_scalar_equation

const bool _has_scalar_equation

A boolean to help compatibility with the old Modules/NavierStokesFV syntax or to deliberately skip ad...

Definition: WCNSFVScalarTransportPhysicsBase.h:50

◆ setSlipVelocityParams()

virtual void WCNSFVScalarTransportPhysicsBase::setSlipVelocityParams ( InputParameters & ) const

inlineprotectedvirtual

Reimplemented in WCNSFVTwoPhaseMixturePhysics, and WCNSLinearFVTwoPhaseMixturePhysics.

Definition at line 44 of file WCNSFVScalarTransportPhysicsBase.h.

Referenced by WCNSLinearFVScalarTransportPhysics::addScalarAdvectionKernels(), and WCNSFVScalarTransportPhysics::addScalarAdvectionKernels().

44 {}

◆ usingNavierStokesFVSyntax()

bool NavierStokesPhysicsBase::usingNavierStokesFVSyntax ( ) const

inlineprotectedinherited

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

Definition at line 32 of file NavierStokesPhysicsBase.h.

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

◆ validParams()

InputParameters WCNSFVScalarTransportPhysicsBase::validParams ( )

static

Definition at line 17 of file WCNSFVScalarTransportPhysicsBase.C.

Referenced by WCNSLinearFVScalarTransportPhysics::validParams(), and WCNSFVScalarTransportPhysics::validParams().

 {
   InputParameters params = NavierStokesPhysicsBase::validParams();
   params += WCNSFVCoupledAdvectionPhysicsHelper::validParams();
   params.addClassDescription(
       "Define the Navier Stokes weakly-compressible scalar field transport equation(s)");
 
   params += NSFVBase::commonScalarFieldAdvectionParams();
 
   // TODO Remove the parameter once NavierStokesFV syntax has been removed
   params.addParam<bool>(
       "add_scalar_equation",
       "Whether to add the scalar transport equation. This parameter is not necessary if "
       "using the Physics syntax");
 
   // These parameters are not shared because the NSFVPhysics use functors
   params.addParam<std::vector<std::vector<MooseFunctorName>>>(
       "passive_scalar_inlet_function",
       std::vector<std::vector<MooseFunctorName>>(),
       "Functors for inlet boundaries in the passive scalar equations.");
 
   // New functor boundary conditions
   params.deprecateParam(
       "passive_scalar_inlet_function", "passive_scalar_inlet_functors", "01/01/2025");
 
   // No need for the duplication
   params.addParam<std::vector<MooseFunctorName>>("passive_scalar_source", "Passive scalar sources");
 
   // Spatial finite volume discretization scheme
   params.transferParam<MooseEnum>(NSFVBase::validParams(),
                                   "passive_scalar_advection_interpolation");
   params.transferParam<bool>(NSFVBase::validParams(), "passive_scalar_two_term_bc_expansion");
 
   // Nonlinear equation solver scaling
   params.addRangeCheckedParam<std::vector<Real>>(
       "passive_scalar_scaling",
       "passive_scalar_scaling > 0.0",
       "The scaling factor for the passive scalar field variables.");
 
   // Parameter groups
   params.addParamNamesToGroup("passive_scalar_names initial_scalar_variables", "Variable");
   params.addParamNamesToGroup("passive_scalar_advection_interpolation passive_scalar_scaling "
                               "passive_scalar_two_term_bc_expansion",
                               "Numerical scheme");
   params.addParamNamesToGroup("passive_scalar_inlet_types passive_scalar_inlet_functors",
                               "Inlet boundary");
 
   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 48 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 44 of file NavierStokesPhysicsBase.h.

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

◆ _density_name

const MooseFunctorName WCNSFVCoupledAdvectionPhysicsHelper::_density_name

protectedinherited

Name of the density material property.

Definition at line 59 of file WCNSFVCoupledAdvectionPhysicsHelper.h.

Referenced by WCNSFVFluidHeatTransferPhysics::addEnergyInletBC(), WCNSFVFluidHeatTransferPhysics::addEnergyTimeKernels(), WCNSLinearFVFluidHeatTransferPhysics::addEnergyTimeKernels(), WCNSFVFluidHeatTransferPhysics::addEnergyWallBC(), WCNSFVTurbulencePhysics::addFlowTurbulenceKernels(), WCNSFVTurbulencePhysics::addFluidEnergyTurbulenceKernels(), WCNSFVTurbulencePhysics::addMaterials(), WCNSFVFluidHeatTransferPhysicsBase::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 61 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.

◆ _has_scalar_equation

const bool WCNSFVScalarTransportPhysicsBase::_has_scalar_equation

protected

A boolean to help compatibility with the old Modules/NavierStokesFV syntax or to deliberately skip adding the equations (for example for mixtures with a stationary phase)

Definition at line 50 of file WCNSFVScalarTransportPhysicsBase.h.

Referenced by addFVBCs(), addFVKernels(), addInitialConditions(), WCNSLinearFVScalarTransportPhysics::addSolverVariables(), WCNSFVScalarTransportPhysics::addSolverVariables(), hasScalarEquations(), and WCNSFVScalarTransportPhysicsBase().