Kernel that adds contributions to the source and the sink of the turbulent kinetic energy discretized using the finite volume method to a linear system. More...

#include <LinearFVTKESourceSink.h>

Inheritance diagram for LinearFVTKESourceSink:

[legend]

Public Types
enum	ResidualTagType { ResidualTagType::NonReference, ResidualTagType::Reference }

typedef DataFileName	DataFileParameterType

Public Member Functions
	LinearFVTKESourceSink (const InputParameters &params)
	Class constructor. More...

virtual void	initialSetup () override

virtual Real	computeMatrixContribution () override

virtual Real	computeRightHandSideContribution () override

virtual void	addMatrixContribution () override

virtual void	addRightHandSideContribution () override

virtual void	setCurrentElemInfo (const ElemInfo *elem_info)

void	setCurrentElemVolume (const Real volume)

virtual const MooseLinearVariableFV< Real > &	variable () const override

void	linkTaggedVectorsAndMatrices (const std::set< TagID > &vector_tags, const std::set< TagID > &matrix_tags)

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

void	setRandomResetFrequency (ExecFlagType exec_flag)

unsigned long	getRandomLong () const

Real	getRandomReal () const

unsigned int	getSeed (std::size_t id)

unsigned int	getMasterSeed () const

bool	isNodal () const

ExecFlagType	getResetOnTime () const

void	setRandomDataPointer (RandomData *random_data)

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

const std::vector< SubdomainName > &	blocks () const

unsigned int	numBlocks () const

virtual const std::set< SubdomainID > &	blockIDs () const

unsigned int	blocksMaxDimension () const

bool	hasBlocks (const SubdomainName &name) const

bool	hasBlocks (const std::vector< SubdomainName > &names) const

bool	hasBlocks (const std::set< SubdomainName > &names) const

bool	hasBlocks (SubdomainID id) const

bool	hasBlocks (const std::vector< SubdomainID > &ids) const

bool	hasBlocks (const std::set< SubdomainID > &ids) const

bool	isBlockSubset (const std::set< SubdomainID > &ids) const

bool	isBlockSubset (const std::vector< SubdomainID > &ids) const

bool	hasBlockMaterialProperty (const std::string &prop_name)

const std::set< SubdomainID > &	meshBlockIDs () const

virtual bool	blockRestricted () const

virtual void	checkVariable (const MooseVariableFieldBase &variable) 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)

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 std::string	deduceFunctorName (const std::string &name, const InputParameters &params)

static void	setRMParamsAdvection (const InputParameters &obj_params, InputParameters &rm_params, const unsigned short conditional_extended_layers)

static void	setRMParamsDiffusion (const InputParameters &obj_params, InputParameters &rm_params, const unsigned short conditional_extended_layers)

Public Attributes
const ConsoleStream	_console

Protected Member Functions
std::string	deduceFunctorName (const std::string &name) const

void	requestVariableCellGradient (const std::string &variable_name)

virtual void	addUserObjectDependencyHelper (const UserObject &) const

virtual void	addPostprocessorDependencyHelper (const PostprocessorName &) const

virtual void	addVectorPostprocessorDependencyHelper (const VectorPostprocessorName &) const

T &	declareRestartableData (const std::string &data_name, Args &&... args)

ManagedValue< T >	declareManagedRestartableDataWithContext (const std::string &data_name, void *context, Args &&... args)

const T &	getRestartableData (const std::string &data_name) const

T &	declareRestartableDataWithContext (const std::string &data_name, void *context, Args &&... args)

T &	declareRecoverableData (const std::string &data_name, Args &&... args)

T &	declareRestartableDataWithObjectName (const std::string &data_name, const std::string &object_name, Args &&... args)

T &	declareRestartableDataWithObjectNameWithContext (const std::string &data_name, const std::string &object_name, void *context, Args &&... args)

std::string	restartableName (const std::string &data_name) 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	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 bool	hasBlockMaterialPropertyHelper (const std::string &prop_name)

void	initializeBlockRestrictable (const MooseObject *moose_object)

Moose::CoordinateSystemType	getBlockCoordSystem ()

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)

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

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 > &	_epsilon
	epsilon - dissipation rate of TKE More...

const Moose::Functor< Real > &	_rho
	Density. More...

const Moose::Functor< Real > &	_mu
	Dynamic viscosity. More...

const Moose::Functor< Real > &	_mu_t
	Turbulent dynamic viscosity. More...

const std::vector< BoundaryName > &	_wall_boundary_names
	Wall boundaries. More...

const bool	_linearized_model
	Linearized model? More...

const NS::WallTreatmentEnum	_wall_treatment
	Method used for wall treatment. More...

const Real	_C_mu
	C_mu constant. More...

const Real	_C_pl
	Production Limiter Constant. More...

const ElemInfo *	_current_elem_info

Real	_current_elem_volume

dof_id_type	_dof_id

MooseLinearVariableFV< Real > &	_var

const unsigned int	_var_num

const unsigned int	_sys_num

FEProblemBase &	_fe_problem

SystemBase &	_sys

libMesh::LinearImplicitSystem &	_linear_system

const THREAD_ID	_tid

MooseMesh &	_mesh

std::vector< NumericVector< Number > *>	_vectors

std::vector< SparseMatrix< Number > *>	_matrices

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

MooseApp &	_restartable_app

const std::string	_restartable_system_name

const THREAD_ID	_restartable_tid

const bool	_restartable_read_only

FEProblemBase &	_mci_feproblem

SubProblem &	_subproblem

DenseVector< Number >	_local_re

DenseMatrix< Number >	_local_ke

DenseMatrix< Number >	_nonlocal_ke

const MaterialData *	_blk_material_data

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


std::unordered_set< const Elem * >	_wall_bounded

std::map< const Elem *, std::vector< Real > >	_dist

std::map< const Elem , std::vector< const FaceInfo > >	_face_infos

Detailed Description

Kernel that adds contributions to the source and the sink of the turbulent kinetic energy discretized using the finite volume method to a linear system.

Definition at line 19 of file LinearFVTKESourceSink.h.

Constructor & Destructor Documentation

◆ LinearFVTKESourceSink()

LinearFVTKESourceSink::LinearFVTKESourceSink ( const InputParameters & params )

Class constructor.

Parameters

params The InputParameters for the kernel.

Definition at line 50 of file LinearFVTKESourceSink.C.

   : LinearFVElementalKernel(params),
     _dim(_subproblem.mesh().dimension()),
     _u_var(getFunctor<Real>("u")),
     _v_var(params.isParamValid("v") ? &(getFunctor<Real>("v")) : nullptr),
     _w_var(params.isParamValid("w") ? &(getFunctor<Real>("w")) : nullptr),
     _epsilon(getFunctor<Real>(NS::TKED)),
     _rho(getFunctor<Real>(NS::density)),
     _mu(getFunctor<Real>(NS::mu)),
     _mu_t(getFunctor<Real>(NS::mu_t)),
     _wall_boundary_names(getParam<std::vector<BoundaryName>>("walls")),
     _linearized_model(getParam<bool>("linearized_model")),
     _wall_treatment(getParam<MooseEnum>("wall_treatment").getEnum<NS::WallTreatmentEnum>()),
     _C_mu(getParam<Real>("C_mu")),
     _C_pl(getParam<Real>("C_pl"))
 {
   if (_dim >= 2 && !_v_var)
     paramError("v", "In two or more dimensions, the v velocity must be supplied!");
 
   if (_dim >= 3 && !_w_var)
     paramError("w", "In three or more dimensions, the w velocity must be supplied!");
 
   // // Strain tensor term requires velocity gradients;
   if (dynamic_cast<const MooseLinearVariableFV<Real> *>(&_u_var))
     requestVariableCellGradient(getParam<MooseFunctorName>("u"));
   if (dynamic_cast<const MooseLinearVariableFV<Real> *>(_v_var))
     requestVariableCellGradient(getParam<MooseFunctorName>("v"));
   if (dynamic_cast<const MooseLinearVariableFV<Real> *>(_w_var))
     requestVariableCellGradient(getParam<MooseFunctorName>("w"));
 }

Member Function Documentation

◆ computeMatrixContribution()

Real LinearFVTKESourceSink::computeMatrixContribution ( )

overridevirtual

Implements LinearFVElementalKernel.

Definition at line 92 of file LinearFVTKESourceSink.C.

 {
   /*
   Matrix contribution:
   - Computes near-wall TKE destruction
   - Computes bulk TKE destruction
   */
 
   // Useful variables
   const auto state = determineState();
   const auto elem_arg = makeElemArg(_current_elem_info->elem());
   const Real rho = _rho(elem_arg, state);
 
   if (_wall_bounded.find(_current_elem_info->elem()) != _wall_bounded.end())
   {
 
     // Useful variables
     const Real mu = _mu(elem_arg, state);
     const Real TKE = _var.getElemValue(*_current_elem_info, state);
 
     // Assembly variables
     Real production = 0.0;
     Real destruction = 0.0;
     Real tot_weight = 0.0;
     std::vector<Real> y_plus_vec, velocity_grad_norm_vec;
 
     // Get near-wall element velocity vector
     RealVectorValue velocity(_u_var(elem_arg, state));
     if (_v_var)
       velocity(1) = (*_v_var)(elem_arg, state);
     if (_w_var)
       velocity(2) = (*_w_var)(elem_arg, state);
 
     // Get faceInfo and distance vector for between all walls and elements
     const auto & face_info_vec = libmesh_map_find(_face_infos, _current_elem_info->elem());
     const auto & distance_vec = libmesh_map_find(_dist, _current_elem_info->elem());
     mooseAssert(distance_vec.size(), "Should have found a distance vector");
     mooseAssert(distance_vec.size() == face_info_vec.size(),
                 "Should be as many distance vectors as face info vectors");
 
     // Populate y+, near wall velocity gradient, and update weights
     for (unsigned int i = 0; i < distance_vec.size(); i++)
     {
       const auto parallel_speed = NS::computeSpeed<Real>(
           velocity - velocity * face_info_vec[i]->normal() * face_info_vec[i]->normal());
       const auto distance = distance_vec[i];
 
       Real y_plus;
       if (_wall_treatment == NS::WallTreatmentEnum::NEQ) // Non-equilibrium --> Non-iterative
         y_plus = distance * std::sqrt(std::sqrt(_C_mu) * TKE) * rho / mu;
       else // Equilibrium --> Iterative
         y_plus = NS::findyPlus<Real>(mu, rho, std::max(parallel_speed, 1e-10), distance);
 
       y_plus_vec.push_back(y_plus);
       const Real velocity_grad_norm = parallel_speed / distance;
       velocity_grad_norm_vec.push_back(velocity_grad_norm);
       tot_weight += 1.0;
     }
 
     // Compute near-wall production and destruction
     for (unsigned int i = 0; i < y_plus_vec.size(); i++)
     {
       const auto y_plus = y_plus_vec[i];
 
       const auto fi = face_info_vec[i];
       const bool defined_on_elem_side = _var.hasFaceSide(*fi, true);
       const Elem * const loc_elem = defined_on_elem_side ? &fi->elem() : fi->neighborPtr();
       const Moose::FaceArg facearg = {
           fi, Moose::FV::LimiterType::CentralDifference, false, false, loc_elem, nullptr};
 
       const Real wall_mut = _mu_t(facearg, state);
       const Real wall_mu = _mu(facearg, state);
       const auto tau_w = (wall_mut + wall_mu) * velocity_grad_norm_vec[i];
       const auto destruction_visc = 2.0 * wall_mu / Utility::pow<2>(distance_vec[i]) / tot_weight;
       const auto destruction_log = std::pow(_C_mu, 0.75) * rho * std::pow(TKE, 0.5) /
                                    (NS::von_karman_constant * distance_vec[i]) / tot_weight;
 
       if (y_plus < 11.25)
         destruction += destruction_visc;
       else
       {
         destruction += destruction_log;
         production += tau_w * std::pow(_C_mu, 0.25) / std::sqrt(TKE) /
                       (NS::von_karman_constant * distance_vec[i]) / tot_weight;
       }
     }
 
     // Assign terms to matrix to solve implicitly (they get multiplied by TKE)
     return (destruction - production) * _current_elem_volume;
   }
   else
   {
     // Compute destruction
     const auto destruction =
         rho * _epsilon(elem_arg, state) / _var.getElemValue(*_current_elem_info, state);
 
     // Assign to matrix to solve implicitly
     return destruction * _current_elem_volume;
   }
 }

◆ computeRightHandSideContribution()

Real LinearFVTKESourceSink::computeRightHandSideContribution ( )

overridevirtual

Implements LinearFVElementalKernel.

Definition at line 194 of file LinearFVTKESourceSink.C.

 {
 
   // Useful variables
   const auto state = determineState();
   const auto elem_arg = makeElemArg(_current_elem_info->elem());
 
   if (_wall_bounded.find(_current_elem_info->elem()) != _wall_bounded.end()) // Wall bounded
     return 0.0;                                                              // Do nothing
   else                                                                       // Not wall bounded
   {
     // Compute TKE production
     const auto symmetric_strain_tensor_sq_norm =
         NS::computeShearStrainRateNormSquared<Real>(_u_var, _v_var, _w_var, elem_arg, state);
 
     auto production = _mu_t(elem_arg, state) * symmetric_strain_tensor_sq_norm;
 
     // k-Production limiter (needed for flows with stagnation zones)
     const Real production_limit = _C_pl * _rho(elem_arg, state) * _epsilon(elem_arg, state);
 
     // Apply production limiter
     production = std::min(production, production_limit);
 
     // Assign production to RHS
     return production * _current_elem_volume;
   }
 }

◆ initialSetup()

void LinearFVTKESourceSink::initialSetup ( )

overridevirtual

Reimplemented from LinearFVElementalKernel.

Definition at line 82 of file LinearFVTKESourceSink.C.

 {
   LinearFVElementalKernel::initialSetup();
   NS::getWallBoundedElements(
       _wall_boundary_names, _fe_problem, _subproblem, blockIDs(), _wall_bounded);
   NS::getWallDistance(_wall_boundary_names, _fe_problem, _subproblem, blockIDs(), _dist);
   NS::getElementFaceArgs(_wall_boundary_names, _fe_problem, _subproblem, blockIDs(), _face_infos);
 }

◆ validParams()

InputParameters LinearFVTKESourceSink::validParams ( )

static

Definition at line 18 of file LinearFVTKESourceSink.C.

 {
   InputParameters params = LinearFVElementalKernel::validParams();
   params.addClassDescription("Elemental kernel to compute the production and destruction "
                              " terms of turbulent kinetic energy (TKE).");
   params.addRequiredParam<MooseFunctorName>("u", "The velocity in the x direction.");
   params.addParam<MooseFunctorName>("v", "The velocity in the y direction.");
   params.addParam<MooseFunctorName>("w", "The velocity in the z direction.");
   params.addRequiredParam<MooseFunctorName>(NS::TKED,
                                             "Coupled turbulent kinetic energy dissipation rate.");
   params.addRequiredParam<MooseFunctorName>(NS::density, "Fluid density");
   params.addRequiredParam<MooseFunctorName>(NS::mu, "Dynamic viscosity.");
   params.addRequiredParam<MooseFunctorName>(NS::mu_t, "Turbulent viscosity.");
 
   params.addParam<std::vector<BoundaryName>>(
       "walls", {}, "Boundaries that correspond to solid walls.");
   params.addParam<bool>(
       "linearized_model",
       true,
       "Boolean to determine if the problem should be use in a linear or nonlinear solve.");
   MooseEnum wall_treatment("eq_newton eq_incremental eq_linearized neq", "neq");
 
   params.addParam<MooseEnum>("wall_treatment",
                              wall_treatment,
                              "The method used for computing the wall functions "
                              "'eq_newton', 'eq_incremental', 'eq_linearized', 'neq'");
   params.addParam<Real>("C_mu", 0.09, "Coupled turbulent kinetic energy closure.");
   params.addParam<Real>("C_pl", 10.0, "Production Limiter Constant Multiplier.");
 
   return params;
 }

Member Data Documentation

◆ _C_mu

const Real LinearFVTKESourceSink::_C_mu

protected

C_mu constant.

Definition at line 69 of file LinearFVTKESourceSink.h.

Referenced by computeMatrixContribution().

◆ _C_pl

const Real LinearFVTKESourceSink::_C_pl

protected

Production Limiter Constant.

Definition at line 72 of file LinearFVTKESourceSink.h.

Referenced by computeRightHandSideContribution().

◆ _dim

const unsigned int LinearFVTKESourceSink::_dim

protected

The dimension of the domain.

Definition at line 38 of file LinearFVTKESourceSink.h.

Referenced by LinearFVTKESourceSink().

◆ _dist

std::map<const Elem *, std::vector<Real> > LinearFVTKESourceSink::_dist

protected

Definition at line 77 of file LinearFVTKESourceSink.h.

Referenced by computeMatrixContribution(), and initialSetup().

◆ _epsilon

const Moose::Functor<Real>& LinearFVTKESourceSink::_epsilon

protected

epsilon - dissipation rate of TKE

Definition at line 48 of file LinearFVTKESourceSink.h.

Referenced by computeMatrixContribution(), and computeRightHandSideContribution().

◆ _face_infos

std::map<const Elem *, std::vector<const FaceInfo *> > LinearFVTKESourceSink::_face_infos

protected

Definition at line 78 of file LinearFVTKESourceSink.h.

Referenced by computeMatrixContribution(), and initialSetup().

◆ _linearized_model

const bool LinearFVTKESourceSink::_linearized_model

protected

Linearized model?

Definition at line 63 of file LinearFVTKESourceSink.h.

◆ _mu

const Moose::Functor<Real>& LinearFVTKESourceSink::_mu

protected

Dynamic viscosity.

Definition at line 54 of file LinearFVTKESourceSink.h.

Referenced by computeMatrixContribution().

◆ _mu_t

const Moose::Functor<Real>& LinearFVTKESourceSink::_mu_t

protected

Turbulent dynamic viscosity.

Definition at line 57 of file LinearFVTKESourceSink.h.

Referenced by computeMatrixContribution(), and computeRightHandSideContribution().

◆ _rho

const Moose::Functor<Real>& LinearFVTKESourceSink::_rho

protected

Density.

Definition at line 51 of file LinearFVTKESourceSink.h.

Referenced by computeMatrixContribution(), and computeRightHandSideContribution().

◆ _u_var

const Moose::Functor<Real>& LinearFVTKESourceSink::_u_var

protected

x-velocity

Definition at line 41 of file LinearFVTKESourceSink.h.

Referenced by computeMatrixContribution(), computeRightHandSideContribution(), and LinearFVTKESourceSink().

◆ _v_var

const Moose::Functor<Real>* LinearFVTKESourceSink::_v_var

protected

y-velocity

Definition at line 43 of file LinearFVTKESourceSink.h.

Referenced by computeMatrixContribution(), computeRightHandSideContribution(), and LinearFVTKESourceSink().

◆ _w_var

const Moose::Functor<Real>* LinearFVTKESourceSink::_w_var

protected

z-velocity

Definition at line 45 of file LinearFVTKESourceSink.h.

Referenced by computeMatrixContribution(), computeRightHandSideContribution(), and LinearFVTKESourceSink().

◆ _wall_boundary_names

const std::vector<BoundaryName>& LinearFVTKESourceSink::_wall_boundary_names

protected

Wall boundaries.

Definition at line 60 of file LinearFVTKESourceSink.h.

Referenced by initialSetup().

◆ _wall_bounded

std::unordered_set<const Elem *> LinearFVTKESourceSink::_wall_bounded

protected

Maps for wall treatement

Definition at line 76 of file LinearFVTKESourceSink.h.

Referenced by computeMatrixContribution(), computeRightHandSideContribution(), and initialSetup().

◆ _wall_treatment

const NS::WallTreatmentEnum LinearFVTKESourceSink::_wall_treatment

protected

Method used for wall treatment.

Definition at line 66 of file LinearFVTKESourceSink.h.

Referenced by computeMatrixContribution().

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

navier_stokes/include/linearfvkernels/LinearFVTKESourceSink.h
navier_stokes/src/linearfvkernels/LinearFVTKESourceSink.C

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ LinearFVTKESourceSink()

Member Function Documentation

◆ computeMatrixContribution()

◆ computeRightHandSideContribution()

◆ initialSetup()

◆ validParams()

Member Data Documentation

◆ _C_mu

◆ _C_pl

◆ _dim

◆ _dist

◆ _epsilon

◆ _face_infos

◆ _linearized_model

◆ _mu

◆ _mu_t

◆ _rho

◆ _u_var

◆ _v_var

◆ _w_var

◆ _wall_boundary_names

◆ _wall_bounded

◆ _wall_treatment