Creates all the objects needed to solve the Navier Stokes scalar transport equations using the nonlinear finite volume weakly-compressible discretization (WCNSFV) More...

#include <WCNSFVScalarTransportPhysics.h>

Inheritance diagram for WCNSFVScalarTransportPhysics:

[legend]

Public Types
typedef DataFileName	DataFileParameterType

Public Member Functions
	WCNSFVScalarTransportPhysics (const InputParameters &parameters)

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

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

virtual void	act () override final

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

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

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

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

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

const T *	getCoupledPhysics (const PhysicsName &phys_name, const bool allow_fail=false) const

const std::vector< T * >	getCoupledPhysics (const bool allow_fail=false) const

unsigned int	dimension () const

const ActionComponent &	getActionComponent (const ComponentName &comp_name) const

void	checkComponentType (const ActionComponent &component) const

virtual void	addComponent (const ActionComponent &component)

const std::vector< VariableName > &	solverVariableNames () const

const std::vector< VariableName > &	auxVariableNames () const

virtual std::vector< UserObjectName >	getSuppliedUserObjects () const

void	timedAct ()

MooseObjectName	uniqueActionName () const

const std::string &	specificTaskName () const

const std::set< std::string > &	getAllTasks () const

void	appendTask (const std::string &task)

MooseApp &	getMooseApp () const

const std::string &	type () const

const std::string &	name () const

std::string	typeAndName () const

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

MooseObjectName	uniqueName () const

const InputParameters &	parameters () const

const hit::Node *	getHitNode () const

bool	hasBase () const

const std::string &	getBase () const

const T &	getParam (const std::string &name) const

std::vector< std::pair< T1, T2 > >	getParam (const std::string &param1, const std::string &param2) const

const T *	queryParam (const std::string &name) const

const T &	getRenamedParam (const std::string &old_name, const std::string &new_name) const

T	getCheckedPointerParam (const std::string &name, const std::string &error_string="") const

bool	isParamValid (const std::string &name) const

bool	isParamSetByUser (const std::string &name) const

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

void	paramError (const std::string &param, Args... args) const

void	paramWarning (const std::string &param, Args... args) const

void	paramWarning (const std::string &param, Args... args) const

void	paramInfo (const std::string &param, Args... args) const

std::string	messagePrefix (const bool hit_prefix=true) const

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

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

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

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

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

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

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

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

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

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

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

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

void	callMooseError (std::string msg, const bool with_prefix, const hit::Node *node=nullptr, const bool show_trace=true) const

std::string	getDataFileName (const std::string &param) const

std::string	getDataFileNameByName (const std::string &relative_path) const

std::string	getDataFilePath (const std::string &relative_path) const

PerfGraph &	perfGraph ()

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

const Parallel::Communicator &	comm () const

processor_id_type	n_processors () const

processor_id_type	processor_id () const

const WCNSFVFlowPhysicsBase *	getCoupledFlowPhysics () const

const WCNSFVTurbulencePhysicsBase *	getCoupledTurbulencePhysics () const

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

const MooseFunctorName &	densityName () const

const MooseFunctorName &	dynamicViscosityName () const

Static Public Member Functions
static InputParameters	validParams ()

static void	callMooseError (MooseApp const app, const InputParameters &params, std::string msg, const bool with_prefix, const hit::Node node, const bool show_trace=true)

Public Attributes
	usingCombinedWarningSolutionWarnings

const ConsoleStream	_console

Static Public Attributes
static const std::string	unique_action_name_param

static const std::string	type_param

static const std::string	name_param

static const std::string	unique_name_param

static const std::string	app_param

static const std::string	moose_base_param

static const std::string	kokkos_object_param

static constexpr auto	SYSTEM

static constexpr auto	NAME

Protected Member Functions
virtual void	actOnAdditionalTasks () override

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.

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)

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

bool	solverVariableExists (const VariableName &var_name) const

const SolverSystemName &	getSolverSystem (unsigned int variable_index) const

const SolverSystemName &	getSolverSystem (const VariableName &variable_name) const

void	addRequiredPhysicsTask (const std::string &task)

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

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

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

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

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

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

bool	isVariableFV (const VariableName &var_name) const

bool	isVariableScalar (const VariableName &var_name) const

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

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

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

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

virtual void	checkIntegrity () const

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

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

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

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

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

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

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

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

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

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

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

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

void	flagInvalidSolutionInternal (const InvalidSolutionID invalid_solution_id) const

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Protected Attributes
std::vector< NonlinearVariableName >	_passive_scalar_names
	Names of the passive scalar variables.

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)

MultiMooseEnum	_passive_scalar_inlet_types
	Passive scalar inlet boundary types.

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.

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

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

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

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	addScalarTimeKernels () override
	Functions adding kernels for the incompressible / weakly-compressible scalar transport equation If the material properties are not constant, some of these can be used for weakly-compressible simulations as well.

virtual void	addScalarDiffusionKernels () override

virtual void	addScalarAdvectionKernels () override

virtual void	addScalarSourceKernels () override
	Equivalent of NSFVAction addScalarCoupledSourceKernels.

virtual void	addScalarInletBC () override
	Functions adding boundary conditions for the incompressible simulation.

virtual void	addScalarWallBC () override

virtual void	addScalarOutletBC () override

virtual void	addInitialConditions () override

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

virtual void	addRelationshipManagers (Moose::RelationshipManagerType input_rm_type) override

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

virtual void	addRelationshipManagers (Moose::RelationshipManagerType when_type)

void	initializePhysics ()

virtual void	initializePhysicsAdditional ()

virtual void	checkIntegrityEarly () const

virtual void	addAuxiliaryVariables ()

virtual void	addFEKernels ()

virtual void	addFVInterpolationMethods ()

virtual void	addNodalKernels ()

virtual void	addDiracKernels ()

virtual void	addDGKernels ()

virtual void	addScalarKernels ()

virtual void	addInterfaceKernels ()

virtual void	addFVInterfaceKernels ()

virtual void	addFEBCs ()

virtual void	addNodalBCs ()

virtual void	addPeriodicBCs ()

virtual void	addFunctions ()

virtual void	addAuxiliaryKernels ()

virtual void	addMaterials ()

virtual void	addFunctorMaterials ()

virtual void	addUserObjects ()

virtual void	addCorrectors ()

virtual void	addMultiApps ()

virtual void	addTransfers ()

virtual void	addPostprocessors ()

virtual void	addVectorPostprocessors ()

virtual void	addReporters ()

virtual void	addOutputs ()

virtual void	addPreconditioning ()

virtual void	addExecutioner ()

virtual void	addExecutors ()

void	checkRequiredTasks () const

bool	addRelationshipManager (Moose::RelationshipManagerType input_rm_type, const InputParameters &moose_object_pars, std::string rm_name, Moose::RelationshipManagerType rm_type, Moose::RelationshipManagerInputParameterCallback rm_input_parameter_func, Moose::RMSystemType sys_type=Moose::RMSystemType::NONE)

virtual std::string	meshPropertyPrefix (const std::string &data_name) const

const RestartableDataValue &	getMeshPropertyInternal (const std::string &data_name, const std::string &prefix) const

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

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

const InputParameters &	forwardParameters () const

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

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

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

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

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

const std::string &	forwardType () const

virtual const std::string &	forwardName () const

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

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

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

Private Attributes
MooseEnum	_is_transient

std::vector< VariableName >	_solver_var_names

std::vector< VariableName >	_aux_var_names

unsigned int	_dim

std::set< std::string >	_required_tasks

const ParallelParamObject &	_parent

MooseApp &	_meta_data_app

const MooseObject *const	_meta_data_object

const MooseBase &	_si_moose_base

const FEProblemBase *	_si_problem

const PhysicsBase *const	_customer_class

Detailed Description

Creates all the objects needed to solve the Navier Stokes scalar transport equations using the nonlinear finite volume weakly-compressible discretization (WCNSFV)

Definition at line 18 of file WCNSFVScalarTransportPhysics.h.

Constructor & Destructor Documentation

◆ WCNSFVScalarTransportPhysics()

WCNSFVScalarTransportPhysics::WCNSFVScalarTransportPhysics ( const InputParameters & parameters )

Definition at line 29 of file WCNSFVScalarTransportPhysics.C.

  : WCNSFVScalarTransportPhysicsBase(parameters)
{
}

Member Function Documentation

◆ actOnAdditionalTasks()

void WCNSFVScalarTransportPhysicsBase::actOnAdditionalTasks ( )

overrideprotectedvirtualinherited

Reimplemented from PhysicsBase.

Definition at line 116 of file WCNSFVScalarTransportPhysicsBase.C.

{
  // Turbulence physics would not be initialized before this task
  if (_current_task == "get_turbulence_physics")
  {
    _turbulence_physics = getCoupledTurbulencePhysics();
    _has_turbulence_model = _turbulence_physics ? _turbulence_physics->hasTurbulenceModel() : false;
  }
}

◆ 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 WCNSFVScalarTransportPhysicsBase::addFVBCs ( )

overrideprotectedvirtualinherited

Reimplemented from PhysicsBase.

Definition at line 143 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 ( )

overrideprotectedvirtualinherited

Reimplemented from PhysicsBase.

Reimplemented in WCNSFVTwoPhaseMixturePhysics, and WCNSLinearFVTwoPhaseMixturePhysics.

Definition at line 127 of file WCNSFVScalarTransportPhysicsBase.C.

{
  // 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 ( )

overrideprivatevirtualinherited

Reimplemented from PhysicsBase.

Definition at line 158 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()

void WCNSFVScalarTransportPhysics::addScalarAdvectionKernels ( )

overrideprivatevirtual

Implements WCNSFVScalarTransportPhysicsBase.

Definition at line 83 of file WCNSFVScalarTransportPhysics.C.

{
  const std::string kernel_type =
      _porous_medium_treatment ? "PINSFVScalarFieldAdvection" : "INSFVScalarFieldAdvection";
  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<MooseEnum>("advected_interp_method") =
      getParam<MooseEnum>("passive_scalar_advection_interpolation");
  setSlipVelocityParams(params);
  if (_porous_medium_treatment)
    params.set<MooseFunctorName>(NS::porosity) =
        _flow_equations_physics->getPorosityFunctorName(/*smoothed=*/true);
 
  for (const auto & vname : _passive_scalar_names)
  {
    params.set<NonlinearVariableName>("variable") = vname;
    getProblem().addFVKernel(kernel_type, prefix() + "ins_" + vname + "_advection", params);
  }
}

◆ addScalarDiffusionKernels()

void WCNSFVScalarTransportPhysics::addScalarDiffusionKernels ( )

overrideprivatevirtual

Implements WCNSFVScalarTransportPhysicsBase.

Definition at line 107 of file WCNSFVScalarTransportPhysics.C.

{
  // Direct specification of diffusion term
  const auto passive_scalar_diffusivities =
      getParam<std::vector<MooseFunctorName>>("passive_scalar_diffusivity");
 
  if (passive_scalar_diffusivities.size())
  {
    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") = passive_scalar_diffusivities[name_i];
      getProblem().addFVKernel(
          kernel_type, prefix() + "ins_" + _passive_scalar_names[name_i] + "_diffusion", params);
    }
  }
}

◆ addScalarInletBC()

void WCNSFVScalarTransportPhysics::addScalarInletBC ( )

overrideprivatevirtual

Functions adding boundary conditions for the incompressible simulation.

These are used for weakly-compressible simulations as well.

Implements WCNSFVScalarTransportPhysicsBase.

Definition at line 162 of file WCNSFVScalarTransportPhysics.C.

{
  const auto & inlet_boundaries = _flow_equations_physics->getInletBoundaries();
  if (inlet_boundaries.empty())
    return;
 
  // Boundary checks
  // TODO: once we have vectors of MooseEnum, we could use the same templated check for types and
  // functors
  if (inlet_boundaries.size() * _passive_scalar_names.size() != _passive_scalar_inlet_types.size())
    paramError(
        "passive_scalar_inlet_types",
        "The number of scalar inlet types (" + std::to_string(_passive_scalar_inlet_types.size()) +
            ") is not equal to the number of inlet boundaries (" +
            std::to_string(inlet_boundaries.size()) + ") times the number of passive scalars (" +
            std::to_string(_passive_scalar_names.size()) + ")");
  if (_passive_scalar_names.size() != _passive_scalar_inlet_functors.size())
    paramError("passive_scalar_inlet_functors",
               "The number of groups of inlet functors (" +
                   std::to_string(_passive_scalar_inlet_functors.size()) +
                   ") is not equal to the number of passive scalars (" +
                   std::to_string(_passive_scalar_names.size()) + ")");
 
  for (const auto name_i : index_range(_passive_scalar_names))
  {
    if (inlet_boundaries.size() != _passive_scalar_inlet_functors[name_i].size())
      paramError("passive_scalar_inlet_functors",
                 "The number of inlet boundary functors for scalar '" +
                     _passive_scalar_names[name_i] +
                     "' does not match the number of inlet boundaries (" +
                     std::to_string(_passive_scalar_inlet_functors[name_i].size()) + ")");
 
    unsigned int flux_bc_counter = 0;
    unsigned int num_inlets = inlet_boundaries.size();
    for (unsigned int bc_ind = 0; bc_ind < num_inlets; ++bc_ind)
    {
      if (_passive_scalar_inlet_types[name_i * num_inlets + bc_ind] == "fixed-value")
      {
        const std::string bc_type = "FVADFunctorDirichletBC";
        InputParameters params = getFactory().getValidParams(bc_type);
        params.set<NonlinearVariableName>("variable") = _passive_scalar_names[name_i];
        params.set<MooseFunctorName>("functor") = _passive_scalar_inlet_functors[name_i][bc_ind];
        params.set<std::vector<BoundaryName>>("boundary") = {inlet_boundaries[bc_ind]};
 
        getProblem().addFVBC(
            bc_type, _passive_scalar_names[name_i] + "_" + inlet_boundaries[bc_ind], params);
      }
      else if (_passive_scalar_inlet_types[name_i * num_inlets + bc_ind] == "flux-mass" ||
               _passive_scalar_inlet_types[name_i * num_inlets + bc_ind] == "flux-velocity")
      {
        const auto flux_inlet_directions = _flow_equations_physics->getFluxInletDirections();
        const auto flux_inlet_pps = _flow_equations_physics->getFluxInletPPs();
 
        const std::string bc_type = "WCNSFVScalarFluxBC";
        InputParameters params = getFactory().getValidParams(bc_type);
        params.set<NonlinearVariableName>("variable") = _passive_scalar_names[name_i];
        params.set<MooseFunctorName>("passive_scalar") = _passive_scalar_names[name_i];
        if (flux_inlet_directions.size())
          params.set<Point>("direction") = flux_inlet_directions[flux_bc_counter];
        if (_passive_scalar_inlet_types[name_i * num_inlets + bc_ind] == "flux-mass")
        {
          params.set<PostprocessorName>("mdot_pp") = flux_inlet_pps[flux_bc_counter];
          params.set<PostprocessorName>("area_pp") = "area_pp_" + inlet_boundaries[bc_ind];
        }
        else
          params.set<PostprocessorName>("velocity_pp") = flux_inlet_pps[flux_bc_counter];
 
        params.set<MooseFunctorName>(NS::density) = _density_name;
        params.set<PostprocessorName>("scalar_value_pp") =
            _passive_scalar_inlet_functors[name_i][bc_ind];
        params.set<std::vector<BoundaryName>>("boundary") = {inlet_boundaries[bc_ind]};
 
        params.set<MooseFunctorName>(NS::velocity_x) = _velocity_names[0];
        if (dimension() > 1)
          params.set<MooseFunctorName>(NS::velocity_y) = _velocity_names[1];
        if (dimension() > 2)
          params.set<MooseFunctorName>(NS::velocity_z) = _velocity_names[2];
 
        getProblem().addFVBC(bc_type,
                             prefix() + _passive_scalar_names[name_i] + "_" +
                                 inlet_boundaries[bc_ind],
                             params);
        flux_bc_counter += 1;
      }
    }
  }
}

◆ addScalarOutletBC()

void WCNSFVScalarTransportPhysics::addScalarOutletBC ( )

overrideprivatevirtual

Implements WCNSFVScalarTransportPhysicsBase.

Definition at line 251 of file WCNSFVScalarTransportPhysics.C.

{
  // Advection outlet is naturally handled by the advection flux kernel
  return;
}

◆ addScalarSourceKernels()

void WCNSFVScalarTransportPhysics::addScalarSourceKernels ( )

overrideprivatevirtual

Equivalent of NSFVAction addScalarCoupledSourceKernels.

Implements WCNSFVScalarTransportPhysicsBase.

Definition at line 129 of file WCNSFVScalarTransportPhysics.C.

{
  const std::string kernel_type = "FVCoupledForce";
  InputParameters params = getFactory().getValidParams(kernel_type);
  assignBlocks(params, _blocks);
 
  for (const auto scalar_i : index_range(_passive_scalar_names))
  {
    params.set<NonlinearVariableName>("variable") = _passive_scalar_names[scalar_i];
    if (_passive_scalar_sources.size())
    {
      // Added for backward compatibility with former Modules/NavierStokesFV syntax
      params.set<MooseFunctorName>("v") = _passive_scalar_sources[scalar_i];
      getProblem().addFVKernel(
          kernel_type, prefix() + "ins_" + _passive_scalar_names[scalar_i] + "_source", params);
    }
 
    // Sufficient for all intents and purposes
    if (_passive_scalar_coupled_sources.size())
      for (const auto i : index_range(_passive_scalar_coupled_sources[scalar_i]))
      {
        params.set<MooseFunctorName>("v") = _passive_scalar_coupled_sources[scalar_i][i];
        if (_passive_scalar_sources_coef.size())
          params.set<Real>("coef") = _passive_scalar_sources_coef[scalar_i][i];
        getProblem().addFVKernel(kernel_type,
                                 prefix() + "ins_" + _passive_scalar_names[scalar_i] +
                                     "_coupled_source_" + std::to_string(i),
                                 params);
      }
  }
}

◆ addScalarTimeKernels()

void WCNSFVScalarTransportPhysics::addScalarTimeKernels ( )

overrideprivatevirtual

Functions adding kernels for the incompressible / weakly-compressible scalar transport equation If the material properties are not constant, some of these can be used for weakly-compressible simulations as well.

Implements WCNSFVScalarTransportPhysicsBase.

Definition at line 68 of file WCNSFVScalarTransportPhysics.C.

{
  for (const auto & vname : _passive_scalar_names)
  {
    const std::string kernel_type = "FVFunctorTimeKernel";
    InputParameters params = getFactory().getValidParams(kernel_type);
    assignBlocks(params, _blocks);
    params.set<NonlinearVariableName>("variable") = vname;
 
    if (shouldCreateTimeDerivative(vname, _blocks, /* error if already defined */ false))
      getProblem().addFVKernel(kernel_type, prefix() + "ins_" + vname + "_time", params);
  }
}

◆ addScalarWallBC()

virtual void WCNSFVScalarTransportPhysics::addScalarWallBC ( )

inlineoverrideprivatevirtual

Implements WCNSFVScalarTransportPhysicsBase.

Definition at line 43 of file WCNSFVScalarTransportPhysics.h.

43{}

◆ addSolverVariables()

void WCNSFVScalarTransportPhysics::addSolverVariables ( )

overrideprivatevirtual

Reimplemented from PhysicsBase.

Definition at line 35 of file WCNSFVScalarTransportPhysics.C.

{
  // For compatibility with Modules/NavierStokesFV syntax
  if (!_has_scalar_equation)
    return;
 
  auto params = getFactory().getValidParams("INSFVScalarFieldVariable");
  assignBlocks(params, _blocks);
  params.set<MooseEnum>("face_interp_method") =
      getParam<MooseEnum>("passive_scalar_face_interpolation");
  params.set<bool>("two_term_boundary_expansion") =
      getParam<bool>("passive_scalar_two_term_bc_expansion");
 
  for (const auto name_i : index_range(_passive_scalar_names))
  {
    // Dont add if the user already defined the variable
    if (!shouldCreateVariable(_passive_scalar_names[name_i], _blocks, /*error if aux*/ true))
    {
      reportPotentiallyMissedParameters({"system_names", "passive_scalar_scaling"},
                                        "INSFVScalarFieldVariable");
      continue;
    }
 
    params.set<SolverSystemName>("solver_sys") = getSolverSystem(name_i);
    if (isParamValid("passive_scalar_scaling"))
      params.set<std::vector<Real>>("scaling") = {
          getParam<std::vector<Real>>("passive_scalar_scaling")[name_i]};
 
    getProblem().addVariable("INSFVScalarFieldVariable", _passive_scalar_names[name_i], params);
  }
}

◆ densityName()

const MooseFunctorName & WCNSFVCoupledAdvectionPhysicsHelper::densityName ( ) const

inlineinherited

Definition at line 36 of file WCNSFVCoupledAdvectionPhysicsHelper.h.

36{ return _density_name; }

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

◆ dynamicViscosityName()

const MooseFunctorName & WCNSFVCoupledAdvectionPhysicsHelper::dynamicViscosityName ( ) const

inlineinherited

Definition at line 37 of file WCNSFVCoupledAdvectionPhysicsHelper.h.

37{ return _dynamic_viscosity_name; }

WCNSFVCoupledAdvectionPhysicsHelper::_dynamic_viscosity_name

const MooseFunctorName _dynamic_viscosity_name

Name of the dynamic viscosity material property.

Definition WCNSFVCoupledAdvectionPhysicsHelper.h:64

◆ getAdditionalRMParams()

InputParameters NavierStokesPhysicsBase::getAdditionalRMParams ( ) const

overrideprotectedvirtualinherited

Parameters to change or add relationship managers.

Reimplemented from PhysicsBase.

Definition at line 56 of file NavierStokesPhysicsBase.C.

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

◆ getAdvectedScalarNames()

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

inlineinherited

Get the names of the advected scalar quantity variables.

Definition at line 34 of file WCNSFVScalarTransportPhysicsBase.h.

  {
    return _passive_scalar_names;
  }

Referenced by WCNSFVTurbulencePhysics::addScalarAdvectionTurbulenceKernels().

◆ 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 WCNSFVScalarTransportPhysicsBase::getNumberAlgebraicGhostingLayersNeeded ( ) const

overrideprivatevirtualinherited

Return the number of ghosting layers needed.

Implements NavierStokesPhysicsBase.

Reimplemented in WCNSLinearFVScalarTransportPhysics.

Definition at line 193 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

inlineinherited

Whether the physics is actually creating the scalar advection equations.

Definition at line 40 of file WCNSFVScalarTransportPhysicsBase.h.

40{ return _has_scalar_equation; }

Referenced by WCNSFVTurbulencePhysicsBase::retrieveCoupledPhysics().

◆ setSlipVelocityParams()

virtual void WCNSFVScalarTransportPhysicsBase::setSlipVelocityParams ( InputParameters & ) const

inlineprotectedvirtualinherited

Reimplemented in WCNSFVTwoPhaseMixturePhysics, and WCNSLinearFVTwoPhaseMixturePhysics.

Definition at line 46 of file WCNSFVScalarTransportPhysicsBase.h.

46{}

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

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

static

Definition at line 19 of file WCNSFVScalarTransportPhysics.C.

{
  InputParameters params = WCNSFVScalarTransportPhysicsBase::validParams();
  params.addClassDescription("Define the Navier Stokes weakly-compressible scalar field transport "
                             "equation(s) using the nonlinear finite volume discretization");
  params.transferParam<MooseEnum>(NSFVBase::validParams(), "passive_scalar_face_interpolation");
  params.addParamNamesToGroup("passive_scalar_face_interpolation", "Numerical scheme");
  return params;
}

Referenced by WCNSFVTwoPhaseMixturePhysics::validParams().

Member Data Documentation

◆ _advection_physics

const NavierStokesPhysicsBase* WCNSFVCoupledAdvectionPhysicsHelper::_advection_physics

protectedinherited

The Physics class using this helper.

Definition at line 41 of file WCNSFVCoupledAdvectionPhysicsHelper.h.

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

◆ _compressibility

const MooseEnum WCNSFVCoupledAdvectionPhysicsHelper::_compressibility

protectedinherited

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

Definition at line 51 of file WCNSFVCoupledAdvectionPhysicsHelper.h.

Referenced by WCNSFVFluidHeatTransferPhysics::addEnergyTimeKernels().

◆ _define_variables

bool NavierStokesPhysicsBase::_define_variables

protectedinherited

Whether to define variables if they do not exist.

Definition at line 48 of file NavierStokesPhysicsBase.h.

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

◆ _density_name

const MooseFunctorName WCNSFVCoupledAdvectionPhysicsHelper::_density_name

protectedinherited

Name of the density material property.

Definition at line 62 of file WCNSFVCoupledAdvectionPhysicsHelper.h.

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

◆ _dynamic_viscosity_name

const MooseFunctorName WCNSFVCoupledAdvectionPhysicsHelper::_dynamic_viscosity_name

protectedinherited

Name of the dynamic viscosity material property.

Definition at line 64 of file WCNSFVCoupledAdvectionPhysicsHelper.h.

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

◆ _flow_equations_physics

const WCNSFVFlowPhysicsBase* WCNSFVCoupledAdvectionPhysicsHelper::_flow_equations_physics

protectedinherited

Flow physics.

Definition at line 43 of file WCNSFVCoupledAdvectionPhysicsHelper.h.

◆ _has_scalar_equation

const bool WCNSFVScalarTransportPhysicsBase::_has_scalar_equation

protectedinherited

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 52 of file WCNSFVScalarTransportPhysicsBase.h.

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

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