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 | List of all members
WCNSFVFlowPhysicsBase Class Referenceabstract

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

#include <WCNSFVFlowPhysicsBase.h>

Inheritance diagram for WCNSFVFlowPhysicsBase:
[legend]

Public Types

typedef DataFileName DataFileParameterType
 

Public Member Functions

 WCNSFVFlowPhysicsBase (const InputParameters &parameters)
 
bool hasFlowEquations () const
 Whether the physics is actually creating the flow equations. More...
 
const std::vector< std::string > & getVelocityNames () const
 To interface with other Physics. More...
 
const NonlinearVariableName & getPressureName () const
 
const NonlinearVariableName & getFluidTemperatureName () const
 
MooseFunctorName getPorosityFunctorName (const bool smoothed) const
 
const 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...
 
const std::vector< Point > & getFluxInletDirections () const
 Get the inlet direction if using a flux inlet. More...
 
const std::vector< PostprocessorName > & getFluxInletPPs () const
 Get the inlet flux postprocessor if using a flux inlet. More...
 
virtual MooseFunctorName getLinearFrictionCoefName () const =0
 Get the name of the linear friction coefficient. Returns an empty string if no friction. More...
 
virtual UserObjectName rhieChowUOName () const =0
 Return the name of the Rhie Chow user object. More...
 
unsigned short getNumberAlgebraicGhostingLayersNeeded () const override
 Return the number of algebraic ghosting layers needed. More...
 
virtual void act () override final
 
void addBlocks (const std::vector< SubdomainName > &blocks)
 
void addBlocksById (const std::vector< SubdomainID > &block_ids)
 
const std::vector< SubdomainName > & blocks () const
 
bool checkBlockRestrictionIdentical (const std::string &object_name, const std::vector< SubdomainName > &blocks, const bool error_if_not_identical=true) const
 
const T * getCoupledPhysics (const PhysicsName &phys_name, const bool allow_fail=false) const
 
const std::vector< T *> getCoupledPhysics (const bool allow_fail=false) const
 
unsigned int dimension () const
 
const 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
 
virtual const std::string & name () const
 
std::string typeAndName () const
 
std::string errorPrefix (const std::string &error_type) const
 
void callMooseError (std::string msg, const bool with_prefix) const
 
MooseObjectParameterName uniqueParameterName (const std::string &parameter_name) const
 
const InputParametersparameters () const
 
MooseObjectName uniqueName () const
 
const T & getParam (const std::string &name) const
 
std::vector< std::pair< T1, T2 > > getParam (const std::string &param1, const std::string &param2) const
 
const T * queryParam (const std::string &name) const
 
const T & getRenamedParam (const std::string &old_name, const std::string &new_name) const
 
getCheckedPointerParam (const std::string &name, const std::string &error_string="") const
 
bool isParamValid (const std::string &name) const
 
bool isParamSetByUser (const std::string &nm) const
 
void paramError (const std::string &param, Args... args) const
 
void paramWarning (const std::string &param, Args... args) const
 
void paramInfo (const std::string &param, Args... args) const
 
void connectControllableParams (const std::string &parameter, const std::string &object_type, const std::string &object_name, const std::string &object_parameter) const
 
void mooseError (Args &&... args) const
 
void mooseErrorNonPrefixed (Args &&... args) const
 
void mooseDocumentedError (const std::string &repo_name, const unsigned int issue_num, Args &&... args) const
 
void mooseWarning (Args &&... args) const
 
void mooseWarningNonPrefixed (Args &&... args) const
 
void mooseDeprecated (Args &&... args) const
 
void mooseInfo (Args &&... args) const
 
std::string getDataFileName (const std::string &param) const
 
std::string getDataFileNameByName (const std::string &relative_path) const
 
std::string getDataFilePath (const std::string &relative_path) const
 
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 ()
 

Public Attributes

const ConsoleStream _console
 

Static Public Attributes

static constexpr auto SYSTEM
 
static constexpr auto NAME
 

Protected Member Functions

virtual void initializePhysicsAdditional () override
 
virtual void actOnAdditionalTasks () override
 
virtual void addSolverVariables () override=0
 
virtual void addInitialConditions () override
 
virtual void addFVKernels () override=0
 
virtual void addFVBCs () override
 
virtual void addMaterials () override
 
virtual void addUserObjects () override=0
 
virtual void addPostprocessors () override
 
virtual void addMomentumTimeKernels ()=0
 Functions adding kernels for the flow momentum equations If the material properties are not constant, these can be used for weakly-compressible simulations (except the Boussinesq kernel) as well. More...
 
virtual void addMomentumPressureKernels ()=0
 
virtual void addMomentumGravityKernels ()=0
 
virtual void addMomentumFrictionKernels ()=0
 
virtual void addMomentumBoussinesqKernels ()=0
 
virtual void addInletBC ()=0
 Functions adding boundary conditions for the flow simulation. More...
 
virtual void addOutletBC ()=0
 
virtual void addWallsBC ()=0
 
virtual void addSeparatorBC ()=0
 
virtual bool hasForchheimerFriction () const =0
 Return whether a Forchheimer friction model is in use. 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...
 
virtual void addRhieChowUserObjects ()=0
 Function which adds the RhieChow interpolator user objects for weakly and incompressible formulations. 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 WCNSFVTurbulencePhysicsgetCoupledTurbulencePhysics () const
 Find the turbulence physics. More...
 
bool usingNavierStokesFVSyntax () const
 Detects if we are using the new Physics syntax or the old NavierStokesFV action. More...
 
InputParameters getAdditionalRMParams () const override
 Parameters to change or add relationship managers. More...
 
void assertParamDefined (const std::string &param) const
 
bool isTransient () const
 
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 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
 
bool addRelationshipManagers (Moose::RelationshipManagerType when_type, const InputParameters &moose_object_pars)
 
void associateWithParameter (const std::string &param_name, InputParameters &params) const
 
void associateWithParameter (const InputParameters &from_params, const std::string &param_name, InputParameters &params) const
 
const T & getMeshProperty (const std::string &data_name, const std::string &prefix)
 
const T & getMeshProperty (const std::string &data_name)
 
bool hasMeshProperty (const std::string &data_name, const std::string &prefix) const
 
bool hasMeshProperty (const std::string &data_name, const std::string &prefix) const
 
bool hasMeshProperty (const std::string &data_name) const
 
bool hasMeshProperty (const std::string &data_name) const
 
std::string meshPropertyName (const std::string &data_name) const
 
PerfID registerTimedSection (const std::string &section_name, const unsigned int level) const
 
PerfID registerTimedSection (const std::string &section_name, const unsigned int level, const std::string &live_message, const bool print_dots=true) const
 
std::string timedSectionName (const std::string &section_name) const
 
void checkParamsBothSetOrNotSet (const std::string &param1, const std::string &param2) const
 
void checkSecondParamSetOnlyIfFirstOneTrue (const std::string &param1, const std::string &param2) const
 
void checkSecondParamSetOnlyIfFirstOneSet (const std::string &param1, const std::string &param2) const
 
void checkSecondParamNotSetIfFirstOneSet (const std::string &param1, const std::string &param2) const
 
void checkVectorParamsSameLength (const std::string &param1, const std::string &param2) const
 
void checkVectorParamAndMultiMooseEnumLength (const std::string &param1, const std::string &param2) const
 
void checkTwoDVectorParamsSameLength (const std::string &param1, const std::string &param2) const
 
void checkVectorParamsNoOverlap (const std::vector< std::string > &param_vecs) const
 
void checkTwoDVectorParamsNoRespectiveOverlap (const std::vector< std::string > &param_vecs) const
 
void checkTwoDVectorParamInnerSameLengthAsOneDVector (const std::string &param1, const std::string &param2) const
 
void checkTwoDVectorParamMultiMooseEnumSameLength (const std::string &param1, const std::string &param2, const bool error_for_param2) const
 
void checkVectorParamNotEmpty (const std::string &param1) const
 
void checkVectorParamsSameLengthIfSet (const std::string &param1, const std::string &param2, const bool ignore_empty_default_param2=false) const
 
void checkVectorParamLengthSameAsCombinedOthers (const std::string &param1, const std::string &param2, const std::string &param3) const
 
void checkBlockwiseConsistency (const std::string &block_param_name, const std::vector< std::string > &parameter_names) const
 
bool parameterConsistent (const InputParameters &other_param, const std::string &param_name) const
 
void warnInconsistent (const InputParameters &parameters, const std::string &param_name) const
 
void errorDependentParameter (const std::string &param1, const std::string &value_not_set, const std::vector< std::string > &dependent_params) const
 
void errorInconsistentDependentParameter (const std::string &param1, const std::string &value_set, const std::vector< std::string > &dependent_params) const
 

Static Protected Member Functions

static std::string meshPropertyName (const std::string &data_name, const std::string &prefix)
 

Protected Attributes

const TagName _pressure_tag = "p_tag"
 Name of the vector to hold pressure momentum equation contributions. More...
 
const bool _has_flow_equations
 Boolean to keep track of whether the flow equations should be created. More...
 
const MooseEnum _compressibility
 Compressibility type, can be compressible, incompressible or weakly-compressible. More...
 
const bool _solve_for_dynamic_pressure
 Whether we are solving for the total or dynamic pressure. More...
 
const bool _porous_medium_treatment
 Whether to use the porous medium treatment. More...
 
const MooseFunctorName _porosity_name
 Name of the porosity functor. More...
 
MooseFunctorName _flow_porosity_functor_name
 Name of the porosity functor for the flow equations (if smoothed) More...
 
const std::vector< std::string > _velocity_names
 Velocity names. More...
 
const NonlinearVariableName _pressure_name
 Pressure name. More...
 
const NonlinearVariableName _fluid_temperature_name
 Fluid temperature name. More...
 
const MooseFunctorName _density_name
 Name of the density material property. More...
 
const MooseFunctorName _density_gravity_name
 Name of the density material property used for gravity and Boussinesq terms. More...
 
const MooseFunctorName _dynamic_viscosity_name
 Name of the dynamic viscosity material property. More...
 
const MooseEnum _velocity_interpolation
 The velocity face interpolation method for advecting other quantities. More...
 
const MooseEnum _momentum_advection_interpolation
 The momentum face interpolation method for being advected. More...
 
const MooseEnum _momentum_face_interpolation
 The momentum face interpolation method for stress terms. More...
 
const WCNSFVTurbulencePhysics_turbulence_physics
 Can be set to a coupled turbulence physics. More...
 
std::vector< std::vector< SubdomainName > > _friction_blocks
 Subdomains where we want to have volumetric friction. More...
 
std::vector< std::vector< std::string > > _friction_types
 The friction correlation types used for each block. More...
 
std::vector< std::vector< std::string > > _friction_coeffs
 The coefficients used for each item if friction type. More...
 
const std::vector< BoundaryName > _inlet_boundaries
 Boundaries with a flow inlet specified on them. More...
 
const std::vector< BoundaryName > _outlet_boundaries
 Boundaries with a flow outlet specified on them. More...
 
const std::vector< BoundaryName > _wall_boundaries
 Boundaries which define a wall (slip/noslip/etc.) More...
 
const std::vector< BoundaryName > _hydraulic_separators
 Hydraulic separator boundaries. More...
 
std::map< BoundaryName, MooseEnum_momentum_inlet_types
 Momentum inlet boundary types. More...
 
std::map< BoundaryName, MooseEnum_momentum_outlet_types
 Momentum outlet boundary types. More...
 
std::map< BoundaryName, MooseEnum_momentum_wall_types
 Momentum wall boundary types. More...
 
std::vector< PostprocessorName > _flux_inlet_pps
 Postprocessors describing the momentum inlet for each boundary. Indexing based on the number of flux boundaries. More...
 
std::vector< Point > _flux_inlet_directions
 Direction of each flux inlet. Indexing based on the number of flux boundaries. More...
 
std::map< BoundaryName, std::vector< MooseFunctorName > > _momentum_inlet_functors
 Functors describing the momentum inlet for each boundary. More...
 
std::map< BoundaryName, MooseFunctorName > _pressure_functors
 Functors describing the outlet pressure on each boundary. More...
 
std::map< BoundaryName, std::vector< MooseFunctorName > > _momentum_wall_functors
 Functors describing the momentum for each wall boundary. More...
 
bool _define_variables
 Whether to define variables if they do not exist. More...
 
std::vector< SolverSystemName > _system_names
 
std::vector< unsigned int_system_numbers
 
const bool _verbose
 
const MooseEnum_preconditioning
 
std::vector< SubdomainName > _blocks
 
std::string _registered_identifier
 
std::string _specific_task_name
 
std::set< std::string > _all_tasks
 
ActionWarehouse_awh
 
const std::string & _current_task
 
std::shared_ptr< MooseMesh > & _mesh
 
std::shared_ptr< MooseMesh > & _displaced_mesh
 
std::shared_ptr< FEProblemBase > & _problem
 
PerfID _act_timer
 
MooseApp_app
 
const std::string _type
 
const std::string _name
 
const InputParameters_pars
 
Factory_factory
 
ActionFactory_action_factory
 
MooseApp_pg_moose_app
 
const std::string _prefix
 
const Parallel::Communicator & _communicator
 

Detailed Description

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

Definition at line 29 of file WCNSFVFlowPhysicsBase.h.

Constructor & Destructor Documentation

◆ WCNSFVFlowPhysicsBase()

WCNSFVFlowPhysicsBase::WCNSFVFlowPhysicsBase ( const InputParameters parameters)

Definition at line 98 of file WCNSFVFlowPhysicsBase.C.

100  _has_flow_equations(getParam<bool>("add_flow_equations")),
101  _compressibility(getParam<MooseEnum>("compressibility")),
102  _solve_for_dynamic_pressure(getParam<bool>("solve_for_dynamic_pressure")),
103  _porous_medium_treatment(getParam<bool>("porous_medium_treatment")),
104  _porosity_name(getParam<MooseFunctorName>("porosity")),
107  isParamValid("velocity_variable")
108  ? getParam<std::vector<std::string>>("velocity_variable")
110  ? std::vector<std::string>(NS::superficial_velocity_vector,
112  : std::vector<std::string>(NS::velocity_vector, NS::velocity_vector + 3))),
113  _pressure_name(isParamValid("pressure_variable")
114  ? getParam<NonlinearVariableName>("pressure_variable")
115  : NS::pressure),
116  _fluid_temperature_name(isParamValid("fluid_temperature_variable")
117  ? getParam<NonlinearVariableName>("fluid_temperature_variable")
118  : NS::T_fluid),
119  _density_name(getParam<MooseFunctorName>("density")),
120  _density_gravity_name(isParamValid("density_gravity")
121  ? getParam<MooseFunctorName>("density_gravity")
122  : getParam<MooseFunctorName>("density")),
123  _dynamic_viscosity_name(getParam<MooseFunctorName>("dynamic_viscosity")),
124  _velocity_interpolation(getParam<MooseEnum>("velocity_interpolation")),
125  _momentum_advection_interpolation(getParam<MooseEnum>("momentum_advection_interpolation")),
126  _momentum_face_interpolation(getParam<MooseEnum>("momentum_face_interpolation")),
127  _friction_blocks(getParam<std::vector<std::vector<SubdomainName>>>("friction_blocks")),
128  _friction_types(getParam<std::vector<std::vector<std::string>>>("friction_types")),
129  _friction_coeffs(getParam<std::vector<std::vector<std::string>>>("friction_coeffs")),
130  _inlet_boundaries(getParam<std::vector<BoundaryName>>("inlet_boundaries")),
131  _outlet_boundaries(getParam<std::vector<BoundaryName>>("outlet_boundaries")),
132  _wall_boundaries(getParam<std::vector<BoundaryName>>("wall_boundaries")),
133  _hydraulic_separators(getParam<std::vector<BoundaryName>>("hydraulic_separator_sidesets")),
134  _flux_inlet_pps(getParam<std::vector<PostprocessorName>>("flux_inlet_pps")),
135  _flux_inlet_directions(getParam<std::vector<Point>>("flux_inlet_directions"))
136 {
137  // Inlet boundary parameter checking
138  checkSecondParamSetOnlyIfFirstOneSet("flux_inlet_pps", "flux_inlet_directions");
139  if (_flux_inlet_directions.size())
140  checkVectorParamsSameLengthIfSet<PostprocessorName, Point>("flux_inlet_pps",
141  "flux_inlet_directions");
142 
143  // Boussinesq parameters checks
144  checkSecondParamSetOnlyIfFirstOneTrue("boussinesq_approximation", "ref_temperature");
145  checkSecondParamSetOnlyIfFirstOneSet("gravity", "boussinesq_approximation");
146 
147  // Dynamic pressure parameter checks
148  if (_compressibility != "incompressible" && _solve_for_dynamic_pressure)
149  paramError("compressibility",
150  "Solving for dynamic pressure is only implemented for incompressible flow");
151 
152  // Boundary parameters checking
153  checkVectorParamAndMultiMooseEnumLength<BoundaryName>("inlet_boundaries", "momentum_inlet_types");
154  checkVectorParamAndMultiMooseEnumLength<BoundaryName>("outlet_boundaries",
155  "momentum_outlet_types");
156  checkVectorParamAndMultiMooseEnumLength<BoundaryName>("wall_boundaries", "momentum_wall_types");
158  std::vector<MooseFunctorName>,
159  PostprocessorName>(
160  "inlet_boundaries", "momentum_inlet_functors", "flux_inlet_pps");
161  checkVectorParamsNoOverlap<BoundaryName>(
162  {"inlet_boundaries", "outlet_boundaries", "wall_boundaries"});
163 
164  // Porous media parameters
165  checkSecondParamSetOnlyIfFirstOneTrue("porous_medium_treatment", "porosity");
166 
168  for (const auto & name : NS::velocity_vector)
169  {
170  const auto & it = std::find(_velocity_names.begin(), _velocity_names.end(), name);
171  if (it != _velocity_names.end())
172  paramError("velocity_variable",
173  "For porous medium simulations, functor name " + *it +
174  " is already reserved for the automatically-computed interstitial velocity. "
175  "Please choose another name for your external velocity variable!");
176  }
177 
178  // Friction parameter checks
179  if (_friction_blocks.size())
180  checkVectorParamsSameLength<std::vector<SubdomainName>, std::vector<std::string>>(
181  "friction_blocks", "friction_types");
182  checkTwoDVectorParamsSameLength<std::string, std::string>("friction_types", "friction_coeffs");
183 
184  // Create maps for boundary-restricted parameters
185  _momentum_inlet_types = Moose::createMapFromVectorAndMultiMooseEnum<BoundaryName>(
186  _inlet_boundaries, getParam<MultiMooseEnum>("momentum_inlet_types"));
187  _momentum_outlet_types = Moose::createMapFromVectorAndMultiMooseEnum<BoundaryName>(
188  _outlet_boundaries, getParam<MultiMooseEnum>("momentum_outlet_types"));
189  _momentum_wall_types = Moose::createMapFromVectorAndMultiMooseEnum<BoundaryName>(
190  _wall_boundaries, getParam<MultiMooseEnum>("momentum_wall_types"));
191  if (isParamSetByUser("momentum_inlet_functors"))
192  {
193  // Not all inlet boundary types require the specification of an inlet functor
194  std::vector<BoundaryName> inlet_boundaries_with_functors;
195  for (const auto & boundary : _inlet_boundaries)
196  if (libmesh_map_find(_momentum_inlet_types, boundary) == "fixed-velocity" ||
197  libmesh_map_find(_momentum_inlet_types, boundary) == "fixed-pressure")
198  inlet_boundaries_with_functors.push_back(boundary);
200  Moose::createMapFromVectors<BoundaryName, std::vector<MooseFunctorName>>(
201  inlet_boundaries_with_functors,
202  getParam<std::vector<std::vector<MooseFunctorName>>>("momentum_inlet_functors"));
203  }
204  if (isParamSetByUser("pressure_functors"))
205  {
206  // Not all outlet boundary types require the specification of an inlet functor
207  std::vector<BoundaryName> outlet_boundaries_with_functors;
208  for (const auto & boundary : _outlet_boundaries)
209  if (libmesh_map_find(_momentum_outlet_types, boundary) == "fixed-pressure-zero-gradient" ||
210  libmesh_map_find(_momentum_outlet_types, boundary) == "fixed-pressure")
211  outlet_boundaries_with_functors.push_back(boundary);
212  const auto & pressure_functors = getParam<std::vector<MooseFunctorName>>("pressure_functors");
213  if (outlet_boundaries_with_functors.size() != pressure_functors.size())
214  paramError("pressure_functors",
215  "Size (" + std::to_string(pressure_functors.size()) +
216  ") is not the same as the number of pressure outlet boundaries in "
217  "'fixed-pressure/fixed-pressure-zero-gradient' (size " +
218  std::to_string(outlet_boundaries_with_functors.size()) + ")");
219  _pressure_functors = Moose::createMapFromVectors<BoundaryName, MooseFunctorName>(
220  outlet_boundaries_with_functors, pressure_functors);
221  }
222 
223  if (isParamSetByUser("momentum_wall_functors"))
224  {
225  // Not all wall boundary types require the specification of an inlet functor
226  std::vector<BoundaryName> wall_boundaries_with_functors;
227  for (const auto & boundary : _wall_boundaries)
228  if (libmesh_map_find(_momentum_wall_types, boundary) == "noslip")
229  wall_boundaries_with_functors.push_back(boundary);
230  const auto & momentum_wall_functors =
231  getParam<std::vector<std::vector<MooseFunctorName>>>("momentum_wall_functors");
232  if (wall_boundaries_with_functors.size() != momentum_wall_functors.size())
233  paramError("momentum_wall_functors",
234  "Size (" + std::to_string(momentum_wall_functors.size()) +
235  ") is not the same as the number of momentum_wall wall boundaries with "
236  "no-slip boundary conditions ' (size " +
237  std::to_string(wall_boundaries_with_functors.size()) + ")");
238 
240  Moose::createMapFromVectors<BoundaryName, std::vector<MooseFunctorName>>(
241  wall_boundaries_with_functors, momentum_wall_functors);
242  }
243 }
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.
std::map< BoundaryName, MooseEnum > _momentum_inlet_types
Momentum inlet boundary types.
const std::vector< BoundaryName > _outlet_boundaries
Boundaries with a flow outlet specified on them.
const MooseFunctorName _density_name
Name of the density material property.
const MooseFunctorName _density_gravity_name
Name of the density material property used for gravity and Boussinesq terms.
std::map< BoundaryName, std::vector< MooseFunctorName > > _momentum_inlet_functors
Functors describing the momentum inlet for each boundary.
const MooseEnum _momentum_advection_interpolation
The momentum face interpolation method for being advected.
std::map< BoundaryName, std::vector< MooseFunctorName > > _momentum_wall_functors
Functors describing the momentum for each wall boundary.
const NonlinearVariableName _pressure_name
Pressure name.
const MooseFunctorName _porosity_name
Name of the porosity functor.
const bool _porous_medium_treatment
Whether to use the porous medium treatment.
virtual const std::string & name() const
const std::vector< BoundaryName > _wall_boundaries
Boundaries which define a wall (slip/noslip/etc.)
bool isParamValid(const std::string &name) const
void checkSecondParamSetOnlyIfFirstOneSet(const std::string &param1, const std::string &param2) const
void checkVectorParamsSameLength(const std::string &param1, const std::string &param2) const
void checkVectorParamLengthSameAsCombinedOthers(const std::string &param1, const std::string &param2, const std::string &param3) const
static const std::string T_fluid
Definition: NS.h:106
std::vector< std::vector< SubdomainName > > _friction_blocks
Subdomains where we want to have volumetric friction.
std::vector< PostprocessorName > _flux_inlet_pps
Postprocessors describing the momentum inlet for each boundary. Indexing based on the number of flux ...
std::map< BoundaryName, MooseEnum > _momentum_outlet_types
Momentum outlet boundary types.
static const std::string superficial_velocity_vector[3]
Definition: NS.h:54
const std::vector< std::string > _velocity_names
Velocity names.
const T & getParam(const std::string &name) const
NavierStokesPhysicsBase(const InputParameters &parameters)
void paramError(const std::string &param, Args... args) const
const MooseFunctorName _dynamic_viscosity_name
Name of the dynamic viscosity material property.
const bool _solve_for_dynamic_pressure
Whether we are solving for the total or dynamic pressure.
const MooseEnum _compressibility
Compressibility type, can be compressible, incompressible or weakly-compressible. ...
MooseFunctorName _flow_porosity_functor_name
Name of the porosity functor for the flow equations (if smoothed)
bool _define_variables
Whether to define variables if they do not exist.
bool isParamSetByUser(const std::string &nm) const
std::map< BoundaryName, MooseEnum > _momentum_wall_types
Momentum wall boundary types.
const NonlinearVariableName _fluid_temperature_name
Fluid temperature name.
const MooseEnum _momentum_face_interpolation
The momentum face interpolation method for stress terms.
const MooseEnum _velocity_interpolation
The velocity face interpolation method for advecting other quantities.
std::map< BoundaryName, MooseFunctorName > _pressure_functors
Functors describing the outlet pressure on each boundary.
static const std::string pressure
Definition: NS.h:56
const std::vector< BoundaryName > _hydraulic_separators
Hydraulic separator boundaries.
const InputParameters & parameters() const
const std::vector< BoundaryName > _inlet_boundaries
Boundaries with a flow inlet specified on them.
const std::string velocity_vector[3]
Definition: NS.h:49
std::vector< Point > _flux_inlet_directions
Direction of each flux inlet. Indexing based on the number of flux boundaries.
void checkSecondParamSetOnlyIfFirstOneTrue(const std::string &param1, const std::string &param2) const
std::vector< std::vector< std::string > > _friction_coeffs
The coefficients used for each item if friction type.

Member Function Documentation

◆ actOnAdditionalTasks()

void WCNSFVFlowPhysicsBase::actOnAdditionalTasks ( )
overrideprotectedvirtual

Reimplemented from PhysicsBase.

Definition at line 252 of file WCNSFVFlowPhysicsBase.C.

253 {
254  // Turbulence physics would not be initialized before this task
255  if (_current_task == "get_turbulence_physics")
257 }
const WCNSFVTurbulencePhysics * _turbulence_physics
Can be set to a coupled turbulence physics.
const std::string & _current_task
const WCNSFVTurbulencePhysics * getCoupledTurbulencePhysics() const
Find the turbulence physics.

◆ addFVBCs()

void WCNSFVFlowPhysicsBase::addFVBCs ( )
overrideprotectedvirtual

Reimplemented from PhysicsBase.

Definition at line 260 of file WCNSFVFlowPhysicsBase.C.

261 {
262  addInletBC();
263  addOutletBC();
264  addWallsBC();
265  addSeparatorBC();
266 }
virtual void addSeparatorBC()=0
virtual void addOutletBC()=0
virtual void addWallsBC()=0
virtual void addInletBC()=0
Functions adding boundary conditions for the flow simulation.

◆ addFVKernels()

virtual void WCNSFVFlowPhysicsBase::addFVKernels ( )
overrideprotectedpure virtual

Reimplemented from PhysicsBase.

Implemented in WCNSLinearFVFlowPhysics, and WCNSFVFlowPhysics.

◆ addInitialConditions()

void WCNSFVFlowPhysicsBase::addInitialConditions ( )
overrideprotectedvirtual

Reimplemented from PhysicsBase.

Definition at line 310 of file WCNSFVFlowPhysicsBase.C.

311 {
312  if (!_define_variables && parameters().isParamSetByUser("initial_velocity") &&
313  parameters().isParamSetByUser("velocity_variable") &&
314  getParam<std::vector<FunctionName>>("initial_velocity").size() != 0)
315  // TODO: Rework and remove this last statement once the NSFV action is removed
316  paramError("initial_velocity",
317  "Velocity is defined externally of WCNSFVFlowPhysicsBase, so should the inital "
318  "conditions");
319  if (!_define_variables && parameters().isParamSetByUser("initial_pressure") &&
320  parameters().isParamSetByUser("pressure_variable"))
321  paramError("initial_pressure",
322  "Pressure is defined externally of WCNSFVFlowPhysicsBase, so should the inital "
323  "condition");
324 
325  // Check dimension
326  if (getParam<std::vector<FunctionName>>("initial_velocity").size() != dimension() &&
327  getParam<std::vector<FunctionName>>("initial_velocity").size() != 3 &&
328  getParam<std::vector<FunctionName>>("initial_velocity").size() != 0)
329  // TODO: Rework and remove this last statement once the NSFV action is removed
330  paramError("initial_velocity",
331  "The number of velocity components in the " + type() + " initial condition is not " +
332  std::to_string(dimension()) + " or 3!");
333 
334  InputParameters params = getFactory().getValidParams("FunctionIC");
335  assignBlocks(params, _blocks);
336  auto vvalue = getParam<std::vector<FunctionName>>("initial_velocity");
337 
338  for (const auto d : make_range(dimension()))
339  {
340  params.set<VariableName>("variable") = _velocity_names[d];
341  params.set<FunctionName>("function") = vvalue[d];
342 
344  _blocks,
345  /*whether IC is a default*/ !isParamSetByUser("initial_velocity"),
346  /*error if already an IC*/ isParamSetByUser("initial_velocity")))
347  getProblem().addInitialCondition("FunctionIC", prefix() + _velocity_names[d] + "_ic", params);
348  }
349 
351  _blocks,
352  /*whether IC is a default*/ !isParamSetByUser("initial_pressure"),
353  /*error if already an IC*/ isParamSetByUser("initial_pressure")))
354  {
355  params.set<VariableName>("variable") = _pressure_name;
356  params.set<FunctionName>("function") = getParam<FunctionName>("initial_pressure");
357 
358  getProblem().addInitialCondition("FunctionIC", prefix() + _pressure_name + "_ic", params);
359  }
360 }
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.
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 void addInitialCondition(const std::string &ic_name, const std::string &name, InputParameters &parameters)
virtual FEProblemBase & getProblem()
const std::vector< std::string > _velocity_names
Velocity names.
const std::string & type() const
const T & getParam(const std::string &name) const
void paramError(const std::string &param, Args... args) const
bool _define_variables
Whether to define variables if they do not exist.
bool isParamSetByUser(const std::string &nm) const
IntRange< T > make_range(T beg, T end)
const InputParameters & parameters() const

◆ addInletBC()

virtual void WCNSFVFlowPhysicsBase::addInletBC ( )
protectedpure virtual

Functions adding boundary conditions for the flow simulation.

These are used for weakly-compressible simulations as well.

Implemented in WCNSFVFlowPhysics, and WCNSLinearFVFlowPhysics.

Referenced by addFVBCs().

◆ addMaterials()

void WCNSFVFlowPhysicsBase::addMaterials ( )
overrideprotectedvirtual

Reimplemented from PhysicsBase.

Definition at line 269 of file WCNSFVFlowPhysicsBase.C.

270 {
273  else
275 }
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.
virtual bool hasForchheimerFriction() const =0
Return whether a Forchheimer friction model is in use.

◆ addMomentumBoussinesqKernels()

virtual void WCNSFVFlowPhysicsBase::addMomentumBoussinesqKernels ( )
protectedpure virtual

◆ addMomentumFrictionKernels()

virtual void WCNSFVFlowPhysicsBase::addMomentumFrictionKernels ( )
protectedpure virtual

◆ addMomentumGravityKernels()

virtual void WCNSFVFlowPhysicsBase::addMomentumGravityKernels ( )
protectedpure virtual

◆ addMomentumPressureKernels()

virtual void WCNSFVFlowPhysicsBase::addMomentumPressureKernels ( )
protectedpure virtual

◆ addMomentumTimeKernels()

virtual void WCNSFVFlowPhysicsBase::addMomentumTimeKernels ( )
protectedpure virtual

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

Implemented in WCNSFVFlowPhysics, and WCNSLinearFVFlowPhysics.

◆ addNonPorousMediumSpeedMaterial()

void WCNSFVFlowPhysicsBase::addNonPorousMediumSpeedMaterial ( )
protected

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

Definition at line 295 of file WCNSFVFlowPhysicsBase.C.

Referenced by addMaterials().

296 {
297  const std::string class_name = "ADVectorMagnitudeFunctorMaterial";
298  InputParameters params = getFactory().getValidParams(class_name);
299  assignBlocks(params, _blocks);
300 
301  const std::vector<std::string> param_names{"x_functor", "y_functor", "z_functor"};
302  for (unsigned int dim_i = 0; dim_i < dimension(); ++dim_i)
303  params.set<MooseFunctorName>(param_names[dim_i]) = _velocity_names[dim_i];
304  params.set<MooseFunctorName>("vector_magnitude_name") = NS::speed;
305 
306  getProblem().addMaterial(class_name, prefix() + "ins_speed_material", params);
307 }
std::string prefix() const
void assignBlocks(InputParameters &params, const std::vector< SubdomainName > &blocks) const
Factory & getFactory()
static const std::string speed
Definition: NS.h:143
virtual void addMaterial(const std::string &material_name, const std::string &name, InputParameters &parameters)
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
virtual FEProblemBase & getProblem()
const std::vector< std::string > _velocity_names
Velocity names.

◆ addOutletBC()

virtual void WCNSFVFlowPhysicsBase::addOutletBC ( )
protectedpure virtual

Implemented in WCNSFVFlowPhysics, and WCNSLinearFVFlowPhysics.

Referenced by addFVBCs().

◆ addPorousMediumSpeedMaterial()

void WCNSFVFlowPhysicsBase::addPorousMediumSpeedMaterial ( )
protected

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

Definition at line 278 of file WCNSFVFlowPhysicsBase.C.

Referenced by addMaterials().

279 {
280  InputParameters params = getFactory().getValidParams("PINSFVSpeedFunctorMaterial");
281  assignBlocks(params, _blocks);
282 
283  for (unsigned int dim_i = 0; dim_i < dimension(); ++dim_i)
284  params.set<MooseFunctorName>(NS::superficial_velocity_vector[dim_i]) = _velocity_names[dim_i];
286  params.set<MooseFunctorName>(NS::porosity) = _flow_porosity_functor_name;
287  else
288  params.set<MooseFunctorName>(NS::porosity) = "1";
289  params.set<bool>("define_interstitial_velocity_components") = _porous_medium_treatment;
290 
291  getProblem().addMaterial("PINSFVSpeedFunctorMaterial", prefix() + "pins_speed_material", params);
292 }
std::string prefix() const
void assignBlocks(InputParameters &params, const std::vector< SubdomainName > &blocks) const
Factory & getFactory()
virtual void addMaterial(const std::string &material_name, const std::string &name, InputParameters &parameters)
T & set(const std::string &name, bool quiet_mode=false)
InputParameters getValidParams(const std::string &name) const
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:104
static const std::string superficial_velocity_vector[3]
Definition: NS.h:54
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 ( )
overrideprotectedvirtual

Reimplemented from PhysicsBase.

Definition at line 370 of file WCNSFVFlowPhysicsBase.C.

371 {
372  const auto momentum_inlet_types = getParam<MultiMooseEnum>("momentum_inlet_types");
373 
374  for (unsigned int bc_ind = 0; bc_ind < momentum_inlet_types.size(); ++bc_ind)
375  if (momentum_inlet_types[bc_ind] == "flux-mass" ||
376  momentum_inlet_types[bc_ind] == "flux-velocity")
377  {
378  const std::string pp_type = "AreaPostprocessor";
379  InputParameters params = getFactory().getValidParams(pp_type);
380  params.set<std::vector<BoundaryName>>("boundary") = {_inlet_boundaries[bc_ind]};
381  params.set<ExecFlagEnum>("execute_on") = EXEC_INITIAL;
382 
383  const auto name_pp = "area_pp_" + _inlet_boundaries[bc_ind];
384  if (!getProblem().hasUserObject(name_pp))
385  getProblem().addPostprocessor(pp_type, name_pp, params);
386  }
387 }
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.

◆ addRhieChowUserObjects()

virtual void WCNSFVFlowPhysicsBase::addRhieChowUserObjects ( )
protectedpure virtual

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

Implemented in WCNSFVFlowPhysics, and WCNSLinearFVFlowPhysics.

◆ addSeparatorBC()

virtual void WCNSFVFlowPhysicsBase::addSeparatorBC ( )
protectedpure virtual

Implemented in WCNSFVFlowPhysics, and WCNSLinearFVFlowPhysics.

Referenced by addFVBCs().

◆ addSolverVariables()

virtual void WCNSFVFlowPhysicsBase::addSolverVariables ( )
overrideprotectedpure virtual

Reimplemented from PhysicsBase.

Implemented in WCNSLinearFVFlowPhysics, and WCNSFVFlowPhysics.

◆ addUserObjects()

virtual void WCNSFVFlowPhysicsBase::addUserObjects ( )
overrideprotectedpure virtual

Reimplemented from PhysicsBase.

Implemented in WCNSLinearFVFlowPhysics, and WCNSFVFlowPhysics.

◆ addWallsBC()

virtual void WCNSFVFlowPhysicsBase::addWallsBC ( )
protectedpure virtual

Implemented in WCNSFVFlowPhysics, and WCNSLinearFVFlowPhysics.

Referenced by addFVBCs().

◆ compressibility()

const MooseEnum& WCNSFVFlowPhysicsBase::compressibility ( ) const
inline

Return the compressibility of the flow equations selected.

Definition at line 47 of file WCNSFVFlowPhysicsBase.h.

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

◆ densityName()

const MooseFunctorName& WCNSFVFlowPhysicsBase::densityName ( ) const
inline

◆ dynamicViscosityName()

const MooseFunctorName& WCNSFVFlowPhysicsBase::dynamicViscosityName ( ) const
inline

◆ getAdditionalRMParams()

InputParameters NavierStokesPhysicsBase::getAdditionalRMParams ( ) const
overrideprotectedvirtualinherited

Parameters to change or add relationship managers.

Reimplemented from PhysicsBase.

Definition at line 42 of file NavierStokesPhysicsBase.C.

43 {
44  unsigned short necessary_layers = getParam<unsigned short>("ghost_layers");
45  necessary_layers = std::max(necessary_layers, getNumberAlgebraicGhostingLayersNeeded());
46 
47  // Just an object that has a ghost_layers parameter
48  const std::string kernel_type = "INSFVMixingLengthReynoldsStress";
49  InputParameters params = getFactory().getValidParams(kernel_type);
50  params.template set<unsigned short>("ghost_layers") = necessary_layers;
51 
52  return params;
53 }
Factory & getFactory()
InputParameters getValidParams(const std::string &name) const
virtual unsigned short getNumberAlgebraicGhostingLayersNeeded() const =0
Return the number of ghosting layers needed.

◆ getCoupledTurbulencePhysics()

const WCNSFVTurbulencePhysics * WCNSFVFlowPhysicsBase::getCoupledTurbulencePhysics ( ) const
protected

Find the turbulence physics.

Definition at line 416 of file WCNSFVFlowPhysicsBase.C.

Referenced by actOnAdditionalTasks().

417 {
418  // User passed it, just use that
419  if (isParamValid("coupled_turbulence_physics"))
420  return getCoupledPhysics<WCNSFVTurbulencePhysics>(
421  getParam<PhysicsName>("coupled_flow_physics"));
422  // Look for any physics of the right type, and check the block restriction
423  else
424  {
425  const auto all_turbulence_physics = getCoupledPhysics<const WCNSFVTurbulencePhysics>(true);
426  for (const auto physics : all_turbulence_physics)
428  physics->name(), physics->blocks(), /*error_if_not_identical=*/false))
429  return physics;
430  }
431  // Did not find one
432  return nullptr;
433 }
bool isParamValid(const std::string &name) const
bool checkBlockRestrictionIdentical(const std::string &object_name, const std::vector< SubdomainName > &blocks, const bool error_if_not_identical=true) const

◆ getFlowVariableName()

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

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

Definition at line 390 of file WCNSFVFlowPhysicsBase.C.

391 {
392  if (short_name == NS::pressure)
393  return getPressureName();
394  else if (short_name == NS::velocity_x && dimension() > 0)
395  return getVelocityNames()[0];
396  else if (short_name == NS::velocity_y && dimension() > 1)
397  return getVelocityNames()[1];
398  else if (short_name == NS::velocity_z && dimension() > 2)
399  return getVelocityNames()[2];
400  else if (short_name == NS::temperature)
401  return getFluidTemperatureName();
402  else
403  mooseError("Short Variable name '", short_name, "' not recognized.");
404 }
const std::vector< std::string > & getVelocityNames() const
To interface with other Physics.
static const std::string velocity_z
Definition: NS.h:48
static const std::string velocity_x
Definition: NS.h:46
static const std::string temperature
Definition: NS.h:59
unsigned int dimension() const
const NonlinearVariableName & getFluidTemperatureName() const
static const std::string velocity_y
Definition: NS.h:47
static const std::string pressure
Definition: NS.h:56
void mooseError(Args &&... args) const
const NonlinearVariableName & getPressureName() const

◆ getFluidTemperatureName()

const NonlinearVariableName& WCNSFVFlowPhysicsBase::getFluidTemperatureName ( ) const
inline

Definition at line 42 of file WCNSFVFlowPhysicsBase.h.

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

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

◆ getFluxInletDirections()

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

Get the inlet direction if using a flux inlet.

Definition at line 77 of file WCNSFVFlowPhysicsBase.h.

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

77 { return _flux_inlet_directions; }
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
inline

Get the inlet flux postprocessor if using a flux inlet.

Definition at line 79 of file WCNSFVFlowPhysicsBase.h.

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

79 { return _flux_inlet_pps; }
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
inline

Get the hydraulic separator boundaries.

Definition at line 75 of file WCNSFVFlowPhysicsBase.h.

Referenced by WCNSFVFluidHeatTransferPhysics::addEnergySeparatorBC().

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

◆ getInletBoundaries()

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

◆ getLinearFrictionCoefName()

virtual MooseFunctorName WCNSFVFlowPhysicsBase::getLinearFrictionCoefName ( ) const
pure virtual

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

Implemented in WCNSLinearFVFlowPhysics, and WCNSFVFlowPhysics.

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

◆ getMomentumAdvectionFaceInterpolationMethod()

const MooseEnum& WCNSFVFlowPhysicsBase::getMomentumAdvectionFaceInterpolationMethod ( ) const
inline

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

Definition at line 59 of file WCNSFVFlowPhysicsBase.h.

60  {
62  }
const MooseEnum _momentum_advection_interpolation
The momentum face interpolation method for being advected.

◆ getMomentumFaceInterpolationMethod()

const MooseEnum& WCNSFVFlowPhysicsBase::getMomentumFaceInterpolationMethod ( ) const
inline

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

Definition at line 64 of file WCNSFVFlowPhysicsBase.h.

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

65  {
67  }
const MooseEnum _momentum_face_interpolation
The momentum face interpolation method for stress terms.

◆ getNumberAlgebraicGhostingLayersNeeded()

unsigned short WCNSFVFlowPhysicsBase::getNumberAlgebraicGhostingLayersNeeded ( ) const
overridevirtual

◆ getOutletBoundaries()

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

Get the outlet boundaries.

Definition at line 71 of file WCNSFVFlowPhysicsBase.h.

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

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

Definition at line 407 of file WCNSFVFlowPhysicsBase.C.

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

408 {
409  if (smoothed)
411  else
412  return _porosity_name;
413 }
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
inline

Definition at line 41 of file WCNSFVFlowPhysicsBase.h.

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

41 { return _pressure_name; }
const NonlinearVariableName _pressure_name
Pressure name.

◆ getVelocityFaceInterpolationMethod()

const MooseEnum& WCNSFVFlowPhysicsBase::getVelocityFaceInterpolationMethod ( ) const
inline

Get the face interpolation method for velocity.

Definition at line 57 of file WCNSFVFlowPhysicsBase.h.

Referenced by WCNSFVTwoPhaseMixturePhysics::addAdvectionSlipTerm().

57 { 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
inline

◆ getWallBoundaries()

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

Get the wall boundaries.

Definition at line 73 of file WCNSFVFlowPhysicsBase.h.

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

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

◆ gravityVector()

RealVectorValue WCNSFVFlowPhysicsBase::gravityVector ( ) const
inline

Return the gravity vector.

Definition at line 51 of file WCNSFVFlowPhysicsBase.h.

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

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

◆ hasFlowEquations()

bool WCNSFVFlowPhysicsBase::hasFlowEquations ( ) const
inline

Whether the physics is actually creating the flow equations.

Definition at line 37 of file WCNSFVFlowPhysicsBase.h.

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

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

◆ hasForchheimerFriction()

virtual bool WCNSFVFlowPhysicsBase::hasForchheimerFriction ( ) const
protectedpure virtual

Return whether a Forchheimer friction model is in use.

Implemented in WCNSFVFlowPhysics, and WCNSLinearFVFlowPhysics.

Referenced by addMaterials().

◆ hasTurbulencePhysics()

bool WCNSFVFlowPhysicsBase::hasTurbulencePhysics ( ) const
inlineprotected

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

Definition at line 131 of file WCNSFVFlowPhysicsBase.h.

Referenced by WCNSFVFlowPhysics::addWallsBC().

132  {
135  else
136  return false;
137  }
const WCNSFVTurbulencePhysics * _turbulence_physics
Can be set to a coupled turbulence physics.
bool hasTurbulenceModel() const
Whether a turbulence model is in use.

◆ initializePhysicsAdditional()

void WCNSFVFlowPhysicsBase::initializePhysicsAdditional ( )
overrideprotectedvirtual

Reimplemented from PhysicsBase.

Reimplemented in WCNSLinearFVFlowPhysics.

Definition at line 246 of file WCNSFVFlowPhysicsBase.C.

Referenced by WCNSLinearFVFlowPhysics::initializePhysicsAdditional().

247 {
248  getProblem().needFV();
249 }
virtual void needFV() override
virtual FEProblemBase & getProblem()

◆ porousMediumTreatment()

bool WCNSFVFlowPhysicsBase::porousMediumTreatment ( ) const
inline

Return whether a porous medium treatment is applied.

Definition at line 49 of file WCNSFVFlowPhysicsBase.h.

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

◆ rhieChowUOName()

virtual UserObjectName WCNSFVFlowPhysicsBase::rhieChowUOName ( ) const
pure virtual

◆ usingNavierStokesFVSyntax()

bool NavierStokesPhysicsBase::usingNavierStokesFVSyntax ( ) const
inlineprotectedinherited

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

Definition at line 32 of file NavierStokesPhysicsBase.h.

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

◆ validParams()

InputParameters WCNSFVFlowPhysicsBase::validParams ( )
static

Definition at line 17 of file WCNSFVFlowPhysicsBase.C.

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

18 {
20  params.addClassDescription("Base class for Physics defining the Navier Stokes flow equations");
21 
23  params.addParam<bool>("add_flow_equations",
24  true,
25  "Whether to add the flow equations. This parameter is not necessary when "
26  "using the Physics syntax");
27 
28  // We pull in parameters from various flow objects. This helps make sure the parameters are
29  // spelled the same way and match the evolution of other objects.
30  // If we remove these objects, or change their parameters, these parameters should be updated
31  // Downstream actions must either implement all these options, or redefine the parameter with
32  // a restricted MooseEnum, or place an error in the constructor for unsupported configurations
33  // We mostly pull the boundary parameters from NSFV Action
34 
36  params.addParam<bool>(
37  "include_deviatoric_stress",
38  false,
39  "Whether to include the full expansion (the transposed term as well) of the stress tensor");
40 
41  // Momentum boundary conditions are important for advection problems as well
43 
44  // Specify the weakly compressible boundary flux information. They are used for specifying in flux
45  // boundary conditions for advection physics in WCNSFV
47  params.addParam<std::vector<std::vector<MooseFunctorName>>>(
48  "momentum_wall_functors",
49  {},
50  "Functors for each component of the velocity value on walls. This is only necessary for the "
51  "fixed-velocity momentum wall types.");
52 
53  // Most downstream physics implementations are valid for porous media too
54  // If yours is not, please remember to disable the 'porous_medium_treatment' parameter
55  params.transferParam<bool>(NSFVBase::validParams(), "porous_medium_treatment");
56  params.transferParam<MooseFunctorName>(NSFVBase::validParams(), "porosity");
57 
58  // New functor boundary conditions
59  params.deprecateParam("momentum_inlet_function", "momentum_inlet_functors", "01/01/2025");
60  params.deprecateParam("pressure_function", "pressure_functors", "01/01/2025");
61 
62  // Initialization parameters
63  params.transferParam<std::vector<FunctionName>>(NSFVBase::validParams(), "initial_velocity");
64  params.transferParam<FunctionName>(NSFVBase::validParams(), "initial_pressure");
65 
66  // Spatial discretization scheme
67  // Specify the numerical schemes for interpolations of velocity and pressure
68  params.transferParam<MooseEnum>(NSFVBase::validParams(), "velocity_interpolation");
69  params.transferParam<MooseEnum>(NSFVBase::validParams(), "momentum_advection_interpolation");
70  params.transferParam<MooseEnum>(NSFVBase::validParams(), "momentum_face_interpolation");
71  params.transferParam<bool>(NSFVBase::validParams(), "momentum_two_term_bc_expansion");
72  params.transferParam<bool>(NSFVBase::validParams(), "pressure_two_term_bc_expansion");
73  MooseEnum coeff_interp_method("average harmonic", "harmonic");
74  params.addParam<MooseEnum>("mu_interp_method",
75  coeff_interp_method,
76  "Switch that can select face interpolation method for the viscosity.");
77 
78  // Parameter groups
79  params.addParamNamesToGroup(
80  "velocity_variable pressure_variable initial_pressure initial_velocity", "Variables");
81  params.addParamNamesToGroup("density dynamic_viscosity", "Material properties");
82  params.addParamNamesToGroup("inlet_boundaries momentum_inlet_types momentum_inlet_functors",
83  "Inlet boundary conditions");
84  params.addParamNamesToGroup("outlet_boundaries momentum_outlet_types pressure_functors",
85  "Outlet boundary conditions");
86  params.addParamNamesToGroup("wall_boundaries momentum_wall_types momentum_wall_functors",
87  "Wall boundary conditions");
88  params.addParamNamesToGroup(
89  "include_deviatoric_stress velocity_interpolation momentum_advection_interpolation "
90  "momentum_two_term_bc_expansion pressure_two_term_bc_expansion mu_interp_method "
91  "momentum_face_interpolation",
92  "Numerical scheme");
93  params.addParamNamesToGroup("thermal_expansion", "Gravity treatment");
94 
95  return params;
96 }
static InputParameters validParams()
Definition: NSFVBase.C:368
void addParam(const std::string &name, const std::initializer_list< typename T::value_type > &value, const std::string &doc_string)
static InputParameters validParams()
static InputParameters commonNavierStokesFlowParams()
Definition: NSFVBase.C:17
static InputParameters commonMomentumBoundaryFluxesParams()
Definition: NSFVBase.C:162
static InputParameters commonMomentumEquationParams()
Definition: NSFVBase.C:55
void addClassDescription(const std::string &doc_string)
static InputParameters commonMomentumBoundaryTypesParams()
Definition: NSFVBase.C:138

Member Data Documentation

◆ _compressibility

const MooseEnum WCNSFVFlowPhysicsBase::_compressibility
protected

◆ _define_variables

bool NavierStokesPhysicsBase::_define_variables
protectedinherited

◆ _density_gravity_name

const MooseFunctorName WCNSFVFlowPhysicsBase::_density_gravity_name
protected

◆ _density_name

const MooseFunctorName WCNSFVFlowPhysicsBase::_density_name
protected

◆ _dynamic_viscosity_name

const MooseFunctorName WCNSFVFlowPhysicsBase::_dynamic_viscosity_name
protected

◆ _flow_porosity_functor_name

MooseFunctorName WCNSFVFlowPhysicsBase::_flow_porosity_functor_name
protected

◆ _fluid_temperature_name

const NonlinearVariableName WCNSFVFlowPhysicsBase::_fluid_temperature_name
protected

◆ _flux_inlet_directions

std::vector<Point> WCNSFVFlowPhysicsBase::_flux_inlet_directions
protected

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

Definition at line 210 of file WCNSFVFlowPhysicsBase.h.

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

◆ _flux_inlet_pps

std::vector<PostprocessorName> WCNSFVFlowPhysicsBase::_flux_inlet_pps
protected

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

Definition at line 208 of file WCNSFVFlowPhysicsBase.h.

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

◆ _friction_blocks

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

Subdomains where we want to have volumetric friction.

Definition at line 185 of file WCNSFVFlowPhysicsBase.h.

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

◆ _friction_coeffs

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

◆ _friction_types

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

◆ _has_flow_equations

const bool WCNSFVFlowPhysicsBase::_has_flow_equations
protected

◆ _hydraulic_separators

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

◆ _inlet_boundaries

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

Boundaries with a flow inlet specified on them.

Definition at line 192 of file WCNSFVFlowPhysicsBase.h.

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

◆ _momentum_advection_interpolation

const MooseEnum WCNSFVFlowPhysicsBase::_momentum_advection_interpolation
protected

The momentum face interpolation method for being advected.

Definition at line 177 of file WCNSFVFlowPhysicsBase.h.

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

◆ _momentum_face_interpolation

const MooseEnum WCNSFVFlowPhysicsBase::_momentum_face_interpolation
protected

The momentum face interpolation method for stress terms.

Definition at line 179 of file WCNSFVFlowPhysicsBase.h.

Referenced by getMomentumFaceInterpolationMethod().

◆ _momentum_inlet_functors

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

Functors describing the momentum inlet for each boundary.

Definition at line 213 of file WCNSFVFlowPhysicsBase.h.

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

◆ _momentum_inlet_types

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

Momentum inlet boundary types.

Definition at line 201 of file WCNSFVFlowPhysicsBase.h.

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

◆ _momentum_outlet_types

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

Momentum outlet boundary types.

Definition at line 203 of file WCNSFVFlowPhysicsBase.h.

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

◆ _momentum_wall_functors

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

Functors describing the momentum for each wall boundary.

Definition at line 217 of file WCNSFVFlowPhysicsBase.h.

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

◆ _momentum_wall_types

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

Momentum wall boundary types.

Definition at line 205 of file WCNSFVFlowPhysicsBase.h.

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

◆ _outlet_boundaries

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

Boundaries with a flow outlet specified on them.

Definition at line 194 of file WCNSFVFlowPhysicsBase.h.

Referenced by getOutletBoundaries(), and WCNSFVFlowPhysicsBase().

◆ _porosity_name

const MooseFunctorName WCNSFVFlowPhysicsBase::_porosity_name
protected

◆ _porous_medium_treatment

const bool WCNSFVFlowPhysicsBase::_porous_medium_treatment
protected

◆ _pressure_functors

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

Functors describing the outlet pressure on each boundary.

Definition at line 215 of file WCNSFVFlowPhysicsBase.h.

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

◆ _pressure_name

const NonlinearVariableName WCNSFVFlowPhysicsBase::_pressure_name
protected

◆ _pressure_tag

const TagName WCNSFVFlowPhysicsBase::_pressure_tag = "p_tag"
protected

Name of the vector to hold pressure momentum equation contributions.

Definition at line 143 of file WCNSFVFlowPhysicsBase.h.

◆ _solve_for_dynamic_pressure

const bool WCNSFVFlowPhysicsBase::_solve_for_dynamic_pressure
protected

Whether we are solving for the total or dynamic pressure.

Definition at line 151 of file WCNSFVFlowPhysicsBase.h.

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

◆ _turbulence_physics

const WCNSFVTurbulencePhysics* WCNSFVFlowPhysicsBase::_turbulence_physics
protected

Can be set to a coupled turbulence physics.

Definition at line 182 of file WCNSFVFlowPhysicsBase.h.

Referenced by actOnAdditionalTasks(), and hasTurbulencePhysics().

◆ _velocity_interpolation

const MooseEnum WCNSFVFlowPhysicsBase::_velocity_interpolation
protected

The velocity face interpolation method for advecting other quantities.

Definition at line 175 of file WCNSFVFlowPhysicsBase.h.

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

◆ _velocity_names

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

◆ _wall_boundaries

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

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

Definition at line 196 of file WCNSFVFlowPhysicsBase.h.

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


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