Creates all the objects needed to solve the Navier Stokes mass and momentum equations. More...

#include <WCNSFVFlowPhysics.h>

Inheritance diagram for WCNSFVFlowPhysics:

Public Types
typedef DataFileName	DataFileParameterType

Public Member Functions
	WCNSFVFlowPhysics (const InputParameters &parameters)

virtual MooseFunctorName	getLinearFrictionCoefName () const override
	Get the name of the linear friction coefficient. Returns an empty string if no friction. More...

UserObjectName	rhieChowUOName () const override
	Return the name of the Rhie Chow user object. More...

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

bool	hasFlowEquations () const
	Whether the physics is actually creating the flow equations. More...

const std::vector< std::string > &	getVelocityNames () const
	To interface with other Physics. More...

const NonlinearVariableName &	getPressureName () const

const NonlinearVariableName &	getFluidTemperatureName () const

MooseFunctorName	getPorosityFunctorName (const bool smoothed) const

const MooseEnum &	compressibility () const
	Return the compressibility of the flow equations selected. More...

bool	porousMediumTreatment () const
	Return whether a porous medium treatment is applied. More...

RealVectorValue	gravityVector () const
	Return the gravity vector. More...

const MooseFunctorName &	densityName () const
	Return the name of the density functor. More...

const MooseFunctorName &	dynamicViscosityName () const
	Return the name of the dynamic viscosity functor. More...

const MooseEnum &	getVelocityFaceInterpolationMethod () const
	Get the face interpolation method for velocity. More...

const MooseEnum &	getMomentumAdvectionFaceInterpolationMethod () const
	Get the face interpolation method for momentum in the advection term. More...

const MooseEnum &	getMomentumFaceInterpolationMethod () const
	Get the face interpolation method for momentum (mostly used in the stress terms) More...

const std::vector< BoundaryName > &	getInletBoundaries () const
	Get the inlet boundaries. More...

const std::vector< BoundaryName > &	getOutletBoundaries () const
	Get the outlet boundaries. More...

const std::vector< BoundaryName > &	getWallBoundaries () const
	Get the wall boundaries. More...

const std::vector< BoundaryName > &	getHydraulicSeparators () const
	Get the hydraulic separator boundaries. More...

const std::vector< Point > &	getFluxInletDirections () const
	Get the inlet direction if using a flux inlet. More...

const std::vector< PostprocessorName > &	getFluxInletPPs () const
	Get the inlet flux postprocessor if using a flux inlet. More...

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

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

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	initializePhysicsAdditional () override

virtual void	actOnAdditionalTasks () override

virtual void	addInitialConditions () override

virtual void	addFVBCs () override

virtual void	addMaterials () override

virtual void	addPostprocessors () override

void	addPorousMediumSpeedMaterial ()
	Add material to define the local speed in porous medium flows. More...

void	addNonPorousMediumSpeedMaterial ()
	Add material to define the local speed with no porous medium treatment. More...

VariableName	getFlowVariableName (const std::string &default_name) const
	Convenience routine to be able to retrieve the actual variable names from their default names. More...

bool	hasTurbulencePhysics () const
	Whether a turbulence Physics has been coupled in, to know which viscosity to pick on symmetry boundary conditions. More...

const WCNSFVTurbulencePhysics *	getCoupledTurbulencePhysics () const
	Find the turbulence physics. More...

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
const TagName	_pressure_tag = "p_tag"
	Name of the vector to hold pressure momentum equation contributions. More...

const bool	_has_flow_equations
	Boolean to keep track of whether the flow equations should be created. More...

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

const bool	_solve_for_dynamic_pressure
	Whether we are solving for the total or dynamic pressure. More...

const bool	_porous_medium_treatment
	Whether to use the porous medium treatment. More...

const MooseFunctorName	_porosity_name
	Name of the porosity functor. More...

MooseFunctorName	_flow_porosity_functor_name
	Name of the porosity functor for the flow equations (if smoothed) More...

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

const NonlinearVariableName	_pressure_name
	Pressure name. More...

const NonlinearVariableName	_fluid_temperature_name
	Fluid temperature name. More...

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

const MooseFunctorName	_density_gravity_name
	Name of the density material property used for gravity and Boussinesq terms. More...

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

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

const MooseEnum	_momentum_advection_interpolation
	The momentum face interpolation method for being advected. More...

const MooseEnum	_momentum_face_interpolation
	The momentum face interpolation method for stress terms. More...

const WCNSFVTurbulencePhysics *	_turbulence_physics
	Can be set to a coupled turbulence physics. More...

std::vector< std::vector< SubdomainName > >	_friction_blocks
	Subdomains where we want to have volumetric friction. More...

std::vector< std::vector< std::string > >	_friction_types
	The friction correlation types used for each block. More...

std::vector< std::vector< std::string > >	_friction_coeffs
	The coefficients used for each item if friction type. More...

const std::vector< BoundaryName >	_inlet_boundaries
	Boundaries with a flow inlet specified on them. More...

const std::vector< BoundaryName >	_outlet_boundaries
	Boundaries with a flow outlet specified on them. More...

const std::vector< BoundaryName >	_wall_boundaries
	Boundaries which define a wall (slip/noslip/etc.) More...

const std::vector< BoundaryName >	_hydraulic_separators
	Hydraulic separator boundaries. More...

std::map< BoundaryName, MooseEnum >	_momentum_inlet_types
	Momentum inlet boundary types. More...

std::map< BoundaryName, MooseEnum >	_momentum_outlet_types
	Momentum outlet boundary types. More...

std::map< BoundaryName, MooseEnum >	_momentum_wall_types
	Momentum wall boundary types. More...

std::vector< PostprocessorName >	_flux_inlet_pps
	Postprocessors describing the momentum inlet for each boundary. Indexing based on the number of flux boundaries. More...

std::vector< Point >	_flux_inlet_directions
	Direction of each flux inlet. Indexing based on the number of flux boundaries. More...

std::map< BoundaryName, std::vector< MooseFunctorName > >	_momentum_inlet_functors
	Functors describing the momentum inlet for each boundary. More...

std::map< BoundaryName, MooseFunctorName >	_pressure_functors
	Functors describing the outlet pressure on each boundary. More...

std::map< BoundaryName, std::vector< MooseFunctorName > >	_momentum_wall_functors
	Functors describing the momentum for each wall boundary. 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

Private Member Functions
virtual void	addSolverVariables () override

virtual void	addFVKernels () override

virtual void	addUserObjects () override

virtual void	addCorrectors () override

void	addMassTimeKernels ()
	Function adding kernels for the time derivative term of the weakly compressible continuity equation. More...

void	addMassKernels ()
	Function adding kernels for the incompressible continuity equation. More...

void	addPressurePinKernel ()
	Function adding the pressure constraint. More...

void	addMomentumTimeKernels () override
	Functions adding kernels for the incompressible momentum equation If the material properties are not constant, these can be used for weakly-compressible simulations (except the Boussinesq kernel) as well. More...

void	addMomentumViscousDissipationKernels ()

void	addMomentumMixingLengthKernels ()

void	addMomentumAdvectionKernels ()

void	addMomentumPressureKernels () override

void	addMomentumGravityKernels () override

void	addMomentumBoussinesqKernels () override

void	addMomentumFrictionKernels () override

void	addInletBC () override
	Functions adding boundary conditions for the incompressible simulation. More...

void	addOutletBC () override

void	addWallsBC () override

void	addSeparatorBC () override

bool	hasForchheimerFriction () const override
	Return whether a Forchheimer friction model is in use. More...

void	addRhieChowUserObjects () override
	Function which adds the RhieChow interpolator user objects for weakly and incompressible formulations. More...

void	checkRhieChowFunctorsDefined () const
	Checks that sufficient Rhie Chow coefficients have been defined for the given dimension, used for scalar or temperature advection by auxiliary variables. More...

Private Attributes
const unsigned	_porosity_smoothing_layers
	The number of smoothing layers if that treatment is used on porosity. More...

UserObjectName	_rc_uo_name
	Name of the user object in charge of computing the Rhie Chow coefficients. More...

Detailed Description

Creates all the objects needed to solve the Navier Stokes mass and momentum equations.

Definition at line 18 of file WCNSFVFlowPhysics.h.

Constructor & Destructor Documentation

◆ WCNSFVFlowPhysics()

WCNSFVFlowPhysics::WCNSFVFlowPhysics ( const InputParameters & parameters )

Definition at line 90 of file WCNSFVFlowPhysics.C.

   : WCNSFVFlowPhysicsBase(parameters),
     _porosity_smoothing_layers(isParamValid("porosity_smoothing_layers")
                                    ? getParam<unsigned short>("porosity_smoothing_layers")
                                    : 0)
 {
   _flow_porosity_functor_name = isParamValid("porosity_smoothing_layers") &&
                                         getParam<unsigned short>("porosity_smoothing_layers")
                                     ? NS::smoothed_porosity
                                     : _porosity_name;
 
   // Most likely to be a mistake
   if (getParam<bool>("pin_pressure") &&
       getParam<std::vector<MooseFunctorName>>("pressure_functors").size())
     paramError("pin_pressure", "Cannot pin the pressure if a pressure boundary exists");
 
   // Pressure pin checks
   checkSecondParamSetOnlyIfFirstOneTrue("pin_pressure", "pinned_pressure_type");
   checkSecondParamSetOnlyIfFirstOneTrue("pin_pressure", "pinned_pressure_value");
   if (getParam<bool>("pin_pressure"))
   {
     if ((std::string(getParam<MooseEnum>("pinned_pressure_type")).find("point") !=
          std::string::npos) &&
         !isParamSetByUser("pinned_pressure_point"))
       paramError("pinned_pressure_point",
                  "This parameter must be set to specify the pinned pressure point");
     else if ((std::string(getParam<MooseEnum>("pinned_pressure_type")).find("point") ==
               std::string::npos) &&
              isParamSetByUser("pinned_pressure_point"))
       paramError("pinned_pressure_point",
                  "This parameter should not be given by the user with the corresponding "
                  "pinned_pressure_type setting: " +
                      std::string(getParam<MooseEnum>("pinned_pressure_type")) + ".");
   }
 
   // Porosity correction checks
   checkSecondParamSetOnlyIfFirstOneTrue("porous_medium_treatment", "use_friction_correction");
   checkSecondParamSetOnlyIfFirstOneTrue("use_friction_correction", "consistent_scaling");
   checkSecondParamSetOnlyIfFirstOneTrue("porous_medium_treatment",
                                         "porosity_interface_pressure_treatment");
   if (getParam<MooseEnum>("porosity_interface_pressure_treatment") != "bernoulli")
     errorDependentParameter("porosity_interface_pressure_treatment",
                             "bernoulli",
                             {"pressure_allow_expansion_on_bernoulli_faces",
                              "pressure_drop_sidesets",
                              "pressure_drop_form_factors"});
 
   // Porous media parameters
   checkSecondParamSetOnlyIfFirstOneTrue("porous_medium_treatment", "porosity_smoothing_layers");
 }

Member Function Documentation

◆ actOnAdditionalTasks()

void WCNSFVFlowPhysicsBase::actOnAdditionalTasks ( )

overrideprotectedvirtualinherited

Reimplemented from PhysicsBase.

Definition at line 252 of file WCNSFVFlowPhysicsBase.C.

 {
   // Turbulence physics would not be initialized before this task
   if (_current_task == "get_turbulence_physics")
     _turbulence_physics = getCoupledTurbulencePhysics();
 }

◆ addCorrectors()

void WCNSFVFlowPhysics::addCorrectors ( )

overrideprivatevirtual

Reimplemented from PhysicsBase.

Definition at line 1041 of file WCNSFVFlowPhysics.C.

 {
   if (!_has_flow_equations)
     return;
 
   // Pressure pin
   if (getParam<bool>("pin_pressure"))
   {
     const auto pin_type = getParam<MooseEnum>("pinned_pressure_type");
     std::string object_type = "NSPressurePin";
 
     // No need for the user object
     if (pin_type == "point-value" || pin_type == "average")
       return;
 
     // Create the average value postprocessor if needed
     if (pin_type == "average-uo")
     {
       // Volume average by default, but we could do inlet or outlet for example
       InputParameters params = getFactory().getValidParams("ElementAverageValue");
       params.set<std::vector<VariableName>>("variable") = {_pressure_name};
       assignBlocks(params, _blocks);
       params.set<std::vector<OutputName>>("outputs") = {"none"};
       getProblem().addPostprocessor("ElementAverageValue", "ns_pressure_average", params);
     }
 
     InputParameters params = getFactory().getValidParams(object_type);
     if (pin_type == "point-value" || pin_type == "point-value-uo")
       params.set<MooseEnum>("pin_type") = "point-value";
     else
       params.set<MooseEnum>("pin_type") = "average";
 
     params.set<PostprocessorName>("phi0") = getParam<PostprocessorName>("pinned_pressure_value");
     params.set<NonlinearVariableName>("variable") = _pressure_name;
     if (pin_type == "point-value" || pin_type == "point-value-uo")
       params.set<Point>("point") = getParam<Point>("pinned_pressure_point");
     else if (pin_type == "average-uo")
       params.set<PostprocessorName>("pressure_average") = "ns_pressure_average";
 
     getProblem().addUserObject(object_type, prefix() + "ins_mass_pressure_pin", params);
   }
 }

◆ addFVBCs()

void WCNSFVFlowPhysicsBase::addFVBCs ( )

overrideprotectedvirtualinherited

Reimplemented from PhysicsBase.

Definition at line 260 of file WCNSFVFlowPhysicsBase.C.

 {
   addInletBC();
   addOutletBC();
   addWallsBC();
   addSeparatorBC();
 }

◆ addFVKernels()

void WCNSFVFlowPhysics::addFVKernels ( )

overrideprivatevirtual

Implements WCNSFVFlowPhysicsBase.

Definition at line 265 of file WCNSFVFlowPhysics.C.

 {
   if (!_has_flow_equations)
     return;
 
   // Mass equation: time derivative
   if (_compressibility == "weakly-compressible" &&
       shouldCreateTimeDerivative(_pressure_name, _blocks, /*error if already defined*/ false))
     addMassTimeKernels();
 
   // Mass equation: divergence of momentum
   addMassKernels();
 
   // Pressure pin
   if (getParam<bool>("pin_pressure"))
     addPressurePinKernel();
 
   // Momentum equation: time derivative
   if (isTransient())
     addMomentumTimeKernels();
 
   // Momentum equation: momentum advection
   addMomentumAdvectionKernels();
 
   // Momentum equation: momentum viscous stress
   addMomentumViscousDissipationKernels();
 
   // Momentum equation: pressure term
   addMomentumPressureKernels();
 
   // Momentum equation: gravity source term
   addMomentumGravityKernels();
 
   // Momentum equation: friction kernels
   if (_friction_types.size())
     addMomentumFrictionKernels();
 
   // Momentum equation: boussinesq approximation
   if (getParam<bool>("boussinesq_approximation"))
     addMomentumBoussinesqKernels();
 }

◆ addInitialConditions()

void WCNSFVFlowPhysicsBase::addInitialConditions ( )

overrideprotectedvirtualinherited

Reimplemented from PhysicsBase.

Definition at line 310 of file WCNSFVFlowPhysicsBase.C.

 {
   if (!_define_variables && parameters().isParamSetByUser("initial_velocity") &&
       parameters().isParamSetByUser("velocity_variable") &&
       getParam<std::vector<FunctionName>>("initial_velocity").size() != 0)
     // TODO: Rework and remove this last statement once the NSFV action is removed
     paramError("initial_velocity",
                "Velocity is defined externally of WCNSFVFlowPhysicsBase, so should the inital "
                "conditions");
   if (!_define_variables && parameters().isParamSetByUser("initial_pressure") &&
       parameters().isParamSetByUser("pressure_variable"))
     paramError("initial_pressure",
                "Pressure is defined externally of WCNSFVFlowPhysicsBase, so should the inital "
                "condition");
 
   // Check dimension
   if (getParam<std::vector<FunctionName>>("initial_velocity").size() != dimension() &&
       getParam<std::vector<FunctionName>>("initial_velocity").size() != 3 &&
       getParam<std::vector<FunctionName>>("initial_velocity").size() != 0)
     // TODO: Rework and remove this last statement once the NSFV action is removed
     paramError("initial_velocity",
                "The number of velocity components in the " + type() + " initial condition is not " +
                    std::to_string(dimension()) + " or 3!");
 
   InputParameters params = getFactory().getValidParams("FunctionIC");
   assignBlocks(params, _blocks);
   auto vvalue = getParam<std::vector<FunctionName>>("initial_velocity");
 
   for (const auto d : make_range(dimension()))
   {
     params.set<VariableName>("variable") = _velocity_names[d];
     params.set<FunctionName>("function") = vvalue[d];
 
     if (shouldCreateIC(_velocity_names[d],
                        _blocks,
                        /*whether IC is a default*/ !isParamSetByUser("initial_velocity"),
                        /*error if already an IC*/ isParamSetByUser("initial_velocity")))
       getProblem().addInitialCondition("FunctionIC", prefix() + _velocity_names[d] + "_ic", params);
   }
 
   if (shouldCreateIC(_pressure_name,
                      _blocks,
                      /*whether IC is a default*/ !isParamSetByUser("initial_pressure"),
                      /*error if already an IC*/ isParamSetByUser("initial_pressure")))
   {
     params.set<VariableName>("variable") = _pressure_name;
     params.set<FunctionName>("function") = getParam<FunctionName>("initial_pressure");
 
     getProblem().addInitialCondition("FunctionIC", prefix() + _pressure_name + "_ic", params);
   }
 }

◆ addInletBC()

void WCNSFVFlowPhysics::addInletBC ( )

overrideprivatevirtual

Functions adding boundary conditions for the incompressible simulation.

These are used for weakly-compressible simulations as well.

Implements WCNSFVFlowPhysicsBase.

Definition at line 684 of file WCNSFVFlowPhysics.C.

 {
   // Check the size of the BC parameters
   unsigned int num_velocity_functor_inlets = 0;
   for (const auto & [bdy, momentum_outlet_type] : _momentum_inlet_types)
     if (momentum_outlet_type == "fixed-velocity" || momentum_outlet_type == "fixed-pressure")
       num_velocity_functor_inlets++;
 
   if (num_velocity_functor_inlets != _momentum_inlet_functors.size())
     paramError("momentum_inlet_functors",
                "Size (" + std::to_string(_momentum_inlet_functors.size()) +
                    ") is not the same as the number of entries in the momentum_inlet_types "
                    "subvector for fixed-velocities/pressures functors (size " +
                    std::to_string(num_velocity_functor_inlets) + ")");
 
   unsigned int flux_bc_counter = 0;
   unsigned int velocity_pressure_counter = 0;
   for (const auto & [inlet_bdy, momentum_inlet_type] : _momentum_inlet_types)
   {
     if (momentum_inlet_type == "fixed-velocity")
     {
       const std::string bc_type = "INSFVInletVelocityBC";
       InputParameters params = getFactory().getValidParams(bc_type);
       params.set<std::vector<BoundaryName>>("boundary") = {inlet_bdy};
       if (_momentum_inlet_functors.size() < velocity_pressure_counter + 1)
         paramError("momentum_inlet_functors",
                    "More non-flux inlets than inlet functors (" +
                        std::to_string(_momentum_inlet_functors.size()) + ")");
 
       // Check that enough functors have been provided for the dimension of the problem
       const auto momentum_functors = libmesh_map_find(_momentum_inlet_functors, inlet_bdy);
       if (momentum_functors.size() < dimension())
         paramError("momentum_inlet_functors",
                    "Subvector for boundary '" + inlet_bdy + "' (size " +
                        std::to_string(momentum_functors.size()) +
                        ") is not the same size as the number of dimensions of the physics (" +
                        std::to_string(dimension()) + ")");
 
       for (const auto d : make_range(dimension()))
       {
         params.set<NonlinearVariableName>("variable") = _velocity_names[d];
         params.set<MooseFunctorName>("functor") = momentum_functors[d];
 
         getProblem().addFVBC(bc_type, _velocity_names[d] + "_" + inlet_bdy, params);
       }
       ++velocity_pressure_counter;
     }
     else if (momentum_inlet_type == "fixed-pressure")
     {
       const std::string bc_type = "INSFVOutletPressureBC";
       InputParameters params = getFactory().getValidParams(bc_type);
       params.set<NonlinearVariableName>("variable") = _pressure_name;
       if (_momentum_inlet_functors.size() < velocity_pressure_counter + 1)
         paramError("momentum_inlet_functors",
                    "More non-flux inlets than inlet functors (" +
                        std::to_string(_momentum_inlet_functors.size()) + ")");
 
       params.set<FunctionName>("function") =
           libmesh_map_find(_momentum_inlet_functors, inlet_bdy)[0];
       params.set<std::vector<BoundaryName>>("boundary") = {inlet_bdy};
 
       getProblem().addFVBC(bc_type, _pressure_name + "_" + inlet_bdy, params);
       ++velocity_pressure_counter;
     }
     else if (momentum_inlet_type == "flux-mass" || momentum_inlet_type == "flux-velocity")
     {
       {
         const std::string bc_type =
             _porous_medium_treatment ? "PWCNSFVMomentumFluxBC" : "WCNSFVMomentumFluxBC";
         InputParameters params = getFactory().getValidParams(bc_type);
 
         if (_flux_inlet_directions.size())
           params.set<Point>("direction") = _flux_inlet_directions[flux_bc_counter];
 
         params.set<MooseFunctorName>(NS::density) = _density_name;
         params.set<std::vector<BoundaryName>>("boundary") = {inlet_bdy};
         params.set<UserObjectName>("rhie_chow_user_object") = rhieChowUOName();
         if (_porous_medium_treatment)
           params.set<MooseFunctorName>(NS::porosity) = _porosity_name;
         if (_flux_inlet_pps.size() < flux_bc_counter + 1)
           paramError("flux_inlet_pps",
                      "More inlet flux BCs than inlet flux pps (" +
                          std::to_string(_flux_inlet_pps.size()) + ")");
 
         if (momentum_inlet_type == "flux-mass")
         {
           params.set<PostprocessorName>("mdot_pp") = _flux_inlet_pps[flux_bc_counter];
           params.set<PostprocessorName>("area_pp") = "area_pp_" + inlet_bdy;
         }
         else
           params.set<PostprocessorName>("velocity_pp") = _flux_inlet_pps[flux_bc_counter];
 
         for (const auto d : make_range(dimension()))
           params.set<MooseFunctorName>(NS::velocity_vector[d]) = _velocity_names[d];
 
         for (const auto d : make_range(dimension()))
         {
           params.set<MooseEnum>("momentum_component") = NS::directions[d];
           params.set<NonlinearVariableName>("variable") = _velocity_names[d];
 
           getProblem().addFVBC(bc_type, _velocity_names[d] + "_" + inlet_bdy, params);
         }
       }
       {
         const std::string bc_type = "WCNSFVMassFluxBC";
         InputParameters params = getFactory().getValidParams(bc_type);
         params.set<MooseFunctorName>(NS::density) = _density_name;
         params.set<NonlinearVariableName>("variable") = _pressure_name;
         params.set<std::vector<BoundaryName>>("boundary") = {inlet_bdy};
 
         if (_flux_inlet_directions.size())
           params.set<Point>("direction") = _flux_inlet_directions[flux_bc_counter];
 
         if (momentum_inlet_type == "flux-mass")
         {
           params.set<PostprocessorName>("mdot_pp") = _flux_inlet_pps[flux_bc_counter];
           params.set<PostprocessorName>("area_pp") = "area_pp_" + inlet_bdy;
         }
         else
           params.set<PostprocessorName>("velocity_pp") = _flux_inlet_pps[flux_bc_counter];
 
         for (const auto d : make_range(dimension()))
           params.set<MooseFunctorName>(NS::velocity_vector[d]) = _velocity_names[d];
 
         getProblem().addFVBC(bc_type, _pressure_name + "_" + inlet_bdy, params);
       }
 
       // need to increment flux_bc_counter
       ++flux_bc_counter;
     }
   }
 }

◆ addMassKernels()

void WCNSFVFlowPhysics::addMassKernels ( )

private

Function adding kernels for the incompressible continuity equation.

Definition at line 329 of file WCNSFVFlowPhysics.C.

Referenced by addFVKernels().

 {
   std::string kernel_type = "INSFVMassAdvection";
   std::string kernel_name = prefix() + "ins_mass_advection";
 
   if (_porous_medium_treatment)
   {
     kernel_type = "PINSFVMassAdvection";
     kernel_name = prefix() + "pins_mass_advection";
   }
 
   InputParameters params = getFactory().getValidParams(kernel_type);
   assignBlocks(params, _blocks);
   params.set<NonlinearVariableName>("variable") = _pressure_name;
   params.set<MooseFunctorName>(NS::density) = _density_name;
   params.set<MooseEnum>("velocity_interp_method") = _velocity_interpolation;
   params.set<UserObjectName>("rhie_chow_user_object") = rhieChowUOName();
   params.set<MooseEnum>("advected_interp_method") =
       getParam<MooseEnum>("mass_advection_interpolation");
 
   getProblem().addFVKernel(kernel_type, kernel_name, params);
 }

◆ addMassTimeKernels()

void WCNSFVFlowPhysics::addMassTimeKernels ( )

private

Function adding kernels for the time derivative term of the weakly compressible continuity equation.

Definition at line 308 of file WCNSFVFlowPhysics.C.

Referenced by addFVKernels().

 {
   std::string mass_kernel_type = "WCNSFVMassTimeDerivative";
   std::string kernel_name = prefix() + "wcns_mass_time";
 
   if (_porous_medium_treatment)
   {
     mass_kernel_type = "PWCNSFVMassTimeDerivative";
     kernel_name = prefix() + "pwcns_mass_time";
   }
 
   InputParameters params = getFactory().getValidParams(mass_kernel_type);
   assignBlocks(params, _blocks);
   params.set<NonlinearVariableName>("variable") = _pressure_name;
   params.set<MooseFunctorName>(NS::time_deriv(NS::density)) = NS::time_deriv(_density_name);
   if (_porous_medium_treatment)
     params.set<MooseFunctorName>(NS::porosity) = _flow_porosity_functor_name;
   getProblem().addFVKernel(mass_kernel_type, kernel_name, params);
 }

◆ addMaterials()

void WCNSFVFlowPhysicsBase::addMaterials ( )

overrideprotectedvirtualinherited

Reimplemented from PhysicsBase.

Definition at line 269 of file WCNSFVFlowPhysicsBase.C.

 {
   if (hasForchheimerFriction() || _porous_medium_treatment)
     addPorousMediumSpeedMaterial();
   else
     addNonPorousMediumSpeedMaterial();
 }

◆ addMomentumAdvectionKernels()

void WCNSFVFlowPhysics::addMomentumAdvectionKernels ( )

private

Definition at line 411 of file WCNSFVFlowPhysics.C.

Referenced by addFVKernels().

 {
   std::string kernel_type = "INSFVMomentumAdvection";
   std::string kernel_name = prefix() + "ins_momentum_advection_";
 
   if (_porous_medium_treatment)
   {
     kernel_type = "PINSFVMomentumAdvection";
     kernel_name = prefix() + "pins_momentum_advection_";
   }
 
   InputParameters params = getFactory().getValidParams(kernel_type);
   assignBlocks(params, _blocks);
   params.set<MooseFunctorName>(NS::density) = _density_name;
   params.set<MooseEnum>("velocity_interp_method") = _velocity_interpolation;
   params.set<UserObjectName>("rhie_chow_user_object") = rhieChowUOName();
   params.set<MooseEnum>("advected_interp_method") = _momentum_advection_interpolation;
   if (_porous_medium_treatment)
     params.set<MooseFunctorName>(NS::porosity) = _flow_porosity_functor_name;
   params.applySpecificParameters(parameters(), INSFVMomentumAdvection::listOfCommonParams());
 
   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);
   }
 }

◆ addMomentumBoussinesqKernels()

void WCNSFVFlowPhysics::addMomentumBoussinesqKernels ( )

overrideprivatevirtual

Implements WCNSFVFlowPhysicsBase.

Definition at line 546 of file WCNSFVFlowPhysics.C.

Referenced by addFVKernels().

 {
   if (_compressibility == "weakly-compressible")
     paramError("boussinesq_approximation",
                "We cannot use boussinesq approximation while running in weakly-compressible mode!");
 
   std::string kernel_type = "INSFVMomentumBoussinesq";
   std::string kernel_name = prefix() + "ins_momentum_boussinesq_";
 
   if (_porous_medium_treatment)
   {
     kernel_type = "PINSFVMomentumBoussinesq";
     kernel_name = prefix() + "pins_momentum_boussinesq_";
   }
 
   InputParameters params = getFactory().getValidParams(kernel_type);
   assignBlocks(params, _blocks);
   params.set<UserObjectName>("rhie_chow_user_object") = rhieChowUOName();
   params.set<MooseFunctorName>(NS::T_fluid) = _fluid_temperature_name;
   params.set<MooseFunctorName>(NS::density) = _density_gravity_name;
   params.set<RealVectorValue>("gravity") = getParam<RealVectorValue>("gravity");
   params.set<Real>("ref_temperature") = getParam<Real>("ref_temperature");
   params.set<MooseFunctorName>("alpha_name") = getParam<MooseFunctorName>("thermal_expansion");
   if (_porous_medium_treatment)
     params.set<MooseFunctorName>(NS::porosity) = _flow_porosity_functor_name;
   // User declared the flow to be incompressible, we have to trust them
   params.set<bool>("_override_constant_check") = true;
 
   for (const auto d : make_range(dimension()))
   {
     params.set<MooseEnum>("momentum_component") = NS::directions[d];
     params.set<NonlinearVariableName>("variable") = _velocity_names[d];
 
     getProblem().addFVKernel(kernel_type, kernel_name + NS::directions[d], params);
   }
 }

◆ addMomentumFrictionKernels()

void WCNSFVFlowPhysics::addMomentumFrictionKernels ( )

overrideprivatevirtual

Implements WCNSFVFlowPhysicsBase.

Definition at line 584 of file WCNSFVFlowPhysics.C.

Referenced by addFVKernels().

 {
   unsigned int num_friction_blocks = _friction_blocks.size();
   unsigned int num_used_blocks = num_friction_blocks ? num_friction_blocks : 1;
 
   const std::string kernel_type = "PINSFVMomentumFriction";
   InputParameters params = getFactory().getValidParams(kernel_type);
   params.set<MooseFunctorName>(NS::density) = _density_name;
   params.set<UserObjectName>("rhie_chow_user_object") = rhieChowUOName();
   if (hasForchheimerFriction())
     params.set<MooseFunctorName>(NS::speed) = NS::speed;
   params.set<bool>("standard_friction_formulation") =
       getParam<bool>("standard_friction_formulation");
   params.set<bool>("is_porous_medium") = _porous_medium_treatment;
 
   for (const auto block_i : make_range(num_used_blocks))
   {
     std::string block_name = "";
     if (num_friction_blocks)
     {
       params.set<std::vector<SubdomainName>>("block") = _friction_blocks[block_i];
       block_name = Moose::stringify(_friction_blocks[block_i]);
     }
     else
     {
       assignBlocks(params, _blocks);
       block_name = std::to_string(block_i);
     }
 
     for (const auto d : make_range(dimension()))
     {
       params.set<NonlinearVariableName>("variable") = _velocity_names[d];
       params.set<MooseEnum>("momentum_component") = NS::directions[d];
       for (unsigned int type_i = 0; type_i < _friction_types[block_i].size(); ++type_i)
       {
         const auto upper_name = MooseUtils::toUpper(_friction_types[block_i][type_i]);
         if (upper_name == "DARCY")
         {
           params.set<MooseFunctorName>(NS::mu) = _dynamic_viscosity_name;
           params.set<MooseFunctorName>("Darcy_name") = _friction_coeffs[block_i][type_i];
         }
         else if (upper_name == "FORCHHEIMER")
         {
           params.set<MooseFunctorName>(NS::speed) = NS::speed;
           params.set<MooseFunctorName>("Forchheimer_name") = _friction_coeffs[block_i][type_i];
         }
         else
           paramError("momentum_friction_types",
                      "Friction type '",
                      _friction_types[block_i][type_i],
                      "' is not implemented");
       }
 
       getProblem().addFVKernel(kernel_type,
                                prefix() + "momentum_friction_" + block_name + "_" +
                                    NS::directions[d],
                                params);
     }
 
     if (_porous_medium_treatment && getParam<bool>("use_friction_correction"))
     {
       const std::string correction_kernel_type = "PINSFVMomentumFrictionCorrection";
       InputParameters corr_params = getFactory().getValidParams(correction_kernel_type);
       if (num_friction_blocks)
         corr_params.set<std::vector<SubdomainName>>("block") = _friction_blocks[block_i];
       else
         assignBlocks(corr_params, _blocks);
       corr_params.set<MooseFunctorName>(NS::density) = _density_name;
       corr_params.set<UserObjectName>("rhie_chow_user_object") = rhieChowUOName();
       corr_params.set<Real>("consistent_scaling") = getParam<Real>("consistent_scaling");
       for (const auto d : make_range(dimension()))
       {
         corr_params.set<NonlinearVariableName>("variable") = _velocity_names[d];
         corr_params.set<MooseEnum>("momentum_component") = NS::directions[d];
         for (unsigned int type_i = 0; type_i < _friction_types[block_i].size(); ++type_i)
         {
           const auto upper_name = MooseUtils::toUpper(_friction_types[block_i][type_i]);
           if (upper_name == "DARCY")
           {
             corr_params.set<MooseFunctorName>(NS::mu) = _dynamic_viscosity_name;
             corr_params.set<MooseFunctorName>("Darcy_name") = _friction_coeffs[block_i][type_i];
           }
           else if (upper_name == "FORCHHEIMER")
           {
             corr_params.set<MooseFunctorName>(NS::speed) = NS::speed;
             corr_params.set<MooseFunctorName>("Forchheimer_name") =
                 _friction_coeffs[block_i][type_i];
           }
         }
 
         getProblem().addFVKernel(correction_kernel_type,
                                  prefix() + "pins_momentum_friction_correction_" + block_name +
                                      "_" + NS::directions[d],
                                  corr_params);
       }
     }
   }
 }

◆ addMomentumGravityKernels()

void WCNSFVFlowPhysics::addMomentumGravityKernels ( )

overrideprivatevirtual

Implements WCNSFVFlowPhysicsBase.

Definition at line 511 of file WCNSFVFlowPhysics.C.

Referenced by addFVKernels().

 {
   if (parameters().isParamValid("gravity") && !_solve_for_dynamic_pressure)
   {
     std::string kernel_type = "INSFVMomentumGravity";
     std::string kernel_name = prefix() + "ins_momentum_gravity_";
 
     if (_porous_medium_treatment)
     {
       kernel_type = "PINSFVMomentumGravity";
       kernel_name = prefix() + "pins_momentum_gravity_";
     }
 
     InputParameters params = getFactory().getValidParams(kernel_type);
     assignBlocks(params, _blocks);
     params.set<UserObjectName>("rhie_chow_user_object") = rhieChowUOName();
     params.set<MooseFunctorName>(NS::density) = _density_gravity_name;
     params.set<RealVectorValue>("gravity") = getParam<RealVectorValue>("gravity");
     if (_porous_medium_treatment)
       params.set<MooseFunctorName>(NS::porosity) = _flow_porosity_functor_name;
 
     for (const auto d : make_range(dimension()))
     {
       if (getParam<RealVectorValue>("gravity")(d) != 0)
       {
         params.set<MooseEnum>("momentum_component") = NS::directions[d];
         params.set<NonlinearVariableName>("variable") = _velocity_names[d];
 
         getProblem().addFVKernel(kernel_type, kernel_name + NS::directions[d], params);
       }
     }
   }
 }

◆ addMomentumMixingLengthKernels()

void WCNSFVFlowPhysics::addMomentumMixingLengthKernels ( )

private

◆ addMomentumPressureKernels()

void WCNSFVFlowPhysics::addMomentumPressureKernels ( )

overrideprivatevirtual

Implements WCNSFVFlowPhysicsBase.

Definition at line 482 of file WCNSFVFlowPhysics.C.

Referenced by addFVKernels().

 {
   std::string kernel_type = "INSFVMomentumPressure";
   std::string kernel_name = prefix() + "ins_momentum_pressure_";
 
   if (_porous_medium_treatment)
   {
     kernel_type = "PINSFVMomentumPressure";
     kernel_name = prefix() + "pins_momentum_pressure_";
   }
 
   InputParameters params = getFactory().getValidParams(kernel_type);
   assignBlocks(params, _blocks);
   params.set<UserObjectName>("rhie_chow_user_object") = rhieChowUOName();
   params.set<MooseFunctorName>("pressure") = _pressure_name;
   params.set<bool>("correct_skewness") =
       getParam<MooseEnum>("pressure_face_interpolation") == "skewness-corrected";
   if (_porous_medium_treatment)
     params.set<MooseFunctorName>(NS::porosity) = _flow_porosity_functor_name;
 
   for (const auto d : make_range(dimension()))
   {
     params.set<MooseEnum>("momentum_component") = NS::directions[d];
     params.set<NonlinearVariableName>("variable") = _velocity_names[d];
     getProblem().addFVKernel(kernel_type, kernel_name + NS::directions[d], params);
   }
 }

◆ addMomentumTimeKernels()

void WCNSFVFlowPhysics::addMomentumTimeKernels ( )

overrideprivatevirtual

Functions adding kernels for the incompressible momentum equation If the material properties are not constant, these can be used for weakly-compressible simulations (except the Boussinesq kernel) as well.

Implements WCNSFVFlowPhysicsBase.

Definition at line 372 of file WCNSFVFlowPhysics.C.

Referenced by addFVKernels().

 {
   std::string kernel_type = (_compressibility == "weakly-compressible")
                                 ? "WCNSFVMomentumTimeDerivative"
                                 : "INSFVMomentumTimeDerivative";
   std::string kernel_name = prefix() +
                             ((_compressibility == "weakly-compressible") ? "wcns_" : "ins_") +
                             "momentum_time_";
 
   if (_porous_medium_treatment)
   {
     // Porosity does not appear in the term
     kernel_type = (_compressibility == "weakly-compressible") ? "WCNSFVMomentumTimeDerivative"
                                                               : "PINSFVMomentumTimeDerivative";
     kernel_name = prefix() + ((_compressibility == "weakly-compressible") ? "pwcns_" : "pins_") +
                   "momentum_time_";
   }
 
   InputParameters params = getFactory().getValidParams(kernel_type);
   assignBlocks(params, _blocks);
   params.set<MooseFunctorName>(NS::density) = _density_name;
   if (_compressibility == "weakly-compressible")
     params.set<MooseFunctorName>(NS::time_deriv(NS::density)) = NS::time_deriv(_density_name);
 
   params.set<UserObjectName>("rhie_chow_user_object") = rhieChowUOName();
   params.set<bool>("contribute_to_rc") =
       getParam<bool>("time_derivative_contributes_to_RC_coefficients");
 
   for (const auto d : make_range(dimension()))
   {
     params.set<NonlinearVariableName>("variable") = _velocity_names[d];
     params.set<MooseEnum>("momentum_component") = NS::directions[d];
 
     if (shouldCreateTimeDerivative(_velocity_names[d], _blocks, /*error if already defined*/ false))
       getProblem().addFVKernel(kernel_type, kernel_name + _velocity_names[d], params);
   }
 }

◆ addMomentumViscousDissipationKernels()

void WCNSFVFlowPhysics::addMomentumViscousDissipationKernels ( )

private

Definition at line 442 of file WCNSFVFlowPhysics.C.

Referenced by addFVKernels().

 {
   std::string kernel_type = "INSFVMomentumDiffusion";
   std::string kernel_name = prefix() + "ins_momentum_diffusion_";
 
   if (_porous_medium_treatment)
   {
     kernel_type = "PINSFVMomentumDiffusion";
     kernel_name = prefix() + "pins_momentum_diffusion_";
   }
 
   InputParameters params = getFactory().getValidParams(kernel_type);
   assignBlocks(params, _blocks);
   params.set<UserObjectName>("rhie_chow_user_object") = rhieChowUOName();
   params.set<MooseFunctorName>(NS::mu) = _dynamic_viscosity_name;
   params.set<MooseEnum>("mu_interp_method") = getParam<MooseEnum>("mu_interp_method");
   params.set<MooseEnum>("variable_interp_method") =
       getParam<MooseEnum>("momentum_face_interpolation");
   if (getParam<bool>("include_deviatoric_stress"))
   {
     params.set<bool>("complete_expansion") = true;
     const std::string u_names[3] = {"u", "v", "w"};
     for (unsigned int i = 0; i < dimension(); ++i)
       params.set<MooseFunctorName>(u_names[i]) = _velocity_names[i];
   }
 
   if (_porous_medium_treatment)
     params.set<MooseFunctorName>(NS::porosity) = _flow_porosity_functor_name;
   // Currently only Newton method for WCNSFVFlowPhysics
   params.set<bool>("newton_solve") = true;
   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);
   }
 }

◆ addNonPorousMediumSpeedMaterial()

void WCNSFVFlowPhysicsBase::addNonPorousMediumSpeedMaterial ( )

protectedinherited

Add material to define the local speed with no porous medium treatment.

Definition at line 295 of file WCNSFVFlowPhysicsBase.C.

Referenced by WCNSFVFlowPhysicsBase::addMaterials().

 {
   const std::string class_name = "ADVectorMagnitudeFunctorMaterial";
   InputParameters params = getFactory().getValidParams(class_name);
   assignBlocks(params, _blocks);
 
   const std::vector<std::string> param_names{"x_functor", "y_functor", "z_functor"};
   for (unsigned int dim_i = 0; dim_i < dimension(); ++dim_i)
     params.set<MooseFunctorName>(param_names[dim_i]) = _velocity_names[dim_i];
   params.set<MooseFunctorName>("vector_magnitude_name") = NS::speed;
 
   getProblem().addMaterial(class_name, prefix() + "ins_speed_material", params);
 }

◆ addOutletBC()

void WCNSFVFlowPhysics::addOutletBC ( )

overrideprivatevirtual

Implements WCNSFVFlowPhysicsBase.

Definition at line 818 of file WCNSFVFlowPhysics.C.

 {
   // Check the BCs size
   unsigned int num_pressure_outlets = 0;
   for (const auto & [bdy, momentum_outlet_type] : _momentum_outlet_types)
     if (momentum_outlet_type == "fixed-pressure" ||
         momentum_outlet_type == "fixed-pressure-zero-gradient")
       num_pressure_outlets++;
 
   if (num_pressure_outlets != _pressure_functors.size())
     paramError("pressure_functors",
                "Size (" + std::to_string(_pressure_functors.size()) +
                    ") is not the same as the number of pressure outlet boundaries in "
                    "'fixed-pressure/fixed-pressure-zero-gradient' (size " +
                    std::to_string(num_pressure_outlets) + ")");
 
   const std::string u_names[3] = {"u", "v", "w"};
   for (const auto & [outlet_bdy, momentum_outlet_type] : _momentum_outlet_types)
   {
     if (momentum_outlet_type == "zero-gradient" ||
         momentum_outlet_type == "fixed-pressure-zero-gradient")
     {
       {
         const std::string bc_type = _porous_medium_treatment ? "PINSFVMomentumAdvectionOutflowBC"
                                                              : "INSFVMomentumAdvectionOutflowBC";
         InputParameters params = getFactory().getValidParams(bc_type);
         params.set<std::vector<BoundaryName>>("boundary") = {outlet_bdy};
         if (_porous_medium_treatment)
           params.set<MooseFunctorName>(NS::porosity) = _flow_porosity_functor_name;
         params.set<UserObjectName>("rhie_chow_user_object") = rhieChowUOName();
         params.set<MooseFunctorName>(NS::density) = _density_name;
 
         for (unsigned int i = 0; i < dimension(); ++i)
           params.set<MooseFunctorName>(u_names[i]) = _velocity_names[i];
 
         for (const auto d : make_range(dimension()))
         {
           params.set<NonlinearVariableName>("variable") = _velocity_names[d];
           params.set<MooseEnum>("momentum_component") = NS::directions[d];
 
           getProblem().addFVBC(bc_type, _velocity_names[d] + "_" + outlet_bdy, params);
         }
       }
     }
 
     if (momentum_outlet_type == "fixed-pressure" ||
         momentum_outlet_type == "fixed-pressure-zero-gradient")
     {
       const std::string bc_type = "INSFVOutletPressureBC";
       InputParameters params = getFactory().getValidParams(bc_type);
       params.set<NonlinearVariableName>("variable") = _pressure_name;
       params.set<MooseFunctorName>("functor") = libmesh_map_find(_pressure_functors, outlet_bdy);
       params.set<std::vector<BoundaryName>>("boundary") = {outlet_bdy};
 
       getProblem().addFVBC(bc_type, _pressure_name + "_" + outlet_bdy, params);
     }
     else if (momentum_outlet_type == "zero-gradient")
     {
       const std::string bc_type = "INSFVMassAdvectionOutflowBC";
       InputParameters params = getFactory().getValidParams(bc_type);
       params.set<NonlinearVariableName>("variable") = _pressure_name;
       params.set<MooseFunctorName>(NS::density) = _density_name;
       params.set<std::vector<BoundaryName>>("boundary") = {outlet_bdy};
 
       for (const auto d : make_range(dimension()))
         params.set<MooseFunctorName>(u_names[d]) = _velocity_names[d];
 
       getProblem().addFVBC(bc_type, _pressure_name + "_" + outlet_bdy, params);
     }
   }
 }

◆ addPorousMediumSpeedMaterial()

void WCNSFVFlowPhysicsBase::addPorousMediumSpeedMaterial ( )

protectedinherited

Add material to define the local speed in porous medium flows.

Definition at line 278 of file WCNSFVFlowPhysicsBase.C.

Referenced by WCNSFVFlowPhysicsBase::addMaterials().

 {
   InputParameters params = getFactory().getValidParams("PINSFVSpeedFunctorMaterial");
   assignBlocks(params, _blocks);
 
   for (unsigned int dim_i = 0; dim_i < dimension(); ++dim_i)
     params.set<MooseFunctorName>(NS::superficial_velocity_vector[dim_i]) = _velocity_names[dim_i];
   if (_porous_medium_treatment)
     params.set<MooseFunctorName>(NS::porosity) = _flow_porosity_functor_name;
   else
     params.set<MooseFunctorName>(NS::porosity) = "1";
   params.set<bool>("define_interstitial_velocity_components") = _porous_medium_treatment;
 
   getProblem().addMaterial("PINSFVSpeedFunctorMaterial", prefix() + "pins_speed_material", params);
 }

◆ addPostprocessors()

void WCNSFVFlowPhysicsBase::addPostprocessors ( )

overrideprotectedvirtualinherited

Reimplemented from PhysicsBase.

Definition at line 370 of file WCNSFVFlowPhysicsBase.C.

 {
   const auto momentum_inlet_types = getParam<MultiMooseEnum>("momentum_inlet_types");
 
   for (unsigned int bc_ind = 0; bc_ind < momentum_inlet_types.size(); ++bc_ind)
     if (momentum_inlet_types[bc_ind] == "flux-mass" ||
         momentum_inlet_types[bc_ind] == "flux-velocity")
     {
       const std::string pp_type = "AreaPostprocessor";
       InputParameters params = getFactory().getValidParams(pp_type);
       params.set<std::vector<BoundaryName>>("boundary") = {_inlet_boundaries[bc_ind]};
       params.set<ExecFlagEnum>("execute_on") = EXEC_INITIAL;
 
       const auto name_pp = "area_pp_" + _inlet_boundaries[bc_ind];
       if (!getProblem().hasUserObject(name_pp))
         getProblem().addPostprocessor(pp_type, name_pp, params);
     }
 }

◆ addPressurePinKernel()

void WCNSFVFlowPhysics::addPressurePinKernel ( )

private

Function adding the pressure constraint.

Definition at line 353 of file WCNSFVFlowPhysics.C.

Referenced by addFVKernels().

 {
   const auto pin_type = getParam<MooseEnum>("pinned_pressure_type");
   const auto object_type =
       (pin_type == "average") ? "FVIntegralValueConstraint" : "FVPointValueConstraint";
   InputParameters params = getFactory().getValidParams(object_type);
   if (pin_type != "point-value" && pin_type != "average")
     return;
 
   params.set<CoupledName>("lambda") = {"lambda"};
   params.set<PostprocessorName>("phi0") = getParam<PostprocessorName>("pinned_pressure_value");
   params.set<NonlinearVariableName>("variable") = _pressure_name;
   if (pin_type == "point-value")
     params.set<Point>("point") = getParam<Point>("pinned_pressure_point");
 
   getProblem().addFVKernel(object_type, prefix() + "ins_mass_pressure_pin", params);
 }

◆ addRhieChowUserObjects()

void WCNSFVFlowPhysics::addRhieChowUserObjects ( )

overrideprivatevirtual

Function which adds the RhieChow interpolator user objects for weakly and incompressible formulations.

Implements WCNSFVFlowPhysicsBase.

Definition at line 1109 of file WCNSFVFlowPhysics.C.

Referenced by addUserObjects().

 {
   mooseAssert(dimension(), "0-dimension not supported");
 
   // First make sure that we only add this object once
   // Potential cases:
   // - there is a flow physics, and an advection one (UO should be added by one)
   // - there is only an advection physics (UO should be created)
   // - there are two advection physics on different blocks with set velocities (first one picks)
   // Counting RC UOs defined on the same blocks seems to be the most fool proof option
   std::vector<UserObject *> objs;
   getProblem()
       .theWarehouse()
       .query()
       .condition<AttribSystem>("UserObject")
       .condition<AttribThread>(0)
       .queryInto(objs);
   bool have_matching_rc_uo = false;
   for (const auto & obj : objs)
     if (const auto * const rc_obj = dynamic_cast<INSFVRhieChowInterpolator *>(obj); rc_obj)
       // Latter check is for whether one of the RC user object is defined everywhere
       if (rc_obj->blocks() == _blocks || (rc_obj->blocks().size() == 0 || _blocks.size() == 0))
       {
         have_matching_rc_uo = true;
         _rc_uo_name = rc_obj->name();
         break;
       }
 
   if (have_matching_rc_uo)
     return;
 
   _rc_uo_name =
       _porous_medium_treatment ? +"pins_rhie_chow_interpolator" : "ins_rhie_chow_interpolator";
 
   const std::string u_names[3] = {"u", "v", "w"};
   const auto object_type =
       _porous_medium_treatment ? "PINSFVRhieChowInterpolator" : "INSFVRhieChowInterpolator";
 
   auto params = getFactory().getValidParams(object_type);
   assignBlocks(params, _blocks);
   for (unsigned int d = 0; d < dimension(); ++d)
     params.set<VariableName>(u_names[d]) = _velocity_names[d];
 
   params.set<VariableName>("pressure") = _pressure_name;
 
   if (_porous_medium_treatment)
   {
     params.set<MooseFunctorName>(NS::porosity) = _porosity_name;
     unsigned short smoothing_layers = isParamValid("porosity_smoothing_layers")
                                           ? getParam<unsigned short>("porosity_smoothing_layers")
                                           : 0;
     params.set<unsigned short>("smoothing_layers") = smoothing_layers;
   }
 
   if (!_has_flow_equations)
   {
     checkRhieChowFunctorsDefined();
     params.set<MooseFunctorName>("a_u") = "ax";
     params.set<MooseFunctorName>("a_v") = "ay";
     params.set<MooseFunctorName>("a_w") = "az";
   }
 
   params.applySpecificParameters(parameters(), INSFVRhieChowInterpolator::listOfCommonParams());
   getProblem().addUserObject(object_type, _rc_uo_name, params);
 }

◆ addSeparatorBC()

void WCNSFVFlowPhysics::addSeparatorBC ( )

overrideprivatevirtual

Implements WCNSFVFlowPhysicsBase.

Definition at line 1009 of file WCNSFVFlowPhysics.C.

 {
   if (_hydraulic_separators.size())
   {
     std::string bc_type = "INSFVVelocityHydraulicSeparatorBC";
     InputParameters params = getFactory().getValidParams(bc_type);
     params.set<std::vector<BoundaryName>>("boundary") = _hydraulic_separators;
     params.set<UserObjectName>("rhie_chow_user_object") = rhieChowUOName();
 
     for (const auto d : make_range(dimension()))
     {
       params.set<NonlinearVariableName>("variable") = _velocity_names[d];
       params.set<MooseEnum>("momentum_component") = NS::directions[d];
       getProblem().addFVBC(bc_type, prefix() + _velocity_names[d] + "_separators", params);
     }
 
     bc_type = "INSFVScalarFieldSeparatorBC";
     params = getFactory().getValidParams(bc_type);
     params.set<std::vector<BoundaryName>>("boundary") = _hydraulic_separators;
     params.set<NonlinearVariableName>("variable") = _pressure_name;
     getProblem().addFVBC(bc_type, prefix() + _pressure_name + "_separators", params);
   }
 }

◆ addSolverVariables()

void WCNSFVFlowPhysics::addSolverVariables ( )

overrideprivatevirtual

Implements WCNSFVFlowPhysicsBase.

Definition at line 142 of file WCNSFVFlowPhysics.C.

 {
   if (!_has_flow_equations)
     return;
 
   for (const auto d : make_range(dimension()))
     saveSolverVariableName(_velocity_names[d]);
   saveSolverVariableName(_pressure_name);
 
   // Check number of variables
   if (_velocity_names.size() != dimension() && _velocity_names.size() != 3)
     paramError("velocity_variable",
                "The number of velocity variable names supplied to the NSFVAction is not " +
                    Moose::stringify(dimension()) + " (mesh dimension)" +
                    ((dimension() == 3) ? "" : " or 3!") + "\nVelocity variables " +
                    Moose::stringify(_velocity_names));
 
   // Velocities
   for (const auto d : make_range(dimension()))
   {
     if (!shouldCreateVariable(_velocity_names[d], _blocks, /*error if aux*/ true))
       reportPotentiallyMissedParameters({"system_names",
                                          "momentum_scaling",
                                          "momentum_face_interpolation",
                                          "momentum_two_term_bc_expansion"},
                                         "INSFVVelocityVariable");
     else if (_define_variables)
     {
       std::string variable_type = "INSFVVelocityVariable";
       if (_porous_medium_treatment)
         variable_type = "PINSFVSuperficialVelocityVariable";
 
       auto params = getFactory().getValidParams(variable_type);
       assignBlocks(params, _blocks); // TODO: check wrt components
       params.set<std::vector<Real>>("scaling") = {getParam<Real>("momentum_scaling")};
       params.set<MooseEnum>("face_interp_method") =
           getParam<MooseEnum>("momentum_face_interpolation");
       params.set<bool>("two_term_boundary_expansion") =
           getParam<bool>("momentum_two_term_bc_expansion");
 
       params.set<SolverSystemName>("solver_sys") = getSolverSystem(_velocity_names[d]);
       getProblem().addVariable(variable_type, _velocity_names[d], params);
     }
     else
       paramError("velocity_variable",
                  "Variable (" + _velocity_names[d] +
                      ") supplied to the WCNSFVFlowPhysics does not exist!");
   }
 
   // Pressure
   const bool using_bernouilli_pressure_var =
       _porous_medium_treatment &&
       getParam<MooseEnum>("porosity_interface_pressure_treatment") != "automatic";
   const auto pressure_type =
       using_bernouilli_pressure_var ? "BernoulliPressureVariable" : "INSFVPressureVariable";
   if (!shouldCreateVariable(_pressure_name, _blocks, /*error if aux*/ true))
   {
     std::vector<std::string> potentially_missed = {"system_names",
                                                    "mass_scaling",
                                                    "pressure_face_interpolation",
                                                    "pressure_two_term_bc_expansion"};
     if (using_bernouilli_pressure_var)
     {
       std::vector<std::string> other_missed = {"pressure_allow_expansion_on_bernoulli_faces",
                                                "pressure_drop_sidesets",
                                                "pressure_drop_form_factors"};
       potentially_missed.insert(potentially_missed.end(), other_missed.begin(), other_missed.end());
     }
     reportPotentiallyMissedParameters(potentially_missed, pressure_type);
   }
   else if (_define_variables)
   {
     auto params = getFactory().getValidParams(pressure_type);
     assignBlocks(params, _blocks);
     params.set<std::vector<Real>>("scaling") = {getParam<Real>("mass_scaling")};
     params.set<MooseEnum>("face_interp_method") =
         getParam<MooseEnum>("pressure_face_interpolation");
     params.set<bool>("two_term_boundary_expansion") =
         getParam<bool>("pressure_two_term_bc_expansion");
 
     if (using_bernouilli_pressure_var)
     {
       params.set<MooseFunctorName>("u") = _velocity_names[0];
       if (dimension() >= 2)
         params.set<MooseFunctorName>("v") = _velocity_names[1];
       if (dimension() == 3)
         params.set<MooseFunctorName>("w") = _velocity_names[2];
       params.set<MooseFunctorName>(NS::porosity) = _porosity_name;
       params.set<MooseFunctorName>(NS::density) = _density_name;
       params.set<bool>("allow_two_term_expansion_on_bernoulli_faces") =
           getParam<bool>("pressure_allow_expansion_on_bernoulli_faces");
       params.set<std::vector<BoundaryName>>("pressure_drop_sidesets") =
           getParam<std::vector<BoundaryName>>("pressure_drop_sidesets");
       params.set<std::vector<Real>>("pressure_drop_form_factors") =
           getParam<std::vector<Real>>("pressure_drop_form_factors");
     }
     params.set<SolverSystemName>("solver_sys") = getSolverSystem(_pressure_name);
     getProblem().addVariable(pressure_type, _pressure_name, params);
   }
   else
     paramError("pressure_variable",
                "Variable (" + _pressure_name +
                    ") supplied to the WCNSFVFlowPhysics does not exist!");
 
   // Add lagrange multiplier for pinning pressure, if needed
   if (getParam<bool>("pin_pressure"))
   {
     auto type = getParam<MooseEnum>("pinned_pressure_type");
     auto lm_params = getFactory().getValidParams("MooseVariableScalar");
     lm_params.set<MooseEnum>("family") = "scalar";
     lm_params.set<MooseEnum>("order") = "first";
 
     if ((type == "point-value" || type == "average") && !_problem->hasScalarVariable("lambda"))
     {
       lm_params.set<SolverSystemName>("solver_sys") = getSolverSystem("lambda");
       getProblem().addVariable("MooseVariableScalar", "lambda", lm_params);
     }
     else
       reportPotentiallyMissedParameters({"system_names"}, "MooseVariableScalar");
   }
 }

◆ addUserObjects()

void WCNSFVFlowPhysics::addUserObjects ( )

overrideprivatevirtual

Implements WCNSFVFlowPhysicsBase.

Definition at line 1034 of file WCNSFVFlowPhysics.C.

 {
   // Rhie Chow user object for interpolation velocities
   addRhieChowUserObjects();
 }

◆ addWallsBC()

void WCNSFVFlowPhysics::addWallsBC ( )

overrideprivatevirtual

Implements WCNSFVFlowPhysicsBase.

Definition at line 891 of file WCNSFVFlowPhysics.C.

 {
   const std::string u_names[3] = {"u", "v", "w"};
 
   // Count the number of fixed velocity wall boundaries (moving walls)
   unsigned int num_functor_walls = 0;
   for (const auto & [boundary_name, momentum_wall_type] : _momentum_wall_types)
     if (momentum_wall_type == "noslip")
       num_functor_walls++;
   if (_momentum_wall_functors.size() && num_functor_walls != _momentum_wall_functors.size())
     paramError("momentum_wall_functors",
                "If any wall functors are specified, the number of boundaries requiring a momentum "
                "functor (" +
                    std::to_string(num_functor_walls) + ") and the number of functors specified (" +
                    std::to_string(_momentum_wall_functors.size()) + ") must match");
   for (const auto & wall_functors : _momentum_wall_functors)
     if (wall_functors.second.size() != dimension())
       paramError("momentum_wall_functors",
                  "Number of wall functors (" + std::to_string(wall_functors.second.size()) +
                      ") must match dimension (" + std::to_string(dimension()) +
                      ").\nFunctors currently specified:" + Moose::stringify(wall_functors.second));
 
   for (const auto & [boundary_name, wall_type] : _momentum_wall_types)
   {
     if (wall_type == "noslip")
     {
       const std::string bc_type = "INSFVNoSlipWallBC";
       InputParameters params = getFactory().getValidParams(bc_type);
       params.set<std::vector<BoundaryName>>("boundary") = {boundary_name};
 
       for (const auto d : make_range(dimension()))
       {
         params.set<NonlinearVariableName>("variable") = _velocity_names[d];
         if (_momentum_wall_functors.count(boundary_name) == 0)
           params.set<FunctionName>("function") = "0";
         else
           params.set<FunctionName>("function") = _momentum_wall_functors[boundary_name][d];
 
         getProblem().addFVBC(bc_type, _velocity_names[d] + "_" + boundary_name, params);
       }
     }
     else if (wall_type == "wallfunction")
     {
       const std::string bc_type = "INSFVWallFunctionBC";
       InputParameters params = getFactory().getValidParams(bc_type);
       params.set<MooseFunctorName>(NS::mu) = _dynamic_viscosity_name;
       params.set<MooseFunctorName>(NS::density) = _density_name;
       params.set<std::vector<BoundaryName>>("boundary") = {boundary_name};
       params.set<UserObjectName>("rhie_chow_user_object") = rhieChowUOName();
 
       for (const auto d : make_range(dimension()))
         params.set<MooseFunctorName>(u_names[d]) = _velocity_names[d];
 
       for (const auto d : make_range(dimension()))
       {
         params.set<NonlinearVariableName>("variable") = _velocity_names[d];
         params.set<MooseEnum>("momentum_component") = NS::directions[d];
 
         getProblem().addFVBC(bc_type, _velocity_names[d] + "_" + boundary_name, params);
       }
     }
     else if (wall_type == "slip")
     {
       const std::string bc_type = "INSFVNaturalFreeSlipBC";
       InputParameters params = getFactory().getValidParams(bc_type);
       params.set<std::vector<BoundaryName>>("boundary") = {boundary_name};
       params.set<UserObjectName>("rhie_chow_user_object") = rhieChowUOName();
 
       for (const auto d : make_range(dimension()))
       {
         params.set<NonlinearVariableName>("variable") = _velocity_names[d];
         params.set<MooseEnum>("momentum_component") = NS::directions[d];
 
         getProblem().addFVBC(bc_type, _velocity_names[d] + "_" + boundary_name, params);
       }
     }
     else if (wall_type == "symmetry")
     {
       {
         std::string bc_type;
         if (_porous_medium_treatment)
           bc_type = "PINSFVSymmetryVelocityBC";
         else
           bc_type = "INSFVSymmetryVelocityBC";
 
         InputParameters params = getFactory().getValidParams(bc_type);
         params.set<std::vector<BoundaryName>>("boundary") = {boundary_name};
 
         MooseFunctorName viscosity_name = _dynamic_viscosity_name;
         if (hasTurbulencePhysics())
           viscosity_name = NS::total_viscosity;
         params.set<MooseFunctorName>(NS::mu) = viscosity_name;
         params.set<UserObjectName>("rhie_chow_user_object") = rhieChowUOName();
 
         for (const auto d : make_range(dimension()))
           params.set<MooseFunctorName>(u_names[d]) = _velocity_names[d];
 
         for (const auto d : make_range(dimension()))
         {
           params.set<NonlinearVariableName>("variable") = _velocity_names[d];
           params.set<MooseEnum>("momentum_component") = NS::directions[d];
 
           getProblem().addFVBC(bc_type, _velocity_names[d] + "_" + boundary_name, params);
         }
       }
       {
         const std::string bc_type = "INSFVSymmetryPressureBC";
         InputParameters params = getFactory().getValidParams(bc_type);
         params.set<NonlinearVariableName>("variable") = _pressure_name;
         params.set<std::vector<BoundaryName>>("boundary") = {boundary_name};
 
         getProblem().addFVBC(bc_type, _pressure_name + "_" + boundary_name, params);
       }
     }
   }
 }

◆ checkRhieChowFunctorsDefined()

void WCNSFVFlowPhysics::checkRhieChowFunctorsDefined ( ) const

private

Checks that sufficient Rhie Chow coefficients have been defined for the given dimension, used for scalar or temperature advection by auxiliary variables.

Definition at line 1176 of file WCNSFVFlowPhysics.C.

Referenced by addRhieChowUserObjects().

 {
   if (!getProblem().hasFunctor("ax", /*thread_id=*/0))
     mooseError("Rhie Chow coefficient ax must be provided for advection by auxiliary velocities");
   if (dimension() >= 2 && !getProblem().hasFunctor("ay", /*thread_id=*/0))
     mooseError("Rhie Chow coefficient ay must be provided for advection by auxiliary velocities");
   if (dimension() == 3 && !getProblem().hasFunctor("az", /*thread_id=*/0))
     mooseError("Rhie Chow coefficient az must be provided for advection by auxiliary velocities");
 }

◆ compressibility()

const MooseEnum& WCNSFVFlowPhysicsBase::compressibility ( ) const

inlineinherited

Return the compressibility of the flow equations selected.

Definition at line 47 of file WCNSFVFlowPhysicsBase.h.

47 { return _compressibility; }

WCNSFVFlowPhysicsBase::_compressibility

const MooseEnum _compressibility

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

Definition: WCNSFVFlowPhysicsBase.h:149

◆ densityName()

const MooseFunctorName& WCNSFVFlowPhysicsBase::densityName ( ) const

inlineinherited

Return the name of the density functor.

Definition at line 53 of file WCNSFVFlowPhysicsBase.h.

Referenced by WCNSFVTurbulencePhysics::addAuxiliaryKernels(), WCNSFVTurbulencePhysics::addFVBCs(), WCNSFVTurbulencePhysics::addInitialConditions(), WCNSFVTurbulencePhysics::addKEpsilonAdvection(), WCNSFVTurbulencePhysics::addKEpsilonSink(), WCNSFVTurbulencePhysics::addMaterials(), PNSFVSolidHeatTransferPhysics::checkFluidAndSolidHeatTransferPhysicsParameters(), WCNSFVTwoPhaseMixturePhysics::WCNSFVTwoPhaseMixturePhysics(), and WCNSLinearFVTwoPhaseMixturePhysics::WCNSLinearFVTwoPhaseMixturePhysics().

53 { return _density_name; }

WCNSFVFlowPhysicsBase::_density_name

const MooseFunctorName _density_name

Name of the density material property.

Definition: WCNSFVFlowPhysicsBase.h:168

◆ dynamicViscosityName()

const MooseFunctorName& WCNSFVFlowPhysicsBase::dynamicViscosityName ( ) const

inlineinherited

Return the name of the dynamic viscosity functor.

Definition at line 55 of file WCNSFVFlowPhysicsBase.h.

Referenced by WCNSFVTurbulencePhysics::addAuxiliaryKernels(), WCNSFVTurbulencePhysics::addFlowTurbulenceKernels(), WCNSFVTurbulencePhysics::addFVBCs(), WCNSFVTurbulencePhysics::addKEpsilonDiffusion(), WCNSFVTurbulencePhysics::addKEpsilonSink(), and WCNSFVTurbulencePhysics::addMaterials().

55 { return _dynamic_viscosity_name; }

WCNSFVFlowPhysicsBase::_dynamic_viscosity_name

const MooseFunctorName _dynamic_viscosity_name

Name of the dynamic viscosity material property.

Definition: WCNSFVFlowPhysicsBase.h:172

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

◆ getCoupledTurbulencePhysics()

const WCNSFVTurbulencePhysics * WCNSFVFlowPhysicsBase::getCoupledTurbulencePhysics ( ) const

protectedinherited

Find the turbulence physics.

Definition at line 416 of file WCNSFVFlowPhysicsBase.C.

Referenced by WCNSFVFlowPhysicsBase::actOnAdditionalTasks().

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

◆ getFlowVariableName()

VariableName WCNSFVFlowPhysicsBase::getFlowVariableName ( const std::string & default_name ) const

protectedinherited

Convenience routine to be able to retrieve the actual variable names from their default names.

Definition at line 390 of file WCNSFVFlowPhysicsBase.C.

 {
   if (short_name == NS::pressure)
     return getPressureName();
   else if (short_name == NS::velocity_x && dimension() > 0)
     return getVelocityNames()[0];
   else if (short_name == NS::velocity_y && dimension() > 1)
     return getVelocityNames()[1];
   else if (short_name == NS::velocity_z && dimension() > 2)
     return getVelocityNames()[2];
   else if (short_name == NS::temperature)
     return getFluidTemperatureName();
   else
     mooseError("Short Variable name '", short_name, "' not recognized.");
 }

◆ getFluidTemperatureName()

const NonlinearVariableName& WCNSFVFlowPhysicsBase::getFluidTemperatureName ( ) const

inlineinherited

Definition at line 42 of file WCNSFVFlowPhysicsBase.h.

Referenced by WCNSFVTurbulencePhysics::addFluidEnergyTurbulenceKernels(), and WCNSFVFlowPhysicsBase::getFlowVariableName().

42 { return _fluid_temperature_name; }

WCNSFVFlowPhysicsBase::_fluid_temperature_name

const NonlinearVariableName _fluid_temperature_name

Fluid temperature name.

Definition: WCNSFVFlowPhysicsBase.h:165

◆ getFluxInletDirections()

const std::vector<Point>& WCNSFVFlowPhysicsBase::getFluxInletDirections ( ) const

inlineinherited

Get the inlet direction if using a flux inlet.

Definition at line 77 of file WCNSFVFlowPhysicsBase.h.

Referenced by WCNSFVFluidHeatTransferPhysics::addEnergyInletBC(), and WCNSFVScalarTransportPhysics::addScalarInletBC().

77 { return _flux_inlet_directions; }

WCNSFVFlowPhysicsBase::_flux_inlet_directions

std::vector< Point > _flux_inlet_directions

Direction of each flux inlet. Indexing based on the number of flux boundaries.

Definition: WCNSFVFlowPhysicsBase.h:210

◆ getFluxInletPPs()

const std::vector<PostprocessorName>& WCNSFVFlowPhysicsBase::getFluxInletPPs ( ) const

inlineinherited

Get the inlet flux postprocessor if using a flux inlet.

Definition at line 79 of file WCNSFVFlowPhysicsBase.h.

Referenced by WCNSFVFluidHeatTransferPhysics::addEnergyInletBC(), and WCNSFVScalarTransportPhysics::addScalarInletBC().

79 { return _flux_inlet_pps; }

WCNSFVFlowPhysicsBase::_flux_inlet_pps

std::vector< PostprocessorName > _flux_inlet_pps

Postprocessors describing the momentum inlet for each boundary. Indexing based on the number of flux ...

Definition: WCNSFVFlowPhysicsBase.h:208

◆ getHydraulicSeparators()

const std::vector<BoundaryName>& WCNSFVFlowPhysicsBase::getHydraulicSeparators ( ) const

inlineinherited

Get the hydraulic separator boundaries.

Definition at line 75 of file WCNSFVFlowPhysicsBase.h.

Referenced by WCNSFVFluidHeatTransferPhysics::addEnergySeparatorBC().

75 { return _hydraulic_separators; }

WCNSFVFlowPhysicsBase::_hydraulic_separators

const std::vector< BoundaryName > _hydraulic_separators

Hydraulic separator boundaries.

Definition: WCNSFVFlowPhysicsBase.h:198

◆ getInletBoundaries()

const std::vector<BoundaryName>& WCNSFVFlowPhysicsBase::getInletBoundaries ( ) const

inlineinherited

Get the inlet boundaries.

Definition at line 69 of file WCNSFVFlowPhysicsBase.h.

Referenced by WCNSFVFluidHeatTransferPhysics::addEnergyInletBC(), WCNSLinearFVFluidHeatTransferPhysics::addEnergyInletBC(), WCNSLinearFVScalarTransportPhysics::addScalarInletBC(), and WCNSFVScalarTransportPhysics::addScalarInletBC().

69 { return _inlet_boundaries; }

WCNSFVFlowPhysicsBase::_inlet_boundaries

const std::vector< BoundaryName > _inlet_boundaries

Boundaries with a flow inlet specified on them.

Definition: WCNSFVFlowPhysicsBase.h:192

◆ getLinearFrictionCoefName()

MooseFunctorName WCNSFVFlowPhysics::getLinearFrictionCoefName ( ) const

overridevirtual

Get the name of the linear friction coefficient. Returns an empty string if no friction.

Implements WCNSFVFlowPhysicsBase.

Definition at line 1194 of file WCNSFVFlowPhysics.C.

 {
   // Check all blocks. If more than one block, they would need to be consolidated #include in
   // a single functor material. We won't implement this for now
   if (_friction_types.empty())
     return "";
   else if (_friction_types.size() == 1)
   {
     for (const auto & type_i : index_range(_friction_types[0]))
     {
       const auto upper_name = MooseUtils::toUpper(_friction_types[0][type_i]);
       if (upper_name == "DARCY")
         return _friction_coeffs[0][type_i];
     }
     // No linear type found
     return "";
   }
   else if (_friction_types.size() > 1)
   {
     bool linear_friction_factor_found = false;
     MooseFunctorName linear_friction_factor;
     for (const auto block_i : index_range(_friction_types))
       for (const auto type_i : index_range(_friction_types[block_i]))
       {
         const auto upper_name = MooseUtils::toUpper(_friction_types[block_i][type_i]);
         if (upper_name == "DARCY" && !linear_friction_factor_found)
         {
           linear_friction_factor_found = true;
           linear_friction_factor = _friction_types[block_i][type_i];
         }
         else if (upper_name == "DARCY" && !linear_friction_factor_found)
           if (linear_friction_factor != _friction_types[block_i][type_i])
             mooseError("Multiple linear friction factor with different names have been specified. "
                        "This is not currently supported as a single name should be retrievable. "
                        "Use a PiecewiseByBlockFunctorMaterial to consolidate them.");
       }
     if (linear_friction_factor_found)
       return linear_friction_factor;
     else
       return "";
   }
   mooseError("Should not get here");
 }

◆ getMomentumAdvectionFaceInterpolationMethod()

const MooseEnum& WCNSFVFlowPhysicsBase::getMomentumAdvectionFaceInterpolationMethod ( ) const

inlineinherited

Get the face interpolation method for momentum in the advection term.

Definition at line 59 of file WCNSFVFlowPhysicsBase.h.

   {
     return _momentum_advection_interpolation;
   }

◆ getMomentumFaceInterpolationMethod()

const MooseEnum& WCNSFVFlowPhysicsBase::getMomentumFaceInterpolationMethod ( ) const

inlineinherited

Get the face interpolation method for momentum (mostly used in the stress terms)

Definition at line 64 of file WCNSFVFlowPhysicsBase.h.

Referenced by WCNSFVTwoPhaseMixturePhysics::addAdvectionSlipTerm(), and WCNSFVTurbulencePhysics::addFlowTurbulenceKernels().

   {
     return _momentum_face_interpolation;
   }

◆ getNumberAlgebraicGhostingLayersNeeded()

unsigned short WCNSFVFlowPhysics::getNumberAlgebraicGhostingLayersNeeded ( ) const

overridevirtual

Return the number of algebraic ghosting layers needed.

Implements NavierStokesPhysicsBase.

Definition at line 1095 of file WCNSFVFlowPhysics.C.

 {
   auto ghost_layers = WCNSFVFlowPhysicsBase::getNumberAlgebraicGhostingLayersNeeded();
   if (_porous_medium_treatment && isParamValid("porosity_smoothing_layers"))
     ghost_layers = std::max(getParam<unsigned short>("porosity_smoothing_layers"), ghost_layers);
   if ((_porous_medium_treatment &&
        getParam<MooseEnum>("porosity_interface_pressure_treatment") != "automatic") ||
       getParam<MooseEnum>("momentum_face_interpolation") == "skewness-corrected" ||
       getParam<MooseEnum>("pressure_face_interpolation") == "skewness-corrected")
     ghost_layers = std::max(ghost_layers, (unsigned short)3);
   return ghost_layers;
 }

◆ getOutletBoundaries()

const std::vector<BoundaryName>& WCNSFVFlowPhysicsBase::getOutletBoundaries ( ) const

inlineinherited

Get the outlet boundaries.

Definition at line 71 of file WCNSFVFlowPhysicsBase.h.

Referenced by WCNSLinearFVFluidHeatTransferPhysics::addEnergyOutletBC(), and WCNSLinearFVScalarTransportPhysics::addScalarOutletBC().

71 { return _outlet_boundaries; }

WCNSFVFlowPhysicsBase::_outlet_boundaries

const std::vector< BoundaryName > _outlet_boundaries

Boundaries with a flow outlet specified on them.

Definition: WCNSFVFlowPhysicsBase.h:194

◆ getPorosityFunctorName()

MooseFunctorName WCNSFVFlowPhysicsBase::getPorosityFunctorName ( const bool smoothed ) const

inherited

Definition at line 407 of file WCNSFVFlowPhysicsBase.C.

Referenced by WCNSFVFluidHeatTransferPhysics::addEnergyHeatConductionKernels(), WCNSFVFluidHeatTransferPhysics::addEnergyTimeKernels(), WCNSFVScalarTransportPhysics::addScalarAdvectionKernels(), and WCNSFVCoupledAdvectionPhysicsHelper::getPorosityFunctorName().

 {
   if (smoothed)
     return _flow_porosity_functor_name;
   else
     return _porosity_name;
 }

◆ getPressureName()

const NonlinearVariableName& WCNSFVFlowPhysicsBase::getPressureName ( ) const

inlineinherited

Definition at line 41 of file WCNSFVFlowPhysicsBase.h.

Referenced by WCNSFVFluidHeatTransferPhysicsBase::addMaterials(), and WCNSFVFlowPhysicsBase::getFlowVariableName().

41 { return _pressure_name; }

WCNSFVFlowPhysicsBase::_pressure_name

const NonlinearVariableName _pressure_name

Pressure name.

Definition: WCNSFVFlowPhysicsBase.h:163

◆ getVelocityFaceInterpolationMethod()

const MooseEnum& WCNSFVFlowPhysicsBase::getVelocityFaceInterpolationMethod ( ) const

inlineinherited

Get the face interpolation method for velocity.

Definition at line 57 of file WCNSFVFlowPhysicsBase.h.

Referenced by WCNSFVTwoPhaseMixturePhysics::addAdvectionSlipTerm().

57 { return _velocity_interpolation; }

WCNSFVFlowPhysicsBase::_velocity_interpolation

const MooseEnum _velocity_interpolation

The velocity face interpolation method for advecting other quantities.

Definition: WCNSFVFlowPhysicsBase.h:175

◆ getVelocityNames()

const std::vector<std::string>& WCNSFVFlowPhysicsBase::getVelocityNames ( ) const

inlineinherited

To interface with other Physics.

Definition at line 40 of file WCNSFVFlowPhysicsBase.h.

Referenced by WCNSFVTwoPhaseMixturePhysics::addAdvectionSlipTerm(), WCNSLinearFVTwoPhaseMixturePhysics::addMaterials(), WCNSFVTwoPhaseMixturePhysics::addMaterials(), WCNSLinearFVTwoPhaseMixturePhysics::addPhaseDriftFluxTerm(), WCNSFVTwoPhaseMixturePhysics::addPhaseDriftFluxTerm(), and WCNSFVFlowPhysicsBase::getFlowVariableName().

40 { return _velocity_names; }

WCNSFVFlowPhysicsBase::_velocity_names

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

Velocity names.

Definition: WCNSFVFlowPhysicsBase.h:161

◆ getWallBoundaries()

const std::vector<BoundaryName>& WCNSFVFlowPhysicsBase::getWallBoundaries ( ) const

inlineinherited

Get the wall boundaries.

Definition at line 73 of file WCNSFVFlowPhysicsBase.h.

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

73 { return _wall_boundaries; }

WCNSFVFlowPhysicsBase::_wall_boundaries

const std::vector< BoundaryName > _wall_boundaries

Boundaries which define a wall (slip/noslip/etc.)

Definition: WCNSFVFlowPhysicsBase.h:196

◆ gravityVector()

RealVectorValue WCNSFVFlowPhysicsBase::gravityVector ( ) const

inlineinherited

Return the gravity vector.

Definition at line 51 of file WCNSFVFlowPhysicsBase.h.

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

51 { return getParam<RealVectorValue>("gravity"); }

◆ hasFlowEquations()

bool WCNSFVFlowPhysicsBase::hasFlowEquations ( ) const

inlineinherited

Whether the physics is actually creating the flow equations.

Definition at line 37 of file WCNSFVFlowPhysicsBase.h.

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

37 { return _has_flow_equations; }

WCNSFVFlowPhysicsBase::_has_flow_equations

const bool _has_flow_equations

Boolean to keep track of whether the flow equations should be created.

Definition: WCNSFVFlowPhysicsBase.h:146

◆ hasForchheimerFriction()

bool WCNSFVFlowPhysics::hasForchheimerFriction ( ) const

overrideprivatevirtual

Return whether a Forchheimer friction model is in use.

Implements WCNSFVFlowPhysicsBase.

Definition at line 1085 of file WCNSFVFlowPhysics.C.

Referenced by addMomentumFrictionKernels().

 {
   for (const auto block_i : index_range(_friction_types))
     for (const auto type_i : index_range(_friction_types[block_i]))
       if (MooseUtils::toUpper(_friction_types[block_i][type_i]) == "FORCHHEIMER")
         return true;
   return false;
 }

◆ hasTurbulencePhysics()

bool WCNSFVFlowPhysicsBase::hasTurbulencePhysics ( ) const

inlineprotectedinherited

Whether a turbulence Physics has been coupled in, to know which viscosity to pick on symmetry boundary conditions.

Definition at line 131 of file WCNSFVFlowPhysicsBase.h.

Referenced by addWallsBC().

   {
     if (_turbulence_physics)
       return _turbulence_physics->hasTurbulenceModel();
     else
       return false;
   }

◆ initializePhysicsAdditional()

void WCNSFVFlowPhysicsBase::initializePhysicsAdditional ( )

overrideprotectedvirtualinherited

Reimplemented from PhysicsBase.

Reimplemented in WCNSLinearFVFlowPhysics.

Definition at line 246 of file WCNSFVFlowPhysicsBase.C.

Referenced by WCNSLinearFVFlowPhysics::initializePhysicsAdditional().

 {
   getProblem().needFV();
 }

◆ porousMediumTreatment()

bool WCNSFVFlowPhysicsBase::porousMediumTreatment ( ) const

inlineinherited

Return whether a porous medium treatment is applied.

Definition at line 49 of file WCNSFVFlowPhysicsBase.h.

49 { return _porous_medium_treatment; }

WCNSFVFlowPhysicsBase::_porous_medium_treatment

const bool _porous_medium_treatment

Whether to use the porous medium treatment.

Definition: WCNSFVFlowPhysicsBase.h:154

◆ rhieChowUOName()

UserObjectName WCNSFVFlowPhysics::rhieChowUOName ( ) const

overridevirtual

Return the name of the Rhie Chow user object.

Implements WCNSFVFlowPhysicsBase.

Definition at line 1187 of file WCNSFVFlowPhysics.C.

Referenced by addInletBC(), addMassKernels(), addMomentumAdvectionKernels(), addMomentumBoussinesqKernels(), addMomentumFrictionKernels(), addMomentumGravityKernels(), addMomentumPressureKernels(), addMomentumTimeKernels(), addMomentumViscousDissipationKernels(), addOutletBC(), addSeparatorBC(), and addWallsBC().

 {
   mooseAssert(!_rc_uo_name.empty(), "The Rhie-Chow user-object name should be set!");
   return _rc_uo_name;
 }

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

static

Definition at line 24 of file WCNSFVFlowPhysics.C.

 {
   InputParameters params = WCNSFVFlowPhysicsBase::validParams();
   params.addClassDescription(
       "Define the Navier Stokes weakly-compressible mass and momentum equations");
 
   // Rhie Chow interpolation parameters
   params.transferParam<Real>(INSFVMomentumAdvection::validParams(), "characteristic_speed");
   params.addParam<bool>(
       "time_derivative_contributes_to_RC_coefficients",
       true,
       "Whether the time derivative term should contribute to the Rhie Chow coefficients. This adds "
       "stabilization, but makes the solution dependent on the time step size");
   params.addParamNamesToGroup("time_derivative_contributes_to_RC_coefficients characteristic_speed",
                               "Numerical scheme");
 
   // Used for flow mixtures, where one phase is solid / not moving under the action of gravity
   params.addParam<MooseFunctorName>(
       "density_for_gravity_terms",
       "If specified, replaces the 'density' for the Boussinesq and gravity momentum kernels");
 
   // Additional porous media parameters
   params.transferParam<unsigned short>(NSFVBase::validParams(), "porosity_smoothing_layers");
 
   // Techniques to limit or remove oscillations at porosity jump interfaces
   params.transferParam<MooseEnum>(NSFVBase::validParams(), "porosity_interface_pressure_treatment");
   params.transferParam<std::vector<BoundaryName>>(NSFVBase::validParams(),
                                                   "pressure_drop_sidesets");
   params.transferParam<std::vector<Real>>(NSFVBase::validParams(), "pressure_drop_form_factors");
 
   // Friction correction, a technique to limit oscillations at friction interfaces
   params.transferParam<bool>(NSFVBase::validParams(), "use_friction_correction");
   params.transferParam<Real>(NSFVBase::validParams(), "consistent_scaling");
 
   // Couple to turbulence physics
   params.addParam<PhysicsName>("coupled_turbulence_physics",
                                "Turbulence Physics coupled with the flow");
 
   // Spatial discretization scheme
   // Specify the numerical schemes for interpolations of velocity and pressure
   params.transferParam<MooseEnum>(NSFVBase::validParams(), "pressure_face_interpolation");
   params.transferParam<MooseEnum>(NSFVBase::validParams(), "mass_advection_interpolation");
   params.transferParam<bool>(NSFVBase::validParams(),
                              "pressure_allow_expansion_on_bernoulli_faces");
 
   // Nonlinear solver parameters
   params.transferParam<Real>(NSFVBase::validParams(), "mass_scaling");
   params.transferParam<Real>(NSFVBase::validParams(), "momentum_scaling");
 
   // Parameter groups
   params.addParamNamesToGroup("coupled_turbulence_physics", "Coupled Physics");
   params.addParamNamesToGroup(
       "porosity_interface_pressure_treatment pressure_allow_expansion_on_bernoulli_faces "
       "porosity_smoothing_layers use_friction_correction consistent_scaling "
       "pressure_drop_sidesets pressure_drop_form_factors",
       "Flow medium discontinuity treatment");
   params.addParamNamesToGroup("pressure_face_interpolation "
                               "mass_advection_interpolation momentum_advection_interpolation "
                               "mass_scaling momentum_scaling characteristic_speed",
                               "Numerical scheme");
 
   // TODO Add default preconditioning and move scaling parameters to a preconditioning group
 
   return params;
 }

Member Data Documentation

◆ _compressibility

const MooseEnum WCNSFVFlowPhysicsBase::_compressibility

protectedinherited

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

Definition at line 149 of file WCNSFVFlowPhysicsBase.h.

Referenced by addFVKernels(), WCNSLinearFVFlowPhysics::addMomentumBoussinesqKernels(), addMomentumBoussinesqKernels(), addMomentumTimeKernels(), WCNSFVFlowPhysicsBase::compressibility(), and WCNSFVFlowPhysicsBase::WCNSFVFlowPhysicsBase().

◆ _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(), WCNSFVScalarTransportPhysicsBase::addInitialConditions(), WCNSFVFlowPhysicsBase::addInitialConditions(), WCNSFVFluidHeatTransferPhysics::addSolverVariables(), WCNSLinearFVFluidHeatTransferPhysics::addSolverVariables(), addSolverVariables(), WCNSLinearFVFlowPhysics::addSolverVariables(), WCNSFVTurbulencePhysics::addSolverVariables(), and WCNSFVFlowPhysicsBase::WCNSFVFlowPhysicsBase().

◆ _density_gravity_name

const MooseFunctorName WCNSFVFlowPhysicsBase::_density_gravity_name

protectedinherited

Name of the density material property used for gravity and Boussinesq terms.

Definition at line 170 of file WCNSFVFlowPhysicsBase.h.

Referenced by WCNSLinearFVFlowPhysics::addFunctorMaterials(), WCNSLinearFVFlowPhysics::addMomentumBoussinesqKernels(), addMomentumBoussinesqKernels(), and addMomentumGravityKernels().

◆ _density_name

const MooseFunctorName WCNSFVFlowPhysicsBase::_density_name

protectedinherited

Name of the density material property.

Definition at line 168 of file WCNSFVFlowPhysicsBase.h.

Referenced by addInletBC(), addMassKernels(), addMassTimeKernels(), addMomentumAdvectionKernels(), addMomentumFrictionKernels(), WCNSLinearFVFlowPhysics::addMomentumTimeKernels(), addMomentumTimeKernels(), addOutletBC(), WCNSLinearFVFlowPhysics::addRhieChowUserObjects(), addSolverVariables(), addWallsBC(), and WCNSFVFlowPhysicsBase::densityName().

◆ _dynamic_viscosity_name

const MooseFunctorName WCNSFVFlowPhysicsBase::_dynamic_viscosity_name

protectedinherited

Name of the dynamic viscosity material property.

Definition at line 172 of file WCNSFVFlowPhysicsBase.h.

Referenced by WCNSLinearFVFlowPhysics::addMomentumFluxKernels(), WCNSLinearFVFlowPhysics::addMomentumFrictionKernels(), addMomentumFrictionKernels(), addMomentumViscousDissipationKernels(), addWallsBC(), and WCNSFVFlowPhysicsBase::dynamicViscosityName().

◆ _flow_porosity_functor_name

MooseFunctorName WCNSFVFlowPhysicsBase::_flow_porosity_functor_name

protectedinherited

Name of the porosity functor for the flow equations (if smoothed)

Definition at line 158 of file WCNSFVFlowPhysicsBase.h.

Referenced by addMassTimeKernels(), addMomentumAdvectionKernels(), addMomentumBoussinesqKernels(), addMomentumGravityKernels(), addMomentumPressureKernels(), addMomentumViscousDissipationKernels(), addOutletBC(), WCNSFVFlowPhysicsBase::addPorousMediumSpeedMaterial(), WCNSFVFlowPhysicsBase::getPorosityFunctorName(), and WCNSFVFlowPhysics().

◆ _fluid_temperature_name

const NonlinearVariableName WCNSFVFlowPhysicsBase::_fluid_temperature_name

protectedinherited

Fluid temperature name.

Definition at line 165 of file WCNSFVFlowPhysicsBase.h.

Referenced by WCNSLinearFVFlowPhysics::addMomentumBoussinesqKernels(), addMomentumBoussinesqKernels(), and WCNSFVFlowPhysicsBase::getFluidTemperatureName().

◆ _flux_inlet_directions

std::vector<Point> WCNSFVFlowPhysicsBase::_flux_inlet_directions

protectedinherited

Direction of each flux inlet. Indexing based on the number of flux boundaries.

Definition at line 210 of file WCNSFVFlowPhysicsBase.h.

Referenced by addInletBC(), WCNSFVFlowPhysicsBase::getFluxInletDirections(), and WCNSFVFlowPhysicsBase::WCNSFVFlowPhysicsBase().

◆ _flux_inlet_pps

std::vector<PostprocessorName> WCNSFVFlowPhysicsBase::_flux_inlet_pps

protectedinherited

Postprocessors describing the momentum inlet for each boundary. Indexing based on the number of flux boundaries.

Definition at line 208 of file WCNSFVFlowPhysicsBase.h.

Referenced by addInletBC(), and WCNSFVFlowPhysicsBase::getFluxInletPPs().

◆ _friction_blocks

std::vector<std::vector<SubdomainName> > WCNSFVFlowPhysicsBase::_friction_blocks

protectedinherited

Subdomains where we want to have volumetric friction.

Definition at line 185 of file WCNSFVFlowPhysicsBase.h.

Referenced by WCNSLinearFVFlowPhysics::addMomentumFrictionKernels(), addMomentumFrictionKernels(), and WCNSFVFlowPhysicsBase::WCNSFVFlowPhysicsBase().

◆ _friction_coeffs

std::vector<std::vector<std::string> > WCNSFVFlowPhysicsBase::_friction_coeffs

protectedinherited

The coefficients used for each item if friction type.

Definition at line 189 of file WCNSFVFlowPhysicsBase.h.

Referenced by WCNSLinearFVFlowPhysics::addMomentumFrictionKernels(), addMomentumFrictionKernels(), and getLinearFrictionCoefName().

◆ _friction_types

std::vector<std::vector<std::string> > WCNSFVFlowPhysicsBase::_friction_types

protectedinherited

The friction correlation types used for each block.

Definition at line 187 of file WCNSFVFlowPhysicsBase.h.

Referenced by addFVKernels(), WCNSLinearFVFlowPhysics::addFVKernels(), WCNSLinearFVFlowPhysics::addMomentumFrictionKernels(), addMomentumFrictionKernels(), getLinearFrictionCoefName(), and hasForchheimerFriction().

◆ _has_flow_equations

const bool WCNSFVFlowPhysicsBase::_has_flow_equations

protectedinherited

Boolean to keep track of whether the flow equations should be created.

Definition at line 146 of file WCNSFVFlowPhysicsBase.h.

Referenced by addCorrectors(), addFVKernels(), WCNSLinearFVFlowPhysics::addFVKernels(), addRhieChowUserObjects(), addSolverVariables(), WCNSLinearFVFlowPhysics::addSolverVariables(), WCNSFVFlowPhysicsBase::hasFlowEquations(), and WCNSLinearFVFlowPhysics::WCNSLinearFVFlowPhysics().

◆ _hydraulic_separators

const std::vector<BoundaryName> WCNSFVFlowPhysicsBase::_hydraulic_separators

protectedinherited

Hydraulic separator boundaries.

Definition at line 198 of file WCNSFVFlowPhysicsBase.h.

Referenced by addSeparatorBC(), WCNSFVFlowPhysicsBase::getHydraulicSeparators(), and WCNSLinearFVFlowPhysics::WCNSLinearFVFlowPhysics().

◆ _inlet_boundaries

const std::vector<BoundaryName> WCNSFVFlowPhysicsBase::_inlet_boundaries

protectedinherited

Boundaries with a flow inlet specified on them.

Definition at line 192 of file WCNSFVFlowPhysicsBase.h.

Referenced by WCNSFVFlowPhysicsBase::addPostprocessors(), WCNSFVFlowPhysicsBase::getInletBoundaries(), and WCNSFVFlowPhysicsBase::WCNSFVFlowPhysicsBase().

◆ _momentum_advection_interpolation

const MooseEnum WCNSFVFlowPhysicsBase::_momentum_advection_interpolation

protectedinherited

The momentum face interpolation method for being advected.

Definition at line 177 of file WCNSFVFlowPhysicsBase.h.

Referenced by addMomentumAdvectionKernels(), WCNSLinearFVFlowPhysics::addMomentumFluxKernels(), and WCNSFVFlowPhysicsBase::getMomentumAdvectionFaceInterpolationMethod().

◆ _momentum_face_interpolation

const MooseEnum WCNSFVFlowPhysicsBase::_momentum_face_interpolation

protectedinherited

The momentum face interpolation method for stress terms.

Definition at line 179 of file WCNSFVFlowPhysicsBase.h.

Referenced by WCNSFVFlowPhysicsBase::getMomentumFaceInterpolationMethod().

◆ _momentum_inlet_functors

std::map<BoundaryName, std::vector<MooseFunctorName> > WCNSFVFlowPhysicsBase::_momentum_inlet_functors

protectedinherited

Functors describing the momentum inlet for each boundary.

Definition at line 213 of file WCNSFVFlowPhysicsBase.h.

Referenced by WCNSLinearFVFlowPhysics::addInletBC(), addInletBC(), and WCNSFVFlowPhysicsBase::WCNSFVFlowPhysicsBase().

◆ _momentum_inlet_types

std::map<BoundaryName, MooseEnum> WCNSFVFlowPhysicsBase::_momentum_inlet_types

protectedinherited

Momentum inlet boundary types.

Definition at line 201 of file WCNSFVFlowPhysicsBase.h.

Referenced by WCNSLinearFVFlowPhysics::addInletBC(), addInletBC(), and WCNSFVFlowPhysicsBase::WCNSFVFlowPhysicsBase().

◆ _momentum_outlet_types

std::map<BoundaryName, MooseEnum> WCNSFVFlowPhysicsBase::_momentum_outlet_types

protectedinherited

Momentum outlet boundary types.

Definition at line 203 of file WCNSFVFlowPhysicsBase.h.

Referenced by WCNSLinearFVFlowPhysics::addOutletBC(), addOutletBC(), and WCNSFVFlowPhysicsBase::WCNSFVFlowPhysicsBase().

◆ _momentum_wall_functors

std::map<BoundaryName, std::vector<MooseFunctorName> > WCNSFVFlowPhysicsBase::_momentum_wall_functors

protectedinherited

Functors describing the momentum for each wall boundary.

Definition at line 217 of file WCNSFVFlowPhysicsBase.h.

Referenced by WCNSLinearFVFlowPhysics::addWallsBC(), addWallsBC(), and WCNSFVFlowPhysicsBase::WCNSFVFlowPhysicsBase().

◆ _momentum_wall_types

std::map<BoundaryName, MooseEnum> WCNSFVFlowPhysicsBase::_momentum_wall_types

protectedinherited

Momentum wall boundary types.

Definition at line 205 of file WCNSFVFlowPhysicsBase.h.

Referenced by WCNSLinearFVFlowPhysics::addWallsBC(), addWallsBC(), and WCNSFVFlowPhysicsBase::WCNSFVFlowPhysicsBase().

◆ _outlet_boundaries

const std::vector<BoundaryName> WCNSFVFlowPhysicsBase::_outlet_boundaries

protectedinherited

Boundaries with a flow outlet specified on them.

Definition at line 194 of file WCNSFVFlowPhysicsBase.h.

Referenced by WCNSFVFlowPhysicsBase::getOutletBoundaries(), and WCNSFVFlowPhysicsBase::WCNSFVFlowPhysicsBase().

◆ _porosity_name

const MooseFunctorName WCNSFVFlowPhysicsBase::_porosity_name

protectedinherited

Name of the porosity functor.

Definition at line 156 of file WCNSFVFlowPhysicsBase.h.

Referenced by addInletBC(), addRhieChowUserObjects(), addSolverVariables(), WCNSFVFlowPhysicsBase::getPorosityFunctorName(), and WCNSFVFlowPhysics().

◆ _porosity_smoothing_layers

const unsigned WCNSFVFlowPhysics::_porosity_smoothing_layers

private

The number of smoothing layers if that treatment is used on porosity.

Definition at line 76 of file WCNSFVFlowPhysics.h.

◆ _porous_medium_treatment

const bool WCNSFVFlowPhysicsBase::_porous_medium_treatment

protectedinherited

◆ _pressure_functors

std::map<BoundaryName, MooseFunctorName> WCNSFVFlowPhysicsBase::_pressure_functors

protectedinherited

Functors describing the outlet pressure on each boundary.

Definition at line 215 of file WCNSFVFlowPhysicsBase.h.

Referenced by WCNSLinearFVFlowPhysics::addOutletBC(), addOutletBC(), and WCNSFVFlowPhysicsBase::WCNSFVFlowPhysicsBase().

◆ _pressure_name

const NonlinearVariableName WCNSFVFlowPhysicsBase::_pressure_name

protectedinherited

◆ _pressure_tag

const TagName WCNSFVFlowPhysicsBase::_pressure_tag = "p_tag"

protectedinherited

Name of the vector to hold pressure momentum equation contributions.

Definition at line 143 of file WCNSFVFlowPhysicsBase.h.

◆ _rc_uo_name

UserObjectName WCNSFVFlowPhysics::_rc_uo_name

private

Name of the user object in charge of computing the Rhie Chow coefficients.

Definition at line 79 of file WCNSFVFlowPhysics.h.

Referenced by addRhieChowUserObjects(), and rhieChowUOName().

◆ _solve_for_dynamic_pressure

const bool WCNSFVFlowPhysicsBase::_solve_for_dynamic_pressure

protectedinherited

Whether we are solving for the total or dynamic pressure.

Definition at line 151 of file WCNSFVFlowPhysicsBase.h.

Referenced by WCNSLinearFVFlowPhysics::addMomentumGravityKernels(), addMomentumGravityKernels(), and WCNSFVFlowPhysicsBase::WCNSFVFlowPhysicsBase().

◆ _turbulence_physics

const WCNSFVTurbulencePhysics* WCNSFVFlowPhysicsBase::_turbulence_physics

protectedinherited

Can be set to a coupled turbulence physics.

Definition at line 182 of file WCNSFVFlowPhysicsBase.h.

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

◆ _velocity_interpolation

const MooseEnum WCNSFVFlowPhysicsBase::_velocity_interpolation

protectedinherited

The velocity face interpolation method for advecting other quantities.

Definition at line 175 of file WCNSFVFlowPhysicsBase.h.

Referenced by addMassKernels(), addMomentumAdvectionKernels(), and WCNSFVFlowPhysicsBase::getVelocityFaceInterpolationMethod().

◆ _velocity_names

const std::vector<std::string> WCNSFVFlowPhysicsBase::_velocity_names

protectedinherited

Velocity names.

Definition at line 161 of file WCNSFVFlowPhysicsBase.h.

◆ _wall_boundaries

const std::vector<BoundaryName> WCNSFVFlowPhysicsBase::_wall_boundaries

protectedinherited

Boundaries which define a wall (slip/noslip/etc.)

Definition at line 196 of file WCNSFVFlowPhysicsBase.h.

Referenced by WCNSLinearFVFlowPhysics::addWallsBC(), WCNSFVFlowPhysicsBase::getWallBoundaries(), and WCNSFVFlowPhysicsBase::WCNSFVFlowPhysicsBase().

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

navier_stokes/include/physics/WCNSFVFlowPhysics.h
navier_stokes/src/physics/WCNSFVFlowPhysics.C

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ WCNSFVFlowPhysics()

Member Function Documentation

◆ actOnAdditionalTasks()

◆ addCorrectors()

◆ addFVBCs()

◆ addFVKernels()

◆ addInitialConditions()

◆ addInletBC()

◆ addMassKernels()

◆ addMassTimeKernels()

◆ addMaterials()

◆ addMomentumAdvectionKernels()

◆ addMomentumBoussinesqKernels()

◆ addMomentumFrictionKernels()

◆ addMomentumGravityKernels()

◆ addMomentumMixingLengthKernels()

◆ addMomentumPressureKernels()

◆ addMomentumTimeKernels()

◆ addMomentumViscousDissipationKernels()

◆ addNonPorousMediumSpeedMaterial()

◆ addOutletBC()

◆ addPorousMediumSpeedMaterial()

◆ addPostprocessors()

◆ addPressurePinKernel()

◆ addRhieChowUserObjects()

◆ addSeparatorBC()

◆ addSolverVariables()

◆ addUserObjects()

◆ addWallsBC()

◆ checkRhieChowFunctorsDefined()

◆ compressibility()

◆ densityName()

◆ dynamicViscosityName()

◆ getAdditionalRMParams()

◆ getCoupledTurbulencePhysics()

◆ getFlowVariableName()

◆ getFluidTemperatureName()

◆ getFluxInletDirections()

◆ getFluxInletPPs()

◆ getHydraulicSeparators()

◆ getInletBoundaries()

◆ getLinearFrictionCoefName()

◆ getMomentumAdvectionFaceInterpolationMethod()

◆ getMomentumFaceInterpolationMethod()

◆ getNumberAlgebraicGhostingLayersNeeded()

◆ getOutletBoundaries()

◆ getPorosityFunctorName()

◆ getPressureName()

◆ getVelocityFaceInterpolationMethod()

◆ getVelocityNames()

◆ getWallBoundaries()

◆ gravityVector()

◆ hasFlowEquations()

◆ hasForchheimerFriction()

◆ hasTurbulencePhysics()

◆ initializePhysicsAdditional()

◆ porousMediumTreatment()

◆ rhieChowUOName()

◆ usingNavierStokesFVSyntax()

◆ validParams()

Member Data Documentation

◆ _compressibility

◆ _define_variables

◆ _density_gravity_name

◆ _density_name

◆ _dynamic_viscosity_name

◆ _flow_porosity_functor_name

◆ _fluid_temperature_name