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)
 
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 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 addInitialConditions () override
 
virtual void addFVBCs () override
 
virtual void addMaterials () override
 
virtual void addPostprocessors () override
 
void addPorousMediumSpeedMaterial ()
 Add material to define the local speed in porous medium flows. More...
 
void addNonPorousMediumSpeedMaterial ()
 Add material to define the local speed with no porous medium treatment. More...
 
VariableName getFlowVariableName (const std::string &default_name) const
 Convenience routine to be able to retrieve the actual variable names from their default names. More...
 
bool hasTurbulencePhysics () const
 Whether a turbulence Physics has been coupled in, to know which viscosity to pick on symmetry boundary conditions. More...
 
const 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
 

Private Member Functions

virtual void addSolverVariables () 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...
 
UserObjectName rhieChowUOName () const override
 Return the name of the Rhie Chow user object. More...
 
unsigned short getNumberAlgebraicGhostingLayersNeeded () const override
 Return the number of algebraic ghosting layers needed. More...
 

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 63 of file WCNSLinearFVFlowPhysics.C.

65  _non_orthogonal_correction(getParam<bool>("orthogonality_correction"))
66 {
68  paramError("porous_medium_treatment", "Porous media unsupported");
70  mooseError("Not supported");
71 
72  if (_hydraulic_separators.size())
73  paramError("hydraulic_separator_sidesets",
74  "Flow separators are not supported yet for linearFV!");
75  if (getParam<bool>("pin_pressure"))
76  paramError("pin_pressure",
77  "Pressure pinning is implemented in the executioner for the linear finite volume "
78  "segregated solves");
79 }
const bool _has_flow_equations
Boolean to keep track of whether the flow equations should be created.
const bool _porous_medium_treatment
Whether to use the porous medium treatment.
void paramError(const std::string &param, Args... args) const
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.
const InputParameters & parameters() const
WCNSFVFlowPhysicsBase(const InputParameters &parameters)

Member Function Documentation

◆ actOnAdditionalTasks()

void WCNSFVFlowPhysicsBase::actOnAdditionalTasks ( )
overrideprotectedvirtualinherited

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.

◆ addFunctorMaterials()

void WCNSLinearFVFlowPhysics::addFunctorMaterials ( )
overrideprivatevirtual

Reimplemented from PhysicsBase.

Definition at line 615 of file WCNSLinearFVFlowPhysics.C.

616 {
617  if (parameters().isParamValid("gravity"))
618  {
619  const auto gravity_vector = getParam<RealVectorValue>("gravity");
620  const std::vector<std::string> comp_axis({"x", "y", "z"});
621  for (const auto d : make_range(dimension()))
622  if (gravity_vector(d) != 0)
623  {
624  // Add rho * g functor for each relevant direction
625  // TODO: we could avoid using an AD functor material for non-AD density functor
626  auto params = getFactory().getValidParams("ADParsedFunctorMaterial");
627  assignBlocks(params, _blocks);
628  params.set<std::string>("expression") =
629  _density_gravity_name + " * " + std::to_string(gravity_vector(d));
631  params.set<std::vector<std::string>>("functor_names") = {_density_gravity_name};
632  params.set<std::string>("property_name") = "rho_g_" + comp_axis[d];
633  // We don't output this helper material
635  "ADParsedFunctorMaterial", prefix() + "gravity_helper_" + comp_axis[d], params);
636  }
637  }
638 }
std::string prefix() const
bool parsesToReal(const std::string &input)
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)
InputParameters getValidParams(const std::string &name) const
std::vector< SubdomainName > _blocks
unsigned int dimension() const
bool isParamValid(const std::string &name) const
virtual FEProblemBase & getProblem()
IntRange< T > make_range(T beg, T end)
const InputParameters & parameters() const

◆ addFVBCs()

void WCNSFVFlowPhysicsBase::addFVBCs ( )
overrideprotectedvirtualinherited

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

void WCNSLinearFVFlowPhysics::addFVKernels ( )
overrideprivatevirtual

Implements WCNSFVFlowPhysicsBase.

Definition at line 162 of file WCNSLinearFVFlowPhysics.C.

163 {
164  if (!_has_flow_equations)
165  return;
166 
167  // Pressure correction equation: divergence of momentum
169 
170  // Momentum equation: time derivative
171  if (isTransient())
173 
174  // Momentum equation: flux terms
176 
177  // Momentum equation: pressure term
179 
180  // Momentum equation: friction term
181  if (_friction_types.size())
183 
184  // Momentum equation: gravity source term
186 
187  // Momentum equation: boussinesq approximation
188  if (getParam<bool>("boussinesq_approximation"))
190 }
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 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()

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 386 of file WCNSLinearFVFlowPhysics.C.

387 {
388  // Check the size of the BC parameters
389  unsigned int num_velocity_functor_inlets = 0;
390  for (const auto & [bdy, momentum_inlet_type] : _momentum_inlet_types)
391  if (momentum_inlet_type == "fixed-velocity" || momentum_inlet_type == "fixed-pressure")
392  num_velocity_functor_inlets++;
393 
394  if (num_velocity_functor_inlets != _momentum_inlet_functors.size())
395  paramError("momentum_inlet_functors",
396  "Size (" + std::to_string(_momentum_inlet_functors.size()) +
397  ") is not the same as the number of entries in the momentum_inlet_types "
398  "subvector for fixed-velocities/pressures functors (size " +
399  std::to_string(num_velocity_functor_inlets) + ")");
400 
401  unsigned int velocity_pressure_counter = 0;
402  for (const auto & [inlet_bdy, momentum_inlet_type] : _momentum_inlet_types)
403  {
404  if (momentum_inlet_type == "fixed-velocity")
405  {
406  const std::string bc_type = "LinearFVAdvectionDiffusionFunctorDirichletBC";
407  InputParameters params = getFactory().getValidParams(bc_type);
408  params.set<std::vector<BoundaryName>>("boundary") = {inlet_bdy};
409  if (_momentum_inlet_functors.size() < velocity_pressure_counter + 1)
410  paramError("momentum_inlet_functors",
411  "More non-flux inlets than inlet functors (" +
412  std::to_string(_momentum_inlet_functors.size()) + ")");
413 
414  // Check that enough functors have been provided for the dimension of the problem
415  const auto momentum_functors = libmesh_map_find(_momentum_inlet_functors, inlet_bdy);
416  if (momentum_functors.size() < dimension())
417  paramError("momentum_inlet_functors",
418  "Subvector for boundary '" + inlet_bdy + "' (size " +
419  std::to_string(momentum_functors.size()) +
420  ") is not the same size as the number of dimensions of the physics (" +
421  std::to_string(dimension()) + ")");
422 
423  for (const auto d : make_range(dimension()))
424  {
425  params.set<LinearVariableName>("variable") = _velocity_names[d];
426  params.set<MooseFunctorName>("functor") = momentum_functors[d];
427 
428  getProblem().addLinearFVBC(bc_type, _velocity_names[d] + "_" + inlet_bdy, params);
429  }
430  ++velocity_pressure_counter;
431 
432  // Add the two term BC expansion for pressure if requested
433  if (getParam<bool>("pressure_two_term_bc_expansion"))
434  {
435  const std::string bc_type = "LinearFVExtrapolatedPressureBC";
436  InputParameters params = getFactory().getValidParams(bc_type);
437  params.set<std::vector<BoundaryName>>("boundary") = {inlet_bdy};
438  params.set<LinearVariableName>("variable") = _pressure_name;
439  params.set<bool>("use_two_term_expansion") = true;
440  getProblem().addLinearFVBC(bc_type,
441  _pressure_name + "_extrapolation_inlet_" +
442  Moose::stringify(inlet_bdy),
443  params);
444  }
445  }
446  else if (momentum_inlet_type == "fixed-pressure")
447  {
448  const std::string bc_type = "LinearFVAdvectionDiffusionFunctorDirichletBC";
449  InputParameters params = getFactory().getValidParams(bc_type);
450  params.set<LinearVariableName>("variable") = _pressure_name;
451  if (_momentum_inlet_functors.size() < velocity_pressure_counter + 1)
452  paramError("momentum_inlet_functors",
453  "More non-flux inlets than inlet functors (" +
454  std::to_string(_momentum_inlet_functors.size()) + ")");
455 
456  params.set<MooseFunctorName>("functor") =
457  libmesh_map_find(_momentum_inlet_functors, inlet_bdy)[0];
458  params.set<std::vector<BoundaryName>>("boundary") = {inlet_bdy};
459 
460  getProblem().addLinearFVBC(bc_type, _pressure_name + "_" + inlet_bdy, params);
461  ++velocity_pressure_counter;
462  }
463  else
464  mooseError("Unsupported inlet boundary condition type: ", momentum_inlet_type);
465  }
466 }
Factory & getFactory()
std::map< BoundaryName, MooseEnum > _momentum_inlet_types
Momentum inlet boundary types.
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.
void paramError(const std::string &param, Args... args) const
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 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()

void WCNSLinearFVFlowPhysics::addMomentumBoussinesqKernels ( )
overrideprivatevirtual

Implements WCNSFVFlowPhysicsBase.

Definition at line 359 of file WCNSLinearFVFlowPhysics.C.

Referenced by addFVKernels().

360 {
361  if (_compressibility == "weakly-compressible")
362  paramError("boussinesq_approximation",
363  "We cannot use boussinesq approximation while running in weakly-compressible mode!");
364 
365  std::string kernel_type = "LinearFVMomentumBoussinesq";
366  std::string kernel_name = prefix() + "ins_momentum_boussinesq_";
367 
368  InputParameters params = getFactory().getValidParams(kernel_type);
369  assignBlocks(params, _blocks);
370  params.set<VariableName>(NS::T_fluid) = _fluid_temperature_name;
371  params.set<MooseFunctorName>(NS::density) = _density_gravity_name;
372  params.set<RealVectorValue>("gravity") = getParam<RealVectorValue>("gravity");
373  params.set<Real>("ref_temperature") = getParam<Real>("ref_temperature");
374  params.set<MooseFunctorName>("alpha_name") = getParam<MooseFunctorName>("thermal_expansion");
375 
376  for (const auto d : make_range(dimension()))
377  {
378  params.set<MooseEnum>("momentum_component") = NS::directions[d];
379  params.set<LinearVariableName>("variable") = _velocity_names[d];
380 
381  getProblem().addLinearFVKernel(kernel_type, kernel_name + NS::directions[d], params);
382  }
383 }
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.
T & set(const std::string &name, bool quiet_mode=false)
static const std::string density
Definition: NS.h:33
InputParameters getValidParams(const std::string &name) const
std::vector< SubdomainName > _blocks
unsigned int dimension() const
static const std::string directions[3]
Definition: NS.h:22
virtual FEProblemBase & getProblem()
static const std::string T_fluid
Definition: NS.h:106
const std::vector< std::string > _velocity_names
Velocity names.
void paramError(const std::string &param, Args... args) const
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 240 of file WCNSLinearFVFlowPhysics.C.

Referenced by addFVKernels().

241 {
242  const std::string u_names[3] = {"u", "v", "w"};
243  std::string kernel_type = "LinearWCNSFVMomentumFlux";
244  std::string kernel_name = prefix() + "ins_momentum_flux_";
245 
246  InputParameters params = getFactory().getValidParams(kernel_type);
247  assignBlocks(params, _blocks);
248  params.set<MooseFunctorName>(NS::mu) = _dynamic_viscosity_name;
249  params.set<UserObjectName>("rhie_chow_user_object") = rhieChowUOName();
250  params.set<MooseEnum>("advected_interp_method") = _momentum_advection_interpolation;
251  params.set<bool>("use_nonorthogonal_correction") = _non_orthogonal_correction;
252  params.set<bool>("use_deviatoric_terms") = getParam<bool>("include_deviatoric_stress");
253 
254  for (unsigned int i = 0; i < dimension(); ++i)
255  params.set<SolverVariableName>(u_names[i]) = _velocity_names[i];
256 
257  for (const auto d : make_range(dimension()))
258  {
259  params.set<LinearVariableName>("variable") = _velocity_names[d];
260  params.set<MooseEnum>("momentum_component") = NS::directions[d];
261 
262  getProblem().addLinearFVKernel(kernel_type, kernel_name + NS::directions[d], params);
263  }
264 }
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 MooseEnum _momentum_advection_interpolation
The momentum face interpolation method for being advected.
std::vector< SubdomainName > _blocks
unsigned int dimension() const
static const std::string directions[3]
Definition: NS.h:22
virtual FEProblemBase & getProblem()
static const std::string mu
Definition: NS.h:123
const std::vector< std::string > _velocity_names
Velocity names.
const MooseFunctorName _dynamic_viscosity_name
Name of the dynamic viscosity material property.
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)
IntRange< T > make_range(T beg, T end)
UserObjectName rhieChowUOName() const override
Return the name of the Rhie Chow user object.

◆ addMomentumFrictionKernels()

void WCNSLinearFVFlowPhysics::addMomentumFrictionKernels ( )
overrideprivatevirtual

Implements WCNSFVFlowPhysicsBase.

Definition at line 285 of file WCNSLinearFVFlowPhysics.C.

Referenced by addFVKernels().

286 {
287  unsigned int num_friction_blocks = _friction_blocks.size();
288  unsigned int num_used_blocks = num_friction_blocks ? num_friction_blocks : 1;
289 
290  const std::string kernel_type = "LinearFVMomentumFriction";
291  InputParameters params = getFactory().getValidParams(kernel_type);
292 
293  for (const auto block_i : make_range(num_used_blocks))
294  {
295  std::string block_name = "";
296  if (num_friction_blocks)
297  {
298  params.set<std::vector<SubdomainName>>("block") = _friction_blocks[block_i];
299  block_name = Moose::stringify(_friction_blocks[block_i]);
300  }
301  else
302  {
303  assignBlocks(params, _blocks);
304  block_name = std::to_string(block_i);
305  }
306 
307  for (const auto d : make_range(dimension()))
308  {
309  params.set<LinearVariableName>("variable") = _velocity_names[d];
310  params.set<MooseEnum>("momentum_component") = NS::directions[d];
311  for (unsigned int type_i = 0; type_i < _friction_types[block_i].size(); ++type_i)
312  {
313  const auto upper_name = MooseUtils::toUpper(_friction_types[block_i][type_i]);
314  if (upper_name == "DARCY")
315  {
316  params.set<MooseFunctorName>(NS::mu) = _dynamic_viscosity_name;
317  params.set<MooseFunctorName>("Darcy_name") = _friction_coeffs[block_i][type_i];
318  }
319  else
320  paramError("momentum_friction_types",
321  "Friction type '",
322  _friction_types[block_i][type_i],
323  "' is not implemented");
324  }
325 
326  getProblem().addLinearFVKernel(kernel_type,
327  prefix() + "momentum_friction_" + block_name + "_" +
328  NS::directions[d],
329  params);
330  }
331  }
332 }
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.
std::string toUpper(const std::string &name)
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:22
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:123
const std::vector< std::string > _velocity_names
Velocity names.
void paramError(const std::string &param, Args... args) const
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 335 of file WCNSLinearFVFlowPhysics.C.

Referenced by addFVKernels().

336 {
338  {
339  std::string kernel_type = "LinearFVSource";
340  std::string kernel_name = prefix() + "ins_momentum_gravity_";
341 
342  InputParameters params = getFactory().getValidParams(kernel_type);
343  assignBlocks(params, _blocks);
344  const auto gravity_vector = getParam<RealVectorValue>("gravity");
345  const std::vector<std::string> comp_axis({"x", "y", "z"});
346 
347  for (const auto d : make_range(dimension()))
348  if (gravity_vector(d) != 0)
349  {
350  params.set<MooseFunctorName>("source_density") = "rho_g_" + comp_axis[d];
351  params.set<LinearVariableName>("variable") = _velocity_names[d];
352 
353  getProblem().addLinearFVKernel(kernel_type, kernel_name + NS::directions[d], params);
354  }
355  }
356 }
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
static const std::string directions[3]
Definition: NS.h:22
bool isParamValid(const std::string &name) const
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)
const InputParameters & parameters() const

◆ addMomentumPressureKernels()

void WCNSLinearFVFlowPhysics::addMomentumPressureKernels ( )
overrideprivatevirtual

Implements WCNSFVFlowPhysicsBase.

Definition at line 267 of file WCNSLinearFVFlowPhysics.C.

Referenced by addFVKernels().

268 {
269  std::string kernel_type = "LinearFVMomentumPressure";
270  std::string kernel_name = prefix() + "ins_momentum_pressure_";
271 
272  InputParameters params = getFactory().getValidParams(kernel_type);
273  assignBlocks(params, _blocks);
274  params.set<VariableName>("pressure") = _pressure_name;
275 
276  for (const auto d : make_range(dimension()))
277  {
278  params.set<MooseEnum>("momentum_component") = NS::directions[d];
279  params.set<LinearVariableName>("variable") = _velocity_names[d];
280  getProblem().addLinearFVKernel(kernel_type, kernel_name + NS::directions[d], params);
281  }
282 }
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:22
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 222 of file WCNSLinearFVFlowPhysics.C.

Referenced by addFVKernels().

223 {
224  std::string kernel_type = "LinearFVTimeDerivative";
225  std::string kernel_name = prefix() + "ins_momentum_time";
226 
227  InputParameters params = getFactory().getValidParams(kernel_type);
228  assignBlocks(params, _blocks);
229  params.set<MooseFunctorName>("factor") = _density_name;
230 
231  for (const auto d : make_range(dimension()))
232  {
233  params.set<LinearVariableName>("variable") = _velocity_names[d];
234  if (shouldCreateTimeDerivative(_velocity_names[d], _blocks, /*error if already defined*/ false))
235  getProblem().addLinearFVKernel(kernel_type, kernel_name + "_" + NS::directions[d], params);
236  }
237 }
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:22
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 295 of file WCNSFVFlowPhysicsBase.C.

Referenced by WCNSFVFlowPhysicsBase::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()

void WCNSLinearFVFlowPhysics::addOutletBC ( )
overrideprivatevirtual

Implements WCNSFVFlowPhysicsBase.

Definition at line 469 of file WCNSLinearFVFlowPhysics.C.

470 {
471  // Check the BCs size
472  unsigned int num_pressure_outlets = 0;
473  for (const auto & [bdy, momentum_outlet_type] : _momentum_outlet_types)
474  if (momentum_outlet_type == "fixed-pressure" ||
475  momentum_outlet_type == "fixed-pressure-zero-gradient")
476  num_pressure_outlets++;
477 
478  if (num_pressure_outlets != _pressure_functors.size())
479  paramError("pressure_functors",
480  "Size (" + std::to_string(_pressure_functors.size()) +
481  ") is not the same as the number of pressure outlet boundaries in "
482  "'fixed-pressure/fixed-pressure-zero-gradient' (size " +
483  std::to_string(num_pressure_outlets) + ")");
484 
485  const std::string u_names[3] = {"u", "v", "w"};
486  for (const auto & [outlet_bdy, momentum_outlet_type] : _momentum_outlet_types)
487  {
488  // Zero tangeantial gradient condition on velocity
489  if (momentum_outlet_type == "zero-gradient" || momentum_outlet_type == "fixed-pressure" ||
490  momentum_outlet_type == "fixed-pressure-zero-gradient")
491  {
492  const std::string bc_type = "LinearFVAdvectionDiffusionOutflowBC";
493  InputParameters params = getFactory().getValidParams(bc_type);
494  params.set<std::vector<BoundaryName>>("boundary") = {outlet_bdy};
495  params.set<bool>("use_two_term_expansion") = getParam<bool>("momentum_two_term_bc_expansion");
496 
497  for (const auto d : make_range(dimension()))
498  {
499  params.set<LinearVariableName>("variable") = _velocity_names[d];
500  getProblem().addLinearFVBC(bc_type, _velocity_names[d] + "_" + outlet_bdy, params);
501  }
502  }
503 
504  // Fixed pressure condition, coming in the pressure correction equation
505  if (momentum_outlet_type == "fixed-pressure" ||
506  momentum_outlet_type == "fixed-pressure-zero-gradient")
507  {
508  const std::string bc_type = "LinearFVAdvectionDiffusionFunctorDirichletBC";
509  InputParameters params = getFactory().getValidParams(bc_type);
510  params.set<LinearVariableName>("variable") = _pressure_name;
511  params.set<MooseFunctorName>("functor") = libmesh_map_find(_pressure_functors, outlet_bdy);
512  params.set<std::vector<BoundaryName>>("boundary") = {outlet_bdy};
513 
514  getProblem().addLinearFVBC(bc_type, _pressure_name + "_" + outlet_bdy, params);
515  }
516  }
517 }
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.
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.
void paramError(const std::string &param, Args... args) const
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 278 of file WCNSFVFlowPhysicsBase.C.

Referenced by WCNSFVFlowPhysicsBase::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 ( )
overrideprotectedvirtualinherited

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.

◆ addPressureCorrectionKernels()

void WCNSLinearFVFlowPhysics::addPressureCorrectionKernels ( )
private

Function adding kernels for the incompressible pressure correction equation.

Definition at line 193 of file WCNSLinearFVFlowPhysics.C.

Referenced by addFVKernels().

194 {
195  {
196  std::string kernel_type = "LinearFVAnisotropicDiffusion";
197  std::string kernel_name = prefix() + "p_diffusion";
198 
199  InputParameters params = getFactory().getValidParams(kernel_type);
200  assignBlocks(params, _blocks);
201  params.set<LinearVariableName>("variable") = _pressure_name;
202  params.set<MooseFunctorName>("diffusion_tensor") = "Ainv";
203  params.set<bool>("use_nonorthogonal_correction") = _non_orthogonal_correction;
204 
205  getProblem().addLinearFVKernel(kernel_type, kernel_name, params);
206  }
207  {
208  std::string kernel_type = "LinearFVDivergence";
209  std::string kernel_name = prefix() + "HbyA_divergence";
210 
211  InputParameters params = getFactory().getValidParams(kernel_type);
212  assignBlocks(params, _blocks);
213  params.set<LinearVariableName>("variable") = _pressure_name;
214  params.set<MooseFunctorName>("face_flux") = "HbyA";
215  params.set<bool>("force_boundary_execution") = true;
216 
217  getProblem().addLinearFVKernel(kernel_type, kernel_name, params);
218  }
219 }
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 567 of file WCNSLinearFVFlowPhysics.C.

Referenced by addUserObjects().

568 {
569  mooseAssert(dimension(), "0-dimension not supported");
570 
571  // First make sure that we only add this object once
572  // Potential cases:
573  // - there is a flow physics, and an advection one (UO should be added by one)
574  // - there is only an advection physics (UO should be created)
575  // - there are two advection physics on different blocks with set velocities (first one picks)
576  // Counting RC UOs defined on the same blocks seems to be the most fool proof option
577  std::vector<UserObject *> objs;
578  getProblem()
579  .theWarehouse()
580  .query()
581  .condition<AttribSystem>("UserObject")
582  .condition<AttribThread>(0)
583  .queryInto(objs);
584  unsigned int num_rc_uo = 0;
585  for (const auto & obj : objs)
586  if (dynamic_cast<RhieChowMassFlux *>(obj))
587  {
588  const auto rc_obj = dynamic_cast<RhieChowMassFlux *>(obj);
589  if (rc_obj->blocks() == _blocks)
590  num_rc_uo++;
591  // one of the RC user object is defined everywhere
592  else if (rc_obj->blocks().size() == 0 || _blocks.size() == 0)
593  num_rc_uo++;
594  }
595 
596  if (num_rc_uo)
597  return;
598 
599  const std::string u_names[3] = {"u", "v", "w"};
600  const auto object_type = "RhieChowMassFlux";
601 
602  auto params = getFactory().getValidParams(object_type);
603  assignBlocks(params, _blocks);
604  for (unsigned int d = 0; d < dimension(); ++d)
605  params.set<VariableName>(u_names[d]) = _velocity_names[d];
606 
607  params.set<VariableName>("pressure") = _pressure_name;
608  params.set<std::string>("p_diffusion_kernel") = prefix() + "p_diffusion";
609  params.set<MooseFunctorName>(NS::density) = _density_name;
610 
611  getProblem().addUserObject(object_type, rhieChowUOName(), params);
612 }
std::string prefix() const
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:33
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.
virtual std::vector< std::shared_ptr< UserObject > > addUserObject(const std::string &user_object_name, const std::string &name, InputParameters &parameters)
Query query()
UserObjectName rhieChowUOName() const override
Return the name of the Rhie Chow user object.

◆ addSeparatorBC()

virtual void WCNSLinearFVFlowPhysics::addSeparatorBC ( )
inlineoverrideprivatevirtual

Implements WCNSFVFlowPhysicsBase.

Definition at line 57 of file WCNSLinearFVFlowPhysics.h.

57 {}

◆ addSolverVariables()

void WCNSLinearFVFlowPhysics::addSolverVariables ( )
overrideprivatevirtual

Implements WCNSFVFlowPhysicsBase.

Definition at line 102 of file WCNSLinearFVFlowPhysics.C.

103 {
104  if (!_has_flow_equations)
105  return;
106 
107  for (const auto d : make_range(dimension()))
110 
111  const std::vector<std::string> v_short = {"u", "v", "w"};
112 
113  // Check number of variables
114  if (_velocity_names.size() != dimension() && _velocity_names.size() != 3)
115  paramError("velocity_variable",
116  "The number of velocity variable names supplied to the NSFVAction is not " +
117  Moose::stringify(dimension()) + " (mesh dimension)" +
118  ((dimension() == 3) ? "" : " or 3!") + "\nVelocity variables " +
120 
121  // Velocities
122  for (const auto d : make_range(dimension()))
123  {
124  if (!shouldCreateVariable(_velocity_names[d], _blocks, /*error if aux*/ true))
125  reportPotentiallyMissedParameters({"system_names"}, "MooseLinearVariableFVReal");
126  else if (_define_variables)
127  {
128  std::string variable_type = "MooseLinearVariableFVReal";
129 
130  auto params = getFactory().getValidParams(variable_type);
131  assignBlocks(params, _blocks);
132  params.set<SolverSystemName>("solver_sys") = getSolverSystem(_velocity_names[d]);
133 
134  getProblem().addVariable(variable_type, _velocity_names[d], params);
135  }
136  else
137  paramError("velocity_variable",
138  "Variable (" + _velocity_names[d] +
139  ") supplied to the WCNSLinearFVFlowPhysics does not exist!");
140  }
141 
142  // Pressure
143  if (!shouldCreateVariable(_pressure_name, _blocks, /*error if aux*/ true))
144  reportPotentiallyMissedParameters({"system_names"}, "MooseLinearVariableFVReal");
145  else if (_define_variables)
146  {
147  const auto pressure_type = "MooseLinearVariableFVReal";
148 
149  auto params = getFactory().getValidParams(pressure_type);
150  assignBlocks(params, _blocks);
151  params.set<SolverSystemName>("solver_sys") = getSolverSystem(_pressure_name);
152 
153  getProblem().addVariable(pressure_type, _pressure_name, params);
154  }
155  else
156  paramError("pressure_variable",
157  "Variable (" + _pressure_name +
158  ") supplied to the WCNSLinearFVFlowPhysics does not exist!");
159 }
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()
InputParameters getValidParams(const std::string &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.
void paramError(const std::string &param, Args... args) const
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 reportPotentiallyMissedParameters(const std::vector< std::string > &param_names, const std::string &object_type) const
void saveSolverVariableName(const VariableName &var_name)

◆ addUserObjects()

void WCNSLinearFVFlowPhysics::addUserObjects ( )
overrideprivatevirtual

Implements WCNSFVFlowPhysicsBase.

Definition at line 560 of file WCNSLinearFVFlowPhysics.C.

561 {
562  // Rhie Chow user object for interpolation velocities
564 }
virtual void addRhieChowUserObjects() override
Function which adds the RhieChow interpolator user objects for weakly and incompressible formulations...

◆ addWallsBC()

void WCNSLinearFVFlowPhysics::addWallsBC ( )
overrideprivatevirtual

Implements WCNSFVFlowPhysicsBase.

Definition at line 520 of file WCNSLinearFVFlowPhysics.C.

521 {
522  const std::string u_names[3] = {"u", "v", "w"};
523 
524  for (const auto & [boundary_name, momentum_wall_type] : _momentum_wall_types)
525  {
526  if (momentum_wall_type == "noslip")
527  {
528  const std::string bc_type = "LinearFVAdvectionDiffusionFunctorDirichletBC";
529  InputParameters params = getFactory().getValidParams(bc_type);
530  params.set<std::vector<BoundaryName>>("boundary") = {boundary_name};
531 
532  for (const auto d : make_range(dimension()))
533  {
534  params.set<LinearVariableName>("variable") = _velocity_names[d];
535  if (_momentum_wall_functors.count(boundary_name) == 0)
536  params.set<MooseFunctorName>("functor") = "0";
537  else
538  params.set<MooseFunctorName>("functor") = _momentum_wall_functors[boundary_name][d];
539 
540  getProblem().addLinearFVBC(bc_type, _velocity_names[d] + "_" + boundary_name, params);
541  }
542  }
543  else
544  mooseError("Unsupported wall boundary condition type: " + std::string(momentum_wall_type));
545  }
546 
547  if (getParam<bool>("pressure_two_term_bc_expansion"))
548  {
549  const std::string bc_type = "LinearFVExtrapolatedPressureBC";
550  InputParameters params = getFactory().getValidParams(bc_type);
551  params.set<std::vector<BoundaryName>>("boundary") = _wall_boundaries;
552  params.set<LinearVariableName>("variable") = _pressure_name;
553  params.set<bool>("use_two_term_expansion") = true;
555  bc_type, _pressure_name + "_extrapolation_" + Moose::stringify(_wall_boundaries), params);
556  }
557 }
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
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 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
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 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
protectedinherited

Find the turbulence physics.

Definition at line 416 of file WCNSFVFlowPhysicsBase.C.

Referenced by WCNSFVFlowPhysicsBase::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
protectedinherited

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
inlineinherited

Definition at line 42 of file WCNSFVFlowPhysicsBase.h.

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

42 { 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 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
inlineinherited

Get the inlet flux postprocessor if using a flux inlet.

Definition at line 79 of file WCNSFVFlowPhysicsBase.h.

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

79 { return _flux_inlet_pps; }
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 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
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 64 of file WCNSLinearFVFlowPhysics.h.

65  {
66  mooseError("Not implemented");
67  }
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 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
inlineinherited

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

Definition at line 64 of file WCNSFVFlowPhysicsBase.h.

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

65  {
67  }
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 648 of file WCNSLinearFVFlowPhysics.C.

649 {
650  return 1;
651 }

◆ getOutletBoundaries()

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

Get the outlet boundaries.

Definition at line 71 of file WCNSFVFlowPhysicsBase.h.

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

71 { return _outlet_boundaries; }
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 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
inlineinherited

Definition at line 41 of file WCNSFVFlowPhysicsBase.h.

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

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

◆ getVelocityFaceInterpolationMethod()

const MooseEnum& WCNSFVFlowPhysicsBase::getVelocityFaceInterpolationMethod ( ) const
inlineinherited

Get the face interpolation method for velocity.

Definition at line 57 of file WCNSFVFlowPhysicsBase.h.

Referenced by WCNSFVTwoPhaseMixturePhysics::addAdvectionSlipTerm().

57 { return _velocity_interpolation; }
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 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
inlineinherited

Return the gravity vector.

Definition at line 51 of file WCNSFVFlowPhysicsBase.h.

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

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

◆ hasFlowEquations()

bool WCNSFVFlowPhysicsBase::hasFlowEquations ( ) const
inlineinherited

Whether the physics is actually creating the flow equations.

Definition at line 37 of file WCNSFVFlowPhysicsBase.h.

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

37 { return _has_flow_equations; }
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 59 of file WCNSLinearFVFlowPhysics.h.

59 { return false; };

◆ hasTurbulencePhysics()

bool WCNSFVFlowPhysicsBase::hasTurbulencePhysics ( ) const
inlineprotectedinherited

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

Definition at line 131 of file WCNSFVFlowPhysicsBase.h.

Referenced by 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 WCNSLinearFVFlowPhysics::initializePhysicsAdditional ( )
overrideprotectedvirtual

Reimplemented from WCNSFVFlowPhysicsBase.

Definition at line 82 of file WCNSLinearFVFlowPhysics.C.

83 {
85  // TODO Add support for multi-system by either:
86  // - creating the problem in the Physics or,
87  // - checking that the right systems are being created
89  // TODO Ban all other nonlinear Physics for now
90 
91  // Fix the default system names if using a different dimension
92  if (!isParamSetByUser("system_name"))
93  {
94  if (dimension() == 1)
95  _system_names = {"u_system", "pressure_system"};
96  else if (dimension() == 2)
97  _system_names = {"u_system", "v_system", "pressure_system"};
98  }
99 }
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 &nm) const
std::vector< SolverSystemName > _system_names

◆ porousMediumTreatment()

bool WCNSFVFlowPhysicsBase::porousMediumTreatment ( ) const
inlineinherited

Return whether a porous medium treatment is applied.

Definition at line 49 of file WCNSFVFlowPhysicsBase.h.

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

◆ rhieChowUOName()

UserObjectName WCNSLinearFVFlowPhysics::rhieChowUOName ( ) const
overrideprivatevirtual

Return the name of the Rhie Chow user object.

Implements WCNSFVFlowPhysicsBase.

Definition at line 641 of file WCNSLinearFVFlowPhysics.C.

Referenced by addMomentumFluxKernels(), and addRhieChowUserObjects().

642 {
643  mooseAssert(!_porous_medium_treatment, "Not implemented");
644  return "ins_rhie_chow_interpolator";
645 }
const bool _porous_medium_treatment
Whether to use the porous medium treatment.

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

Definition at line 25 of file WCNSLinearFVFlowPhysics.C.

26 {
28  params.addClassDescription(
29  "Define the Navier Stokes weakly-compressible equations with the linear "
30  "solver implementation of the SIMPLE scheme");
31 
32  params.addParam<bool>(
33  "orthogonality_correction", false, "Whether to use orthogonality correction");
34  params.set<unsigned short>("ghost_layers") = 1;
35 
36  // This will be adapted based on the dimension
37  params.set<std::vector<SolverSystemName>>("system_names") = {
38  "u_system", "v_system", "w_system", "pressure_system"};
39 
40  // Implemented in the executioner
41  params.suppressParameter<MooseEnum>("pinned_pressure_type");
42  params.suppressParameter<Point>("pinned_pressure_point");
43  params.suppressParameter<PostprocessorName>("pinned_pressure_value");
44 
45  // Not supported
46  params.suppressParameter<bool>("add_flow_equations");
47  params.set<bool>("porous_medium_treatment") = false;
48  params.suppressParameter<bool>("porous_medium_treatment");
49  params.set<MooseFunctorName>("porosity") = "1";
50  params.suppressParameter<MooseFunctorName>("porosity");
51  params.suppressParameter<MooseEnum>("mu_interp_method");
52  // Not needed
53  params.suppressParameter<bool>("add_flow_equations");
54  params.suppressParameter<MooseEnum>("preconditioning");
55 
56  // No other options so far
57  params.set<MooseEnum>("velocity_interpolation") = "rc";
58  params.suppressParameter<MooseEnum>("velocity_interpolation");
59 
60  return params;
61 }
void addParam(const std::string &name, const std::initializer_list< typename T::value_type > &value, const std::string &doc_string)
T & set(const std::string &name, bool quiet_mode=false)
static InputParameters validParams()
void suppressParameter(const std::string &name)
void addClassDescription(const std::string &doc_string)

Member Data Documentation

◆ _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 170 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 210 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 208 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 185 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 189 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

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

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

◆ _momentum_face_interpolation

const MooseEnum WCNSFVFlowPhysicsBase::_momentum_face_interpolation
protectedinherited

The momentum face interpolation method for stress terms.

Definition at line 179 of file WCNSFVFlowPhysicsBase.h.

Referenced by WCNSFVFlowPhysicsBase::getMomentumFaceInterpolationMethod().

◆ _momentum_inlet_functors

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

Functors describing the momentum inlet for each boundary.

Definition at line 213 of file WCNSFVFlowPhysicsBase.h.

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

◆ _momentum_inlet_types

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

Momentum inlet boundary types.

Definition at line 201 of file WCNSFVFlowPhysicsBase.h.

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

◆ _momentum_outlet_types

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

Momentum outlet boundary types.

Definition at line 203 of file WCNSFVFlowPhysicsBase.h.

Referenced by 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 217 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 205 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 74 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 194 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 215 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 143 of file WCNSFVFlowPhysicsBase.h.

◆ _solve_for_dynamic_pressure

const bool WCNSFVFlowPhysicsBase::_solve_for_dynamic_pressure
protectedinherited

Whether we are solving for the total or dynamic pressure.

Definition at line 151 of file WCNSFVFlowPhysicsBase.h.

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

◆ _turbulence_physics

const WCNSFVTurbulencePhysics* WCNSFVFlowPhysicsBase::_turbulence_physics
protectedinherited

Can be set to a coupled turbulence physics.

Definition at line 182 of file WCNSFVFlowPhysicsBase.h.

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

◆ _velocity_interpolation

const MooseEnum WCNSFVFlowPhysicsBase::_velocity_interpolation
protectedinherited

The velocity face interpolation method for advecting other quantities.

Definition at line 175 of file WCNSFVFlowPhysicsBase.h.

Referenced by 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 196 of file WCNSFVFlowPhysicsBase.h.

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


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