https://mooseframework.inl.gov
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | List of all members
LinearFVTurbulentViscosityWallFunctionBC Class Reference

Class implementing a Dirichlet boundary condition for the turbulent viscosity wall function in a RANS simulation. More...

#include <LinearFVTurbulentViscosityWallFunctionBC.h>

Inheritance diagram for LinearFVTurbulentViscosityWallFunctionBC:
[legend]

Public Types

enum  TEST_TYPE
 
enum  ResidualTagType { ResidualTagType::NonReference, ResidualTagType::Reference }
 
typedef DataFileName DataFileParameterType
 

Public Member Functions

 LinearFVTurbulentViscosityWallFunctionBC (const InputParameters &parameters)
 Class constructor. More...
 
virtual Real computeBoundaryValue () const override
 
virtual Real computeBoundaryNormalGradient () const override
 
virtual Real computeBoundaryValueMatrixContribution () const override
 
virtual Real computeBoundaryValueRHSContribution () const override
 
virtual Real computeBoundaryGradientMatrixContribution () const override
 
virtual Real computeBoundaryGradientRHSContribution () const override
 
virtual bool useBoundaryGradientExtrapolation () const override
 
Real computeTurbulentViscosity () const
 
virtual bool includesMaterialPropertyMultiplier () const
 
virtual bool hasFaceSide (const FaceInfo &fi, bool fi_elem_side) const override
 
const SubProblem & subProblem () const
 
const MooseLinearVariableFV< Real > & variable () const
 
void setupFaceData (const FaceInfo *face_info, const FaceInfo::VarFaceNeighbors face_type)
 
const FaceInfo * currentFaceInfo () const
 
FaceInfo::VarFaceNeighbors currentFaceType () const
 
virtual bool enabled () const
 
std::shared_ptr< MooseObject > getSharedPtr ()
 
std::shared_ptr< const MooseObject > getSharedPtr () const
 
MooseApp & getMooseApp () const
 
const std::string & type () const
 
virtual const std::string & name () const
 
std::string typeAndName () const
 
std::string errorPrefix (const std::string &error_type) const
 
void callMooseError (std::string msg, const bool with_prefix) const
 
MooseObjectParameterName uniqueParameterName (const std::string &parameter_name) const
 
const InputParameters & parameters () const
 
MooseObjectName uniqueName () const
 
const T & getParam (const std::string &name) const
 
std::vector< std::pair< T1, T2 > > getParam (const std::string &param1, const std::string &param2) const
 
const T * queryParam (const std::string &name) const
 
const T & getRenamedParam (const std::string &old_name, const std::string &new_name) const
 
T getCheckedPointerParam (const std::string &name, const std::string &error_string="") const
 
bool isParamValid (const std::string &name) const
 
bool isParamSetByUser (const std::string &nm) const
 
void paramError (const std::string &param, Args... args) const
 
void paramWarning (const std::string &param, Args... args) const
 
void paramInfo (const std::string &param, Args... args) const
 
void connectControllableParams (const std::string &parameter, const std::string &object_type, const std::string &object_name, const std::string &object_parameter) const
 
void mooseError (Args &&... args) const
 
void mooseErrorNonPrefixed (Args &&... args) const
 
void mooseDocumentedError (const std::string &repo_name, const unsigned int issue_num, Args &&... args) const
 
void mooseWarning (Args &&... args) const
 
void mooseWarningNonPrefixed (Args &&... args) const
 
void mooseDeprecated (Args &&... args) const
 
void mooseInfo (Args &&... args) const
 
std::string getDataFileName (const std::string &param) const
 
std::string getDataFileNameByName (const std::string &relative_path) const
 
std::string getDataFilePath (const std::string &relative_path) const
 
virtual const std::set< BoundaryID > & boundaryIDs () const
 
const std::vector< BoundaryName > & boundaryNames () const
 
unsigned int numBoundaryIDs () const
 
bool hasBoundary (const BoundaryName &name) const
 
bool hasBoundary (const std::vector< BoundaryName > &names) const
 
bool hasBoundary (const BoundaryID &id) const
 
bool hasBoundary (const std::vector< BoundaryID > &ids, TEST_TYPE type=ALL) const
 
bool hasBoundary (const std::set< BoundaryID > &ids, TEST_TYPE type=ALL) const
 
bool isBoundarySubset (const std::set< BoundaryID > &ids) const
 
bool isBoundarySubset (const std::vector< BoundaryID > &ids) const
 
bool hasBoundaryMaterialProperty (const std::string &prop_name) const
 
virtual bool boundaryRestricted () const
 
const std::set< BoundaryID > & meshBoundaryIDs () const
 
virtual bool checkVariableBoundaryIntegrity () const
 
virtual void initialSetup ()
 
virtual void timestepSetup ()
 
virtual void jacobianSetup ()
 
virtual void residualSetup ()
 
virtual void subdomainSetup ()
 
virtual void customSetup (const ExecFlagType &)
 
const ExecFlagEnum & getExecuteOnEnum () const
 
const Function & getFunction (const std::string &name) const
 
const Function & getFunctionByName (const FunctionName &name) const
 
bool hasFunction (const std::string &param_name) const
 
bool hasFunctionByName (const FunctionName &name) const
 
UserObjectName getUserObjectName (const std::string &param_name) const
 
const T & getUserObject (const std::string &param_name, bool is_dependency=true) const
 
const T & getUserObjectByName (const UserObjectName &object_name, bool is_dependency=true) const
 
const UserObject & getUserObjectBase (const std::string &param_name, bool is_dependency=true) const
 
const UserObject & getUserObjectBaseByName (const UserObjectName &object_name, bool is_dependency=true) const
 
bool isImplicit ()
 
Moose::StateArg determineState () const
 
bool isDefaultPostprocessorValue (const std::string &param_name, const unsigned int index=0) const
 
bool hasPostprocessor (const std::string &param_name, const unsigned int index=0) const
 
bool hasPostprocessorByName (const PostprocessorName &name) const
 
std::size_t coupledPostprocessors (const std::string &param_name) const
 
const PostprocessorName & getPostprocessorName (const std::string &param_name, const unsigned int index=0) const
 
const VectorPostprocessorValue & getVectorPostprocessorValue (const std::string &param_name, const std::string &vector_name) const
 
const VectorPostprocessorValue & getVectorPostprocessorValue (const std::string &param_name, const std::string &vector_name, bool needs_broadcast) const
 
const VectorPostprocessorValue & getVectorPostprocessorValueByName (const VectorPostprocessorName &name, const std::string &vector_name) const
 
const VectorPostprocessorValue & getVectorPostprocessorValueByName (const VectorPostprocessorName &name, const std::string &vector_name, bool needs_broadcast) const
 
const VectorPostprocessorValue & getVectorPostprocessorValueOld (const std::string &param_name, const std::string &vector_name) const
 
const VectorPostprocessorValue & getVectorPostprocessorValueOld (const std::string &param_name, const std::string &vector_name, bool needs_broadcast) const
 
const VectorPostprocessorValue & getVectorPostprocessorValueOldByName (const VectorPostprocessorName &name, const std::string &vector_name) const
 
const VectorPostprocessorValue & getVectorPostprocessorValueOldByName (const VectorPostprocessorName &name, const std::string &vector_name, bool needs_broadcast) const
 
const ScatterVectorPostprocessorValue & getScatterVectorPostprocessorValue (const std::string &param_name, const std::string &vector_name) const
 
const ScatterVectorPostprocessorValue & getScatterVectorPostprocessorValueByName (const VectorPostprocessorName &name, const std::string &vector_name) const
 
const ScatterVectorPostprocessorValue & getScatterVectorPostprocessorValueOld (const std::string &param_name, const std::string &vector_name) const
 
const ScatterVectorPostprocessorValue & getScatterVectorPostprocessorValueOldByName (const VectorPostprocessorName &name, const std::string &vector_name) const
 
bool hasVectorPostprocessor (const std::string &param_name, const std::string &vector_name) const
 
bool hasVectorPostprocessor (const std::string &param_name) const
 
bool hasVectorPostprocessorByName (const VectorPostprocessorName &name, const std::string &vector_name) const
 
bool hasVectorPostprocessorByName (const VectorPostprocessorName &name) const
 
const VectorPostprocessorName & getVectorPostprocessorName (const std::string &param_name) const
 
PenetrationLocator & getPenetrationLocator (const BoundaryName &primary, const BoundaryName &secondary, Order order)
 
PenetrationLocator & getQuadraturePenetrationLocator (const BoundaryName &primary, const BoundaryName &secondary, Order order)
 
NearestNodeLocator & getNearestNodeLocator (const BoundaryName &primary, const BoundaryName &secondary)
 
NearestNodeLocator & getQuadratureNearestNodeLocator (const BoundaryName &primary, const BoundaryName &secondary)
 
bool requiresGeometricSearch () const
 
virtual void meshChanged ()
 
void useVectorTag (const TagName &tag_name, VectorTagsKey)
 
void useVectorTag (TagID tag_id, VectorTagsKey)
 
void useMatrixTag (const TagName &tag_name, MatrixTagsKey)
 
void useMatrixTag (TagID tag_id, MatrixTagsKey)
 
bool isVectorTagged ()
 
bool isMatrixTagged ()
 
bool hasVectorTags () const
 
const std::set< TagID > & getVectorTags (VectorTagsKey) const
 
const std::set< TagID > & getMatrixTags (MatrixTagsKey) const
 
MooseVariableBase * mooseVariableBase () const
 
MooseVariableField< Real > & mooseVariableField ()
 
MooseVariableFE< Real > * mooseVariable () const
 
MooseVariableFV< Real > * mooseVariableFV () const
 
MooseLinearVariableFV< Real > * mooseLinearVariableFV () const
 
const std::set< MooseVariableFieldBase *> & getMooseVariableDependencies () const
 
std::set< MooseVariableFieldBase *> checkAllVariables (const DofObjectType &dof_object, const std::set< MooseVariableFieldBase * > &vars_to_omit={})
 
std::set< MooseVariableFieldBase *> checkVariables (const DofObjectType &dof_object, const std::set< MooseVariableFieldBase * > &vars_to_check)
 
void addMooseVariableDependency (MooseVariableFieldBase *var)
 
void addMooseVariableDependency (const std::vector< MooseVariableFieldBase * > &vars)
 
Moose::FaceArg makeFace (const FaceInfo &fi, const Moose::FV::LimiterType limiter_type, const bool elem_is_upwind, const bool correct_skewness=false, const Moose::StateArg *state_limiter=nullptr) const
 
Moose::FaceArg makeCDFace (const FaceInfo &fi, const bool correct_skewness=false) const
 
const Distribution & getDistribution (const std::string &name) const
 
const T & getDistribution (const std::string &name) const
 
const Distribution & getDistribution (const std::string &name) const
 
const T & getDistribution (const std::string &name) const
 
const Distribution & getDistributionByName (const DistributionName &name) const
 
const T & getDistributionByName (const std::string &name) const
 
const Distribution & getDistributionByName (const DistributionName &name) const
 
const T & getDistributionByName (const std::string &name) const
 
bool hasUserObject (const std::string &param_name) const
 
bool hasUserObject (const std::string &param_name) const
 
bool hasUserObject (const std::string &param_name) const
 
bool hasUserObject (const std::string &param_name) const
 
bool hasUserObjectByName (const UserObjectName &object_name) const
 
bool hasUserObjectByName (const UserObjectName &object_name) const
 
bool hasUserObjectByName (const UserObjectName &object_name) const
 
bool hasUserObjectByName (const UserObjectName &object_name) const
 
const PostprocessorValue & getPostprocessorValue (const std::string &param_name, const unsigned int index=0) const
 
const PostprocessorValue & getPostprocessorValue (const std::string &param_name, const unsigned int index=0) const
 
const PostprocessorValue & getPostprocessorValueOld (const std::string &param_name, const unsigned int index=0) const
 
const PostprocessorValue & getPostprocessorValueOld (const std::string &param_name, const unsigned int index=0) const
 
const PostprocessorValue & getPostprocessorValueOlder (const std::string &param_name, const unsigned int index=0) const
 
const PostprocessorValue & getPostprocessorValueOlder (const std::string &param_name, const unsigned int index=0) const
 
virtual const PostprocessorValue & getPostprocessorValueByName (const PostprocessorName &name) const
 
virtual const PostprocessorValue & getPostprocessorValueByName (const PostprocessorName &name) const
 
const PostprocessorValue & getPostprocessorValueOldByName (const PostprocessorName &name) const
 
const PostprocessorValue & getPostprocessorValueOldByName (const PostprocessorName &name) const
 
const PostprocessorValue & getPostprocessorValueOlderByName (const PostprocessorName &name) const
 
const PostprocessorValue & getPostprocessorValueOlderByName (const PostprocessorName &name) const
 
bool isVectorPostprocessorDistributed (const std::string &param_name) const
 
bool isVectorPostprocessorDistributed (const std::string &param_name) const
 
bool isVectorPostprocessorDistributedByName (const VectorPostprocessorName &name) const
 
bool isVectorPostprocessorDistributedByName (const VectorPostprocessorName &name) const
 
const Parallel::Communicator & comm () const
 
processor_id_type n_processors () const
 
processor_id_type processor_id () const
 

Static Public Member Functions

static InputParameters validParams ()
 
static bool restricted (const std::set< BoundaryID > &ids)
 
static std::string deduceFunctorName (const std::string &name, const InputParameters &params)
 

Public Attributes

 ALL
 
 ANY
 
const ConsoleStream _console
 

Protected Member Functions

std::string deduceFunctorName (const std::string &name) const
 
Real computeCellToFaceDistance () const
 
RealVectorValue computeCellToFaceVector () const
 
Moose::FaceArg singleSidedFaceArg (const FaceInfo *fi, Moose::FV::LimiterType limiter_type=Moose::FV::LimiterType::CentralDifference, bool correct_skewness=false) const
 
bool hasBoundaryMaterialPropertyHelper (const std::string &prop_name) const
 
virtual void addUserObjectDependencyHelper (const UserObject &) const
 
virtual void addPostprocessorDependencyHelper (const PostprocessorName &) const
 
virtual void addVectorPostprocessorDependencyHelper (const VectorPostprocessorName &) const
 
void prepareVectorTag (Assembly &assembly, unsigned int ivar)
 
void prepareVectorTag (Assembly &assembly, unsigned int ivar, ResidualTagType tag_type)
 
void prepareVectorTag (Assembly &assembly, unsigned int ivar, ResidualTagType tag_type)
 
void prepareVectorTag (Assembly &assembly, unsigned int ivar, ResidualTagType tag_type)
 
void prepareVectorTagNeighbor (Assembly &assembly, unsigned int ivar)
 
void prepareVectorTagLower (Assembly &assembly, unsigned int ivar)
 
void prepareMatrixTag (Assembly &assembly, unsigned int ivar, unsigned int jvar)
 
void prepareMatrixTag (Assembly &assembly, unsigned int ivar, unsigned int jvar, DenseMatrix< Number > &k) const
 
void prepareMatrixTagNonlocal (Assembly &assembly, unsigned int ivar, unsigned int jvar)
 
void prepareMatrixTagNeighbor (Assembly &assembly, unsigned int ivar, unsigned int jvar, Moose::DGJacobianType type)
 
void prepareMatrixTagNeighbor (Assembly &assembly, unsigned int ivar, unsigned int jvar, Moose::DGJacobianType type, DenseMatrix< Number > &k) const
 
void prepareMatrixTagLower (Assembly &assembly, unsigned int ivar, unsigned int jvar, Moose::ConstraintJacobianType type)
 
void accumulateTaggedLocalResidual ()
 
void assignTaggedLocalResidual ()
 
void accumulateTaggedLocalMatrix ()
 
void accumulateTaggedLocalMatrix (Assembly &assembly, unsigned int ivar, unsigned int jvar, const DenseMatrix< Number > &k)
 
void accumulateTaggedLocalMatrix (Assembly &assembly, unsigned int ivar, unsigned int jvar, Moose::DGJacobianType type, const DenseMatrix< Number > &k)
 
void accumulateTaggedNonlocalMatrix ()
 
void assignTaggedLocalMatrix ()
 
void addResiduals (Assembly &assembly, const Residuals &residuals, const Indices &dof_indices, Real scaling_factor)
 
void addResiduals (Assembly &assembly, const DenseVector< T > &residuals, const Indices &dof_indices, Real scaling_factor)
 
void addResiduals (Assembly &assembly, const ADResidualsPacket &packet)
 
void addResidualsAndJacobian (Assembly &assembly, const Residuals &residuals, const Indices &dof_indices, Real scaling_factor)
 
void addResidualsAndJacobian (Assembly &assembly, const ADResidualsPacket &packet)
 
void addJacobian (Assembly &assembly, const Residuals &residuals, const Indices &dof_indices, Real scaling_factor)
 
void addJacobian (Assembly &assembly, const ADResidualsPacket &packet)
 
void addJacobian (Assembly &assembly, DenseMatrix< Real > &local_k, const std::vector< dof_id_type > &row_indices, const std::vector< dof_id_type > &column_indices, Real scaling_factor)
 
void addResidualsWithoutConstraints (Assembly &assembly, const Residuals &residuals, const Indices &dof_indices, Real scaling_factor)
 
void addResidualsAndJacobianWithoutConstraints (Assembly &assembly, const Residuals &residuals, const Indices &dof_indices, Real scaling_factor)
 
void addJacobianWithoutConstraints (Assembly &assembly, const Residuals &residuals, const Indices &dof_indices, Real scaling_factor)
 
void addJacobianElement (Assembly &assembly, Real value, dof_id_type row_index, dof_id_type column_index, Real scaling_factor)
 
void setResidual (SystemBase &sys, const T &residual, MooseVariableFE< T > &var)
 
void setResidual (SystemBase &sys, Real residual, dof_id_type dof_index)
 
void setResidual (SystemBase &sys, SetResidualFunctor set_residual_functor)
 
virtual const OutputTools< Real >::VariableValue & value ()
 
virtual const OutputTools< Real >::VariableValue & valueOld ()
 
virtual const OutputTools< Real >::VariableValue & valueOlder ()
 
virtual const OutputTools< Real >::VariableValue & dot ()
 
virtual const OutputTools< Real >::VariableValue & dotDot ()
 
virtual const OutputTools< Real >::VariableValue & dotOld ()
 
virtual const OutputTools< Real >::VariableValue & dotDotOld ()
 
virtual const VariableValue & dotDu ()
 
virtual const VariableValue & dotDotDu ()
 
virtual const OutputTools< Real >::VariableGradient & gradient ()
 
virtual const OutputTools< Real >::VariableGradient & gradientOld ()
 
virtual const OutputTools< Real >::VariableGradient & gradientOlder ()
 
virtual const OutputTools< Real >::VariableSecond & second ()
 
virtual const OutputTools< Real >::VariableSecond & secondOld ()
 
virtual const OutputTools< Real >::VariableSecond & secondOlder ()
 
virtual const OutputTools< Real >::VariableTestSecond & secondTest ()
 
virtual const OutputTools< Real >::VariableTestSecond & secondTestFace ()
 
virtual const OutputTools< Real >::VariablePhiSecond & secondPhi ()
 
virtual const OutputTools< Real >::VariablePhiSecond & secondPhiFace ()
 
const Moose::Functor< T > & getFunctor (const std::string &name)
 
const Moose::Functor< T > & getFunctor (const std::string &name, THREAD_ID tid)
 
const Moose::Functor< T > & getFunctor (const std::string &name, SubProblem &subproblem)
 
const Moose::Functor< T > & getFunctor (const std::string &name, SubProblem &subproblem, THREAD_ID tid)
 
bool isFunctor (const std::string &name) const
 
bool isFunctor (const std::string &name, const SubProblem &subproblem) const
 
Moose::ElemArg makeElemArg (const Elem *elem, bool correct_skewnewss=false) const
 
void checkFunctorSupportsSideIntegration (const std::string &name, bool qp_integration)
 

Protected Attributes

const unsigned int _dim
 the dimension of the domain More...
 
const Moose::Functor< Real > & _u_var
 x-velocity More...
 
const Moose::Functor< Real > * _v_var
 y-velocity More...
 
const Moose::Functor< Real > * _w_var
 z-velocity More...
 
const Moose::Functor< Real > & _rho
 Density. More...
 
const Moose::Functor< Real > & _mu
 Dynamic viscosity. More...
 
const Moose::Functor< Real > & _k
 Turbulent kinetic energy. More...
 
const Real _C_mu
 C_mu turbulent coefficient. More...
 
const NS::WallTreatmentEnum _wall_treatment
 Method used for wall treatment. More...
 
const Real _mut_30
 
const THREAD_ID _tid
 
SubProblem & _subproblem
 
MooseMesh & _mesh
 
FEProblemBase & _fv_problem
 
MooseLinearVariableFV< Real > & _var
 
SystemBase & _sys
 
const FaceInfo * _current_face_info
 
FaceInfo::VarFaceNeighbors _current_face_type
 
const unsigned int _var_num
 
const unsigned int _sys_num
 
const bool & _enabled
 
MooseApp & _app
 
const std::string _type
 
const std::string _name
 
const InputParameters & _pars
 
Factory & _factory
 
ActionFactory & _action_factory
 
const ExecFlagEnum & _execute_enum
 
const ExecFlagType & _current_execute_flag
 
const InputParameters & _ti_params
 
FEProblemBase & _ti_feproblem
 
bool _is_implicit
 
Real & _t
 
const Real & _t_old
 
int & _t_step
 
Real & _dt
 
Real & _dt_old
 
bool _is_transient
 
GeometricSearchData & _geometric_search_data
 
bool _requires_geometric_search
 
FEProblemBase & _mci_feproblem
 
DenseVector< Number > _local_re
 
DenseMatrix< Number > _local_ke
 
DenseMatrix< Number > _nonlocal_ke
 
bool _nodal
 
MooseVariableFE< Real > * _variable
 
MooseVariableFV< Real > * _fv_variable
 
MooseLinearVariableFV< Real > * _linear_fv_variable
 
MooseVariableField< Real > * _field_variable
 
Assembly * _mvi_assembly
 
const Parallel::Communicator & _communicator
 

Detailed Description

Class implementing a Dirichlet boundary condition for the turbulent viscosity wall function in a RANS simulation.

Definition at line 19 of file LinearFVTurbulentViscosityWallFunctionBC.h.

Constructor & Destructor Documentation

◆ LinearFVTurbulentViscosityWallFunctionBC()

LinearFVTurbulentViscosityWallFunctionBC::LinearFVTurbulentViscosityWallFunctionBC ( const InputParameters &  parameters)

Class constructor.

Parameters
parametersThe InputParameters for the object

Definition at line 35 of file LinearFVTurbulentViscosityWallFunctionBC.C.

37  : LinearFVAdvectionDiffusionBC(params),
38  _dim(_subproblem.mesh().dimension()),
39  _u_var(getFunctor<Real>("u")),
40  _v_var(params.isParamValid("v") ? &(getFunctor<Real>("v")) : nullptr),
41  _w_var(params.isParamValid("w") ? &(getFunctor<Real>("w")) : nullptr),
42  _rho(getFunctor<Real>(NS::density)),
43  _mu(getFunctor<Real>(NS::mu)),
44  _k(getFunctor<Real>(NS::TKE)),
45  _C_mu(getParam<Real>("C_mu")),
46  _wall_treatment(getParam<MooseEnum>("wall_treatment").getEnum<NS::WallTreatmentEnum>())
47 {
48 }
SubProblem::mesh
virtual MooseMesh & mesh()=0
NS::density
static const std::string density
Definition: NS.h:33
NS::TKE
static const std::string TKE
Definition: NS.h:176
LinearFVAdvectionDiffusionBC::LinearFVAdvectionDiffusionBC
LinearFVAdvectionDiffusionBC(const InputParameters &parameters)
NS::WallTreatmentEnum
WallTreatmentEnum
Wall treatment options.
Definition: NS.h:182
MooseMesh::dimension
virtual unsigned int dimension() const
NS::mu
static const std::string mu
Definition: NS.h:123
LinearFVTurbulentViscosityWallFunctionBC::_k
const Moose::Functor< Real > & _k
Turbulent kinetic energy.
Definition: LinearFVTurbulentViscosityWallFunctionBC.h:63
LinearFVTurbulentViscosityWallFunctionBC::_mu
const Moose::Functor< Real > & _mu
Dynamic viscosity.
Definition: LinearFVTurbulentViscosityWallFunctionBC.h:60
LinearFVTurbulentViscosityWallFunctionBC::_wall_treatment
const NS::WallTreatmentEnum _wall_treatment
Method used for wall treatment.
Definition: LinearFVTurbulentViscosityWallFunctionBC.h:69
LinearFVTurbulentViscosityWallFunctionBC::_dim
const unsigned int _dim
the dimension of the domain
Definition: LinearFVTurbulentViscosityWallFunctionBC.h:48

Member Function Documentation

◆ computeBoundaryGradientMatrixContribution()

Real LinearFVTurbulentViscosityWallFunctionBC::computeBoundaryGradientMatrixContribution ( ) const
overridevirtual

Implements LinearFVAdvectionDiffusionBC.

Definition at line 169 of file LinearFVTurbulentViscosityWallFunctionBC.C.

170 {
171  mooseError("We should not solve for the turbulent viscosity directly meaning that this should "
172  "contribute to neither vector nor a right hand side.");
173 }
LinearFVAdvectionDiffusionBC::mooseError
void mooseError(Args &&... args) const

◆ computeBoundaryGradientRHSContribution()

Real LinearFVTurbulentViscosityWallFunctionBC::computeBoundaryGradientRHSContribution ( ) const
overridevirtual

Implements LinearFVAdvectionDiffusionBC.

Definition at line 176 of file LinearFVTurbulentViscosityWallFunctionBC.C.

177 {
178  mooseError("We should not solve for the turbulent viscosity directly meaning that this should "
179  "contribute to neither vector nor a right hand side.");
180 }
LinearFVAdvectionDiffusionBC::mooseError
void mooseError(Args &&... args) const

◆ computeBoundaryNormalGradient()

Real LinearFVTurbulentViscosityWallFunctionBC::computeBoundaryNormalGradient ( ) const
overridevirtual

Implements LinearFVAdvectionDiffusionBC.

Definition at line 144 of file LinearFVTurbulentViscosityWallFunctionBC.C.

145 {
146  const auto elem_arg = makeElemArg(_current_face_type == FaceInfo::VarFaceNeighbors::ELEM
147  ? _current_face_info->elemPtr()
148  : _current_face_info->neighborPtr());
149  const Real distance = computeCellToFaceDistance();
150  return (this->computeTurbulentViscosity() - raw_value(_var(elem_arg, determineState()))) /
151  distance;
152 }
LinearFVAdvectionDiffusionBC::computeCellToFaceDistance
Real computeCellToFaceDistance() const
LinearFVAdvectionDiffusionBC::determineState
Moose::StateArg determineState() const
raw_value
auto raw_value(const Eigen::Map< T > &in)
distance
Real distance(const Point &p)
LinearFVAdvectionDiffusionBC::makeElemArg
Moose::ElemArg makeElemArg(const Elem *elem, bool correct_skewnewss=false) const
FaceInfo::neighborPtr
const Elem * neighborPtr() const
LinearFVAdvectionDiffusionBC::_current_face_type
FaceInfo::VarFaceNeighbors _current_face_type
LinearFVAdvectionDiffusionBC::_var
MooseLinearVariableFV< Real > & _var
FaceInfo::elemPtr
const Elem * elemPtr() const
Real
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
LinearFVAdvectionDiffusionBC::_current_face_info
const FaceInfo * _current_face_info

◆ computeBoundaryValue()

Real LinearFVTurbulentViscosityWallFunctionBC::computeBoundaryValue ( ) const
overridevirtual

Implements LinearFVAdvectionDiffusionBC.

Definition at line 138 of file LinearFVTurbulentViscosityWallFunctionBC.C.

139 {
140  return this->computeTurbulentViscosity();
141 }

◆ computeBoundaryValueMatrixContribution()

Real LinearFVTurbulentViscosityWallFunctionBC::computeBoundaryValueMatrixContribution ( ) const
overridevirtual

Implements LinearFVAdvectionDiffusionBC.

Definition at line 155 of file LinearFVTurbulentViscosityWallFunctionBC.C.

156 {
157  mooseError("We should not solve for the turbulent viscosity directly meaning that this should "
158  "contribute to neither vector nor a right hand side.");
159 }
LinearFVAdvectionDiffusionBC::mooseError
void mooseError(Args &&... args) const

◆ computeBoundaryValueRHSContribution()

Real LinearFVTurbulentViscosityWallFunctionBC::computeBoundaryValueRHSContribution ( ) const
overridevirtual

Implements LinearFVAdvectionDiffusionBC.

Definition at line 162 of file LinearFVTurbulentViscosityWallFunctionBC.C.

163 {
164  mooseError("We should not solve for the turbulent viscosity directly meaning that this should "
165  "contribute to neither vector nor a right hand side.");
166 }
LinearFVAdvectionDiffusionBC::mooseError
void mooseError(Args &&... args) const

◆ computeTurbulentViscosity()

Real LinearFVTurbulentViscosityWallFunctionBC::computeTurbulentViscosity ( ) const

Definition at line 51 of file LinearFVTurbulentViscosityWallFunctionBC.C.

Referenced by computeBoundaryNormalGradient(), and computeBoundaryValue().

52 {
53  // Utility functions
54  const auto wall_dist = computeCellToFaceDistance();
55  const auto & elem = _current_face_type == FaceInfo::VarFaceNeighbors::NEIGHBOR
56  ? _current_face_info->neighborPtr()
57  : _current_face_info->elemPtr();
58  const auto re = makeElemArg(elem);
59  const auto old_state = Moose::StateArg(1, Moose::SolutionIterationType::Nonlinear);
60  const auto mu = _mu(re, old_state);
61  const auto rho = _rho(re, old_state);
62 
63  // Get the velocity vector
64  RealVectorValue velocity(_u_var(re, old_state));
65  if (_v_var)
66  velocity(1) = (*_v_var)(re, old_state);
67  if (_w_var)
68  velocity(2) = (*_w_var)(re, old_state);
69 
70  // Compute the velocity and direction of the velocity component that is parallel to the wall
71  const auto parallel_speed = NS::computeSpeed<Real>(
72  velocity - velocity * (_current_face_info->normal()) * (_current_face_info->normal()));
73 
74  // Switch for determining the near wall quantities
75  // wall_treatment can be: "eq_newton eq_incremental eq_linearized neq"
76  Real y_plus = 0.0;
77  Real mu_wall = 0.0; // total wall viscosity to obtain the shear stress at the wall
78 
79  if (_wall_treatment == NS::WallTreatmentEnum::EQ_NEWTON)
80  {
81  // Full Newton-Raphson solve to find the wall quantities from the law of the wall
82  const auto u_tau = NS::findUStar<Real>(mu, rho, parallel_speed, wall_dist);
83  y_plus = wall_dist * u_tau * rho / mu;
84  mu_wall = rho * Utility::pow<2>(u_tau) * wall_dist / parallel_speed;
85  }
86  else if (_wall_treatment == NS::WallTreatmentEnum::EQ_INCREMENTAL)
87  {
88  // Incremental solve on y_plus to get the near-wall quantities
89  y_plus = NS::findyPlus<Real>(mu, rho, std::max(parallel_speed, 1e-10), wall_dist);
90  mu_wall = mu * (NS::von_karman_constant * y_plus /
91  std::log(std::max(NS::E_turb_constant * y_plus, 1 + 1e-4)));
92  }
93  else if (_wall_treatment == NS::WallTreatmentEnum::EQ_LINEARIZED)
94  {
95  // Linearized approximation to the wall function to find the near-wall quantities faster
96  const Real a_c = 1 / NS::von_karman_constant;
97  const Real b_c = 1 / NS::von_karman_constant *
98  (std::log(NS::E_turb_constant * std::max(wall_dist, 1.0) / mu) + 1.0);
99  const Real c_c = parallel_speed;
100 
101  const auto u_tau = (-b_c + std::sqrt(std::pow(b_c, 2) + 4.0 * a_c * c_c)) / (2.0 * a_c);
102  y_plus = wall_dist * u_tau * rho / mu;
103  mu_wall = rho * Utility::pow<2>(u_tau) * wall_dist / parallel_speed;
104  }
105  else if (_wall_treatment == NS::WallTreatmentEnum::NEQ)
106  {
107  // Assign non-equilibrium wall function value
108  y_plus = std::pow(_C_mu, 0.25) * wall_dist * std::sqrt(_k(re, old_state)) * rho / mu;
109  mu_wall = mu * (NS::von_karman_constant * y_plus /
110  std::log(std::max(NS::E_turb_constant * y_plus, 1.0 + 1e-4)));
111  }
112  else
113  mooseAssert(false,
114  "For `INSFVTurbulentViscosityWallFunction` , wall treatment should not reach here");
115 
116  const Real mut_log = mu_wall - mu; // turbulent log-layer viscosity
117 
118  Real mu_t = 0;
119 
120  if (y_plus <= 5.0)
121  // sub-laminar layer
122  mu_t += 0.0;
123  else if (y_plus >= 30.0)
124  // log-layer
125  mu_t += std::max(mut_log, NS::mu_t_low_limit);
126  else
127  {
128  // buffer layer
129  const auto blending_function = (y_plus - 5.0) / 25.0;
130  // the blending depends on the mut_log at y+=30
131  const auto mut_log = mu * _mut_30;
132  mu_t += std::max(blending_function * mut_log, NS::mu_t_low_limit);
133  }
134  return mu_t;
135 }
NS::von_karman_constant
static constexpr Real von_karman_constant
Definition: NS.h:191
NS::mu_t
static const std::string mu_t
Definition: NS.h:125
LinearFVAdvectionDiffusionBC::computeCellToFaceDistance
Real computeCellToFaceDistance() const
NS::findUStar< Real >
template Real findUStar< Real >(const Real &mu, const Real &rho, const Real &u, const Real dist)
LinearFVAdvectionDiffusionBC::makeElemArg
Moose::ElemArg makeElemArg(const Elem *elem, bool correct_skewnewss=false) const
NS::findyPlus< Real >
template Real findyPlus< Real >(const Real &mu, const Real &rho, const Real &u, Real dist)
FaceInfo::neighborPtr
const Elem * neighborPtr() const
NS::mu
static const std::string mu
Definition: NS.h:123
LinearFVAdvectionDiffusionBC::_current_face_type
FaceInfo::VarFaceNeighbors _current_face_type
FaceInfo::normal
const Point & normal() const
LinearFVTurbulentViscosityWallFunctionBC::_k
const Moose::Functor< Real > & _k
Turbulent kinetic energy.
Definition: LinearFVTurbulentViscosityWallFunctionBC.h:63
FaceInfo::elemPtr
const Elem * elemPtr() const
LinearFVTurbulentViscosityWallFunctionBC::_mu
const Moose::Functor< Real > & _mu
Dynamic viscosity.
Definition: LinearFVTurbulentViscosityWallFunctionBC.h:60
Real
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
NS::E_turb_constant
static constexpr Real E_turb_constant
Definition: NS.h:192
LinearFVAdvectionDiffusionBC::_current_face_info
const FaceInfo * _current_face_info
LinearFVTurbulentViscosityWallFunctionBC::_wall_treatment
const NS::WallTreatmentEnum _wall_treatment
Method used for wall treatment.
Definition: LinearFVTurbulentViscosityWallFunctionBC.h:69
NS::velocity
static const std::string velocity
Definition: NS.h:45
NS::computeSpeed< Real >
template Real computeSpeed< Real >(const libMesh::VectorValue< Real > &velocity)
NS::mu_t_low_limit
static constexpr Real mu_t_low_limit
Definition: NS.h:194
std::pow
MooseUnits pow(const MooseUnits &, int)

◆ useBoundaryGradientExtrapolation()

virtual bool LinearFVTurbulentViscosityWallFunctionBC::useBoundaryGradientExtrapolation ( ) const
inlineoverridevirtual

Reimplemented from LinearFVAdvectionDiffusionBC.

Definition at line 42 of file LinearFVTurbulentViscosityWallFunctionBC.h.

42 { return true; }

◆ validParams()

InputParameters LinearFVTurbulentViscosityWallFunctionBC::validParams ( )
static

Definition at line 16 of file LinearFVTurbulentViscosityWallFunctionBC.C.

17 {
18  InputParameters params = LinearFVAdvectionDiffusionBC::validParams();
19  params.addClassDescription("Adds Dirichlet BC for wall values of the turbulent viscosity.");
20  params.addRequiredParam<MooseFunctorName>("u", "The velocity in the x direction.");
21  params.addParam<MooseFunctorName>("v", "The velocity in the y direction.");
22  params.addParam<MooseFunctorName>("w", "The velocity in the z direction.");
23  params.addRequiredParam<MooseFunctorName>(NS::density, "Density");
24  params.addRequiredParam<MooseFunctorName>(NS::mu, "Dynamic viscosity.");
25  params.addParam<MooseFunctorName>("k", "The turbulent kinetic energy.");
26  params.deprecateParam("k", NS::TKE, "01/01/2025");
27  params.addParam<Real>("C_mu", 0.09, "Coupled turbulent kinetic energy closure.");
28 
29  MooseEnum wall_treatment("eq_newton eq_incremental eq_linearized neq", "neq");
30  params.addParam<MooseEnum>(
31  "wall_treatment", wall_treatment, "The method used for computing the wall functions");
32  return params;
33 }
InputParameters::addParam
void addParam(const std::string &name, const std::initializer_list< typename T::value_type > &value, const std::string &doc_string)
NS::density
static const std::string density
Definition: NS.h:33
NS::TKE
static const std::string TKE
Definition: NS.h:176
InputParameters::addRequiredParam
void addRequiredParam(const std::string &name, const std::string &doc_string)
InputParameters::deprecateParam
void deprecateParam(const std::string &old_name, const std::string &new_name, const std::string &removal_date)
NS::mu
static const std::string mu
Definition: NS.h:123
Real
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
InputParameters::addClassDescription
void addClassDescription(const std::string &doc_string)
LinearFVAdvectionDiffusionBC::validParams
static InputParameters validParams()

Member Data Documentation

◆ _C_mu

const Real LinearFVTurbulentViscosityWallFunctionBC::_C_mu
protected

C_mu turbulent coefficient.

Definition at line 66 of file LinearFVTurbulentViscosityWallFunctionBC.h.

Referenced by computeTurbulentViscosity().

◆ _dim

const unsigned int LinearFVTurbulentViscosityWallFunctionBC::_dim
protected

the dimension of the domain

Definition at line 48 of file LinearFVTurbulentViscosityWallFunctionBC.h.

◆ _k

const Moose::Functor<Real>& LinearFVTurbulentViscosityWallFunctionBC::_k
protected

Turbulent kinetic energy.

Definition at line 63 of file LinearFVTurbulentViscosityWallFunctionBC.h.

Referenced by computeTurbulentViscosity().

◆ _mu

const Moose::Functor<Real>& LinearFVTurbulentViscosityWallFunctionBC::_mu
protected

Dynamic viscosity.

Definition at line 60 of file LinearFVTurbulentViscosityWallFunctionBC.h.

Referenced by computeTurbulentViscosity().

◆ _mut_30

const Real LinearFVTurbulentViscosityWallFunctionBC::_mut_30
protected
Initial value:
=
(NS::von_karman_constant * 30.0 / std::log(NS::E_turb_constant * 30.0) - 1.0)

Definition at line 72 of file LinearFVTurbulentViscosityWallFunctionBC.h.

Referenced by computeTurbulentViscosity().

◆ _rho

const Moose::Functor<Real>& LinearFVTurbulentViscosityWallFunctionBC::_rho
protected

Density.

Definition at line 58 of file LinearFVTurbulentViscosityWallFunctionBC.h.

Referenced by computeTurbulentViscosity().

◆ _u_var

const Moose::Functor<Real>& LinearFVTurbulentViscosityWallFunctionBC::_u_var
protected

x-velocity

Definition at line 51 of file LinearFVTurbulentViscosityWallFunctionBC.h.

Referenced by computeTurbulentViscosity().

◆ _v_var

const Moose::Functor<Real>* LinearFVTurbulentViscosityWallFunctionBC::_v_var
protected

y-velocity

Definition at line 53 of file LinearFVTurbulentViscosityWallFunctionBC.h.

Referenced by computeTurbulentViscosity().

◆ _w_var

const Moose::Functor<Real>* LinearFVTurbulentViscosityWallFunctionBC::_w_var
protected

z-velocity

Definition at line 55 of file LinearFVTurbulentViscosityWallFunctionBC.h.

Referenced by computeTurbulentViscosity().

◆ _wall_treatment

const NS::WallTreatmentEnum LinearFVTurbulentViscosityWallFunctionBC::_wall_treatment
protected

Method used for wall treatment.

Definition at line 69 of file LinearFVTurbulentViscosityWallFunctionBC.h.

Referenced by computeTurbulentViscosity().

The documentation for this class was generated from the following files:
Generated on Wed Aug 6 2025 14:42:47 for https://mooseframework.inl.gov by   doxygen 1.8.14