https://mooseframework.inl.gov
SCMMixingConstantBeta.C
Go to the documentation of this file.
1 //* This file is part of the MOOSE framework
2 //* https://mooseframework.inl.gov
3 //*
4 //* All rights reserved, see COPYRIGHT for full restrictions
5 //* https://github.com/idaholab/moose/blob/master/COPYRIGHT
6 //*
7 //* Licensed under LGPL 2.1, please see LICENSE for details
8 //* https://www.gnu.org/licenses/lgpl-2.1.html
9 
10 #include "SCMMixingConstantBeta.h"
12 
14 
17 {
19  params.addClassDescription(
20  "Class that models the turbulent mixing coefficient beta as a user defined constant.");
21  params.addRequiredParam<Real>("beta", "Turbulent mixing parameter [-].");
22  return params;
23 }
24 
26  : SCMMixingClosureBase(parameters), _beta(getParam<Real>("beta"))
27 {
28 }
29 
30 Real
31 SCMMixingConstantBeta::computeMixingParameter(const unsigned int /*i_gap*/,
32  const unsigned int /*iz*/) const
33 {
34  return _beta;
35 }
registerMooseObject("SubChannelApp", SCMMixingConstantBeta)
static InputParameters validParams()
Base class for turbulent mixing closures used in SCM.
void addRequiredParam(const std::string &name, const std::string &doc_string)
virtual Real computeMixingParameter(const unsigned int i_gap, const unsigned int iz) const override
Computes the turbulent mixing coefficient for the local conditions around gap(i_gap) and axial level(...
static InputParameters validParams()
const Real _beta
Turbulent mixing parameter.
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
SCMMixingConstantBeta(const InputParameters &parameters)
Class that models the turbulent mixing coefficient $$ as a user-defined constant. ...
void addClassDescription(const std::string &doc_string)