https://mooseframework.inl.gov
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Protected Attributes | Private Member Functions | Static Private Member Functions | Private Attributes | List of all members
INSFVTurbulentViscosityWallFunction Class Reference

Applies a wall function to the turbulent viscosity field. More...

#include <INSFVTurbulentViscosityWallFunction.h>

Inheritance diagram for INSFVTurbulentViscosityWallFunction:
[legend]

Public Types

enum  TEST_TYPE
 
enum  ResidualTagType
 
typedef DataFileName DataFileParameterType
 

Public Member Functions

 INSFVTurbulentViscosityWallFunction (const InputParameters &parameters)
 
ADReal boundaryValue (const FaceInfo &fi, const Moose::StateArg &state) const override
 
const SubProblem & subProblem () const
 
const MooseVariableFV< Real > & variable () const
 
bool hasFaceSide (const FaceInfo &fi, bool fi_elem_side) const override
 
virtual bool enabled () const
 
std::shared_ptr< MooseObject > getSharedPtr ()
 
std::shared_ptr< const MooseObject > getSharedPtr () const
 
bool isKokkosObject () const
 
MooseApp & getMooseApp () const
 
const std::string & type () const
 
const std::string & name () const
 
std::string typeAndName () const
 
MooseObjectParameterName uniqueParameterName (const std::string &parameter_name) const
 
MooseObjectName uniqueName () const
 
const InputParameters & parameters () const
 
const hit::Node * getHitNode () const
 
bool hasBase () const
 
const std::string & getBase () const
 
const T & getParam (const std::string &name) const
 
std::vector< std::pair< T1, T2 > > getParam (const std::string &param1, const std::string &param2) const
 
const T * queryParam (const std::string &name) const
 
const T & getRenamedParam (const std::string &old_name, const std::string &new_name) const
 
T getCheckedPointerParam (const std::string &name, const std::string &error_string="") const
 
bool isParamValid (const std::string &name) const
 
bool isParamSetByUser (const std::string &name) const
 
void connectControllableParams (const std::string &parameter, const std::string &object_type, const std::string &object_name, const std::string &object_parameter) const
 
void paramError (const std::string &param, Args... args) const
 
void paramWarning (const std::string &param, Args... args) const
 
void paramWarning (const std::string &param, Args... args) const
 
void paramInfo (const std::string &param, Args... args) const
 
std::string messagePrefix (const bool hit_prefix=true) const
 
std::string errorPrefix (const std::string &) const
 
void mooseError (Args &&... args) const
 
void mooseDocumentedError (const std::string &repo_name, const unsigned int issue_num, Args &&... args) const
 
void mooseErrorNonPrefixed (Args &&... args) const
 
void mooseWarning (Args &&... args) const
 
void mooseWarning (Args &&... args) const
 
void mooseWarningNonPrefixed (Args &&... args) const
 
void mooseWarningNonPrefixed (Args &&... args) const
 
void mooseDeprecated (Args &&... args) const
 
void mooseDeprecated (Args &&... args) const
 
void mooseDeprecatedNoTrace (Args &&... args) const
 
void mooseInfo (Args &&... args) const
 
void callMooseError (std::string msg, const bool with_prefix, const hit::Node *node=nullptr, const bool show_trace=true) const
 
std::string getDataFileName (const std::string &param) const
 
std::string getDataFileNameByName (const std::string &relative_path) const
 
std::string getDataFilePath (const std::string &relative_path) const
 
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 hasBoundary (const std::vector< BoundaryID > &ids, TEST_TYPE type=ALL) const
 
bool hasBoundary (const std::set< BoundaryID > &ids, TEST_TYPE type=ALL) 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 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
 
Moose::Kokkos::Function getKokkosFunction (const std::string &name) const
 
const T & getKokkosFunction (const std::string &name) const
 
Moose::Kokkos::Function getKokkosFunctionByName (const FunctionName &name) const
 
const T & getKokkosFunctionByName (const FunctionName &name) const
 
bool hasKokkosFunction (const std::string &param_name) const
 
bool hasKokkosFunctionByName (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 UserObjectBase & getUserObjectBase (const std::string &param_name, bool is_dependency=true) const
 
const UserObjectBase & 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={})
 
virtual std::set< MooseVariableFieldBase * > checkVariables (const libMesh::Node &node, const std::set< MooseVariableFieldBase * > &vars_to_check)
 
std::set< MooseVariableFieldBase * > checkVariables (const libMesh::Elem &element, const std::set< MooseVariableFieldBase * > &vars_to_check)
 
void addMooseVariableDependency (MooseVariableFieldBase *var)
 
void addMooseVariableDependency (const std::vector< MooseVariableFieldBase * > &vars)
 
const Moose::Functor< Real > * defaultFunctor (const std::string &name)
 
const Moose::Functor< ADReal > * defaultFunctor (const std::string &name)
 
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 void callMooseError (MooseApp *const app, const InputParameters &params, std::string msg, const bool with_prefix, const hit::Node *node, const bool show_trace=true)
 
static bool restricted (const std::set< BoundaryID > &ids)
 
static std::string deduceFunctorName (const std::string &name, const InputParameters &params)
 

Public Attributes

 ALL
 
 ANY
 
 usingCombinedWarningSolutionWarnings
 
const ConsoleStream _console
 

Static Public Attributes

static const std::string type_param
 
static const std::string name_param
 
static const std::string unique_name_param
 
static const std::string app_param
 
static const std::string moose_base_param
 
static const std::string kokkos_object_param
 

Protected Member Functions

std::string deduceFunctorName (const std::string &name) const
 
Moose::FaceArg singleSidedFaceArg (const FaceInfo *fi=nullptr, Moose::FV::LimiterType limiter_type=Moose::FV::LimiterType::CentralDifference, bool correct_skewness=false, const Moose::StateArg *state_limiter=nullptr) const
 
void flagInvalidSolutionInternal (const InvalidSolutionID invalid_solution_id) const
 
InvalidSolutionID registerInvalidSolutionInternal (const std::string &message, const bool warning) const
 
bool hasBoundaryMaterialPropertyHelper (const std::string &prop_name) const
 
KOKKOS_FUNCTION dof_id_type numKokkosBoundaryNodes () const
 
KOKKOS_FUNCTION dof_id_type numKokkosBoundarySides () const
 
KOKKOS_FUNCTION ContiguousNodeID kokkosBoundaryNodeID (Moose::Kokkos::ThreadID tid) const
 
KOKKOS_FUNCTION auto kokkosBoundaryElementSideID (Moose::Kokkos::ThreadID tid) const
 
virtual void addUserObjectDependencyHelper (const UserObjectBase &) 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 Residuals &residuals, const Indices &dof_indices, const std::vector< Real > &scaling_factors)
 
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 Residuals &residuals, const Indices &dof_indices, const std::vector< Real > &scaling_factors)
 
void addJacobian (Assembly &assembly, const ADResidualsPacket &packet)
 
void addJacobian (Assembly &assembly, const 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)
 
const Moose::Functor< T > & getFunctorByName (const std::string &name)
 

Protected Attributes

const std::pair< unsigned int, unsigned int > _var_sys_numbers_pair
 
MooseVariableFV< Real > & _var
 
SubProblem & _subproblem
 
FEProblemBase & _fv_problem
 
SystemBase & _sys
 
THREAD_ID _tid
 
Assembly & _assembly
 
MooseMesh & _mesh
 
const FaceInfo * _face_info
 
const bool & _enabled
 
MooseApp & _app
 
Factory & _factory
 
ActionFactory & _action_factory
 
const std::string & _type
 
const std::string & _name
 
const InputParameters & _pars
 
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
 

Private Member Functions

const Moose::Functor< T > * defaultFunctor (const std::string &name)
 
const Moose::Functor< Real > * defaultFunctor (const std::string &name)
 
const Moose::Functor< ADReal > * defaultFunctor (const std::string &name)
 
const Moose::Functor< T > & getFunctorByName (const std::string &name, SubProblem &subproblem, THREAD_ID tid)
 
void initializeBoundaryRestrictable ()
 
void initializeKokkosBoundaryRestrictable ()
 
const Moose::FunctionBase * getKokkosFunctionByNameHelper (const FunctionName &name) const
 
const UserObjectBase & getUserObjectFromFEProblem (const UserObjectName &object_name, const THREAD_ID tid=0) const
 
const T & castUserObject (const UserObjectBase &uo_base, const std::string &param_name="") const
 
void mooseObjectError (const std::string &param_name, std::stringstream &oss) const
 
const std::string & userObjectType (const UserObjectBase &uo) const
 
const std::string & userObjectName (const UserObjectBase &uo) const
 
const PostprocessorName & getPostprocessorNameInternal (const std::string &param_name, const unsigned int index, const bool allow_default_value=true) const
 
bool isDefaultPostprocessorValueByName (const PostprocessorName &name) const
 
PostprocessorValue getDefaultPostprocessorValueByName (const PostprocessorName &name) const
 
void checkParam (const std::string &param_name, const unsigned int index=std::numeric_limits< unsigned int >::max()) const
 
bool postprocessorsAdded () const
 
const VectorPostprocessorValue & getVectorPostprocessorByNameHelper (const VectorPostprocessorName &name, const std::string &vector_name, bool broadcast, std::size_t t_index) const
 
const VectorPostprocessorContext< VectorPostprocessorValue > & getVectorPostprocessorContextByNameHelper (const VectorPostprocessorName &name, const std::string &vector_name) const
 
bool vectorPostprocessorsAdded () const
 
void prepareVectorTagInternal (Assembly &assembly, unsigned int ivar, const std::set< TagID > &vector_tags, const std::set< TagID > &absolute_value_vector_tags)
 
void checkForNans () const
 
std::set< MooseVariableFieldBase * > checkVariablesHelper (const DofObjectType &dof_object, const std::set< MooseVariableFieldBase * > &vars_to_check)
 
virtual bool isADObject () const override
 
const PostprocessorValue & getPostprocessorValueInternal (const std::string &param_name, unsigned int index, std::size_t t_index) const
 
const PostprocessorValue & getPostprocessorValueInternal (const std::string &param_name, unsigned int index, std::size_t t_index) const
 
const PostprocessorValue & getPostprocessorValueByNameInternal (const PostprocessorName &name, std::size_t t_index) const
 
const PostprocessorValue & getPostprocessorValueByNameInternal (const PostprocessorName &name, std::size_t t_index) const
 
void possiblyCheckHasVectorPostprocessor (const std::string &param_name, const std::string &vector_name) const
 
void possiblyCheckHasVectorPostprocessor (const std::string &param_name, const std::string &vector_name) const
 
void possiblyCheckHasVectorPostprocessorByName (const VectorPostprocessorName &name, const std::string &vector_name) const
 
void possiblyCheckHasVectorPostprocessorByName (const VectorPostprocessorName &name, const std::string &vector_name) const
 

Static Private Member Functions

static const hit::Node * getHitNode (const InputParameters &params)
 
static std::string messagePrefix (const InputParameters &params, const bool hit_prefix)
 

Private Attributes

const unsigned int _dim
 the dimension of the domain
 
const Moose::Functor< ADReal > & _u_var
 x-velocity
 
const Moose::Functor< ADReal > * _v_var
 y-velocity
 
const Moose::Functor< ADReal > * _w_var
 z-velocity
 
const Moose::Functor< ADReal > & _rho
 Density.
 
const Moose::Functor< ADReal > & _mu
 Dynamic viscosity.
 
const Moose::Functor< ADReal > & _mu_t
 Turbulent dynamic viscosity.
 
const Moose::Functor< ADReal > & _k
 Turbulent kinetic energy.
 
const Real _C_mu
 C_mu turbulent coefficient.
 
NS::WallTreatmentEnum _wall_treatment
 Method used for wall treatment.
 
const bool _preserve_sparsity_pattern
 For Newton solves we want to add extra zero-valued terms regardless of y-plus to avoid sparsity pattern changes as y-plus changes near the walls.
 
const Real _mut_30
 
const ParallelParamObject & _parent
 
const MooseBase & _si_moose_base
 
const FEProblemBase * _si_problem
 
FEProblemBase * _bnd_feproblem
 
MooseMesh * _bnd_mesh
 
std::set< BoundaryID > _bnd_ids
 
std::vector< BoundaryID > _vec_ids
 
std::vector< BoundaryName > _boundary_names
 
const bool _bnd_dual_restrictable
 
const std::set< SubdomainID > _empty_block_ids
 
const std::set< SubdomainID > & _block_ids
 
THREAD_ID _bnd_tid
 
const MaterialData & _bnd_material_data
 
bool _bnd_nodal
 
const MooseObject & _moose_object
 
Moose::Kokkos::Array< ContiguousNodeID > _kokkos_node_ids
 
Moose::Kokkos::Array< Moose::Kokkos::Pair< ContiguousElementID, unsigned int > > _kokkos_element_side_ids
 
ExecFlagEnum _empty_execute_enum
 
const MooseObject & _fni_object
 
const InputParameters & _fni_params
 
FEProblemBase & _fni_feproblem
 
const THREAD_ID _fni_tid
 
const InputParameters & _dni_params
 
FEProblemBase & _dni_feproblem
 
const MooseObject *const _dni_moose_object_ptr
 
const MooseObject & _uoi_moose_object
 
const FEProblemBase & _uoi_feproblem
 
const THREAD_ID _uoi_tid
 
const std::string _ti_name
 
const MooseObject & _ppi_moose_object
 
const InputParameters & _ppi_params
 
const FEProblemBase & _ppi_feproblem
 
std::map< PostprocessorName, std::unique_ptr< PostprocessorValue > > _default_values
 
const bool _broadcast_by_default
 
const MooseObject & _vpi_moose_object
 
const FEProblemBase & _vpi_feproblem
 
const THREAD_ID _vpi_tid
 
std::set< TagID > _vector_tags
 
std::set< TagID > _abs_vector_tags
 
std::set< TagID > _matrix_tags
 
std::set< TagID > _non_ref_vector_tags
 
std::set< TagID > _non_ref_abs_vector_tags
 
std::set< TagID > _ref_vector_tags
 
std::set< TagID > _ref_abs_vector_tags
 
const InputParameters & _tag_params
 
std::vector< DenseVector< Number > * > _re_blocks
 
std::vector< DenseVector< Number > * > _absre_blocks
 
std::vector< DenseMatrix< Number > * > _ke_blocks
 
std::vector< Real > _absolute_residuals
 
std::set< MooseVariableFieldBase * > _moose_variable_dependencies
 
std::vector< libMesh::dof_id_type > _dof_indices
 
const InputParameters & _fi_params
 
const std::string _fi_name
 
SubProblem *const _fi_subproblem
 
const THREAD_ID _fi_tid
 
std::vector< std::unique_ptr< Moose::Functor< Real > > > _default_real_functors
 
std::vector< std::unique_ptr< Moose::Functor< ADReal > > > _default_ad_real_functors
 

Detailed Description

Applies a wall function to the turbulent viscosity field.

Definition at line 19 of file INSFVTurbulentViscosityWallFunction.h.

Constructor & Destructor Documentation

◆ INSFVTurbulentViscosityWallFunction()

INSFVTurbulentViscosityWallFunction::INSFVTurbulentViscosityWallFunction ( const InputParameters &  parameters)

Definition at line 36 of file INSFVTurbulentViscosityWallFunction.C.

38 : FVDirichletBCBase(params),
39 _dim(_subproblem.mesh().dimension()),
40 _u_var(getFunctor<ADReal>("u")),
41 _v_var(params.isParamValid("v") ? &(getFunctor<ADReal>("v")) : nullptr),
42 _w_var(params.isParamValid("w") ? &(getFunctor<ADReal>("w")) : nullptr),
43 _rho(getFunctor<ADReal>(NS::density)),
44 _mu(getFunctor<ADReal>(NS::mu)),
45 _mu_t(getFunctor<ADReal>(NS::mu_t)),
46 _k(getFunctor<ADReal>(NS::TKE)),
47 _C_mu(getParam<Real>("C_mu")),
48 _wall_treatment(getParam<MooseEnum>("wall_treatment").getEnum<NS::WallTreatmentEnum>()),
49 _preserve_sparsity_pattern(_fv_problem.preserveMatrixSparsityPattern())
50{
51}
ADReal
DualNumber< Real, DNDerivativeType, true > ADReal
mu
const double mu
Definition GasLiquidMassTransferTest.C:22
FVDirichletBCBase::_fv_problem
FEProblemBase & _fv_problem
FVDirichletBCBase::_subproblem
SubProblem & _subproblem
FVDirichletBCBase::getFunctor
const Moose::Functor< T > & getFunctor(const std::string &name)
INSFVTurbulentViscosityWallFunction::_v_var
const Moose::Functor< ADReal > * _v_var
y-velocity
Definition INSFVTurbulentViscosityWallFunction.h:35
INSFVTurbulentViscosityWallFunction::_mu_t
const Moose::Functor< ADReal > & _mu_t
Turbulent dynamic viscosity.
Definition INSFVTurbulentViscosityWallFunction.h:44
INSFVTurbulentViscosityWallFunction::_preserve_sparsity_pattern
const bool _preserve_sparsity_pattern
For Newton solves we want to add extra zero-valued terms regardless of y-plus to avoid sparsity patte...
Definition INSFVTurbulentViscosityWallFunction.h:56
INSFVTurbulentViscosityWallFunction::_wall_treatment
NS::WallTreatmentEnum _wall_treatment
Method used for wall treatment.
Definition INSFVTurbulentViscosityWallFunction.h:53
INSFVTurbulentViscosityWallFunction::_dim
const unsigned int _dim
the dimension of the domain
Definition INSFVTurbulentViscosityWallFunction.h:30
INSFVTurbulentViscosityWallFunction::_rho
const Moose::Functor< ADReal > & _rho
Density.
Definition INSFVTurbulentViscosityWallFunction.h:40
INSFVTurbulentViscosityWallFunction::_u_var
const Moose::Functor< ADReal > & _u_var
x-velocity
Definition INSFVTurbulentViscosityWallFunction.h:33
INSFVTurbulentViscosityWallFunction::_w_var
const Moose::Functor< ADReal > * _w_var
z-velocity
Definition INSFVTurbulentViscosityWallFunction.h:37
INSFVTurbulentViscosityWallFunction::_k
const Moose::Functor< ADReal > & _k
Turbulent kinetic energy.
Definition INSFVTurbulentViscosityWallFunction.h:47
INSFVTurbulentViscosityWallFunction::_mu
const Moose::Functor< ADReal > & _mu
Dynamic viscosity.
Definition INSFVTurbulentViscosityWallFunction.h:42
FVDirichletBCBase::getParam
const T & getParam(const std::string &name) const
FVDirichletBCBase::isParamValid
bool isParamValid(const std::string &name) const
MooseMesh::dimension
virtual unsigned int dimension() const
SubProblem::mesh
virtual MooseMesh & mesh()=0
NS::WallTreatmentEnum
WallTreatmentEnum
Wall treatment options.
Definition NS.h:187
libMesh::Real
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real

Member Function Documentation

◆ boundaryValue()

ADReal INSFVTurbulentViscosityWallFunction::boundaryValue ( const FaceInfo &  fi,
const Moose::StateArg &  state 
) const
overridevirtual

Implements FVDirichletBCBase.

Definition at line 54 of file INSFVTurbulentViscosityWallFunction.C.

56{
57 using std::abs, std::max, std::sqrt, std::pow, std::log;
58
59 // if on an internal face (internal to the mesh, but an external boundary of the flow area),
60 // we have to select the element on which the flow variables / viscosity is defined
61 const bool use_elem = (fi.faceType(_var_sys_numbers_pair) == FaceInfo::VarFaceNeighbors::ELEM);
62 const Real wall_dist = abs(
63 ((use_elem ? fi.elemCentroid() : fi.neighborCentroid()) - fi.faceCentroid()) * fi.normal());
64 const Elem * const elem_ptr = use_elem ? fi.elemPtr() : fi.neighborPtr();
65 const auto elem_arg = makeElemArg(elem_ptr);
66
67 // Get the previous non linear iteration values
68 const auto old_state = Moose::StateArg(1, Moose::SolutionIterationType::Nonlinear);
69 const auto mu = _mu(elem_arg, old_state);
70 const auto rho = _rho(elem_arg, old_state);
71
72 // Get the velocity vector
73 ADRealVectorValue velocity(_u_var(elem_arg, old_state));
74 if (_v_var)
75 velocity(1) = (*_v_var)(elem_arg, old_state);
76 if (_w_var)
77 velocity(2) = (*_w_var)(elem_arg, old_state);
78
79 // Compute the velocity and direction of the velocity component that is parallel to the wall
80 const auto parallel_speed =
81 NS::computeSpeed<ADReal>(velocity - velocity * (fi.normal()) * (fi.normal()));
82
83 // Switch for determining the near wall quantities
84 // wall_treatment can be: "eq_newton eq_incremental eq_linearized neq"
85 ADReal y_plus;
86 ADReal mut_log; // turbulent log-layer viscosity
87 ADReal mu_wall; // total wall viscosity to obtain the shear stress at the wall
88
89 if (_wall_treatment == NS::WallTreatmentEnum::EQ_NEWTON)
90 {
91 // Full Newton-Raphson solve to find the wall quantities from the law of the wall
92 const auto u_tau = NS::findUStar<ADReal>(mu, rho, parallel_speed, wall_dist);
93 y_plus = wall_dist * u_tau * rho / mu;
94 mu_wall = rho * Utility::pow<2>(u_tau) * wall_dist / parallel_speed;
95 mut_log = mu_wall - mu;
96 }
97 else if (_wall_treatment == NS::WallTreatmentEnum::EQ_INCREMENTAL)
98 {
99 // Incremental solve on y_plus to get the near-wall quantities
100 y_plus = NS::findyPlus<ADReal>(mu, rho, max(parallel_speed, 1e-10), wall_dist);
101 mu_wall =
102 mu * (NS::von_karman_constant * y_plus / log(max(NS::E_turb_constant * y_plus, 1 + 1e-4)));
103 mut_log = mu_wall - mu;
104 }
105 else if (_wall_treatment == NS::WallTreatmentEnum::EQ_LINEARIZED)
106 {
107 // Linearized approximation to the wall function to find the near-wall quantities faster
108 const ADReal a_c = 1 / NS::von_karman_constant;
109 const ADReal b_c =
110 1 / NS::von_karman_constant * (log(NS::E_turb_constant * max(wall_dist, 1.0) / mu) + 1.0);
111 const ADReal c_c = parallel_speed;
112
113 const auto u_tau = (-b_c + sqrt(pow(b_c, 2) + 4.0 * a_c * c_c)) / (2.0 * a_c);
114 y_plus = wall_dist * u_tau * rho / mu;
115 mu_wall = rho * Utility::pow<2>(u_tau) * wall_dist / parallel_speed;
116 mut_log = mu_wall - mu;
117 }
118 else if (_wall_treatment == NS::WallTreatmentEnum::NEQ)
119 {
120 // Assign non-equilibrium wall function value
121 y_plus = pow(_C_mu, 0.25) * wall_dist * sqrt(_k(elem_arg, old_state)) * rho / mu;
122 mu_wall = mu * (NS::von_karman_constant * y_plus /
123 log(max(NS::E_turb_constant * y_plus, 1.0 + 1e-4)));
124 mut_log = mu_wall - mu;
125 }
126 else
127 mooseAssert(false,
128 "For `INSFVTurbulentViscosityWallFunction` , wall treatment should not reach here");
129
130 ADReal residual = 0;
131 // To keep the same sparsity pattern for all y_plus
132 if (_preserve_sparsity_pattern)
133 residual = 0 * mut_log * y_plus;
134
135 if (y_plus <= 5.0)
136 // sub-laminar layer
137 residual += 0.0;
138 else if (y_plus >= 30.0)
139 // log-layer
140 residual += max(mut_log, NS::mu_t_low_limit);
141 else
142 {
143 // buffer layer
144 const auto blending_function = (y_plus - 5.0) / 25.0;
145 // the blending depends on the mut_log at y+=30
146 const auto mut_log = mu * _mut_30;
147 residual += max(blending_function * mut_log, NS::mu_t_low_limit);
148 }
149 return residual;
150}
pow
ExpressionBuilder::EBTerm pow(const ExpressionBuilder::EBTerm &left, T exponent)
Definition ExpressionBuilder.h:690
rho
const double rho
Definition GasLiquidMassTransferTest.C:27
FVDirichletBCBase::_var_sys_numbers_pair
const std::pair< unsigned int, unsigned int > _var_sys_numbers_pair
FaceInfo::normal
const Point & normal() const
FaceInfo::faceType
VarFaceNeighbors faceType(const std::pair< unsigned int, unsigned int > &var_sys) const
FaceInfo::neighborPtr
const Elem * neighborPtr() const
FaceInfo::elemPtr
const Elem * elemPtr() const
FaceInfo::elemCentroid
const Point & elemCentroid() const
FVDirichletBCBase::makeElemArg
Moose::ElemArg makeElemArg(const Elem *elem, bool correct_skewnewss=false) const
CompileTimeDerivatives::max
auto max(const L &left, const R &right)
CompileTimeDerivatives::log
auto log(const T &)
CompileTimeDerivatives::sqrt
CTSub CT_OPERATOR_BINARY CTMul CTCompareLess CTCompareGreater CTCompareEqual _arg template * sqrt(_arg)) *_arg.template D< dtag >()) CT_SIMPLE_UNARY_FUNCTION(tanh
Eigen::internal::abs
MetaPhysicL::DualNumber< V, D, asd > abs(const MetaPhysicL::DualNumber< V, D, asd > &a)
NS::mu_t_low_limit
static constexpr Real mu_t_low_limit
Definition NS.h:208
NS::findyPlus< ADReal >
template ADReal findyPlus< ADReal >(const ADReal &mu, const ADReal &rho, const ADReal &u, Real dist)
NS::von_karman_constant
static constexpr Real von_karman_constant
Definition NS.h:205
NS::computeSpeed< ADReal >
template ADReal computeSpeed< ADReal >(const libMesh::VectorValue< ADReal > &velocity)
NS::E_turb_constant
static constexpr Real E_turb_constant
Definition NS.h:206
NS::findUStar< ADReal >
template ADReal findUStar< ADReal >(const ADReal &mu, const ADReal &rho, const ADReal &u, const Real dist)

◆ validParams()

InputParameters INSFVTurbulentViscosityWallFunction::validParams ( )
static

Definition at line 17 of file INSFVTurbulentViscosityWallFunction.C.

18{
19 InputParameters params = FVDirichletBCBase::validParams();
20 params.addClassDescription("Adds Dirichlet BC for wall values of the turbulent viscosity.");
21 params.addRequiredParam<MooseFunctorName>("u", "The velocity in the x direction.");
22 params.addParam<MooseFunctorName>("v", "The velocity in the y direction.");
23 params.addParam<MooseFunctorName>("w", "The velocity in the z direction.");
24 params.addRequiredParam<MooseFunctorName>(NS::density, "Density");
25 params.addRequiredParam<MooseFunctorName>(NS::mu, "Dynamic viscosity.");
26 params.addRequiredParam<MooseFunctorName>(NS::mu_t, "The turbulent viscosity.");
27 params.addParam<MooseFunctorName>(NS::TKE, "The turbulent kinetic energy.");
28 params.addParam<Real>("C_mu", 0.09, "Coupled turbulent kinetic energy closure.");
29
30 MooseEnum wall_treatment("eq_newton eq_incremental eq_linearized neq", "neq");
31 params.addParam<MooseEnum>(
32 "wall_treatment", wall_treatment, "The method used for computing the wall functions");
33 return params;
34}
FVDirichletBCBase::validParams
static InputParameters validParams()
InputParameters::addRequiredParam
void addRequiredParam(const std::string &name, const std::string &doc_string)
InputParameters::addParam
void addParam(const std::string &name, const std::initializer_list< typename T::value_type > &value, const std::string &doc_string)
InputParameters::addClassDescription
void addClassDescription(const std::string &doc_string)
NS::density
static const std::string density
Definition NS.h:34
NS::mu_t
static const std::string mu_t
Definition NS.h:129
NS::mu
static const std::string mu
Definition NS.h:127
NS::TKE
static const std::string TKE
Definition NS.h:180

Referenced by WCNSFVTurbulencePhysicsBase::validParams().

Member Data Documentation

◆ _C_mu

const Real INSFVTurbulentViscosityWallFunction::_C_mu
private

C_mu turbulent coefficient.

Definition at line 50 of file INSFVTurbulentViscosityWallFunction.h.

Referenced by boundaryValue().

◆ _dim

const unsigned int INSFVTurbulentViscosityWallFunction::_dim
private

the dimension of the domain

Definition at line 30 of file INSFVTurbulentViscosityWallFunction.h.

◆ _k

const Moose::Functor<ADReal>& INSFVTurbulentViscosityWallFunction::_k
private

Turbulent kinetic energy.

Definition at line 47 of file INSFVTurbulentViscosityWallFunction.h.

Referenced by boundaryValue().

◆ _mu

const Moose::Functor<ADReal>& INSFVTurbulentViscosityWallFunction::_mu
private

Dynamic viscosity.

Definition at line 42 of file INSFVTurbulentViscosityWallFunction.h.

Referenced by boundaryValue().

◆ _mu_t

const Moose::Functor<ADReal>& INSFVTurbulentViscosityWallFunction::_mu_t
private

Turbulent dynamic viscosity.

Definition at line 44 of file INSFVTurbulentViscosityWallFunction.h.

◆ _mut_30

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

Definition at line 59 of file INSFVTurbulentViscosityWallFunction.h.

Referenced by boundaryValue().

◆ _preserve_sparsity_pattern

const bool INSFVTurbulentViscosityWallFunction::_preserve_sparsity_pattern
private

For Newton solves we want to add extra zero-valued terms regardless of y-plus to avoid sparsity pattern changes as y-plus changes near the walls.

Definition at line 56 of file INSFVTurbulentViscosityWallFunction.h.

Referenced by boundaryValue().

◆ _rho

const Moose::Functor<ADReal>& INSFVTurbulentViscosityWallFunction::_rho
private

Density.

Definition at line 40 of file INSFVTurbulentViscosityWallFunction.h.

Referenced by boundaryValue().

◆ _u_var

const Moose::Functor<ADReal>& INSFVTurbulentViscosityWallFunction::_u_var
private

x-velocity

Definition at line 33 of file INSFVTurbulentViscosityWallFunction.h.

Referenced by boundaryValue().

◆ _v_var

const Moose::Functor<ADReal>* INSFVTurbulentViscosityWallFunction::_v_var
private

y-velocity

Definition at line 35 of file INSFVTurbulentViscosityWallFunction.h.

Referenced by boundaryValue().

◆ _w_var

const Moose::Functor<ADReal>* INSFVTurbulentViscosityWallFunction::_w_var
private

z-velocity

Definition at line 37 of file INSFVTurbulentViscosityWallFunction.h.

Referenced by boundaryValue().

◆ _wall_treatment

NS::WallTreatmentEnum INSFVTurbulentViscosityWallFunction::_wall_treatment
private

Method used for wall treatment.

Definition at line 53 of file INSFVTurbulentViscosityWallFunction.h.

Referenced by boundaryValue().

The documentation for this class was generated from the following files:
Generated on Fri Aug 21 2026 13:43:05 for https://mooseframework.inl.gov by doxygen 1.9.8