https://mooseframework.inl.gov
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 | List of all members
WCNSLinearFVFlowPhysics Class Referencefinal

Creates all the objects needed to solve the Navier-Stokes equations with the SIMPLE algorithm using the linear finite volume discretization Currently does not implement: More...

#include <WCNSLinearFVFlowPhysics.h>

Inheritance diagram for WCNSLinearFVFlowPhysics:
[legend]

Public Types

typedef DataFileName DataFileParameterType
 

Public Member Functions

 WCNSLinearFVFlowPhysics (const InputParameters &parameters)
 
virtual std::vector< UserObjectName > getSuppliedUserObjects () const override
 
bool hasFlowEquations () const
 Whether the physics is actually creating the flow equations. More...
 
bool addAxisymmetricViscousSourceEnabled () const
 Whether the cylindrical viscous source helper is enabled. More...
 
bool includeSymmetrizedViscousStress () const
 Whether to include the symmetrized contribution in the viscous stress. More...
 
bool includeIsotropicStress () const
 Whether to include the isotropic viscous stress contribution. 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 MooseEnumcompressibility () 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 MooseEnumgetVelocityFaceInterpolationMethod () const
 Get the face interpolation method for velocity. More...
 
const MooseEnumgetMomentumAdvectionFaceInterpolationMethod () const
 Get the face interpolation method for momentum in the advection term. More...
 
const MooseEnumgetMomentumFaceInterpolationMethod () 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...
 
NS::MomentumInletTypes inletBoundaryType (const BoundaryName &boundary_name) const
 Get the type of the inlet BC. 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...
 
const UserObjectName & rhieChowUOName () const
 Return the name of the Rhie Chow user object. 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
 
bool hasBlocks (const std::vector< SubdomainName > &blocks) const
 
const TgetCoupledPhysics (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 ActionComponentgetActionComponent (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)
 
MooseAppgetMooseApp () 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 InputParametersparameters () const
 
const hit::Node * getHitNode () const
 
bool hasBase () const
 
const std::string & getBase () const
 
const TgetParam (const std::string &name) const
 
std::vector< std::pair< T1, T2 > > getParam (const std::string &param1, const std::string &param2) const
 
const TqueryParam (const std::string &name) const
 
const TgetRenamedParam (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
 
PerfGraphperfGraph ()
 
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 addInitialConditions () override
 
virtual void addFVBCs () override
 
virtual void addMaterials () override
 
virtual void addPostprocessors () override
 
void addAxisymmetricViscousSource ()
 Adds the cylindrical source kernel for the radial momentum equation when requested and valid. More...
 
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. More...
 
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...
 
void addFluidPropertiesFunctorMaterial ()
 Function which adds the general functor fluid properties functor material to define fluid functor material property. 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 WCNSFVTurbulencePhysicsBasegetCoupledTurbulencePhysics () const
 Find the turbulence physics. More...
 
std::vector< SubdomainName > getAxisymmetricRZBlocks () const
 Return the set of blocks restricted to an RZ coordinate system. 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 addFVAdvectedInterpolationMethod (const MooseEnum &interpolation_method)
 Add the FVInterpolationMethod object for an advected interpolation method if absent. More...
 
void assertParamDefined (const std::string &param) const
 
bool isTransient () const
 
FactorygetFactory ()
 
FactorygetFactory () const
 
virtual FEProblemBasegetProblem ()
 
virtual const FEProblemBasegetProblem () 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< SubdomainIDgetSubdomainIDs (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
 
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 TgetMeshProperty (const std::string &data_name, const std::string &prefix)
 
const TgetMeshProperty (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. More...
 
const bool _has_flow_equations
 Boolean to keep track of whether the flow equations should be created. More...
 
const bool _add_rz_viscous_source
 Whether to automatically add the cylindrical viscous source term. 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 bool _include_symmetrized_viscous_stress
 Whether to include the symmetrized viscous stress contribution. More...
 
const bool _include_isotropic_viscous_stress
 Whether to include the isotropic viscous stress contribution. More...
 
UserObjectName _rc_uo_name
 name of the Rhie Chow user object 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 WCNSFVTurbulencePhysicsBase_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
 
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 addSolverVariables () override
 
virtual void addFVInterpolationMethods () override
 
virtual void addFVKernels () override
 
virtual void addUserObjects () override
 
void addPressureCorrectionKernels ()
 Function adding kernels for the incompressible pressure correction equation. 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 addMomentumFluxKernels ()
 
virtual void addMomentumPressureKernels () override
 
virtual void addMomentumGravityKernels () override
 
virtual void addMomentumFrictionKernels () override
 
virtual void addMomentumBoussinesqKernels () override
 
virtual void addInletBC () override
 Functions adding boundary conditions for the flow simulation. More...
 
virtual void addOutletBC () override
 
virtual void addWallsBC () override
 
virtual void addSeparatorBC () override
 
virtual bool hasForchheimerFriction () const override
 Return whether a Forchheimer friction model is in use. More...
 
virtual void addRhieChowUserObjects () override
 Function which adds the RhieChow interpolator user objects for weakly and incompressible formulations. More...
 
virtual void addFunctorMaterials () override
 
virtual MooseFunctorName getLinearFrictionCoefName () const override
 Get the name of the linear friction coefficient. Returns an empty string if no friction. More...
 
unsigned short getNumberAlgebraicGhostingLayersNeeded () const override
 Return the number of algebraic ghosting layers needed. More...
 

Private Attributes

const bool _non_orthogonal_correction
 Whether to use the correction term for non-orthogonality. More...
 

Detailed Description

Creates all the objects needed to solve the Navier-Stokes equations with the SIMPLE algorithm using the linear finite volume discretization Currently does not implement:

Definition at line 24 of file WCNSLinearFVFlowPhysics.h.

Constructor & Destructor Documentation

◆ WCNSLinearFVFlowPhysics()

WCNSLinearFVFlowPhysics::WCNSLinearFVFlowPhysics ( const InputParameters parameters)

Definition at line 80 of file WCNSLinearFVFlowPhysics.C.

82  _non_orthogonal_correction(getParam<bool>("orthogonality_correction"))
83 {
84  addRequiredPhysicsTask("add_interpolation_method_physics");
85 
87  paramError("porous_medium_treatment", "Porous media unsupported");
89  mooseError("Not supported");
90 
91  if (_hydraulic_separators.size())
92  paramError("hydraulic_separator_sidesets",
93  "Flow separators are not supported yet for linearFV!");
94  if (getParam<bool>("pin_pressure"))
95  paramError("pin_pressure",
96  "Pressure pinning is implemented in the executioner for the linear finite volume "
97  "segregated solves");
98 }
const bool _has_flow_equations
Boolean to keep track of whether the flow equations should be created.
void paramError(const std::string &param, Args... args) const
void addRequiredPhysicsTask(const std::string &task)
const InputParameters & parameters() const
const bool _porous_medium_treatment
Whether to use the porous medium treatment.
const bool _non_orthogonal_correction
Whether to use the correction term for non-orthogonality.
void mooseError(Args &&... args) const
const std::vector< BoundaryName > _hydraulic_separators
Hydraulic separator boundaries.
WCNSFVFlowPhysicsBase(const InputParameters &parameters)

Member Function Documentation

◆ actOnAdditionalTasks()

void WCNSFVFlowPhysicsBase::actOnAdditionalTasks ( )
overrideprotectedvirtualinherited

Reimplemented from PhysicsBase.

Definition at line 289 of file WCNSFVFlowPhysicsBase.C.

290 {
291  // Turbulence physics would not be initialized before this task
292  if (_current_task == "get_turbulence_physics")
294 }
const std::string & _current_task
const WCNSFVTurbulencePhysicsBase * getCoupledTurbulencePhysics() const
Find the turbulence physics.
const WCNSFVTurbulencePhysicsBase * _turbulence_physics
Can be set to a coupled turbulence physics.

◆ addAxisymmetricViscousSource()

void WCNSFVFlowPhysicsBase::addAxisymmetricViscousSource ( )
protectedinherited

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

Definition at line 570 of file WCNSFVFlowPhysicsBase.C.

Referenced by WCNSFVFlowPhysics::addFVKernels().

571 {
573  return;
574 
575  const auto rz_blocks = getAxisymmetricRZBlocks();
576  if (rz_blocks.empty())
577  return;
578 
579  const auto radial_index = getProblem().mesh().getAxisymmetricRadialCoord();
580  addAxisymmetricViscousSourceKernel(rz_blocks, radial_index);
581 }
const bool _has_flow_equations
Boolean to keep track of whether the flow equations should be created.
virtual void addAxisymmetricViscousSourceKernel(const std::vector< SubdomainName > &, unsigned int)
Derived classes must override this hook to add the actual object that implements the axisymmetric vis...
virtual FEProblemBase & getProblem()
unsigned int getAxisymmetricRadialCoord() const
std::vector< SubdomainName > getAxisymmetricRZBlocks() const
Return the set of blocks restricted to an RZ coordinate system.
const bool _add_rz_viscous_source
Whether to automatically add the cylindrical viscous source term.
virtual MooseMesh & mesh() override

◆ addAxisymmetricViscousSourceEnabled()

bool WCNSFVFlowPhysicsBase::addAxisymmetricViscousSourceEnabled ( ) const
inlineinherited

Whether the cylindrical viscous source helper is enabled.

Definition at line 39 of file WCNSFVFlowPhysicsBase.h.

Referenced by WCNSFVTurbulencePhysics::addAxisymmetricTurbulentViscousSource().

39 { return _add_rz_viscous_source; }
const bool _add_rz_viscous_source
Whether to automatically add the cylindrical viscous source term.

◆ addAxisymmetricViscousSourceKernel()

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

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.

Referenced by WCNSFVFlowPhysicsBase::addAxisymmetricViscousSource().

129  {
130  }

◆ addFluidPropertiesFunctorMaterial()

void WCNSFVFlowPhysicsBase::addFluidPropertiesFunctorMaterial ( )
protectedinherited

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

Definition at line 354 of file WCNSFVFlowPhysicsBase.C.

Referenced by WCNSFVFlowPhysicsBase::addMaterials().

355 {
356  // Not very future-proof but it works
357  const bool use_ad = !dynamic_cast<WCNSLinearFVFlowPhysics *>(this);
358  const std::string class_name =
359  use_ad ? "GeneralFunctorFluidProps" : "NonADGeneralFunctorFluidProps";
360  InputParameters params = getFactory().getValidParams(class_name);
361  assignBlocks(params, _blocks);
362 
363  params.set<MooseFunctorName>(NS::pressure) = _pressure_name;
364  params.set<MooseFunctorName>(NS::T_fluid) = _fluid_temperature_name;
365  params.set<MooseFunctorName>(NS::speed) = NS::speed;
366  params.applySpecificParameters(parameters(), {NS::fluid, NS::density, "mu_rampdown"});
368  params.set<bool>("force_define_density") = true;
370  {
371  params.set<MooseFunctorName>(NS::porosity) = "1";
372  params.set<MooseFunctorName>("characteristic_length") = "1";
373  }
374  else
375  // not implemented yet
376  paramInfo(
377  NS::fluid,
378  "Specifying the fluid properties user object does not define the GeneralFunctorFluidProps "
379  "when using the porous medium treatment. You have to define this object in the input");
380 
381  // Dynamic pressure
382  params.set<bool>("solving_for_dynamic_pressure") = _solve_for_dynamic_pressure;
384  {
385  params.set<Point>("reference_pressure_point") = getParam<Point>("reference_pressure_point");
386  if (!isParamSetByUser("reference_pressure_point"))
387  paramWarning("reference_pressure_point",
388  "Default value of (0,0,0) used. If this point is outside the flow domain, the "
389  "simulation will error");
390  params.set<Real>("reference_pressure") = getParam<Real>("reference_pressure");
391  }
392  params.set<Point>("gravity") = getParam<RealVectorValue>("gravity");
393 
395  getProblem().addFunctorMaterial(class_name, prefix() + "functor_fluidprops", params);
396 }
std::string prefix() const
Creates all the objects needed to solve the Navier-Stokes equations with the SIMPLE algorithm using t...
void assignBlocks(InputParameters &params, const std::vector< SubdomainName > &blocks) const
Factory & getFactory()
static const std::string speed
Definition: NS.h:147
void applySpecificParameters(const InputParameters &common, const std::vector< std::string > &include, bool allow_private=false)
const MooseFunctorName _density_name
Name of the density material property.
const InputParameters & parameters() const
T & set(const std::string &name, bool quiet_mode=false)
static const std::string density
Definition: NS.h:34
InputParameters getValidParams(const std::string &name) const
static const std::string fluid
Definition: NS.h:88
virtual void addFunctorMaterial(const std::string &functor_material_name, const std::string &name, InputParameters &parameters)
const NonlinearVariableName _pressure_name
Pressure name.
const bool _porous_medium_treatment
Whether to use the porous medium treatment.
std::vector< SubdomainName > _blocks
virtual FEProblemBase & getProblem()
static const std::string porosity
Definition: NS.h:108
static const std::string T_fluid
Definition: NS.h:110
const bool _solve_for_dynamic_pressure
Whether we are solving for the total or dynamic pressure.
const NonlinearVariableName _fluid_temperature_name
Fluid temperature name.
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
static const std::string pressure
Definition: NS.h:57
void paramWarning(const std::string &param, Args... args) const
bool parsesToReal(const std::string &input, Real *parsed_real)
bool isParamSetByUser(const std::string &name) const
void paramInfo(const std::string &param, Args... args) const

◆ addFunctorMaterials()

void WCNSLinearFVFlowPhysics::addFunctorMaterials ( )
overrideprivatevirtual

Reimplemented from PhysicsBase.

Definition at line 708 of file WCNSLinearFVFlowPhysics.C.

709 {
710  if (parameters().isParamValid("gravity"))
711  {
712  const auto gravity_vector = getParam<RealVectorValue>("gravity");
713  const std::vector<std::string> comp_axis({"x", "y", "z"});
714  for (const auto d : make_range(dimension()))
715  if (gravity_vector(d) != 0)
716  {
717  // Add rho * g functor for each relevant direction
718  // TODO: we could avoid using an AD functor material for non-AD density functor
719  auto params = getFactory().getValidParams("ADParsedFunctorMaterial");
720  assignBlocks(params, _blocks);
721  params.set<std::string>("expression") =
722  _density_gravity_name + " * " + std::to_string(gravity_vector(d));
724  params.set<std::vector<std::string>>("functor_names") = {_density_gravity_name};
725  params.set<std::string>("property_name") = "rho_g_" + comp_axis[d];
726  // We don't output this helper material
728  "ADParsedFunctorMaterial", prefix() + "gravity_helper_" + comp_axis[d], params);
729  }
730  }
731 }
std::string prefix() const
void assignBlocks(InputParameters &params, const std::vector< SubdomainName > &blocks) const
Factory & getFactory()
const MooseFunctorName _density_gravity_name
Name of the density material property used for gravity and Boussinesq terms.
virtual void addMaterial(const std::string &material_name, const std::string &name, InputParameters &parameters)
const InputParameters & parameters() const
InputParameters getValidParams(const std::string &name) const
std::vector< SubdomainName > _blocks
unsigned int dimension() const
virtual FEProblemBase & getProblem()
IntRange< T > make_range(T beg, T end)
bool isParamValid(const std::string &name) const
bool parsesToReal(const std::string &input, Real *parsed_real)

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

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

44 {
45  const std::string method_name = interpolation_method;
46  if (getProblem().hasFVInterpolationMethod(method_name))
47  return;
48 
49  const auto method_type = NS::fvAdvectedInterpolationMethodType(interpolation_method);
50 
51  InputParameters params = getFactory().getValidParams(method_type);
52  getProblem().addFVInterpolationMethod(method_type, method_name, params);
53 }
Factory & getFactory()
InputParameters getValidParams(const std::string &name) const
std::string fvAdvectedInterpolationMethodType(const MooseEnum &interpolation_method)
Gets the FVInterpolationMethod object type for an advected interpolation method.
Definition: NSFVUtils.C:67
virtual FEProblemBase & getProblem()
virtual void addFVInterpolationMethod(const std::string &method_type, const std::string &name, InputParameters &parameters)

◆ addFVBCs()

void WCNSFVFlowPhysicsBase::addFVBCs ( )
overrideprotectedvirtualinherited

Reimplemented from PhysicsBase.

Definition at line 297 of file WCNSFVFlowPhysicsBase.C.

298 {
299  addInletBC();
300  addOutletBC();
301  addWallsBC();
302  addSeparatorBC();
303 }
virtual void addSeparatorBC()=0
virtual void addOutletBC()=0
virtual void addWallsBC()=0
virtual void addInletBC()=0
Functions adding boundary conditions for the flow simulation.

◆ addFVInterpolationMethods()

void WCNSLinearFVFlowPhysics::addFVInterpolationMethods ( )
overrideprivatevirtual

Reimplemented from PhysicsBase.

Definition at line 101 of file WCNSLinearFVFlowPhysics.C.

102 {
103  if (!_has_flow_equations || isParamValid("momentum_advection_interpolation_method_name"))
104  return;
105 
106  addFVAdvectedInterpolationMethod(getParam<MooseEnum>("momentum_advection_interpolation"));
107 }
const bool _has_flow_equations
Boolean to keep track of whether the flow equations should be created.
void addFVAdvectedInterpolationMethod(const MooseEnum &interpolation_method)
Add the FVInterpolationMethod object for an advected interpolation method if absent.
bool isParamValid(const std::string &name) const

◆ addFVKernels()

void WCNSLinearFVFlowPhysics::addFVKernels ( )
overrideprivatevirtual

Implements WCNSFVFlowPhysicsBase.

Definition at line 190 of file WCNSLinearFVFlowPhysics.C.

191 {
192  if (!_has_flow_equations)
193  return;
194 
195  // Pressure correction equation: divergence of momentum
197 
198  // Momentum equation: time derivative
199  if (isTransient())
201 
202  // Momentum equation: flux terms
204 
205  // Momentum equation: pressure term
207 
208  // Momentum equation: friction term
209  if (_friction_types.size())
211 
212  // Momentum equation: gravity source term
214 
215  // Momentum equation: boussinesq approximation
216  if (getParam<bool>("boussinesq_approximation"))
218 }
const bool _has_flow_equations
Boolean to keep track of whether the flow equations should be created.
std::vector< std::vector< std::string > > _friction_types
The friction correlation types used for each block.
virtual void addMomentumPressureKernels() override
void addMomentumTimeKernels() override
Functions adding kernels for the incompressible momentum equation If the material properties are not ...
void addPressureCorrectionKernels()
Function adding kernels for the incompressible pressure correction equation.
virtual void addMomentumGravityKernels() override
virtual void addMomentumFrictionKernels() override
virtual void addMomentumBoussinesqKernels() override
bool isTransient() const

◆ addInitialConditions()

void WCNSFVFlowPhysicsBase::addInitialConditions ( )
overrideprotectedvirtualinherited

Reimplemented from PhysicsBase.

Definition at line 399 of file WCNSFVFlowPhysicsBase.C.

400 {
401  if (!_define_variables && parameters().isParamSetByUser("initial_velocity") &&
402  parameters().isParamSetByUser("velocity_variable") &&
403  getParam<std::vector<FunctionName>>("initial_velocity").size() != 0)
404  // TODO: Rework and remove this last statement once the NSFV action is removed
405  paramError("initial_velocity",
406  "Velocity is defined externally of WCNSFVFlowPhysicsBase, so should the inital "
407  "conditions");
408  if (!_define_variables && parameters().isParamSetByUser("initial_pressure") &&
409  parameters().isParamSetByUser("pressure_variable"))
410  paramError("initial_pressure",
411  "Pressure is defined externally of WCNSFVFlowPhysicsBase, so should the inital "
412  "condition");
413 
414  // Check dimension
415  if (getParam<std::vector<FunctionName>>("initial_velocity").size() != dimension() &&
416  getParam<std::vector<FunctionName>>("initial_velocity").size() != 3 &&
417  getParam<std::vector<FunctionName>>("initial_velocity").size() != 0)
418  // TODO: Rework and remove this last statement once the NSFV action is removed
419  paramError("initial_velocity",
420  "The number of velocity components in the " + type() + " initial condition is not " +
421  std::to_string(dimension()) + " or 3!");
422 
423  InputParameters params = getFactory().getValidParams("FVFunctionIC");
424  assignBlocks(params, _blocks);
425  auto vvalue = getParam<std::vector<FunctionName>>("initial_velocity");
426 
427  for (const auto d : make_range(dimension()))
428  {
429  params.set<VariableName>("variable") = _velocity_names[d];
430  params.set<FunctionName>("function") = vvalue[d];
431 
433  _blocks,
434  /*whether IC is a default*/ !isParamSetByUser("initial_velocity"),
435  /*error if already an IC*/ isParamSetByUser("initial_velocity")))
437  "FVFunctionIC", prefix() + _velocity_names[d] + "_ic", params);
438  }
439 
441  _blocks,
442  /*whether IC is a default*/ !isParamSetByUser("initial_pressure"),
443  /*error if already an IC*/ isParamSetByUser("initial_pressure")))
444  {
445  params.set<VariableName>("variable") = _pressure_name;
446  params.set<FunctionName>("function") = getParam<FunctionName>("initial_pressure");
447 
448  getProblem().addFVInitialCondition("FVFunctionIC", prefix() + _pressure_name + "_ic", params);
449  }
450 }
std::string prefix() const
virtual void addFVInitialCondition(const std::string &ic_name, const std::string &name, InputParameters &parameters)
void assignBlocks(InputParameters &params, const std::vector< SubdomainName > &blocks) const
Factory & getFactory()
void paramError(const std::string &param, Args... args) const
const T & getParam(const std::string &name) const
const InputParameters & parameters() const
T & set(const std::string &name, bool quiet_mode=false)
InputParameters getValidParams(const std::string &name) const
const NonlinearVariableName _pressure_name
Pressure name.
bool shouldCreateIC(const VariableName &var_name, const std::vector< SubdomainName > &blocks, const bool ic_is_default_ic, const bool error_if_already_defined) const
std::vector< SubdomainName > _blocks
unsigned int dimension() const
virtual FEProblemBase & getProblem()
const std::vector< std::string > _velocity_names
Velocity names.
const std::string & type() const
bool _define_variables
Whether to define variables if they do not exist.
IntRange< T > make_range(T beg, T end)
bool isParamSetByUser(const std::string &name) const

◆ addInletBC()

void WCNSLinearFVFlowPhysics::addInletBC ( )
overrideprivatevirtual

Functions adding boundary conditions for the flow simulation.

These are used for weakly-compressible simulations as well.

Implements WCNSFVFlowPhysicsBase.

Definition at line 425 of file WCNSLinearFVFlowPhysics.C.

426 {
427  // Check the size of the BC parameters
428  unsigned int num_velocity_functor_inlets = 0;
429  for (const auto & [bdy, momentum_inlet_type] : _momentum_inlet_types)
430  if (momentum_inlet_type == "fixed-velocity" || momentum_inlet_type == "fixed-pressure")
431  num_velocity_functor_inlets++;
432 
433  if (num_velocity_functor_inlets != _momentum_inlet_functors.size())
434  paramError("momentum_inlet_functors",
435  "Size (" + std::to_string(_momentum_inlet_functors.size()) +
436  ") is not the same as the number of entries in the momentum_inlet_types "
437  "subvector for fixed-velocities/pressures functors (size " +
438  std::to_string(num_velocity_functor_inlets) + ")");
439 
440  unsigned int velocity_pressure_counter = 0;
441  for (const auto & [inlet_bdy, momentum_inlet_type] : _momentum_inlet_types)
442  {
443  if (momentum_inlet_type == "fixed-velocity")
444  {
445  const std::string bc_type = "LinearFVAdvectionDiffusionFunctorDirichletBC";
446  InputParameters params = getFactory().getValidParams(bc_type);
447  params.set<std::vector<BoundaryName>>("boundary") = {inlet_bdy};
448  if (_momentum_inlet_functors.size() < velocity_pressure_counter + 1)
449  paramError("momentum_inlet_functors",
450  "More non-flux inlets than inlet functors (" +
451  std::to_string(_momentum_inlet_functors.size()) + ")");
452 
453  // Check that enough functors have been provided for the dimension of the problem
454  const auto momentum_functors = libmesh_map_find(_momentum_inlet_functors, inlet_bdy);
455  if (momentum_functors.size() < dimension())
456  paramError("momentum_inlet_functors",
457  "Subvector for boundary '" + inlet_bdy + "' (size " +
458  std::to_string(momentum_functors.size()) +
459  ") is not the same size as the number of dimensions of the physics (" +
460  std::to_string(dimension()) + ")");
461 
462  for (const auto d : make_range(dimension()))
463  {
464  params.set<LinearVariableName>("variable") = _velocity_names[d];
465  params.set<MooseFunctorName>("functor") = momentum_functors[d];
466 
467  getProblem().addLinearFVBC(bc_type, _velocity_names[d] + "_" + inlet_bdy, params);
468  }
469  ++velocity_pressure_counter;
470 
471  // Add the two term BC expansion for pressure if requested
472  if (getParam<bool>("pressure_two_term_bc_expansion"))
473  {
474  const std::string bc_type = "LinearFVExtrapolatedPressureBC";
475  InputParameters params = getFactory().getValidParams(bc_type);
476  params.set<std::vector<BoundaryName>>("boundary") = {inlet_bdy};
477  params.set<LinearVariableName>("variable") = _pressure_name;
478  params.set<bool>("use_two_term_expansion") = true;
479  getProblem().addLinearFVBC(bc_type,
480  _pressure_name + "_extrapolation_inlet_" +
481  Moose::stringify(inlet_bdy),
482  params);
483  }
484  }
485  else if (momentum_inlet_type == "fixed-pressure")
486  {
487  const std::string bc_type = "LinearFVAdvectionDiffusionFunctorDirichletBC";
488  InputParameters params = getFactory().getValidParams(bc_type);
489  params.set<LinearVariableName>("variable") = _pressure_name;
490  if (_momentum_inlet_functors.size() < velocity_pressure_counter + 1)
491  paramError("momentum_inlet_functors",
492  "More non-flux inlets than inlet functors (" +
493  std::to_string(_momentum_inlet_functors.size()) + ")");
494 
495  params.set<MooseFunctorName>("functor") =
496  libmesh_map_find(_momentum_inlet_functors, inlet_bdy)[0];
497  params.set<std::vector<BoundaryName>>("boundary") = {inlet_bdy};
498 
499  getProblem().addLinearFVBC(bc_type, _pressure_name + "_" + inlet_bdy, params);
500  ++velocity_pressure_counter;
501  }
502  else
503  mooseError("Unsupported inlet boundary condition type: ", momentum_inlet_type);
504  }
505 }
Factory & getFactory()
std::map< BoundaryName, MooseEnum > _momentum_inlet_types
Momentum inlet boundary types.
void paramError(const std::string &param, Args... args) const
T & set(const std::string &name, bool quiet_mode=false)
InputParameters getValidParams(const std::string &name) const
std::map< BoundaryName, std::vector< MooseFunctorName > > _momentum_inlet_functors
Functors describing the momentum inlet for each boundary.
const NonlinearVariableName _pressure_name
Pressure name.
unsigned int dimension() const
virtual FEProblemBase & getProblem()
const std::vector< std::string > _velocity_names
Velocity names.
std::string stringify(const T &t)
virtual void addLinearFVBC(const std::string &fv_bc_name, const std::string &name, InputParameters &parameters)
IntRange< T > make_range(T beg, T end)
void mooseError(Args &&... args) const

◆ addMaterials()

void WCNSFVFlowPhysicsBase::addMaterials ( )
overrideprotectedvirtualinherited

Reimplemented from PhysicsBase.

Definition at line 306 of file WCNSFVFlowPhysicsBase.C.

307 {
310  else
312 
313  if (isParamValid(NS::fluid))
315 }
static const std::string fluid
Definition: NS.h:88
const bool _porous_medium_treatment
Whether to use the porous medium treatment.
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 mat...
virtual bool hasForchheimerFriction() const =0
Return whether a Forchheimer friction model is in use.
bool isParamValid(const std::string &name) const

◆ addMomentumBoussinesqKernels()

void WCNSLinearFVFlowPhysics::addMomentumBoussinesqKernels ( )
overrideprivatevirtual

Implements WCNSFVFlowPhysicsBase.

Definition at line 398 of file WCNSLinearFVFlowPhysics.C.

Referenced by addFVKernels().

399 {
400  if (_compressibility == "weakly-compressible")
401  paramError("boussinesq_approximation",
402  "We cannot use boussinesq approximation while running in weakly-compressible mode!");
403 
404  std::string kernel_type = "LinearFVMomentumBoussinesq";
405  std::string kernel_name = prefix() + "ins_momentum_boussinesq_";
406 
407  InputParameters params = getFactory().getValidParams(kernel_type);
408  assignBlocks(params, _blocks);
409  params.set<VariableName>(NS::T_fluid) = _fluid_temperature_name;
410  params.set<MooseFunctorName>(NS::density) = _density_gravity_name;
411  params.set<RealVectorValue>("gravity") = getParam<RealVectorValue>("gravity");
412  params.set<Real>("ref_temperature") = getParam<Real>("ref_temperature");
413  params.set<MooseFunctorName>("alpha_name") = getParam<MooseFunctorName>("thermal_expansion");
414 
415  for (const auto d : make_range(dimension()))
416  {
417  params.set<MooseEnum>("momentum_component") = NS::directions[d];
418  params.set<LinearVariableName>("variable") = _velocity_names[d];
419 
420  getProblem().addLinearFVKernel(kernel_type, kernel_name + NS::directions[d], params);
421  }
422 }
std::string prefix() const
void assignBlocks(InputParameters &params, const std::vector< SubdomainName > &blocks) const
Factory & getFactory()
void paramError(const std::string &param, Args... args) const
const MooseFunctorName _density_gravity_name
Name of the density material property used for gravity and Boussinesq terms.
T & set(const std::string &name, bool quiet_mode=false)
static const std::string density
Definition: NS.h:34
InputParameters getValidParams(const std::string &name) const
std::vector< SubdomainName > _blocks
unsigned int dimension() const
static const std::string directions[3]
Definition: NS.h:23
virtual FEProblemBase & getProblem()
static const std::string T_fluid
Definition: NS.h:110
const std::vector< std::string > _velocity_names
Velocity names.
const MooseEnum _compressibility
Compressibility type, can be compressible, incompressible or weakly-compressible. ...
virtual void addLinearFVKernel(const std::string &kernel_name, const std::string &name, InputParameters &parameters)
const NonlinearVariableName _fluid_temperature_name
Fluid temperature name.
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
IntRange< T > make_range(T beg, T end)

◆ addMomentumFluxKernels()

void WCNSLinearFVFlowPhysics::addMomentumFluxKernels ( )
private

Definition at line 268 of file WCNSLinearFVFlowPhysics.C.

Referenced by addFVKernels().

269 {
270  const auto momentum_advection_method_name =
271  isParamValid("momentum_advection_interpolation_method_name")
272  ? getParam<InterpolationMethodName>("momentum_advection_interpolation_method_name")
273  : InterpolationMethodName(
274  std::string(getParam<MooseEnum>("momentum_advection_interpolation")));
275 
276  const std::string u_names[3] = {"u", "v", "w"};
277  std::string kernel_type = "LinearWCNSFVMomentumFlux";
278  std::string kernel_name = prefix() + "ins_momentum_flux_";
279 
280  InputParameters params = getFactory().getValidParams(kernel_type);
281  assignBlocks(params, _blocks);
282  if (!_turbulence_physics)
283  params.set<MooseFunctorName>(NS::mu) = _dynamic_viscosity_name;
284  else
285  params.set<MooseFunctorName>(NS::mu) = NS::mu_eff;
286 
287  params.set<UserObjectName>("rhie_chow_user_object") = rhieChowUOName();
288  params.set<InterpolationMethodName>("advected_interp_method_name") =
289  momentum_advection_method_name;
290  params.set<bool>("use_nonorthogonal_correction") = _non_orthogonal_correction;
291  params.set<bool>("use_deviatoric_terms") = includeSymmetrizedViscousStress();
292 
293  for (unsigned int i = 0; i < dimension(); ++i)
294  params.set<SolverVariableName>(u_names[i]) = _velocity_names[i];
295 
296  for (const auto d : make_range(dimension()))
297  {
298  params.set<LinearVariableName>("variable") = _velocity_names[d];
299  params.set<MooseEnum>("momentum_component") = NS::directions[d];
300 
301  getProblem().addLinearFVKernel(kernel_type, kernel_name + NS::directions[d], params);
302  }
303 }
std::string prefix() const
void assignBlocks(InputParameters &params, const std::vector< SubdomainName > &blocks) const
Factory & getFactory()
T & set(const std::string &name, bool quiet_mode=false)
InputParameters getValidParams(const std::string &name) const
std::vector< SubdomainName > _blocks
unsigned int dimension() const
bool includeSymmetrizedViscousStress() const
Whether to include the symmetrized contribution in the viscous stress.
static const std::string directions[3]
Definition: NS.h:23
virtual FEProblemBase & getProblem()
static const std::string mu
Definition: NS.h:127
const std::vector< std::string > _velocity_names
Velocity names.
const MooseFunctorName _dynamic_viscosity_name
Name of the dynamic viscosity material property.
static const std::string mu_eff
Definition: NS.h:133
const bool _non_orthogonal_correction
Whether to use the correction term for non-orthogonality.
virtual void addLinearFVKernel(const std::string &kernel_name, const std::string &name, InputParameters &parameters)
const UserObjectName & rhieChowUOName() const
Return the name of the Rhie Chow user object.
IntRange< T > make_range(T beg, T end)
bool isParamValid(const std::string &name) const
const WCNSFVTurbulencePhysicsBase * _turbulence_physics
Can be set to a coupled turbulence physics.

◆ addMomentumFrictionKernels()

void WCNSLinearFVFlowPhysics::addMomentumFrictionKernels ( )
overrideprivatevirtual

Implements WCNSFVFlowPhysicsBase.

Definition at line 324 of file WCNSLinearFVFlowPhysics.C.

Referenced by addFVKernels().

325 {
326  unsigned int num_friction_blocks = _friction_blocks.size();
327  unsigned int num_used_blocks = num_friction_blocks ? num_friction_blocks : 1;
328 
329  const std::string kernel_type = "LinearFVMomentumFriction";
330  InputParameters params = getFactory().getValidParams(kernel_type);
331 
332  for (const auto block_i : make_range(num_used_blocks))
333  {
334  std::string block_name = "";
335  if (num_friction_blocks)
336  {
337  params.set<std::vector<SubdomainName>>("block") = _friction_blocks[block_i];
338  block_name = Moose::stringify(_friction_blocks[block_i]);
339  }
340  else
341  {
342  assignBlocks(params, _blocks);
343  block_name = std::to_string(block_i);
344  }
345 
346  for (const auto d : make_range(dimension()))
347  {
348  params.set<LinearVariableName>("variable") = _velocity_names[d];
349  params.set<MooseEnum>("momentum_component") = NS::directions[d];
350  for (unsigned int type_i = 0; type_i < _friction_types[block_i].size(); ++type_i)
351  {
352  const auto upper_name = MooseUtils::toUpper(_friction_types[block_i][type_i]);
353  if (upper_name == "DARCY")
354  {
355  params.set<MooseFunctorName>(NS::mu) = _dynamic_viscosity_name;
356  params.set<MooseFunctorName>("Darcy_name") = _friction_coeffs[block_i][type_i];
357  }
358  else
359  paramError("friction_types",
360  "Friction type '",
361  _friction_types[block_i][type_i],
362  "' is not implemented");
363  }
364 
365  getProblem().addLinearFVKernel(kernel_type,
366  prefix() + "momentum_friction_" + block_name + "_" +
367  NS::directions[d],
368  params);
369  }
370  }
371 }
std::string prefix() const
void assignBlocks(InputParameters &params, const std::vector< SubdomainName > &blocks) const
Factory & getFactory()
std::vector< std::vector< std::string > > _friction_types
The friction correlation types used for each block.
void paramError(const std::string &param, Args... args) const
T & set(const std::string &name, bool quiet_mode=false)
InputParameters getValidParams(const std::string &name) const
std::vector< SubdomainName > _blocks
unsigned int dimension() const
static const std::string directions[3]
Definition: NS.h:23
std::string toUpper(std::string name)
virtual FEProblemBase & getProblem()
std::vector< std::vector< SubdomainName > > _friction_blocks
Subdomains where we want to have volumetric friction.
static const std::string mu
Definition: NS.h:127
const std::vector< std::string > _velocity_names
Velocity names.
const MooseFunctorName _dynamic_viscosity_name
Name of the dynamic viscosity material property.
std::string stringify(const T &t)
virtual void addLinearFVKernel(const std::string &kernel_name, const std::string &name, InputParameters &parameters)
IntRange< T > make_range(T beg, T end)
std::vector< std::vector< std::string > > _friction_coeffs
The coefficients used for each item if friction type.

◆ addMomentumGravityKernels()

void WCNSLinearFVFlowPhysics::addMomentumGravityKernels ( )
overrideprivatevirtual

Implements WCNSFVFlowPhysicsBase.

Definition at line 374 of file WCNSLinearFVFlowPhysics.C.

Referenced by addFVKernels().

375 {
377  {
378  std::string kernel_type = "LinearFVSource";
379  std::string kernel_name = prefix() + "ins_momentum_gravity_";
380 
381  InputParameters params = getFactory().getValidParams(kernel_type);
382  assignBlocks(params, _blocks);
383  const auto gravity_vector = getParam<RealVectorValue>("gravity");
384  const std::vector<std::string> comp_axis({"x", "y", "z"});
385 
386  for (const auto d : make_range(dimension()))
387  if (gravity_vector(d) != 0)
388  {
389  params.set<MooseFunctorName>("source_density") = "rho_g_" + comp_axis[d];
390  params.set<LinearVariableName>("variable") = _velocity_names[d];
391 
392  getProblem().addLinearFVKernel(kernel_type, kernel_name + NS::directions[d], params);
393  }
394  }
395 }
std::string prefix() const
void assignBlocks(InputParameters &params, const std::vector< SubdomainName > &blocks) const
Factory & getFactory()
const InputParameters & parameters() const
T & set(const std::string &name, bool quiet_mode=false)
InputParameters getValidParams(const std::string &name) const
std::vector< SubdomainName > _blocks
unsigned int dimension() const
static const std::string directions[3]
Definition: NS.h:23
virtual FEProblemBase & getProblem()
const std::vector< std::string > _velocity_names
Velocity names.
const bool _solve_for_dynamic_pressure
Whether we are solving for the total or dynamic pressure.
virtual void addLinearFVKernel(const std::string &kernel_name, const std::string &name, InputParameters &parameters)
IntRange< T > make_range(T beg, T end)
bool isParamValid(const std::string &name) const

◆ addMomentumPressureKernels()

void WCNSLinearFVFlowPhysics::addMomentumPressureKernels ( )
overrideprivatevirtual

Implements WCNSFVFlowPhysicsBase.

Definition at line 306 of file WCNSLinearFVFlowPhysics.C.

Referenced by addFVKernels().

307 {
308  std::string kernel_type = "LinearFVMomentumPressure";
309  std::string kernel_name = prefix() + "ins_momentum_pressure_";
310 
311  InputParameters params = getFactory().getValidParams(kernel_type);
312  assignBlocks(params, _blocks);
313  params.set<VariableName>("pressure") = _pressure_name;
314 
315  for (const auto d : make_range(dimension()))
316  {
317  params.set<MooseEnum>("momentum_component") = NS::directions[d];
318  params.set<LinearVariableName>("variable") = _velocity_names[d];
319  getProblem().addLinearFVKernel(kernel_type, kernel_name + NS::directions[d], params);
320  }
321 }
std::string prefix() const
void assignBlocks(InputParameters &params, const std::vector< SubdomainName > &blocks) const
Factory & getFactory()
T & set(const std::string &name, bool quiet_mode=false)
InputParameters getValidParams(const std::string &name) const
const NonlinearVariableName _pressure_name
Pressure name.
std::vector< SubdomainName > _blocks
unsigned int dimension() const
static const std::string directions[3]
Definition: NS.h:23
virtual FEProblemBase & getProblem()
const std::vector< std::string > _velocity_names
Velocity names.
virtual void addLinearFVKernel(const std::string &kernel_name, const std::string &name, InputParameters &parameters)
IntRange< T > make_range(T beg, T end)

◆ addMomentumTimeKernels()

void WCNSLinearFVFlowPhysics::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 250 of file WCNSLinearFVFlowPhysics.C.

Referenced by addFVKernels().

251 {
252  std::string kernel_type = "LinearFVTimeDerivative";
253  std::string kernel_name = prefix() + "ins_momentum_time";
254 
255  InputParameters params = getFactory().getValidParams(kernel_type);
256  assignBlocks(params, _blocks);
257  params.set<MooseFunctorName>("factor") = _density_name;
258 
259  for (const auto d : make_range(dimension()))
260  {
261  params.set<LinearVariableName>("variable") = _velocity_names[d];
262  if (shouldCreateTimeDerivative(_velocity_names[d], _blocks, /*error if already defined*/ false))
263  getProblem().addLinearFVKernel(kernel_type, kernel_name + "_" + NS::directions[d], params);
264  }
265 }
std::string prefix() const
void assignBlocks(InputParameters &params, const std::vector< SubdomainName > &blocks) const
Factory & getFactory()
const MooseFunctorName _density_name
Name of the density material property.
T & set(const std::string &name, bool quiet_mode=false)
InputParameters getValidParams(const std::string &name) const
bool shouldCreateTimeDerivative(const VariableName &var_name, const std::vector< SubdomainName > &blocks, const bool error_if_already_defined) const
std::vector< SubdomainName > _blocks
unsigned int dimension() const
static const std::string directions[3]
Definition: NS.h:23
virtual FEProblemBase & getProblem()
const std::vector< std::string > _velocity_names
Velocity names.
virtual void addLinearFVKernel(const std::string &kernel_name, const std::string &name, InputParameters &parameters)
IntRange< T > make_range(T beg, T end)

◆ addNonPorousMediumSpeedMaterial()

void WCNSFVFlowPhysicsBase::addNonPorousMediumSpeedMaterial ( )
protectedinherited

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

Definition at line 336 of file WCNSFVFlowPhysicsBase.C.

Referenced by WCNSFVFlowPhysicsBase::addMaterials().

337 {
338  // Not very future-proof but it works
339  const bool use_ad = !dynamic_cast<WCNSLinearFVFlowPhysics *>(this);
340  const std::string class_name =
341  use_ad ? "ADVectorMagnitudeFunctorMaterial" : "VectorMagnitudeFunctorMaterial";
342  InputParameters params = getFactory().getValidParams(class_name);
343  assignBlocks(params, _blocks);
344 
345  const std::vector<std::string> param_names{"x_functor", "y_functor", "z_functor"};
346  for (unsigned int dim_i = 0; dim_i < dimension(); ++dim_i)
347  params.set<MooseFunctorName>(param_names[dim_i]) = _velocity_names[dim_i];
348  params.set<MooseFunctorName>("vector_magnitude_name") = NS::speed;
349 
350  getProblem().addFunctorMaterial(class_name, prefix() + "ins_speed_material", params);
351 }
std::string prefix() const
Creates all the objects needed to solve the Navier-Stokes equations with the SIMPLE algorithm using t...
void assignBlocks(InputParameters &params, const std::vector< SubdomainName > &blocks) const
Factory & getFactory()
static const std::string speed
Definition: NS.h:147
T & set(const std::string &name, bool quiet_mode=false)
InputParameters getValidParams(const std::string &name) const
virtual void addFunctorMaterial(const std::string &functor_material_name, const std::string &name, InputParameters &parameters)
std::vector< SubdomainName > _blocks
unsigned int dimension() const
virtual FEProblemBase & getProblem()
const std::vector< std::string > _velocity_names
Velocity names.

◆ addOutletBC()

void WCNSLinearFVFlowPhysics::addOutletBC ( )
overrideprivatevirtual

Implements WCNSFVFlowPhysicsBase.

Definition at line 508 of file WCNSLinearFVFlowPhysics.C.

509 {
510  // Check the BCs size
511  unsigned int num_pressure_outlets = 0;
512  for (const auto & [bdy, momentum_outlet_type] : _momentum_outlet_types)
513  if (momentum_outlet_type == "fixed-pressure" ||
514  momentum_outlet_type == "fixed-pressure-zero-gradient")
515  num_pressure_outlets++;
516 
517  if (num_pressure_outlets != _pressure_functors.size())
518  paramError("pressure_functors",
519  "Size (" + std::to_string(_pressure_functors.size()) +
520  ") is not the same as the number of pressure outlet boundaries in "
521  "'fixed-pressure/fixed-pressure-zero-gradient' (size " +
522  std::to_string(num_pressure_outlets) + ")");
523 
524  const std::string u_names[3] = {"u", "v", "w"};
525  for (const auto & [outlet_bdy, momentum_outlet_type] : _momentum_outlet_types)
526  {
527  // Zero tangeantial gradient condition on velocity
528  if (momentum_outlet_type == "zero-gradient" || momentum_outlet_type == "fixed-pressure" ||
529  momentum_outlet_type == "fixed-pressure-zero-gradient")
530  {
531  const std::string bc_type = "LinearFVAdvectionDiffusionOutflowBC";
532  InputParameters params = getFactory().getValidParams(bc_type);
533  params.set<std::vector<BoundaryName>>("boundary") = {outlet_bdy};
534  params.set<bool>("use_two_term_expansion") = getParam<bool>("momentum_two_term_bc_expansion");
535 
536  for (const auto d : make_range(dimension()))
537  {
538  params.set<LinearVariableName>("variable") = _velocity_names[d];
539  getProblem().addLinearFVBC(bc_type, _velocity_names[d] + "_" + outlet_bdy, params);
540  }
541  }
542 
543  // Fixed pressure condition, coming in the pressure correction equation
544  if (momentum_outlet_type == "fixed-pressure" ||
545  momentum_outlet_type == "fixed-pressure-zero-gradient")
546  {
547  const std::string bc_type = "LinearFVAdvectionDiffusionFunctorDirichletBC";
548  InputParameters params = getFactory().getValidParams(bc_type);
549  params.set<LinearVariableName>("variable") = _pressure_name;
550  params.set<MooseFunctorName>("functor") = libmesh_map_find(_pressure_functors, outlet_bdy);
551  params.set<std::vector<BoundaryName>>("boundary") = {outlet_bdy};
552 
553  getProblem().addLinearFVBC(bc_type, _pressure_name + "_" + outlet_bdy, params);
554  }
555  }
556 }
Factory & getFactory()
void paramError(const std::string &param, Args... args) const
T & set(const std::string &name, bool quiet_mode=false)
InputParameters getValidParams(const std::string &name) const
const NonlinearVariableName _pressure_name
Pressure name.
unsigned int dimension() const
virtual FEProblemBase & getProblem()
std::map< BoundaryName, MooseEnum > _momentum_outlet_types
Momentum outlet boundary types.
const std::vector< std::string > _velocity_names
Velocity names.
std::map< BoundaryName, MooseFunctorName > _pressure_functors
Functors describing the outlet pressure on each boundary.
virtual void addLinearFVBC(const std::string &fv_bc_name, const std::string &name, InputParameters &parameters)
IntRange< T > make_range(T beg, T end)

◆ addPorousMediumSpeedMaterial()

void WCNSFVFlowPhysicsBase::addPorousMediumSpeedMaterial ( )
protectedinherited

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

Definition at line 318 of file WCNSFVFlowPhysicsBase.C.

Referenced by WCNSFVFlowPhysicsBase::addMaterials().

319 {
320  InputParameters params = getFactory().getValidParams("PINSFVSpeedFunctorMaterial");
321  assignBlocks(params, _blocks);
322 
323  for (unsigned int dim_i = 0; dim_i < dimension(); ++dim_i)
324  params.set<MooseFunctorName>(NS::superficial_velocity_vector[dim_i]) = _velocity_names[dim_i];
326  params.set<MooseFunctorName>(NS::porosity) = _flow_porosity_functor_name;
327  else
328  params.set<MooseFunctorName>(NS::porosity) = "1";
329  params.set<bool>("define_interstitial_velocity_components") = _porous_medium_treatment;
330 
332  "PINSFVSpeedFunctorMaterial", prefix() + "pins_speed_material", params);
333 }
std::string prefix() const
void assignBlocks(InputParameters &params, const std::vector< SubdomainName > &blocks) const
Factory & getFactory()
T & set(const std::string &name, bool quiet_mode=false)
InputParameters getValidParams(const std::string &name) const
virtual void addFunctorMaterial(const std::string &functor_material_name, const std::string &name, InputParameters &parameters)
const bool _porous_medium_treatment
Whether to use the porous medium treatment.
std::vector< SubdomainName > _blocks
unsigned int dimension() const
virtual FEProblemBase & getProblem()
static const std::string porosity
Definition: NS.h:108
static const std::string superficial_velocity_vector[3]
Definition: NS.h:55
const std::vector< std::string > _velocity_names
Velocity names.
MooseFunctorName _flow_porosity_functor_name
Name of the porosity functor for the flow equations (if smoothed)

◆ addPostprocessors()

void WCNSFVFlowPhysicsBase::addPostprocessors ( )
overrideprotectedvirtualinherited

Reimplemented from PhysicsBase.

Definition at line 460 of file WCNSFVFlowPhysicsBase.C.

461 {
462  const auto momentum_inlet_types = getParam<MultiMooseEnum>("momentum_inlet_types");
463 
464  for (unsigned int bc_ind = 0; bc_ind < momentum_inlet_types.size(); ++bc_ind)
465  if (momentum_inlet_types[bc_ind] == "flux-mass" ||
466  momentum_inlet_types[bc_ind] == "flux-velocity")
467  {
468  const std::string pp_type = "AreaPostprocessor";
469  InputParameters params = getFactory().getValidParams(pp_type);
470  params.set<std::vector<BoundaryName>>("boundary") = {_inlet_boundaries[bc_ind]};
471  params.set<ExecFlagEnum>("execute_on") = EXEC_INITIAL;
472 
473  const auto name_pp = "area_pp_" + _inlet_boundaries[bc_ind];
474  if (!getProblem().hasUserObject(name_pp))
475  getProblem().addPostprocessor(pp_type, name_pp, params);
476  }
477 }
Factory & getFactory()
T & set(const std::string &name, bool quiet_mode=false)
InputParameters getValidParams(const std::string &name) const
bool hasUserObject(const std::string &name) const
virtual FEProblemBase & getProblem()
virtual void addPostprocessor(const std::string &pp_name, const std::string &name, InputParameters &parameters)
const std::vector< BoundaryName > _inlet_boundaries
Boundaries with a flow inlet specified on them.

◆ addPressureCorrectionKernels()

void WCNSLinearFVFlowPhysics::addPressureCorrectionKernels ( )
private

Function adding kernels for the incompressible pressure correction equation.

Definition at line 221 of file WCNSLinearFVFlowPhysics.C.

Referenced by addFVKernels().

222 {
223  {
224  std::string kernel_type = "LinearFVPressureCorrectionDiffusion";
225  std::string kernel_name = prefix() + "p_diffusion";
226 
227  InputParameters params = getFactory().getValidParams(kernel_type);
228  assignBlocks(params, _blocks);
229  params.set<LinearVariableName>("variable") = _pressure_name;
230  params.set<MooseFunctorName>("diffusion_tensor") = "Ainv";
231  params.set<bool>("use_nonorthogonal_correction") = _non_orthogonal_correction;
232 
233  getProblem().addLinearFVKernel(kernel_type, kernel_name, params);
234  }
235  {
236  std::string kernel_type = "LinearFVDivergence";
237  std::string kernel_name = prefix() + "HbyA_divergence";
238 
239  InputParameters params = getFactory().getValidParams(kernel_type);
240  assignBlocks(params, _blocks);
241  params.set<LinearVariableName>("variable") = _pressure_name;
242  params.set<MooseFunctorName>("face_flux") = "HbyA";
243  params.set<bool>("force_boundary_execution") = true;
244 
245  getProblem().addLinearFVKernel(kernel_type, kernel_name, params);
246  }
247 }
std::string prefix() const
void assignBlocks(InputParameters &params, const std::vector< SubdomainName > &blocks) const
Factory & getFactory()
T & set(const std::string &name, bool quiet_mode=false)
InputParameters getValidParams(const std::string &name) const
const NonlinearVariableName _pressure_name
Pressure name.
std::vector< SubdomainName > _blocks
virtual FEProblemBase & getProblem()
const bool _non_orthogonal_correction
Whether to use the correction term for non-orthogonality.
virtual void addLinearFVKernel(const std::string &kernel_name, const std::string &name, InputParameters &parameters)

◆ addRhieChowUserObjects()

void WCNSLinearFVFlowPhysics::addRhieChowUserObjects ( )
overrideprivatevirtual

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

Implements WCNSFVFlowPhysicsBase.

Definition at line 650 of file WCNSLinearFVFlowPhysics.C.

Referenced by addUserObjects().

651 {
652  mooseAssert(dimension(), "0-dimension not supported");
653 
654  // First make sure that we only add this object once
655  // Potential cases:
656  // - there is a flow physics, and an advection one (UO should be added by one)
657  // - there is only an advection physics (UO should be created)
658  // - there are two advection physics on different blocks with set velocities (first one picks)
659  // Counting RC UOs defined on the same blocks seems to be the most fool proof option
660  std::vector<UserObject *> objs;
661  getProblem()
662  .theWarehouse()
663  .query()
664  .condition<AttribSystem>("UserObject")
665  .condition<AttribThread>(0)
666  .queryInto(objs);
667  unsigned int num_rc_uo = 0;
668  for (const auto & obj : objs)
669  if (dynamic_cast<RhieChowMassFlux *>(obj))
670  {
671  const auto rc_obj = dynamic_cast<RhieChowMassFlux *>(obj);
672  if (rc_obj->blocks() == _blocks)
673  num_rc_uo++;
674  // one of the RC user object is defined everywhere
675  else if (rc_obj->blocks().size() == 0 || _blocks.size() == 0)
676  num_rc_uo++;
677  }
678 
679  if (num_rc_uo)
680  return;
681 
682  const std::string u_names[3] = {"u", "v", "w"};
683  const auto object_type = "RhieChowMassFlux";
684 
685  auto params = getFactory().getValidParams(object_type);
686  assignBlocks(params, _blocks);
687  for (unsigned int d = 0; d < dimension(); ++d)
688  params.set<VariableName>(u_names[d]) = _velocity_names[d];
689 
690  params.set<VariableName>("pressure") = _pressure_name;
691  params.set<std::string>("p_diffusion_kernel") = prefix() + "p_diffusion";
692  params.set<MooseFunctorName>(NS::density) = _density_name;
693  params.set<MooseEnum>("pressure_projection_method") =
694  getParam<MooseEnum>("pressure_projection_method");
695  params.set<MooseEnum>("pressure_diffusion_interpolation") =
696  getParam<MooseEnum>("pressure_diffusion_interpolation");
697 
698  addUserObject(object_type, rhieChowUOName(), params);
699 }
std::string prefix() const
void addUserObject(const std::string &uo_type, const std::string &uo_name, InputParameters &params)
void assignBlocks(InputParameters &params, const std::vector< SubdomainName > &blocks) const
User object responsible for determining the face fluxes using the Rhie-Chow interpolation in a segreg...
Factory & getFactory()
const MooseFunctorName _density_name
Name of the density material property.
static const std::string density
Definition: NS.h:34
InputParameters getValidParams(const std::string &name) const
const NonlinearVariableName _pressure_name
Pressure name.
std::vector< SubdomainName > _blocks
unsigned int dimension() const
virtual FEProblemBase & getProblem()
TheWarehouse & theWarehouse() const
const std::vector< std::string > _velocity_names
Velocity names.
Query query()
const UserObjectName & rhieChowUOName() const
Return the name of the Rhie Chow user object.

◆ addSeparatorBC()

virtual void WCNSLinearFVFlowPhysics::addSeparatorBC ( )
inlineoverrideprivatevirtual

Implements WCNSFVFlowPhysicsBase.

Definition at line 60 of file WCNSLinearFVFlowPhysics.h.

60 {}

◆ addSolverVariables()

void WCNSLinearFVFlowPhysics::addSolverVariables ( )
overrideprivatevirtual

Implements WCNSFVFlowPhysicsBase.

Definition at line 130 of file WCNSLinearFVFlowPhysics.C.

131 {
132  if (!_has_flow_equations)
133  return;
134 
135  for (const auto d : make_range(dimension()))
138 
139  const std::vector<std::string> v_short = {"u", "v", "w"};
140 
141  // Check number of variables
142  if (_velocity_names.size() != dimension() && _velocity_names.size() != 3)
143  paramError("velocity_variable",
144  "The number of velocity variable names supplied to the NSFVAction is not " +
145  Moose::stringify(dimension()) + " (mesh dimension)" +
146  ((dimension() == 3) ? "" : " or 3!") + "\nVelocity variables " +
148 
149  // Velocities
150  for (const auto d : make_range(dimension()))
151  {
152  if (!shouldCreateVariable(_velocity_names[d], _blocks, /*error if aux*/ true))
153  reportPotentiallyMissedParameters({"system_names"}, "MooseLinearVariableFVReal");
154  else if (_define_variables)
155  {
156  std::string variable_type = "MooseLinearVariableFVReal";
157 
158  auto params = getFactory().getValidParams(variable_type);
159  assignBlocks(params, _blocks);
160  params.set<SolverSystemName>("solver_sys") = getSolverSystem(_velocity_names[d]);
161 
162  getProblem().addVariable(variable_type, _velocity_names[d], params);
163  }
164  else
165  paramError("velocity_variable",
166  "Variable (" + _velocity_names[d] +
167  ") supplied to the WCNSLinearFVFlowPhysics does not exist!");
168  }
169 
170  // Pressure
171  if (!shouldCreateVariable(_pressure_name, _blocks, /*error if aux*/ true))
172  reportPotentiallyMissedParameters({"system_names"}, "MooseLinearVariableFVReal");
173  else if (_define_variables)
174  {
175  const auto pressure_type = "MooseLinearVariableFVReal";
176 
177  auto params = getFactory().getValidParams(pressure_type);
178  assignBlocks(params, _blocks);
179  params.set<SolverSystemName>("solver_sys") = getSolverSystem(_pressure_name);
180 
181  getProblem().addVariable(pressure_type, _pressure_name, params);
182  }
183  else
184  paramError("pressure_variable",
185  "Variable (" + _pressure_name +
186  ") supplied to the WCNSLinearFVFlowPhysics does not exist!");
187 }
const bool _has_flow_equations
Boolean to keep track of whether the flow equations should be created.
void assignBlocks(InputParameters &params, const std::vector< SubdomainName > &blocks) const
bool shouldCreateVariable(const VariableName &var_name, const std::vector< SubdomainName > &blocks, const bool error_if_aux)
Factory & getFactory()
void paramError(const std::string &param, Args... args) const
InputParameters getValidParams(const std::string &name) const
void reportPotentiallyMissedParameters(const std::vector< std::string > &param_names, const std::string &object_type, const std::string &object_name="") const
const NonlinearVariableName _pressure_name
Pressure name.
std::vector< SubdomainName > _blocks
unsigned int dimension() const
virtual FEProblemBase & getProblem()
const SolverSystemName & getSolverSystem(unsigned int variable_index) const
const std::vector< std::string > _velocity_names
Velocity names.
std::string stringify(const T &t)
virtual void addVariable(const std::string &var_type, const std::string &var_name, InputParameters &params)
bool _define_variables
Whether to define variables if they do not exist.
IntRange< T > make_range(T beg, T end)
void saveSolverVariableName(const VariableName &var_name)

◆ addUserObjects()

void WCNSLinearFVFlowPhysics::addUserObjects ( )
overrideprivatevirtual

Implements WCNSFVFlowPhysicsBase.

Definition at line 642 of file WCNSLinearFVFlowPhysics.C.

643 {
644  mooseAssert(!_porous_medium_treatment, "Not implemented");
645  // Rhie Chow user object for interpolation velocities
647 }
virtual void addRhieChowUserObjects() override
Function which adds the RhieChow interpolator user objects for weakly and incompressible formulations...
const bool _porous_medium_treatment
Whether to use the porous medium treatment.

◆ addWallsBC()

void WCNSLinearFVFlowPhysics::addWallsBC ( )
overrideprivatevirtual

Implements WCNSFVFlowPhysicsBase.

Definition at line 559 of file WCNSLinearFVFlowPhysics.C.

560 {
561  const std::string u_names[3] = {"u", "v", "w"};
562  bool has_symmetry_bc = false;
563 
564  for (const auto & [boundary_name, momentum_wall_type] : _momentum_wall_types)
565  {
566  if (momentum_wall_type == "noslip")
567  {
568  const std::string bc_type = "LinearFVAdvectionDiffusionFunctorDirichletBC";
569  InputParameters params = getFactory().getValidParams(bc_type);
570  params.set<std::vector<BoundaryName>>("boundary") = {boundary_name};
571 
572  for (const auto d : make_range(dimension()))
573  {
574  params.set<LinearVariableName>("variable") = _velocity_names[d];
575  if (_momentum_wall_functors.count(boundary_name) == 0)
576  params.set<MooseFunctorName>("functor") = "0";
577  else
578  params.set<MooseFunctorName>("functor") = _momentum_wall_functors[boundary_name][d];
579 
580  getProblem().addLinearFVBC(bc_type, _velocity_names[d] + "_" + boundary_name, params);
581  }
582  }
583  else if (momentum_wall_type == "symmetry")
584  {
585  has_symmetry_bc = true;
586  {
587  const std::string bc_type = "LinearFVVelocitySymmetryBC";
588  InputParameters params = getFactory().getValidParams(bc_type);
589  params.set<std::vector<BoundaryName>>("boundary") = {boundary_name};
590  for (unsigned int d = 0; d < dimension(); ++d)
591  params.set<SolverVariableName>(u_names[d]) = _velocity_names[d];
592 
593  for (const auto d : make_range(dimension()))
594  {
595  params.set<LinearVariableName>("variable") = _velocity_names[d];
596  params.set<MooseEnum>("momentum_component") = NS::directions[d];
597 
598  getProblem().addLinearFVBC(bc_type, _velocity_names[d] + "_" + boundary_name, params);
599  }
600  }
601  {
602  const std::string bc_type = "LinearFVPressureSymmetryBC";
603  InputParameters params = getFactory().getValidParams(bc_type);
604  params.set<std::vector<BoundaryName>>("boundary") = {boundary_name};
605  params.set<LinearVariableName>("variable") = _pressure_name;
606  params.set<MooseFunctorName>("HbyA_flux") = "HbyA";
607  getProblem().addLinearFVBC(bc_type, _pressure_name + "_" + boundary_name, params);
608  }
609  }
610  else
611  mooseError("Unsupported wall boundary condition type: " + std::string(momentum_wall_type));
612  }
613 
614  if (getParam<bool>("pressure_two_term_bc_expansion"))
615  {
616  if (!has_symmetry_bc)
617  {
618  const std::string bc_type = "LinearFVExtrapolatedPressureBC";
619  InputParameters params = getFactory().getValidParams(bc_type);
620  params.set<std::vector<BoundaryName>>("boundary") = _wall_boundaries;
621  params.set<LinearVariableName>("variable") = _pressure_name;
622  params.set<bool>("use_two_term_expansion") = true;
624  bc_type, _pressure_name + "_extrapolation_" + Moose::stringify(_wall_boundaries), params);
625  }
626  else
627  for (const auto & [boundary_name, momentum_wall_type] : _momentum_wall_types)
628  if (momentum_wall_type != "symmetry")
629  {
630  const std::string bc_type = "LinearFVExtrapolatedPressureBC";
631  InputParameters params = getFactory().getValidParams(bc_type);
632  params.set<std::vector<BoundaryName>>("boundary") = {boundary_name};
633  params.set<LinearVariableName>("variable") = _pressure_name;
634  params.set<bool>("use_two_term_expansion") = true;
636  bc_type, _pressure_name + "_extrapolation_" + boundary_name, params);
637  }
638  }
639 }
Factory & getFactory()
T & set(const std::string &name, bool quiet_mode=false)
InputParameters getValidParams(const std::string &name) const
std::map< BoundaryName, std::vector< MooseFunctorName > > _momentum_wall_functors
Functors describing the momentum for each wall boundary.
const NonlinearVariableName _pressure_name
Pressure name.
const std::vector< BoundaryName > _wall_boundaries
Boundaries which define a wall (slip/noslip/etc.)
unsigned int dimension() const
static const std::string directions[3]
Definition: NS.h:23
virtual FEProblemBase & getProblem()
const std::vector< std::string > _velocity_names
Velocity names.
std::string stringify(const T &t)
std::map< BoundaryName, MooseEnum > _momentum_wall_types
Momentum wall boundary types.
virtual void addLinearFVBC(const std::string &fv_bc_name, const std::string &name, InputParameters &parameters)
IntRange< T > make_range(T beg, T end)
void mooseError(Args &&... args) const

◆ compressibility()

const MooseEnum& WCNSFVFlowPhysicsBase::compressibility ( ) const
inlineinherited

Return the compressibility of the flow equations selected.

Definition at line 53 of file WCNSFVFlowPhysicsBase.h.

53 { return _compressibility; }
const MooseEnum _compressibility
Compressibility type, can be compressible, incompressible or weakly-compressible. ...

◆ densityName()

const MooseFunctorName& WCNSFVFlowPhysicsBase::densityName ( ) const
inlineinherited

◆ dynamicViscosityName()

const MooseFunctorName& WCNSFVFlowPhysicsBase::dynamicViscosityName ( ) const
inlineinherited

◆ getAdditionalRMParams()

InputParameters NavierStokesPhysicsBase::getAdditionalRMParams ( ) const
overrideprotectedvirtualinherited

Parameters to change or add relationship managers.

Reimplemented from PhysicsBase.

Definition at line 56 of file NavierStokesPhysicsBase.C.

57 {
58  unsigned short necessary_layers = getParam<unsigned short>("ghost_layers");
59  necessary_layers = std::max(necessary_layers, getNumberAlgebraicGhostingLayersNeeded());
60 
61  // Just an object that has a ghost_layers parameter
62  const std::string kernel_type = "INSFVMixingLengthReynoldsStress";
63  InputParameters params = getFactory().getValidParams(kernel_type);
64  params.template set<unsigned short>("ghost_layers") = necessary_layers;
65 
66  return params;
67 }
Factory & getFactory()
InputParameters getValidParams(const std::string &name) const
virtual unsigned short getNumberAlgebraicGhostingLayersNeeded() const =0
Return the number of ghosting layers needed.

◆ getAxisymmetricRZBlocks()

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

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

Definition at line 539 of file WCNSFVFlowPhysicsBase.C.

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

540 {
541  std::vector<SubdomainName> rz_blocks;
542  const auto & mesh = getProblem().mesh();
543 
544  const bool use_all_blocks =
545  _blocks.empty() || allMeshBlocks(_blocks) ||
546  std::find(_blocks.begin(), _blocks.end(), "ANY_BLOCK_ID") != _blocks.end();
547 
548  std::vector<SubdomainID> block_ids;
549  if (use_all_blocks)
550  {
551  const auto & mesh_blocks = mesh.meshSubdomains();
552  block_ids.insert(block_ids.end(), mesh_blocks.begin(), mesh_blocks.end());
553  }
554  else
555  block_ids = mesh.getSubdomainIDs(_blocks);
556 
557  for (const auto subdomain_id : block_ids)
558  if (mesh.getCoordSystem(subdomain_id) == Moose::COORD_RZ)
559  {
560  auto name = mesh.getSubdomainName(subdomain_id);
561  if (name.empty())
562  name = Moose::stringify(subdomain_id);
563  rz_blocks.push_back(name);
564  }
565 
566  return rz_blocks;
567 }
MeshBase & mesh
bool allMeshBlocks(const std::vector< SubdomainName > &blocks) const
std::vector< SubdomainName > _blocks
virtual FEProblemBase & getProblem()
const std::string & name() const
std::string stringify(const T &t)
virtual MooseMesh & mesh() override

◆ getCoupledTurbulencePhysics()

const WCNSFVTurbulencePhysicsBase * WCNSFVFlowPhysicsBase::getCoupledTurbulencePhysics ( ) const
protectedinherited

Find the turbulence physics.

Definition at line 506 of file WCNSFVFlowPhysicsBase.C.

Referenced by WCNSFVFlowPhysicsBase::actOnAdditionalTasks().

507 {
508  // User passed it, just use that
509  if (isParamValid("coupled_turbulence_physics"))
510  return getCoupledPhysics<WCNSFVTurbulencePhysicsBase>(
511  getParam<PhysicsName>("coupled_turbulence_physics"));
512  // Look for any physics of the right type, and check the block restriction
513  else
514  {
515  const auto all_turbulence_physics = getCoupledPhysics<const WCNSFVTurbulencePhysicsBase>(true);
516  for (const auto physics : all_turbulence_physics)
517  {
519  physics->name(), physics->blocks(), /*error_if_not_identical=*/false))
520  return physics;
521  else if (_verbose)
522  mooseInfoRepeated("Detected Turbulence Physics '" + physics->name() +
523  "' with an incompatible block restriction. It will thus not be coupled "
524  "to this flow equations physics");
525  }
526  }
527  // Did not find one
528  return nullptr;
529 }
void mooseInfoRepeated(Args &&... args)
const bool _verbose
bool checkBlockRestrictionIdentical(const std::string &object_name, const std::vector< SubdomainName > &blocks, const bool error_if_not_identical=true) const
bool isParamValid(const std::string &name) const

◆ 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 480 of file WCNSFVFlowPhysicsBase.C.

481 {
482  if (short_name == NS::pressure)
483  return getPressureName();
484  else if (short_name == NS::velocity_x && dimension() > 0)
485  return getVelocityNames()[0];
486  else if (short_name == NS::velocity_y && dimension() > 1)
487  return getVelocityNames()[1];
488  else if (short_name == NS::velocity_z && dimension() > 2)
489  return getVelocityNames()[2];
490  else if (short_name == NS::temperature)
491  return getFluidTemperatureName();
492  else
493  mooseError("Short Variable name '", short_name, "' not recognized.");
494 }
const std::vector< std::string > & getVelocityNames() const
To interface with other Physics.
static const std::string velocity_z
Definition: NS.h:49
static const std::string velocity_x
Definition: NS.h:47
static const std::string temperature
Definition: NS.h:60
unsigned int dimension() const
const NonlinearVariableName & getFluidTemperatureName() const
static const std::string velocity_y
Definition: NS.h:48
static const std::string pressure
Definition: NS.h:57
void mooseError(Args &&... args) const
const NonlinearVariableName & getPressureName() const

◆ getFluidTemperatureName()

const NonlinearVariableName& WCNSFVFlowPhysicsBase::getFluidTemperatureName ( ) const
inlineinherited

Definition at line 48 of file WCNSFVFlowPhysicsBase.h.

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

48 { return _fluid_temperature_name; }
const NonlinearVariableName _fluid_temperature_name
Fluid temperature name.

◆ getFluxInletDirections()

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

Get the inlet direction if using a flux inlet.

Definition at line 89 of file WCNSFVFlowPhysicsBase.h.

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

89 { return _flux_inlet_directions; }
std::vector< Point > _flux_inlet_directions
Direction of each flux inlet. Indexing based on the number of flux boundaries.

◆ getFluxInletPPs()

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

Get the inlet flux postprocessor if using a flux inlet.

Definition at line 91 of file WCNSFVFlowPhysicsBase.h.

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

91 { return _flux_inlet_pps; }
std::vector< PostprocessorName > _flux_inlet_pps
Postprocessors describing the momentum inlet for each boundary. Indexing based on the number of flux ...

◆ getHydraulicSeparators()

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

Get the hydraulic separator boundaries.

Definition at line 81 of file WCNSFVFlowPhysicsBase.h.

Referenced by WCNSFVFluidHeatTransferPhysics::addEnergySeparatorBC().

81 { return _hydraulic_separators; }
const std::vector< BoundaryName > _hydraulic_separators
Hydraulic separator boundaries.

◆ getInletBoundaries()

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

◆ getLinearFrictionCoefName()

virtual MooseFunctorName WCNSLinearFVFlowPhysics::getLinearFrictionCoefName ( ) const
inlineoverrideprivatevirtual

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

Implements WCNSFVFlowPhysicsBase.

Definition at line 67 of file WCNSLinearFVFlowPhysics.h.

68  {
69  mooseError("Not implemented");
70  }
void mooseError(Args &&... args) const

◆ getMomentumAdvectionFaceInterpolationMethod()

const MooseEnum& WCNSFVFlowPhysicsBase::getMomentumAdvectionFaceInterpolationMethod ( ) const
inlineinherited

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

Definition at line 65 of file WCNSFVFlowPhysicsBase.h.

66  {
68  }
const MooseEnum _momentum_advection_interpolation
The momentum face interpolation method for being advected.

◆ getMomentumFaceInterpolationMethod()

const MooseEnum& WCNSFVFlowPhysicsBase::getMomentumFaceInterpolationMethod ( ) const
inlineinherited

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

Definition at line 70 of file WCNSFVFlowPhysicsBase.h.

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

71  {
73  }
const MooseEnum _momentum_face_interpolation
The momentum face interpolation method for stress terms.

◆ getNumberAlgebraicGhostingLayersNeeded()

unsigned short WCNSLinearFVFlowPhysics::getNumberAlgebraicGhostingLayersNeeded ( ) const
overrideprivatevirtual

Return the number of algebraic ghosting layers needed.

Reimplemented from WCNSFVFlowPhysicsBase.

Definition at line 734 of file WCNSLinearFVFlowPhysics.C.

735 {
736  return 1;
737 }

◆ getOutletBoundaries()

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

Get the outlet boundaries.

Definition at line 77 of file WCNSFVFlowPhysicsBase.h.

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

77 { return _outlet_boundaries; }
const std::vector< BoundaryName > _outlet_boundaries
Boundaries with a flow outlet specified on them.

◆ getPorosityFunctorName()

MooseFunctorName WCNSFVFlowPhysicsBase::getPorosityFunctorName ( const bool  smoothed) const
inherited

Definition at line 497 of file WCNSFVFlowPhysicsBase.C.

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

498 {
499  if (smoothed)
501  else
502  return _porosity_name;
503 }
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)

◆ getPressureName()

const NonlinearVariableName& WCNSFVFlowPhysicsBase::getPressureName ( ) const
inlineinherited

◆ getSuppliedUserObjects()

std::vector< UserObjectName > WCNSLinearFVFlowPhysics::getSuppliedUserObjects ( ) const
overridevirtual

Reimplemented from PhysicsBase.

Definition at line 702 of file WCNSLinearFVFlowPhysics.C.

703 {
704  return {rhieChowUOName()};
705 }
const UserObjectName & rhieChowUOName() const
Return the name of the Rhie Chow user object.

◆ getVelocityFaceInterpolationMethod()

const MooseEnum& WCNSFVFlowPhysicsBase::getVelocityFaceInterpolationMethod ( ) const
inlineinherited

Get the face interpolation method for velocity.

Definition at line 63 of file WCNSFVFlowPhysicsBase.h.

Referenced by WCNSFVTwoPhaseMixturePhysics::addAdvectionSlipTerm().

63 { return _velocity_interpolation; }
const MooseEnum _velocity_interpolation
The velocity face interpolation method for advecting other quantities.

◆ getVelocityNames()

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

◆ getWallBoundaries()

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

Get the wall boundaries.

Definition at line 79 of file WCNSFVFlowPhysicsBase.h.

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

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

◆ gravityVector()

RealVectorValue WCNSFVFlowPhysicsBase::gravityVector ( ) const
inlineinherited

Return the gravity vector.

Definition at line 57 of file WCNSFVFlowPhysicsBase.h.

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

57 { 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 WCNSFVTurbulencePhysics::addFlowTurbulenceKernels(), WCNSLinearFVTwoPhaseMixturePhysics::addFVKernels(), WCNSFVTwoPhaseMixturePhysics::addFVKernels(), and WCNSFVTurbulencePhysicsBase::retrieveCoupledPhysics().

37 { return _has_flow_equations; }
const bool _has_flow_equations
Boolean to keep track of whether the flow equations should be created.

◆ hasForchheimerFriction()

virtual bool WCNSLinearFVFlowPhysics::hasForchheimerFriction ( ) const
inlineoverrideprivatevirtual

Return whether a Forchheimer friction model is in use.

Implements WCNSFVFlowPhysicsBase.

Definition at line 62 of file WCNSLinearFVFlowPhysics.h.

62 { 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 156 of file WCNSFVFlowPhysicsBase.h.

Referenced by WCNSFVFlowPhysics::addWallsBC().

157  {
160  else
161  return false;
162  }
bool hasTurbulenceModel() const
Whether a turbulence model is in use.
const WCNSFVTurbulencePhysicsBase * _turbulence_physics
Can be set to a coupled turbulence physics.

◆ includeIsotropicStress()

bool WCNSFVFlowPhysicsBase::includeIsotropicStress ( ) const
inlineinherited

Whether to include the isotropic viscous stress contribution.

Definition at line 43 of file WCNSFVFlowPhysicsBase.h.

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

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

◆ includeSymmetrizedViscousStress()

bool WCNSFVFlowPhysicsBase::includeSymmetrizedViscousStress ( ) const
inlineinherited

Whether to include the symmetrized contribution in the viscous stress.

Definition at line 41 of file WCNSFVFlowPhysicsBase.h.

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

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

◆ initializePhysicsAdditional()

void WCNSLinearFVFlowPhysics::initializePhysicsAdditional ( )
overrideprotectedvirtual

Reimplemented from WCNSFVFlowPhysicsBase.

Definition at line 110 of file WCNSLinearFVFlowPhysics.C.

111 {
113  // TODO Add support for multi-system by either:
114  // - creating the problem in the Physics or,
115  // - checking that the right systems are being created
117  // TODO Ban all other nonlinear Physics for now
118 
119  // Fix the default system names if using a different dimension
120  if (!isParamSetByUser("system_name"))
121  {
122  if (dimension() == 1)
123  _system_names = {"u_system", "pressure_system"};
124  else if (dimension() == 2)
125  _system_names = {"u_system", "v_system", "pressure_system"};
126  }
127 }
virtual void initializePhysicsAdditional() override
unsigned int dimension() const
virtual FEProblemBase & getProblem()
void needSolutionState(unsigned int oldest_needed, Moose::SolutionIterationType iteration_type)
bool isParamSetByUser(const std::string &name) const
std::vector< SolverSystemName > _system_names

◆ inletBoundaryType()

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

Get the type of the inlet BC.

Definition at line 83 of file WCNSFVFlowPhysicsBase.h.

Referenced by WCNSFVFluidHeatTransferPhysics::addEnergyInletBC().

84  {
86  static_cast<int>(libmesh_map_find(_momentum_inlet_types, boundary_name)));
87  }
MomentumInletTypes
Definition: NS.h:215
std::map< BoundaryName, MooseEnum > _momentum_inlet_types
Momentum inlet boundary types.

◆ porousMediumTreatment()

bool WCNSFVFlowPhysicsBase::porousMediumTreatment ( ) const
inlineinherited

Return whether a porous medium treatment is applied.

Definition at line 55 of file WCNSFVFlowPhysicsBase.h.

55 { return _porous_medium_treatment; }
const bool _porous_medium_treatment
Whether to use the porous medium treatment.

◆ rhieChowUOName()

const UserObjectName & WCNSFVFlowPhysicsBase::rhieChowUOName ( ) const
inherited

Return the name of the Rhie Chow user object.

Definition at line 532 of file WCNSFVFlowPhysicsBase.C.

Referenced by WCNSFVTwoPhaseMixturePhysics::addAdvectionSlipTerm(), WCNSFVTurbulencePhysics::addAxisymmetricTurbulentViscousSource(), WCNSFVFlowPhysics::addAxisymmetricViscousSourceKernel(), WCNSFVFluidHeatTransferPhysics::addEnergyAdvectionKernels(), WCNSLinearFVFluidHeatTransferPhysics::addEnergyAdvectionKernels(), WCNSFVTurbulencePhysics::addFlowTurbulenceKernels(), WCNSFVFlowPhysics::addInletBC(), WCNSLinearFVTurbulencePhysics::addKEpsilonAdvection(), WCNSFVTurbulencePhysics::addKEpsilonAdvection(), WCNSFVFlowPhysics::addMassKernels(), WCNSFVFlowPhysics::addMomentumAdvectionKernels(), WCNSFVFlowPhysics::addMomentumBoussinesqKernels(), addMomentumFluxKernels(), WCNSFVFlowPhysics::addMomentumFrictionKernels(), WCNSFVFlowPhysics::addMomentumGravityKernels(), WCNSFVFlowPhysics::addMomentumPressureKernels(), WCNSFVFlowPhysics::addMomentumTimeKernels(), WCNSFVFlowPhysics::addMomentumViscousDissipationKernels(), WCNSFVFlowPhysics::addOutletBC(), WCNSLinearFVTwoPhaseMixturePhysics::addPhaseDriftFluxTerm(), WCNSFVTwoPhaseMixturePhysics::addPhaseDriftFluxTerm(), addRhieChowUserObjects(), WCNSFVScalarTransportPhysics::addScalarAdvectionKernels(), WCNSLinearFVScalarTransportPhysics::addScalarAdvectionKernels(), WCNSFVFlowPhysics::addSeparatorBC(), WCNSFVFlowPhysics::addWallsBC(), WCNSFVFlowPhysics::getSuppliedUserObjects(), and getSuppliedUserObjects().

533 {
534  mooseAssert(!_rc_uo_name.empty(), "The Rhie-Chow user-object name should be set!");
535  return _rc_uo_name;
536 }
UserObjectName _rc_uo_name
name of the Rhie Chow user object

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

34  {
35  return (parameters().get<std::string>("registered_identifier") == "Modules/NavierStokesFV");
36  }
const InputParameters & parameters() const

◆ validParams()

InputParameters WCNSLinearFVFlowPhysics::validParams ( )
static

Definition at line 27 of file WCNSLinearFVFlowPhysics.C.

28 {
30  params.addClassDescription(
31  "Define the Navier Stokes weakly-compressible equations with the linear "
32  "solver implementation of the SIMPLE scheme");
33  params.set<MooseEnum>("momentum_advection_interpolation") = NS::fvAdvectedInterpolationMethods();
34  params.addParam<InterpolationMethodName>(
35  "momentum_advection_interpolation_method_name",
36  "Name of an externally defined FVInterpolationMethod to use for momentum advection. When "
37  "provided, this overrides 'momentum_advection_interpolation'.");
38 
39  params.addParam<bool>(
40  "orthogonality_correction", false, "Whether to use orthogonality correction");
41  params.renameParam("orthogonality_correction", "use_nonorthogonal_correction", "");
42  params.addParam<MooseEnum>(
43  "pressure_diffusion_interpolation",
45  "The face interpolation method for Ainv in the pressure correction diffusion term.");
46  params.addParamNamesToGroup("pressure_diffusion_interpolation", "Numerical scheme");
47  params.set<unsigned short>("ghost_layers") = 1;
48 
49  // This will be adapted based on the dimension
50  params.set<std::vector<SolverSystemName>>("system_names") = {
51  "u_system", "v_system", "w_system", "pressure_system"};
52 
53  // Implemented in the executioner
54  params.suppressParameter<MooseEnum>("pinned_pressure_type");
55  params.suppressParameter<Point>("pinned_pressure_point");
56  params.suppressParameter<PostprocessorName>("pinned_pressure_value");
57 
58  // Not supported
59  params.suppressParameter<bool>("add_flow_equations");
60  params.set<bool>("porous_medium_treatment") = false;
61  params.suppressParameter<bool>("porous_medium_treatment");
62  params.set<MooseFunctorName>("porosity") = "1";
63  params.suppressParameter<MooseFunctorName>("porosity");
64  params.suppressParameter<MooseEnum>("mu_interp_method");
65  // Not needed
66  params.suppressParameter<bool>("add_flow_equations");
67  params.suppressParameter<MooseEnum>("preconditioning");
68 
69  // No other options so far
70  params.set<MooseEnum>("velocity_interpolation") = "rc";
71  params.suppressParameter<MooseEnum>("velocity_interpolation");
72 
73  // Rhie-Chow
74  params.transferParam<MooseEnum>(RhieChowMassFlux::validParams(), "pressure_projection_method");
75  params.addParamNamesToGroup("momentum_advection_interpolation_method_name", "Numerical scheme");
76 
77  return params;
78 }
void renameParam(const std::string &old_name, const std::string &new_name, const std::string &new_docstring)
void addParam(const std::string &name, const std::initializer_list< typename T::value_type > &value, const std::string &doc_string)
MooseEnum fvFaceInterpolationMethods()
Enum of the interpolation methods supported by FVInterpolationMethod objects.
Definition: NSFVUtils.C:85
T & set(const std::string &name, bool quiet_mode=false)
static InputParameters validParams()
void suppressParameter(const std::string &name)
static InputParameters validParams()
void transferParam(const InputParameters &source_param, const std::string &name, const std::string &new_name="", const std::string &new_description="")
MooseEnum fvAdvectedInterpolationMethods()
Enum of the advected interpolation methods supported by FVInterpolationMethod objects.
Definition: NSFVUtils.C:61
void addClassDescription(const std::string &doc_string)
void addParamNamesToGroup(const std::string &space_delim_names, const std::string group_name)

Member Data Documentation

◆ _add_rz_viscous_source

const bool WCNSFVFlowPhysicsBase::_add_rz_viscous_source
protectedinherited

Whether to automatically add the cylindrical viscous source term.

Definition at line 176 of file WCNSFVFlowPhysicsBase.h.

Referenced by WCNSFVFlowPhysicsBase::addAxisymmetricViscousSource(), and WCNSFVFlowPhysicsBase::addAxisymmetricViscousSourceEnabled().

◆ _compressibility

const MooseEnum WCNSFVFlowPhysicsBase::_compressibility
protectedinherited

◆ _define_variables

bool NavierStokesPhysicsBase::_define_variables
protectedinherited

◆ _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 200 of file WCNSFVFlowPhysicsBase.h.

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

◆ _density_name

const MooseFunctorName WCNSFVFlowPhysicsBase::_density_name
protectedinherited

◆ _dynamic_viscosity_name

const MooseFunctorName WCNSFVFlowPhysicsBase::_dynamic_viscosity_name
protectedinherited

◆ _flow_porosity_functor_name

MooseFunctorName WCNSFVFlowPhysicsBase::_flow_porosity_functor_name
protectedinherited

◆ _fluid_temperature_name

const NonlinearVariableName WCNSFVFlowPhysicsBase::_fluid_temperature_name
protectedinherited

◆ _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 246 of file WCNSFVFlowPhysicsBase.h.

Referenced by WCNSFVFlowPhysics::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 244 of file WCNSFVFlowPhysicsBase.h.

Referenced by WCNSFVFlowPhysics::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 221 of file WCNSFVFlowPhysicsBase.h.

Referenced by addMomentumFrictionKernels(), WCNSFVFlowPhysics::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 225 of file WCNSFVFlowPhysicsBase.h.

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

◆ _friction_types

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

◆ _has_flow_equations

const bool WCNSFVFlowPhysicsBase::_has_flow_equations
protectedinherited

◆ _hydraulic_separators

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

◆ _include_isotropic_viscous_stress

const bool WCNSFVFlowPhysicsBase::_include_isotropic_viscous_stress
protectedinherited

Whether to include the isotropic viscous stress contribution.

Definition at line 206 of file WCNSFVFlowPhysicsBase.h.

Referenced by WCNSFVFlowPhysicsBase::includeIsotropicStress().

◆ _include_symmetrized_viscous_stress

const bool WCNSFVFlowPhysicsBase::_include_symmetrized_viscous_stress
protectedinherited

Whether to include the symmetrized viscous stress contribution.

Definition at line 204 of file WCNSFVFlowPhysicsBase.h.

Referenced by WCNSFVFlowPhysicsBase::includeSymmetrizedViscousStress().

◆ _inlet_boundaries

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

◆ _momentum_advection_interpolation

const MooseEnum WCNSFVFlowPhysicsBase::_momentum_advection_interpolation
protectedinherited

The momentum face interpolation method for being advected.

Definition at line 213 of file WCNSFVFlowPhysicsBase.h.

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

◆ _momentum_face_interpolation

const MooseEnum WCNSFVFlowPhysicsBase::_momentum_face_interpolation
protectedinherited

The momentum face interpolation method for stress terms.

Definition at line 215 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 249 of file WCNSFVFlowPhysicsBase.h.

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

◆ _momentum_inlet_types

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

◆ _momentum_outlet_types

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

Momentum outlet boundary types.

Definition at line 239 of file WCNSFVFlowPhysicsBase.h.

Referenced by addOutletBC(), WCNSFVFlowPhysics::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 253 of file WCNSFVFlowPhysicsBase.h.

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

◆ _momentum_wall_types

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

Momentum wall boundary types.

Definition at line 241 of file WCNSFVFlowPhysicsBase.h.

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

◆ _non_orthogonal_correction

const bool WCNSLinearFVFlowPhysics::_non_orthogonal_correction
private

Whether to use the correction term for non-orthogonality.

Definition at line 75 of file WCNSLinearFVFlowPhysics.h.

Referenced by addMomentumFluxKernels(), and addPressureCorrectionKernels().

◆ _outlet_boundaries

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

Boundaries with a flow outlet specified on them.

Definition at line 230 of file WCNSFVFlowPhysicsBase.h.

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

◆ _porosity_name

const MooseFunctorName WCNSFVFlowPhysicsBase::_porosity_name
protectedinherited

◆ _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 251 of file WCNSFVFlowPhysicsBase.h.

Referenced by addOutletBC(), WCNSFVFlowPhysics::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 171 of file WCNSFVFlowPhysicsBase.h.

◆ _rc_uo_name

UserObjectName WCNSFVFlowPhysicsBase::_rc_uo_name
protectedinherited

name of the Rhie Chow user object

Definition at line 209 of file WCNSFVFlowPhysicsBase.h.

Referenced by WCNSFVFlowPhysicsBase::rhieChowUOName().

◆ _solve_for_dynamic_pressure

const bool WCNSFVFlowPhysicsBase::_solve_for_dynamic_pressure
protectedinherited

◆ _turbulence_physics

const WCNSFVTurbulencePhysicsBase* WCNSFVFlowPhysicsBase::_turbulence_physics
protectedinherited

Can be set to a coupled turbulence physics.

Definition at line 218 of file WCNSFVFlowPhysicsBase.h.

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

◆ _velocity_interpolation

const MooseEnum WCNSFVFlowPhysicsBase::_velocity_interpolation
protectedinherited

The velocity face interpolation method for advecting other quantities.

Definition at line 211 of file WCNSFVFlowPhysicsBase.h.

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

◆ _velocity_names

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

◆ _wall_boundaries

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

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

Definition at line 232 of file WCNSFVFlowPhysicsBase.h.

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


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