Base class for Physics which create the Navier Stokes flow equations. More...

#include <WCNSFVFlowPhysicsBase.h>

Inheritance diagram for WCNSFVFlowPhysicsBase:

Public Types
typedef DataFileName	DataFileParameterType

Public Member Functions
	WCNSFVFlowPhysicsBase (const InputParameters &parameters)

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

bool	addAxisymmetricViscousSourceEnabled () const
	Whether the cylindrical viscous source helper is enabled.

bool	includeSymmetrizedViscousStress () const
	Whether to include the symmetrized contribution in the viscous stress.

bool	includeIsotropicStress () const
	Whether to include the isotropic viscous stress contribution.

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

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.

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

RealVectorValue	gravityVector () const
	Return the gravity vector.

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

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

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

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

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

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

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

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

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

NS::MomentumInletTypes	inletBoundaryType (const BoundaryName &boundary_name) const
	Get the type of the inlet BC.

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

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

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

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

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

virtual void	act () override final

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

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

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

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

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

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

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

unsigned int	dimension () const

const ActionComponent &	getActionComponent (const ComponentName &comp_name) const

void	checkComponentType (const ActionComponent &component) const

virtual void	addComponent (const ActionComponent &component)

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

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

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

void	timedAct ()

MooseObjectName	uniqueActionName () const

const std::string &	specificTaskName () const

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

void	appendTask (const std::string &task)

MooseApp &	getMooseApp () const

const std::string &	type () const

const std::string &	name () const

std::string	typeAndName () const

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

MooseObjectName	uniqueName () const

const InputParameters &	parameters () const

const hit::Node *	getHitNode () const

bool	hasBase () const

const std::string &	getBase () const

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

PerfGraph &	perfGraph ()

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

const Parallel::Communicator &	comm () const

processor_id_type	n_processors () const

processor_id_type	processor_id () const

Static Public Member Functions
static InputParameters	validParams ()

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

Public Attributes
	usingCombinedWarningSolutionWarnings

const ConsoleStream	_console

Static Public Attributes
static const std::string	unique_action_name_param

static const std::string	type_param

static const std::string	name_param

static const std::string	unique_name_param

static const std::string	app_param

static const std::string	moose_base_param

static const std::string	kokkos_object_param

static constexpr auto	SYSTEM

static constexpr auto	NAME

Protected Member Functions
virtual void	initializePhysicsAdditional () override

virtual void	actOnAdditionalTasks () override

virtual void	addSolverVariables () override=0

virtual void	addInitialConditions () override

virtual void	addFVKernels () override=0

virtual void	addFVBCs () override

virtual void	addMaterials () override

virtual void	addUserObjects () override=0

virtual void	addPostprocessors () override

virtual void	addMomentumTimeKernels ()=0
	Functions adding kernels for the flow momentum equations If the material properties are not constant, these can be used for weakly-compressible simulations (except the Boussinesq kernel) as well.

virtual void	addMomentumPressureKernels ()=0

virtual void	addMomentumGravityKernels ()=0

virtual void	addMomentumFrictionKernels ()=0

virtual void	addMomentumBoussinesqKernels ()=0

void	addAxisymmetricViscousSource ()
	Adds the cylindrical source kernel for the radial momentum equation when requested and valid.

virtual void	addAxisymmetricViscousSourceKernel (const std::vector< SubdomainName > &, unsigned int)
	Derived classes must override this hook to add the actual object that implements the axisymmetric viscous source term for their formulation once the helper has determined the relevant blocks and radial component.

virtual void	addInletBC ()=0
	Functions adding boundary conditions for the flow simulation.

virtual void	addOutletBC ()=0

virtual void	addWallsBC ()=0

virtual void	addSeparatorBC ()=0

virtual bool	hasForchheimerFriction () const =0
	Return whether a Forchheimer friction model is in use.

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

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

void	addFluidPropertiesFunctorMaterial ()
	Function which adds the general functor fluid properties functor material to define fluid functor material property.

virtual void	addRhieChowUserObjects ()=0
	Function which adds the RhieChow interpolator user objects for weakly and incompressible formulations.

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

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

const WCNSFVTurbulencePhysicsBase *	getCoupledTurbulencePhysics () const
	Find the turbulence physics.

std::vector< SubdomainName >	getAxisymmetricRZBlocks () const
	Return the set of blocks restricted to an RZ coordinate system.

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

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

void	addFVAdvectedInterpolationMethod (const MooseEnum &interpolation_method)
	Add the FVInterpolationMethod object for an advected interpolation method if absent.

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

bool	isTransient () const

Factory &	getFactory ()

Factory &	getFactory () const

virtual FEProblemBase &	getProblem ()

virtual const FEProblemBase &	getProblem () const

void	prepareCopyVariablesFromMesh () const

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

std::string	prefix () const

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

void	saveSolverVariableName (const VariableName &var_name)

void	saveAuxVariableName (const VariableName &var_name)

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

bool	solverVariableExists (const VariableName &var_name) const

const SolverSystemName &	getSolverSystem (unsigned int variable_index) const

const SolverSystemName &	getSolverSystem (const VariableName &variable_name) const

void	addRequiredPhysicsTask (const std::string &task)

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

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

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

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

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

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

bool	isVariableFV (const VariableName &var_name) const

bool	isVariableScalar (const VariableName &var_name) const

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

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

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

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

virtual void	checkIntegrity () const

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

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

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

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

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

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

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

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

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

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

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

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

void	flagInvalidSolutionInternal (const InvalidSolutionID invalid_solution_id) const

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Protected Attributes
const TagName	_pressure_tag = "p_tag"
	Name of the vector to hold pressure momentum equation contributions.

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

const bool	_add_rz_viscous_source
	Whether to automatically add the cylindrical viscous source term.

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

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

const bool	_porous_medium_treatment
	Whether to use the porous medium treatment.

const MooseFunctorName	_porosity_name
	Name of the porosity functor.

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

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

const NonlinearVariableName	_pressure_name
	Pressure name.

const NonlinearVariableName	_fluid_temperature_name
	Fluid temperature name.

const MooseFunctorName	_density_name
	Name of the density material property.

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

const MooseFunctorName	_dynamic_viscosity_name
	Name of the dynamic viscosity material property.

const bool	_include_symmetrized_viscous_stress
	Whether to include the symmetrized viscous stress contribution.

const bool	_include_isotropic_viscous_stress
	Whether to include the isotropic viscous stress contribution.

UserObjectName	_rc_uo_name
	name of the Rhie Chow user object

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

std::map< BoundaryName, std::vector< MooseFunctorName > >	_momentum_wall_functors
	Functors describing the momentum for each wall boundary.

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

std::vector< SolverSystemName >	_system_names

std::vector< unsigned int >	_system_numbers

const bool	_verbose

const MooseEnum &	_preconditioning

std::vector< SubdomainName >	_blocks

std::string	_registered_identifier

std::string	_specific_task_name

std::set< std::string >	_all_tasks

ActionWarehouse &	_awh

const std::string &	_current_task

std::shared_ptr< MooseMesh > &	_mesh

std::shared_ptr< MooseMesh > &	_displaced_mesh

std::shared_ptr< FEProblemBase > &	_problem

PerfID	_act_timer

MooseApp &	_app

Factory &	_factory

ActionFactory &	_action_factory

const std::string &	_type

const std::string &	_name

const InputParameters &	_pars

MooseApp &	_pg_moose_app

const std::string	_prefix

const Parallel::Communicator &	_communicator

Private Member Functions
virtual void	addRelationshipManagers (Moose::RelationshipManagerType input_rm_type) override

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

virtual void	addRelationshipManagers (Moose::RelationshipManagerType when_type)

void	initializePhysics ()

virtual void	checkIntegrityEarly () const

virtual void	addAuxiliaryVariables ()

virtual void	addFEKernels ()

virtual void	addFVInterpolationMethods ()

virtual void	addNodalKernels ()

virtual void	addDiracKernels ()

virtual void	addDGKernels ()

virtual void	addScalarKernels ()

virtual void	addInterfaceKernels ()

virtual void	addFVInterfaceKernels ()

virtual void	addFEBCs ()

virtual void	addNodalBCs ()

virtual void	addPeriodicBCs ()

virtual void	addFunctions ()

virtual void	addAuxiliaryKernels ()

virtual void	addFunctorMaterials ()

virtual void	addCorrectors ()

virtual void	addMultiApps ()

virtual void	addTransfers ()

virtual void	addVectorPostprocessors ()

virtual void	addReporters ()

virtual void	addOutputs ()

virtual void	addPreconditioning ()

virtual void	addExecutioner ()

virtual void	addExecutors ()

void	checkRequiredTasks () const

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

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

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

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

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

const InputParameters &	forwardParameters () const

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

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

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

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

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

const std::string &	forwardType () const

virtual const std::string &	forwardName () const

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

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

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

Private Attributes
MooseEnum	_is_transient

std::vector< VariableName >	_solver_var_names

std::vector< VariableName >	_aux_var_names

unsigned int	_dim

std::set< std::string >	_required_tasks

const ParallelParamObject &	_parent

MooseApp &	_meta_data_app

const MooseObject *const	_meta_data_object

const MooseBase &	_si_moose_base

const FEProblemBase *	_si_problem

const PhysicsBase *const	_customer_class

Friends
class	WCNSFVTurbulencePhysics

Detailed Description

Base class for Physics which create the Navier Stokes flow equations.

Definition at line 29 of file WCNSFVFlowPhysicsBase.h.

Constructor & Destructor Documentation

◆ WCNSFVFlowPhysicsBase()

WCNSFVFlowPhysicsBase::WCNSFVFlowPhysicsBase ( const InputParameters & parameters )

Definition at line 119 of file WCNSFVFlowPhysicsBase.C.

  : NavierStokesPhysicsBase(parameters),
    _has_flow_equations(getParam<bool>("add_flow_equations")),
    _add_rz_viscous_source(getParam<bool>("add_rz_viscous_source")),
    _compressibility(getParam<MooseEnum>("compressibility")),
    _solve_for_dynamic_pressure(getParam<bool>("solve_for_dynamic_pressure")),
    _porous_medium_treatment(getParam<bool>("porous_medium_treatment")),
    _porosity_name(getParam<MooseFunctorName>("porosity")),
    _flow_porosity_functor_name(_porosity_name),
    _velocity_names(
        isParamValid("velocity_variable")
            ? getParam<std::vector<std::string>>("velocity_variable")
            : (_porous_medium_treatment
                   ? std::vector<std::string>(NS::superficial_velocity_vector,
                                              NS::superficial_velocity_vector + 3)
                   : std::vector<std::string>(NS::velocity_vector, NS::velocity_vector + 3))),
    _pressure_name(isParamValid("pressure_variable")
                       ? getParam<NonlinearVariableName>("pressure_variable")
                       : NS::pressure),
    _fluid_temperature_name(isParamValid("fluid_temperature_variable")
                                ? getParam<NonlinearVariableName>("fluid_temperature_variable")
                                : NS::T_fluid),
    _density_name(getParam<MooseFunctorName>("density")),
    _density_gravity_name(isParamValid("density_for_gravity_terms")
                              ? getParam<MooseFunctorName>("density_for_gravity_terms")
                              : getParam<MooseFunctorName>("density")),
    _dynamic_viscosity_name(getParam<MooseFunctorName>("dynamic_viscosity")),
    _include_symmetrized_viscous_stress(getParam<bool>("include_symmetrized_viscous_stress")),
    _include_isotropic_viscous_stress(getParam<bool>("include_isotropic_viscous_stress")),
    _rc_uo_name(isParamValid("rhie_chow_uo_name")
                    ? getParam<UserObjectName>("rhie_chow_uo_name")
                    : (_porous_medium_treatment ? "pins_rhie_chow_interpolator"
                                                : "ins_rhie_chow_interpolator")),
    _velocity_interpolation(getParam<MooseEnum>("velocity_interpolation")),
    _momentum_advection_interpolation(getParam<MooseEnum>("momentum_advection_interpolation")),
    _momentum_face_interpolation(getParam<MooseEnum>("momentum_face_interpolation")),
    _friction_blocks(getParam<std::vector<std::vector<SubdomainName>>>("friction_blocks")),
    _friction_types(getParam<std::vector<std::vector<std::string>>>("friction_types")),
    _friction_coeffs(getParam<std::vector<std::vector<std::string>>>("friction_coeffs")),
    _inlet_boundaries(getParam<std::vector<BoundaryName>>("inlet_boundaries")),
    _outlet_boundaries(getParam<std::vector<BoundaryName>>("outlet_boundaries")),
    _wall_boundaries(getParam<std::vector<BoundaryName>>("wall_boundaries")),
    _hydraulic_separators(getParam<std::vector<BoundaryName>>("hydraulic_separator_sidesets")),
    _flux_inlet_pps(getParam<std::vector<PostprocessorName>>("flux_inlet_pps")),
    _flux_inlet_directions(getParam<std::vector<Point>>("flux_inlet_directions"))
{
  // Inlet boundary parameter checking
  checkSecondParamSetOnlyIfFirstOneSet("flux_inlet_pps", "flux_inlet_directions");
  if (_flux_inlet_directions.size())
    checkVectorParamsSameLengthIfSet<PostprocessorName, Point>("flux_inlet_pps",
                                                               "flux_inlet_directions");
 
  // Boussinesq parameters checks
  checkSecondParamSetOnlyIfFirstOneTrue("boussinesq_approximation", "ref_temperature");
  checkSecondParamSetOnlyIfFirstOneSet("gravity", "boussinesq_approximation");
 
  // Dynamic pressure parameter checks
  if (_compressibility != "incompressible" && _solve_for_dynamic_pressure)
    paramError("compressibility",
               "Solving for dynamic pressure is only implemented for incompressible flow");
 
  // Boundary parameters checking
  checkVectorParamAndMultiMooseEnumLength<BoundaryName>("inlet_boundaries", "momentum_inlet_types");
  checkVectorParamAndMultiMooseEnumLength<BoundaryName>("outlet_boundaries",
                                                        "momentum_outlet_types");
  checkVectorParamAndMultiMooseEnumLength<BoundaryName>("wall_boundaries", "momentum_wall_types");
  checkVectorParamLengthSameAsCombinedOthers<BoundaryName,
                                             std::vector<MooseFunctorName>,
                                             PostprocessorName>(
      "inlet_boundaries", "momentum_inlet_functors", "flux_inlet_pps");
  checkVectorParamsNoOverlap<BoundaryName>(
      {"inlet_boundaries", "outlet_boundaries", "wall_boundaries"});
 
  // Porous media parameters
  checkSecondParamSetOnlyIfFirstOneTrue("porous_medium_treatment", "porosity");
 
  if (_define_variables && _porous_medium_treatment)
    for (const auto & name : NS::velocity_vector)
    {
      const auto & it = std::find(_velocity_names.begin(), _velocity_names.end(), name);
      if (it != _velocity_names.end())
        paramError("velocity_variable",
                   "For porous medium simulations, functor name " + *it +
                       " is already reserved for the automatically-computed interstitial velocity. "
                       "Please choose another name for your external velocity variable!");
    }
 
  // Friction parameter checks
  if (_friction_blocks.size())
    checkVectorParamsSameLength<std::vector<SubdomainName>, std::vector<std::string>>(
        "friction_blocks", "friction_types");
  checkTwoDVectorParamsSameLength<std::string, std::string>("friction_types", "friction_coeffs");
 
  // Create maps for boundary-restricted parameters
  _momentum_inlet_types = Moose::createMapFromVectorAndMultiMooseEnum<BoundaryName>(
      _inlet_boundaries, getParam<MultiMooseEnum>("momentum_inlet_types"));
  _momentum_outlet_types = Moose::createMapFromVectorAndMultiMooseEnum<BoundaryName>(
      _outlet_boundaries, getParam<MultiMooseEnum>("momentum_outlet_types"));
  _momentum_wall_types = Moose::createMapFromVectorAndMultiMooseEnum<BoundaryName>(
      _wall_boundaries, getParam<MultiMooseEnum>("momentum_wall_types"));
  if (isParamSetByUser("momentum_inlet_functors"))
  {
    // Not all inlet boundary types require the specification of an inlet functor
    std::vector<BoundaryName> inlet_boundaries_with_functors;
    for (const auto & boundary : _inlet_boundaries)
      if (libmesh_map_find(_momentum_inlet_types, boundary) == "fixed-velocity" ||
          libmesh_map_find(_momentum_inlet_types, boundary) == "fixed-pressure")
        inlet_boundaries_with_functors.push_back(boundary);
    _momentum_inlet_functors =
        Moose::createMapFromVectors<BoundaryName, std::vector<MooseFunctorName>>(
            inlet_boundaries_with_functors,
            getParam<std::vector<std::vector<MooseFunctorName>>>("momentum_inlet_functors"));
  }
  if (isParamSetByUser("pressure_functors"))
  {
    // Not all outlet boundary types require the specification of an inlet functor
    std::vector<BoundaryName> outlet_boundaries_with_functors;
    for (const auto & boundary : _outlet_boundaries)
      if (libmesh_map_find(_momentum_outlet_types, boundary) == "fixed-pressure-zero-gradient" ||
          libmesh_map_find(_momentum_outlet_types, boundary) == "fixed-pressure")
        outlet_boundaries_with_functors.push_back(boundary);
    const auto & pressure_functors = getParam<std::vector<MooseFunctorName>>("pressure_functors");
    if (outlet_boundaries_with_functors.size() != 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(outlet_boundaries_with_functors.size()) + ")");
    _pressure_functors = Moose::createMapFromVectors<BoundaryName, MooseFunctorName>(
        outlet_boundaries_with_functors, pressure_functors);
  }
 
  if (isParamSetByUser("momentum_wall_functors"))
  {
    // Not all wall boundary types require the specification of an inlet functor
    std::vector<BoundaryName> wall_boundaries_with_functors;
    for (const auto & boundary : _wall_boundaries)
      if (libmesh_map_find(_momentum_wall_types, boundary) == "noslip")
        wall_boundaries_with_functors.push_back(boundary);
    const auto & momentum_wall_functors =
        getParam<std::vector<std::vector<MooseFunctorName>>>("momentum_wall_functors");
    if (wall_boundaries_with_functors.size() != momentum_wall_functors.size())
      paramError("momentum_wall_functors",
                 "Size (" + std::to_string(momentum_wall_functors.size()) +
                     ") is not the same as the number of momentum_wall wall boundaries with "
                     "no-slip boundary conditions ' (size " +
                     std::to_string(wall_boundaries_with_functors.size()) + ")");
 
    _momentum_wall_functors =
        Moose::createMapFromVectors<BoundaryName, std::vector<MooseFunctorName>>(
            wall_boundaries_with_functors, momentum_wall_functors);
  }
 
  addRequiredPhysicsTask("add_geometric_rm");
  addRequiredPhysicsTask("add_variables_physics");
  addRequiredPhysicsTask("add_ics_physics");
  addRequiredPhysicsTask("add_materials_physics");
  addRequiredPhysicsTask("add_user_object");
  addRequiredPhysicsTask("add_postprocessor");
  addRequiredPhysicsTask("add_corrector");
  addRequiredPhysicsTask("get_turbulence_physics");
}

Member Function Documentation

◆ actOnAdditionalTasks()

void WCNSFVFlowPhysicsBase::actOnAdditionalTasks ( )

overrideprotectedvirtual

Reimplemented from PhysicsBase.

Definition at line 289 of file WCNSFVFlowPhysicsBase.C.

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

◆ addAxisymmetricViscousSource()

void WCNSFVFlowPhysicsBase::addAxisymmetricViscousSource ( )

protected

Adds the cylindrical source kernel for the radial momentum equation when requested and valid.

Definition at line 570 of file WCNSFVFlowPhysicsBase.C.

{
  if (!_has_flow_equations || !_add_rz_viscous_source)
    return;
 
  const auto rz_blocks = getAxisymmetricRZBlocks();
  if (rz_blocks.empty())
    return;
 
  const auto radial_index = getProblem().mesh().getAxisymmetricRadialCoord();
  addAxisymmetricViscousSourceKernel(rz_blocks, radial_index);
}

Referenced by WCNSFVFlowPhysics::addFVKernels().

◆ addAxisymmetricViscousSourceEnabled()

bool WCNSFVFlowPhysicsBase::addAxisymmetricViscousSourceEnabled ( ) const

inline

Whether the cylindrical viscous source helper is enabled.

Definition at line 39 of file WCNSFVFlowPhysicsBase.h.

39{ return _add_rz_viscous_source; }

Referenced by WCNSFVTurbulencePhysics::addAxisymmetricTurbulentViscousSource().

◆ addAxisymmetricViscousSourceKernel()

virtual void WCNSFVFlowPhysicsBase::addAxisymmetricViscousSourceKernel	(	const std::vector< SubdomainName > &	,
		unsigned int
	)

inlineprotectedvirtual

Derived classes must override this hook to add the actual object that implements the axisymmetric viscous source term for their formulation once the helper has determined the relevant blocks and radial component.

Reimplemented in WCNSFVFlowPhysics.

Definition at line 127 of file WCNSFVFlowPhysicsBase.h.

129 {

130 }

Referenced by addAxisymmetricViscousSource().

◆ addFluidPropertiesFunctorMaterial()

void WCNSFVFlowPhysicsBase::addFluidPropertiesFunctorMaterial ( )

protected

Function which adds the general functor fluid properties functor material to define fluid functor material property.

Definition at line 354 of file WCNSFVFlowPhysicsBase.C.

{
  // Not very future-proof but it works
  const bool use_ad = !dynamic_cast<WCNSLinearFVFlowPhysics *>(this);
  const std::string class_name =
      use_ad ? "GeneralFunctorFluidProps" : "NonADGeneralFunctorFluidProps";
  InputParameters params = getFactory().getValidParams(class_name);
  assignBlocks(params, _blocks);
 
  params.set<MooseFunctorName>(NS::pressure) = _pressure_name;
  params.set<MooseFunctorName>(NS::T_fluid) = _fluid_temperature_name;
  params.set<MooseFunctorName>(NS::speed) = NS::speed;
  params.applySpecificParameters(parameters(), {NS::fluid, NS::density, "mu_rampdown"});
  if (!MooseUtils::parsesToReal(_density_name))
    params.set<bool>("force_define_density") = true;
  if (!_porous_medium_treatment)
  {
    params.set<MooseFunctorName>(NS::porosity) = "1";
    params.set<MooseFunctorName>("characteristic_length") = "1";
  }
  else
    // not implemented yet
    paramInfo(
        NS::fluid,
        "Specifying the fluid properties user object does not define the GeneralFunctorFluidProps "
        "when using the porous medium treatment. You have to define this object in the input");
 
  // Dynamic pressure
  params.set<bool>("solving_for_dynamic_pressure") = _solve_for_dynamic_pressure;
  if (_solve_for_dynamic_pressure)
  {
    params.set<Point>("reference_pressure_point") = getParam<Point>("reference_pressure_point");
    if (!isParamSetByUser("reference_pressure_point"))
      paramWarning("reference_pressure_point",
                   "Default value of (0,0,0) used. If this point is outside the flow domain, the "
                   "simulation will error");
    params.set<Real>("reference_pressure") = getParam<Real>("reference_pressure");
  }
  params.set<Point>("gravity") = getParam<RealVectorValue>("gravity");
 
  if (!_porous_medium_treatment)
    getProblem().addFunctorMaterial(class_name, prefix() + "functor_fluidprops", params);
}

Referenced by addMaterials().

◆ addFVAdvectedInterpolationMethod()

void NavierStokesPhysicsBase::addFVAdvectedInterpolationMethod ( const MooseEnum & interpolation_method )

protectedinherited

Add the FVInterpolationMethod object for an advected interpolation method if absent.

Definition at line 43 of file NavierStokesPhysicsBase.C.

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

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

◆ addFVBCs()

void WCNSFVFlowPhysicsBase::addFVBCs ( )

overrideprotectedvirtual

Reimplemented from PhysicsBase.

Definition at line 297 of file WCNSFVFlowPhysicsBase.C.

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

◆ addFVKernels()

virtual void WCNSFVFlowPhysicsBase::addFVKernels ( )

overrideprotectedpure virtual

Reimplemented from PhysicsBase.

Implemented in WCNSFVFlowPhysics, and WCNSLinearFVFlowPhysics.

◆ addInitialConditions()

void WCNSFVFlowPhysicsBase::addInitialConditions ( )

overrideprotectedvirtual

Reimplemented from PhysicsBase.

Definition at line 399 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("FVFunctionIC");
  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().addFVInitialCondition(
          "FVFunctionIC", 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().addFVInitialCondition("FVFunctionIC", prefix() + _pressure_name + "_ic", params);
  }
}

◆ addInletBC()

virtual void WCNSFVFlowPhysicsBase::addInletBC ( )

protectedpure virtual

Functions adding boundary conditions for the flow simulation.

These are used for weakly-compressible simulations as well.

Implemented in WCNSFVFlowPhysics, and WCNSLinearFVFlowPhysics.

Referenced by addFVBCs().

◆ addMaterials()

void WCNSFVFlowPhysicsBase::addMaterials ( )

overrideprotectedvirtual

Reimplemented from PhysicsBase.

Definition at line 306 of file WCNSFVFlowPhysicsBase.C.

{
  if (hasForchheimerFriction() || _porous_medium_treatment)
    addPorousMediumSpeedMaterial();
  else
    addNonPorousMediumSpeedMaterial();
 
  if (isParamValid(NS::fluid))
    addFluidPropertiesFunctorMaterial();
}

◆ addMomentumBoussinesqKernels()

virtual void WCNSFVFlowPhysicsBase::addMomentumBoussinesqKernels ( )

protectedpure virtual

Implemented in WCNSFVFlowPhysics, and WCNSLinearFVFlowPhysics.

◆ addMomentumFrictionKernels()

virtual void WCNSFVFlowPhysicsBase::addMomentumFrictionKernels ( )

protectedpure virtual

Implemented in WCNSFVFlowPhysics, and WCNSLinearFVFlowPhysics.

◆ addMomentumGravityKernels()

virtual void WCNSFVFlowPhysicsBase::addMomentumGravityKernels ( )

protectedpure virtual

Implemented in WCNSFVFlowPhysics, and WCNSLinearFVFlowPhysics.

◆ addMomentumPressureKernels()

virtual void WCNSFVFlowPhysicsBase::addMomentumPressureKernels ( )

protectedpure virtual

Implemented in WCNSFVFlowPhysics, and WCNSLinearFVFlowPhysics.

◆ addMomentumTimeKernels()

virtual void WCNSFVFlowPhysicsBase::addMomentumTimeKernels ( )

protectedpure virtual

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

Implemented in WCNSFVFlowPhysics, and WCNSLinearFVFlowPhysics.

◆ addNonPorousMediumSpeedMaterial()

void WCNSFVFlowPhysicsBase::addNonPorousMediumSpeedMaterial ( )

protected

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

Definition at line 336 of file WCNSFVFlowPhysicsBase.C.

{
  // Not very future-proof but it works
  const bool use_ad = !dynamic_cast<WCNSLinearFVFlowPhysics *>(this);
  const std::string class_name =
      use_ad ? "ADVectorMagnitudeFunctorMaterial" : "VectorMagnitudeFunctorMaterial";
  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().addFunctorMaterial(class_name, prefix() + "ins_speed_material", params);
}

Referenced by addMaterials().

◆ addOutletBC()

virtual void WCNSFVFlowPhysicsBase::addOutletBC ( )

protectedpure virtual

Implemented in WCNSFVFlowPhysics, and WCNSLinearFVFlowPhysics.

Referenced by addFVBCs().

◆ addPorousMediumSpeedMaterial()

void WCNSFVFlowPhysicsBase::addPorousMediumSpeedMaterial ( )

protected

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

Definition at line 318 of file WCNSFVFlowPhysicsBase.C.

{
  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().addFunctorMaterial(
      "PINSFVSpeedFunctorMaterial", prefix() + "pins_speed_material", params);
}

Referenced by addMaterials().

◆ addPostprocessors()

void WCNSFVFlowPhysicsBase::addPostprocessors ( )

overrideprotectedvirtual

Reimplemented from PhysicsBase.

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

◆ addRhieChowUserObjects()

virtual void WCNSFVFlowPhysicsBase::addRhieChowUserObjects ( )

protectedpure virtual

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

Implemented in WCNSFVFlowPhysics, and WCNSLinearFVFlowPhysics.

◆ addSeparatorBC()

virtual void WCNSFVFlowPhysicsBase::addSeparatorBC ( )

protectedpure virtual

Implemented in WCNSFVFlowPhysics, and WCNSLinearFVFlowPhysics.

Referenced by addFVBCs().

◆ addSolverVariables()

virtual void WCNSFVFlowPhysicsBase::addSolverVariables ( )

overrideprotectedpure virtual

Reimplemented from PhysicsBase.

Implemented in WCNSFVFlowPhysics, and WCNSLinearFVFlowPhysics.

◆ addUserObjects()

virtual void WCNSFVFlowPhysicsBase::addUserObjects ( )

overrideprotectedpure virtual

Reimplemented from PhysicsBase.

Implemented in WCNSFVFlowPhysics, and WCNSLinearFVFlowPhysics.

◆ addWallsBC()

virtual void WCNSFVFlowPhysicsBase::addWallsBC ( )

protectedpure virtual

Implemented in WCNSFVFlowPhysics, and WCNSLinearFVFlowPhysics.

Referenced by addFVBCs().

◆ compressibility()

const MooseEnum & WCNSFVFlowPhysicsBase::compressibility ( ) const

inline

Return the compressibility of the flow equations selected.

Definition at line 53 of file WCNSFVFlowPhysicsBase.h.

53{ return _compressibility; }

◆ densityName()

const MooseFunctorName & WCNSFVFlowPhysicsBase::densityName ( ) const

inline

Return the name of the density functor.

Definition at line 59 of file WCNSFVFlowPhysicsBase.h.

59{ return _density_name; }

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

◆ dynamicViscosityName()

const MooseFunctorName & WCNSFVFlowPhysicsBase::dynamicViscosityName ( ) const

inline

Return the name of the dynamic viscosity functor.

Definition at line 61 of file WCNSFVFlowPhysicsBase.h.

61{ return _dynamic_viscosity_name; }

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

◆ getAdditionalRMParams()

InputParameters NavierStokesPhysicsBase::getAdditionalRMParams ( ) const

overrideprotectedvirtualinherited

Parameters to change or add relationship managers.

Reimplemented from PhysicsBase.

Definition at line 56 of file NavierStokesPhysicsBase.C.

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

◆ getAxisymmetricRZBlocks()

std::vector< SubdomainName > WCNSFVFlowPhysicsBase::getAxisymmetricRZBlocks ( ) const

protected

Return the set of blocks restricted to an RZ coordinate system.

Definition at line 539 of file WCNSFVFlowPhysicsBase.C.

{
  std::vector<SubdomainName> rz_blocks;
  const auto & mesh = getProblem().mesh();
 
  const bool use_all_blocks =
      _blocks.empty() || allMeshBlocks(_blocks) ||
      std::find(_blocks.begin(), _blocks.end(), "ANY_BLOCK_ID") != _blocks.end();
 
  std::vector<SubdomainID> block_ids;
  if (use_all_blocks)
  {
    const auto & mesh_blocks = mesh.meshSubdomains();
    block_ids.insert(block_ids.end(), mesh_blocks.begin(), mesh_blocks.end());
  }
  else
    block_ids = mesh.getSubdomainIDs(_blocks);
 
  for (const auto subdomain_id : block_ids)
    if (mesh.getCoordSystem(subdomain_id) == Moose::COORD_RZ)
    {
      auto name = mesh.getSubdomainName(subdomain_id);
      if (name.empty())
        name = Moose::stringify(subdomain_id);
      rz_blocks.push_back(name);
    }
 
  return rz_blocks;
}

Referenced by WCNSFVTurbulencePhysics::addAxisymmetricTurbulentViscousSource(), and addAxisymmetricViscousSource().

◆ getCoupledTurbulencePhysics()

const WCNSFVTurbulencePhysicsBase * WCNSFVFlowPhysicsBase::getCoupledTurbulencePhysics ( ) const

protected

Find the turbulence physics.

Definition at line 506 of file WCNSFVFlowPhysicsBase.C.

{
  // User passed it, just use that
  if (isParamValid("coupled_turbulence_physics"))
    return getCoupledPhysics<WCNSFVTurbulencePhysicsBase>(
        getParam<PhysicsName>("coupled_turbulence_physics"));
  // Look for any physics of the right type, and check the block restriction
  else
  {
    const auto all_turbulence_physics = getCoupledPhysics<const WCNSFVTurbulencePhysicsBase>(true);
    for (const auto physics : all_turbulence_physics)
    {
      if (checkBlockRestrictionIdentical(
              physics->name(), physics->blocks(), /*error_if_not_identical=*/false))
        return physics;
      else if (_verbose)
        mooseInfoRepeated("Detected Turbulence Physics '" + physics->name() +
                          "' with an incompatible block restriction. It will thus not be coupled "
                          "to this flow equations physics");
    }
  }
  // Did not find one
  return nullptr;
}

Referenced by actOnAdditionalTasks().

◆ getFlowVariableName()

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

protected

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

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

inline

Definition at line 48 of file WCNSFVFlowPhysicsBase.h.

48{ return _fluid_temperature_name; }

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

◆ getFluxInletDirections()

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

inline

Get the inlet direction if using a flux inlet.

Definition at line 89 of file WCNSFVFlowPhysicsBase.h.

89{ return _flux_inlet_directions; }

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

◆ getFluxInletPPs()

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

inline

Get the inlet flux postprocessor if using a flux inlet.

Definition at line 91 of file WCNSFVFlowPhysicsBase.h.

91{ return _flux_inlet_pps; }

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

◆ getHydraulicSeparators()

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

inline

Get the hydraulic separator boundaries.

Definition at line 81 of file WCNSFVFlowPhysicsBase.h.

81{ return _hydraulic_separators; }

Referenced by WCNSFVFluidHeatTransferPhysics::addEnergySeparatorBC().

◆ getInletBoundaries()

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

inline

Get the inlet boundaries.

Definition at line 75 of file WCNSFVFlowPhysicsBase.h.

75{ return _inlet_boundaries; }

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

◆ getLinearFrictionCoefName()

virtual MooseFunctorName WCNSFVFlowPhysicsBase::getLinearFrictionCoefName ( ) const

pure virtual

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

Implemented in WCNSFVFlowPhysics, and WCNSLinearFVFlowPhysics.

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

◆ getMomentumAdvectionFaceInterpolationMethod()

const MooseEnum & WCNSFVFlowPhysicsBase::getMomentumAdvectionFaceInterpolationMethod ( ) const

inline

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

Definition at line 65 of file WCNSFVFlowPhysicsBase.h.

  {
    return _momentum_advection_interpolation;
  }

◆ getMomentumFaceInterpolationMethod()

const MooseEnum & WCNSFVFlowPhysicsBase::getMomentumFaceInterpolationMethod ( ) const

inline

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

Definition at line 70 of file WCNSFVFlowPhysicsBase.h.

  {
    return _momentum_face_interpolation;
  }

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

◆ getNumberAlgebraicGhostingLayersNeeded()

unsigned short WCNSFVFlowPhysicsBase::getNumberAlgebraicGhostingLayersNeeded ( ) const

overridevirtual

Return the number of algebraic ghosting layers needed.

Implements NavierStokesPhysicsBase.

Reimplemented in WCNSLinearFVFlowPhysics.

Definition at line 453 of file WCNSFVFlowPhysicsBase.C.

{
  unsigned short ghost_layers = 2;
  return ghost_layers;
}

Referenced by WCNSFVFlowPhysics::getNumberAlgebraicGhostingLayersNeeded(), WCNSFVFluidHeatTransferPhysicsBase::getNumberAlgebraicGhostingLayersNeeded(), WCNSFVScalarTransportPhysicsBase::getNumberAlgebraicGhostingLayersNeeded(), WCNSFVTurbulencePhysics::getNumberAlgebraicGhostingLayersNeeded(), and WCNSLinearFVTurbulencePhysics::getNumberAlgebraicGhostingLayersNeeded().

◆ getOutletBoundaries()

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

inline

Get the outlet boundaries.

Definition at line 77 of file WCNSFVFlowPhysicsBase.h.

77{ return _outlet_boundaries; }

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

◆ getPorosityFunctorName()

MooseFunctorName WCNSFVFlowPhysicsBase::getPorosityFunctorName ( const bool smoothed ) const

Definition at line 497 of file WCNSFVFlowPhysicsBase.C.

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

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

◆ getPressureName()

const NonlinearVariableName & WCNSFVFlowPhysicsBase::getPressureName ( ) const

inline

Definition at line 47 of file WCNSFVFlowPhysicsBase.h.

47{ return _pressure_name; }

Referenced by WCNSFVFluidHeatTransferPhysics::addEnergyInletBC(), WCNSFVFluidHeatTransferPhysics::addEnergyWallBC(), WCNSFVFluidHeatTransferPhysicsBase::addInitialConditions(), WCNSFVFluidHeatTransferPhysics::addMaterials(), WCNSLinearFVFluidHeatTransferPhysics::addMaterials(), and getFlowVariableName().

◆ getVelocityFaceInterpolationMethod()

const MooseEnum & WCNSFVFlowPhysicsBase::getVelocityFaceInterpolationMethod ( ) const

inline

Get the face interpolation method for velocity.

Definition at line 63 of file WCNSFVFlowPhysicsBase.h.

63{ return _velocity_interpolation; }

Referenced by WCNSFVTwoPhaseMixturePhysics::addAdvectionSlipTerm().

◆ getVelocityNames()

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

inline

To interface with other Physics.

Definition at line 46 of file WCNSFVFlowPhysicsBase.h.

46{ return _velocity_names; }

Referenced by WCNSFVTwoPhaseMixturePhysics::addAdvectionSlipTerm(), WCNSFVTurbulencePhysics::addAxisymmetricTurbulentViscousSource(), WCNSFVTwoPhaseMixturePhysics::addFunctorMaterials(), WCNSLinearFVTwoPhaseMixturePhysics::addMaterials(), WCNSFVTwoPhaseMixturePhysics::addPhaseDriftFluxTerm(), WCNSLinearFVTwoPhaseMixturePhysics::addPhaseDriftFluxTerm(), and getFlowVariableName().

◆ getWallBoundaries()

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

inline

Get the wall boundaries.

Definition at line 79 of file WCNSFVFlowPhysicsBase.h.

79{ return _wall_boundaries; }

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

◆ gravityVector()

RealVectorValue WCNSFVFlowPhysicsBase::gravityVector ( ) const

inline

Return the gravity vector.

Definition at line 57 of file WCNSFVFlowPhysicsBase.h.

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

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

◆ hasFlowEquations()

bool WCNSFVFlowPhysicsBase::hasFlowEquations ( ) const

inline

Whether the physics is actually creating the flow equations.

Definition at line 37 of file WCNSFVFlowPhysicsBase.h.

37{ return _has_flow_equations; }

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

◆ hasForchheimerFriction()

virtual bool WCNSFVFlowPhysicsBase::hasForchheimerFriction ( ) const

protectedpure virtual

Return whether a Forchheimer friction model is in use.

Implemented in WCNSFVFlowPhysics, and WCNSLinearFVFlowPhysics.

Referenced by addMaterials().

◆ hasTurbulencePhysics()

bool WCNSFVFlowPhysicsBase::hasTurbulencePhysics ( ) const

inlineprotected

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

Definition at line 156 of file WCNSFVFlowPhysicsBase.h.

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

Referenced by WCNSFVFlowPhysics::addWallsBC().

◆ includeIsotropicStress()

bool WCNSFVFlowPhysicsBase::includeIsotropicStress ( ) const

inline

Whether to include the isotropic viscous stress contribution.

Definition at line 43 of file WCNSFVFlowPhysicsBase.h.

43{ return _include_isotropic_viscous_stress; }

Referenced by WCNSFVTurbulencePhysics::addFlowTurbulenceKernels(), and WCNSFVFlowPhysics::addMomentumViscousDissipationKernels().

◆ includeSymmetrizedViscousStress()

bool WCNSFVFlowPhysicsBase::includeSymmetrizedViscousStress ( ) const

inline

Whether to include the symmetrized contribution in the viscous stress.

Definition at line 41 of file WCNSFVFlowPhysicsBase.h.

41{ return _include_symmetrized_viscous_stress; }

Referenced by WCNSFVTurbulencePhysics::addAxisymmetricTurbulentViscousSource(), WCNSFVFlowPhysics::addAxisymmetricViscousSourceKernel(), WCNSLinearFVFlowPhysics::addMomentumFluxKernels(), and WCNSFVFlowPhysics::addMomentumViscousDissipationKernels().

◆ initializePhysicsAdditional()

void WCNSFVFlowPhysicsBase::initializePhysicsAdditional ( )

overrideprotectedvirtual

Reimplemented from PhysicsBase.

Reimplemented in WCNSLinearFVFlowPhysics.

Definition at line 283 of file WCNSFVFlowPhysicsBase.C.

{
  getProblem().needFV();
}

Referenced by WCNSLinearFVFlowPhysics::initializePhysicsAdditional().

◆ inletBoundaryType()

NS::MomentumInletTypes WCNSFVFlowPhysicsBase::inletBoundaryType ( const BoundaryName & boundary_name ) const

inline

Get the type of the inlet BC.

Definition at line 83 of file WCNSFVFlowPhysicsBase.h.

  {
    return NS::MomentumInletTypes(
        static_cast<int>(libmesh_map_find(_momentum_inlet_types, boundary_name)));
  }

Referenced by WCNSFVFluidHeatTransferPhysics::addEnergyInletBC().

◆ porousMediumTreatment()

bool WCNSFVFlowPhysicsBase::porousMediumTreatment ( ) const

inline

Return whether a porous medium treatment is applied.

Definition at line 55 of file WCNSFVFlowPhysicsBase.h.

55{ return _porous_medium_treatment; }

◆ rhieChowUOName()

const UserObjectName & WCNSFVFlowPhysicsBase::rhieChowUOName ( ) const

Return the name of the Rhie Chow user object.

Definition at line 532 of file WCNSFVFlowPhysicsBase.C.

{
  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 33 of file NavierStokesPhysicsBase.h.

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

◆ validParams()

InputParameters WCNSFVFlowPhysicsBase::validParams ( )

static

Definition at line 19 of file WCNSFVFlowPhysicsBase.C.

{
  InputParameters params = NavierStokesPhysicsBase::validParams();
  params.addClassDescription("Base class for Physics defining the Navier Stokes flow equations");
 
  params += NSFVBase::commonMomentumEquationParams();
  params.addParam<bool>("add_flow_equations",
                        true,
                        "Whether to add the flow equations. This parameter is not necessary when "
                        "using the Physics syntax");
 
  // We pull in parameters from various flow objects. This helps make sure the parameters are
  // spelled the same way and match the evolution of other objects.
  // If we remove these objects, or change their parameters, these parameters should be updated
  // Downstream actions must either implement all these options, or redefine the parameter with
  // a restricted MooseEnum, or place an error in the constructor for unsupported configurations
  // We mostly pull the boundary parameters from NSFV Action
 
  params += NSFVBase::commonNavierStokesFlowParams();
  params.addParam<bool>("include_deviatoric_stress",
                        false,
                        "Whether to include the symmetrized viscous stress contribution "
                        "(grad(u)+grad(u)^T).");
  params.deprecateParam(
      "include_deviatoric_stress", "include_symmetrized_viscous_stress", "12/31/2025");
  params.addParam<bool>("include_isotropic_viscous_stress",
                        false,
                        "Whether to add the isotropic -(2/3) mu div(u) I contribution to the "
                        "viscous stress (requires complete expansion of the velocity gradient).");
  params.addParam<bool>("add_rz_viscous_source",
                        true,
                        "When true, automatically adds INSFVMomentumViscousSourceRZ to the radial "
                        "momentum equation on RZ blocks. Disable if this term should be omitted.");
 
  // Momentum boundary conditions are important for advection problems as well
  params += NSFVBase::commonMomentumBoundaryTypesParams();
 
  // Convenient for sharing the executioner block with a non-Physics syntax
  // or for defining the RhieChow user object outside the Physics
  params.addParam<UserObjectName>(
      "rhie_chow_uo_name",
      "Name of the Rhie Chow user object. Defaults to 'pins_rhie_chow_interpolator' for porous "
      "flow and 'ins_rhie_chow_interpolator' for non-porous.");
 
  // Specify the weakly compressible boundary flux information. They are used for specifying in flux
  // boundary conditions for advection physics in WCNSFV
  params += NSFVBase::commonMomentumBoundaryFluxesParams();
  params.addParam<std::vector<std::vector<MooseFunctorName>>>(
      "momentum_wall_functors",
      {},
      "Functors for each component of the velocity value on walls. This is only necessary for the "
      "fixed-velocity momentum wall types.");
 
  // Most downstream physics implementations are valid for porous media too
  // If yours is not, please remember to disable the 'porous_medium_treatment' parameter
  params.transferParam<bool>(NSFVBase::validParams(), "porous_medium_treatment");
  params.transferParam<MooseFunctorName>(NSFVBase::validParams(), "porosity");
 
  // Initialization parameters
  params.transferParam<std::vector<FunctionName>>(NSFVBase::validParams(), "initial_velocity");
  params.transferParam<FunctionName>(NSFVBase::validParams(), "initial_pressure");
 
  // Spatial discretization scheme
  // Specify the numerical schemes for interpolations of velocity and pressure
  params.transferParam<MooseEnum>(NSFVBase::validParams(), "velocity_interpolation");
  params.transferParam<MooseEnum>(NSFVBase::validParams(), "momentum_advection_interpolation");
  params.transferParam<MooseEnum>(NSFVBase::validParams(), "momentum_face_interpolation");
  params.transferParam<bool>(NSFVBase::validParams(), "momentum_two_term_bc_expansion");
  params.transferParam<bool>(NSFVBase::validParams(), "pressure_two_term_bc_expansion");
  MooseEnum coeff_interp_method("average harmonic", "harmonic");
  params.addParam<MooseEnum>("mu_interp_method",
                             coeff_interp_method,
                             "Switch that can select face interpolation method for the viscosity.");
 
  // Fluid properties
  params.addParam<UserObjectName>(NS::fluid, "Fluid properties userobject");
  params.addParam<FunctionName>(
      "mu_rampdown", 1, "A function describing a ramp down of viscosity over time");
  params.addParamNamesToGroup(NS::fluid + " mu_rampdown", "Material properties");
 
  // Parameter groups
  params.addParamNamesToGroup(
      "velocity_variable pressure_variable initial_pressure initial_velocity", "Variables");
  params.addParamNamesToGroup("density dynamic_viscosity", "Material properties");
  params.addParamNamesToGroup("inlet_boundaries momentum_inlet_types momentum_inlet_functors",
                              "Inlet boundary conditions");
  params.addParamNamesToGroup("outlet_boundaries momentum_outlet_types pressure_functors",
                              "Outlet boundary conditions");
  params.addParamNamesToGroup("wall_boundaries momentum_wall_types momentum_wall_functors",
                              "Wall boundary conditions");
  params.addParamNamesToGroup(
      "include_symmetrized_viscous_stress include_isotropic_viscous_stress velocity_interpolation "
      "momentum_advection_interpolation momentum_two_term_bc_expansion "
      "pressure_two_term_bc_expansion mu_interp_method momentum_face_interpolation",
      "Numerical scheme");
  params.addParamNamesToGroup("thermal_expansion", "Gravity treatment");
 
  return params;
}

Referenced by WCNSFVFlowPhysics::validParams(), and WCNSLinearFVFlowPhysics::validParams().

Friends And Related Symbol Documentation

◆ WCNSFVTurbulencePhysics

friend class WCNSFVTurbulencePhysics

friend

Definition at line 255 of file WCNSFVFlowPhysicsBase.h.

Member Data Documentation

◆ _add_rz_viscous_source

const bool WCNSFVFlowPhysicsBase::_add_rz_viscous_source

protected

Whether to automatically add the cylindrical viscous source term.

Definition at line 176 of file WCNSFVFlowPhysicsBase.h.

Referenced by addAxisymmetricViscousSource(), and addAxisymmetricViscousSourceEnabled().

◆ _compressibility

const MooseEnum WCNSFVFlowPhysicsBase::_compressibility

protected

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

Definition at line 179 of file WCNSFVFlowPhysicsBase.h.

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

◆ _define_variables

bool NavierStokesPhysicsBase::_define_variables

protectedinherited

Whether to define variables if they do not exist.

Definition at line 48 of file NavierStokesPhysicsBase.h.

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

◆ _density_gravity_name

const MooseFunctorName WCNSFVFlowPhysicsBase::_density_gravity_name

protected

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

Definition at line 200 of file WCNSFVFlowPhysicsBase.h.

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

◆ _density_name

const MooseFunctorName WCNSFVFlowPhysicsBase::_density_name

protected

Name of the density material property.

Definition at line 198 of file WCNSFVFlowPhysicsBase.h.

◆ _dynamic_viscosity_name

const MooseFunctorName WCNSFVFlowPhysicsBase::_dynamic_viscosity_name

protected

Name of the dynamic viscosity material property.

Definition at line 202 of file WCNSFVFlowPhysicsBase.h.

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

◆ _flow_porosity_functor_name

MooseFunctorName WCNSFVFlowPhysicsBase::_flow_porosity_functor_name

protected

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

Definition at line 188 of file WCNSFVFlowPhysicsBase.h.

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

◆ _fluid_temperature_name

const NonlinearVariableName WCNSFVFlowPhysicsBase::_fluid_temperature_name

protected

Fluid temperature name.

Definition at line 195 of file WCNSFVFlowPhysicsBase.h.

Referenced by addFluidPropertiesFunctorMaterial(), WCNSFVFlowPhysics::addMomentumBoussinesqKernels(), WCNSLinearFVFlowPhysics::addMomentumBoussinesqKernels(), and getFluidTemperatureName().

◆ _flux_inlet_directions

std::vector<Point> WCNSFVFlowPhysicsBase::_flux_inlet_directions

protected

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

Definition at line 246 of file WCNSFVFlowPhysicsBase.h.

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

◆ _flux_inlet_pps

std::vector<PostprocessorName> WCNSFVFlowPhysicsBase::_flux_inlet_pps

protected

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

Definition at line 244 of file WCNSFVFlowPhysicsBase.h.

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

◆ _friction_blocks

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

protected

Subdomains where we want to have volumetric friction.

Definition at line 221 of file WCNSFVFlowPhysicsBase.h.

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

◆ _friction_coeffs

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

protected

The coefficients used for each item if friction type.

Definition at line 225 of file WCNSFVFlowPhysicsBase.h.

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

◆ _friction_types

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

protected

The friction correlation types used for each block.

Definition at line 223 of file WCNSFVFlowPhysicsBase.h.

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

◆ _has_flow_equations

const bool WCNSFVFlowPhysicsBase::_has_flow_equations

protected

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

Definition at line 174 of file WCNSFVFlowPhysicsBase.h.

Referenced by addAxisymmetricViscousSource(), WCNSFVFlowPhysics::addCorrectors(), WCNSLinearFVFlowPhysics::addFVInterpolationMethods(), WCNSFVFlowPhysics::addFVKernels(), WCNSLinearFVFlowPhysics::addFVKernels(), WCNSFVFlowPhysics::addRhieChowUserObjects(), WCNSFVFlowPhysics::addSolverVariables(), WCNSLinearFVFlowPhysics::addSolverVariables(), hasFlowEquations(), and WCNSLinearFVFlowPhysics::WCNSLinearFVFlowPhysics().

◆ _hydraulic_separators

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

protected

Hydraulic separator boundaries.

Definition at line 234 of file WCNSFVFlowPhysicsBase.h.

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

◆ _include_isotropic_viscous_stress

const bool WCNSFVFlowPhysicsBase::_include_isotropic_viscous_stress

protected

Whether to include the isotropic viscous stress contribution.

Definition at line 206 of file WCNSFVFlowPhysicsBase.h.

Referenced by includeIsotropicStress().

◆ _include_symmetrized_viscous_stress

const bool WCNSFVFlowPhysicsBase::_include_symmetrized_viscous_stress

protected

Whether to include the symmetrized viscous stress contribution.

Definition at line 204 of file WCNSFVFlowPhysicsBase.h.

Referenced by includeSymmetrizedViscousStress().

◆ _inlet_boundaries

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

protected

Boundaries with a flow inlet specified on them.

Definition at line 228 of file WCNSFVFlowPhysicsBase.h.

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

◆ _momentum_advection_interpolation

const MooseEnum WCNSFVFlowPhysicsBase::_momentum_advection_interpolation

protected

The momentum face interpolation method for being advected.

Definition at line 213 of file WCNSFVFlowPhysicsBase.h.

Referenced by WCNSFVFlowPhysics::addMomentumAdvectionKernels(), and getMomentumAdvectionFaceInterpolationMethod().

◆ _momentum_face_interpolation

const MooseEnum WCNSFVFlowPhysicsBase::_momentum_face_interpolation

protected

The momentum face interpolation method for stress terms.

Definition at line 215 of file WCNSFVFlowPhysicsBase.h.

Referenced by getMomentumFaceInterpolationMethod().

◆ _momentum_inlet_functors

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

protected

Functors describing the momentum inlet for each boundary.

Definition at line 249 of file WCNSFVFlowPhysicsBase.h.

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

◆ _momentum_inlet_types

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

protected

Momentum inlet boundary types.

Definition at line 237 of file WCNSFVFlowPhysicsBase.h.

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

◆ _momentum_outlet_types

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

protected

Momentum outlet boundary types.

Definition at line 239 of file WCNSFVFlowPhysicsBase.h.

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

◆ _momentum_wall_functors

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

protected

Functors describing the momentum for each wall boundary.

Definition at line 253 of file WCNSFVFlowPhysicsBase.h.

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

◆ _momentum_wall_types

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

protected

Momentum wall boundary types.

Definition at line 241 of file WCNSFVFlowPhysicsBase.h.

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

◆ _outlet_boundaries

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

protected

Boundaries with a flow outlet specified on them.

Definition at line 230 of file WCNSFVFlowPhysicsBase.h.

Referenced by getOutletBoundaries(), and WCNSFVFlowPhysicsBase().

◆ _porosity_name

const MooseFunctorName WCNSFVFlowPhysicsBase::_porosity_name

protected

Name of the porosity functor.

Definition at line 186 of file WCNSFVFlowPhysicsBase.h.

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

◆ _porous_medium_treatment

const bool WCNSFVFlowPhysicsBase::_porous_medium_treatment

protected

Whether to use the porous medium treatment.

Definition at line 184 of file WCNSFVFlowPhysicsBase.h.

◆ _pressure_functors

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

protected

Functors describing the outlet pressure on each boundary.

Definition at line 251 of file WCNSFVFlowPhysicsBase.h.

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

◆ _pressure_name

const NonlinearVariableName WCNSFVFlowPhysicsBase::_pressure_name

protected

Pressure name.

Definition at line 193 of file WCNSFVFlowPhysicsBase.h.

Referenced by WCNSFVFlowPhysics::addCorrectors(), addFluidPropertiesFunctorMaterial(), WCNSFVFlowPhysics::addFVKernels(), addInitialConditions(), WCNSFVFlowPhysics::addInletBC(), WCNSLinearFVFlowPhysics::addInletBC(), WCNSFVFlowPhysics::addMassKernels(), WCNSFVFlowPhysics::addMassTimeKernels(), WCNSFVFlowPhysics::addMomentumPressureKernels(), WCNSLinearFVFlowPhysics::addMomentumPressureKernels(), WCNSFVFlowPhysics::addOutletBC(), WCNSLinearFVFlowPhysics::addOutletBC(), WCNSLinearFVFlowPhysics::addPressureCorrectionKernels(), WCNSFVFlowPhysics::addPressurePinKernel(), WCNSFVFlowPhysics::addRhieChowUserObjects(), WCNSLinearFVFlowPhysics::addRhieChowUserObjects(), WCNSFVFlowPhysics::addSeparatorBC(), WCNSFVFlowPhysics::addSolverVariables(), WCNSLinearFVFlowPhysics::addSolverVariables(), WCNSFVFlowPhysics::addWallsBC(), WCNSLinearFVFlowPhysics::addWallsBC(), and getPressureName().

◆ _pressure_tag

const TagName WCNSFVFlowPhysicsBase::_pressure_tag = "p_tag"

protected

Name of the vector to hold pressure momentum equation contributions.

Definition at line 171 of file WCNSFVFlowPhysicsBase.h.

◆ _rc_uo_name

UserObjectName WCNSFVFlowPhysicsBase::_rc_uo_name

protected

name of the Rhie Chow user object

Definition at line 209 of file WCNSFVFlowPhysicsBase.h.

Referenced by rhieChowUOName().

◆ _solve_for_dynamic_pressure

const bool WCNSFVFlowPhysicsBase::_solve_for_dynamic_pressure

protected

Whether we are solving for the total or dynamic pressure.

Definition at line 181 of file WCNSFVFlowPhysicsBase.h.

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

◆ _turbulence_physics

const WCNSFVTurbulencePhysicsBase* WCNSFVFlowPhysicsBase::_turbulence_physics

protected

Can be set to a coupled turbulence physics.

Definition at line 218 of file WCNSFVFlowPhysicsBase.h.

Referenced by actOnAdditionalTasks(), WCNSLinearFVFlowPhysics::addMomentumFluxKernels(), and hasTurbulencePhysics().

◆ _velocity_interpolation

const MooseEnum WCNSFVFlowPhysicsBase::_velocity_interpolation

protected

The velocity face interpolation method for advecting other quantities.

Definition at line 211 of file WCNSFVFlowPhysicsBase.h.

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

◆ _velocity_names

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

protected

Velocity names.

Definition at line 191 of file WCNSFVFlowPhysicsBase.h.

◆ _wall_boundaries

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

protected

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

Definition at line 232 of file WCNSFVFlowPhysicsBase.h.

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

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

navier_stokes/include/physics/WCNSFVFlowPhysicsBase.h
navier_stokes/src/physics/WCNSFVFlowPhysicsBase.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

Static Private Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ WCNSFVFlowPhysicsBase()

Member Function Documentation

◆ actOnAdditionalTasks()

◆ addAxisymmetricViscousSource()

◆ addAxisymmetricViscousSourceEnabled()

◆ addAxisymmetricViscousSourceKernel()

◆ addFluidPropertiesFunctorMaterial()

◆ addFVAdvectedInterpolationMethod()

◆ addFVBCs()

◆ addFVKernels()

◆ addInitialConditions()

◆ addInletBC()

◆ addMaterials()

◆ addMomentumBoussinesqKernels()

◆ addMomentumFrictionKernels()

◆ addMomentumGravityKernels()

◆ addMomentumPressureKernels()

◆ addMomentumTimeKernels()

◆ addNonPorousMediumSpeedMaterial()

◆ addOutletBC()

◆ addPorousMediumSpeedMaterial()

◆ addPostprocessors()

◆ addRhieChowUserObjects()

◆ addSeparatorBC()

◆ addSolverVariables()

◆ addUserObjects()

◆ addWallsBC()

◆ compressibility()

◆ densityName()

◆ dynamicViscosityName()

◆ getAdditionalRMParams()

◆ getAxisymmetricRZBlocks()

◆ getCoupledTurbulencePhysics()

◆ getFlowVariableName()

◆ getFluidTemperatureName()

◆ getFluxInletDirections()

◆ getFluxInletPPs()

◆ getHydraulicSeparators()

◆ getInletBoundaries()

◆ getLinearFrictionCoefName()

◆ getMomentumAdvectionFaceInterpolationMethod()

◆ getMomentumFaceInterpolationMethod()

◆ getNumberAlgebraicGhostingLayersNeeded()

◆ getOutletBoundaries()

◆ getPorosityFunctorName()

◆ getPressureName()

◆ getVelocityFaceInterpolationMethod()

◆ getVelocityNames()

◆ getWallBoundaries()

◆ gravityVector()

◆ hasFlowEquations()

◆ hasForchheimerFriction()

◆ hasTurbulencePhysics()

◆ includeIsotropicStress()

◆ includeSymmetrizedViscousStress()

◆ initializePhysicsAdditional()

◆ inletBoundaryType()

◆ porousMediumTreatment()

◆ rhieChowUOName()

◆ usingNavierStokesFVSyntax()

◆ validParams()

Friends And Related Symbol Documentation

◆ WCNSFVTurbulencePhysics

Member Data Documentation

◆ _add_rz_viscous_source

◆ _compressibility