GRINS::SpalartAllmarasParameters Class Reference

Encapsulate Spalart-Allmaras model parameters. More...

#include <spalart_allmaras_parameters.h>

Inheritance diagram for GRINS::SpalartAllmarasParameters:

Collaboration diagram for GRINS::SpalartAllmarasParameters:

Public Member Functions
	SpalartAllmarasParameters (const GetPot &input)
	~SpalartAllmarasParameters ()
libMesh::Real	source_fn (libMesh::Number nu, libMesh::Real mu, libMesh::Real wall_distance, libMesh::Real vorticity_value, bool infinite_distance) const
libMesh::Real	destruction_fn (libMesh::Number nu, libMesh::Real wall_distance, libMesh::Real S_tilde, bool infinite_distance) const
libMesh::Real	fv1 (libMesh::Real chi) const
	Helper function. More...
libMesh::Real	get_kappa () const
libMesh::Real	get_cv1 () const
libMesh::Real	get_cv2 () const
libMesh::Real	get_cv3 () const
libMesh::Real	get_cb1 () const
libMesh::Real	get_cb2 () const
libMesh::Real	get_sigma () const
libMesh::Real	get_c_w2 () const
libMesh::Real	get_c_w3 () const
libMesh::Real	get_r_lin () const
libMesh::Real	get_c_t3 () const
libMesh::Real	get_c_t4 () const
libMesh::Real	get_c_n1 () const
Public Member Functions inherited from GRINS::ParameterUser
	ParameterUser (const std::string &user_name)
virtual	~ParameterUser ()
virtual void	set_parameter (libMesh::Number &param_variable, const GetPot &input, const std::string &param_name, libMesh::Number param_default)
	Each subclass can simultaneously read a parameter value from. More...
virtual void	set_parameter (libMesh::ParsedFunction< libMesh::Number, libMesh::Gradient > &func, const GetPot &input, const std::string &func_param_name, const std::string &param_default)
	Each subclass can simultaneously read a parsed function from. More...
virtual void	set_parameter (libMesh::ParsedFEMFunction< libMesh::Number > &func, const GetPot &input, const std::string &func_param_name, const std::string &param_default)
	Each subclass can simultaneously read a parsed function from. More...
virtual void	move_parameter (const libMesh::Number &old_parameter, libMesh::Number &new_parameter)
	When cloning an object, we need to update parameter pointers. More...
virtual void	move_parameter (const libMesh::ParsedFunction< libMesh::Number, libMesh::Gradient > &old_func, libMesh::ParsedFunction< libMesh::Number, libMesh::Gradient > &new_func)
	When cloning an object, we need to update parameter pointers. More...
virtual void	move_parameter (const libMesh::ParsedFEMFunction< libMesh::Number > &old_func, libMesh::ParsedFEMFunction< libMesh::Number > &new_func)
	When cloning an object, we need to update parameter pointers. More...
virtual void	register_parameter (const std::string &param_name, libMesh::ParameterMultiAccessor< libMesh::Number > &param_pointer) const
	Each subclass will register its copy of an independent. More...

Protected Attributes
libMesh::Real	_kappa
	Constants specific to the calculation of the source function. More...
libMesh::Real	_cv1
libMesh::Real	_cv2
libMesh::Real	_cv3
libMesh::Real	_cb1
	Spalart Allmaras model constants, the constant _cw1 are calculated, not cached. More...
libMesh::Real	_sigma
libMesh::Real	_cb2
libMesh::Real	_r_lin
	Constants specific to the calculation of the destruction function. More...
libMesh::Real	_c_w2
libMesh::Real	_c_w3
libMesh::Real	_c_t3
	Constants specific to the calculation of the trip function (but used in. More...
libMesh::Real	_c_t4
libMesh::Real	_c_n1
	Constants specific to the calculation of the negative S-A model. More...

Private Member Functions
	SpalartAllmarasParameters ()

Additional Inherited Members
Static Public Attributes inherited from GRINS::ParameterUser
static std::string	zero_vector_function = std::string("{0}")
	A parseable function string with LIBMESH_DIM components, all 0. More...

Detailed Description

Encapsulate Spalart-Allmaras model parameters.

This is mostly a container class, but there are a few helper functions here that are used in different places in SpalartAllmaras classes.

Definition at line 40 of file spalart_allmaras_parameters.h.

Constructor & Destructor Documentation

GRINS::SpalartAllmarasParameters::SpalartAllmarasParameters

(

const GetPot &

input

)

Definition at line 37 of file spalart_allmaras_parameters.C.

References _c_n1, _c_t3, _c_t4, _c_w2, _c_w3, _cb1, _cb2, _cv1, _cv2, _cv3, _kappa, _r_lin, _sigma, GRINS::ParameterUser::set_parameter(), and GRINS::PhysicsNaming::spalart_allmaras().

    : ParameterUser("SpalartAllmarasParameters"),
      _kappa(input("Physics/"+PhysicsNaming::spalart_allmaras()+"/Parameters/kappa",0.41)),
      _cv1(input("Physics/"+PhysicsNaming::spalart_allmaras()+"/Parameters/cv1",7.1)),
      _cv2(input("Physics/"+PhysicsNaming::spalart_allmaras()+"/Parameters/cv2",0.7)),
      _cv3(input("Physics/"+PhysicsNaming::spalart_allmaras()+"/Parameters/cv3",0.9)),
      _cb1(input("Physics/"+PhysicsNaming::spalart_allmaras()+"/Parameters/cb1",0.1355)),
      _sigma(input("Physics/"+PhysicsNaming::spalart_allmaras()+"/Parameters/sigma",2./3.)),
      _cb2(input("Physics/"+PhysicsNaming::spalart_allmaras()+"/Parameters/cb2",0.622)),
      //_cw1( _cb1/(_kappa*_kappa) + (1.0+_cb2)/_sigma ),
      _r_lin(input("Physics/"+PhysicsNaming::spalart_allmaras()+"/Parameters/r_lin",10.0)),
      _c_w2(input("Physics/"+PhysicsNaming::spalart_allmaras()+"/Parameters/c_w2",0.3)),
      _c_w3(input("Physics/"+PhysicsNaming::spalart_allmaras()+"/Parameters/c_w3",2.0)),
      _c_t3(input("Physics/"+PhysicsNaming::spalart_allmaras()+"/Parameters/c_t3",1.2)),
      _c_t4(input("Physics/"+PhysicsNaming::spalart_allmaras()+"/Parameters/c_t4",0.5)),
      _c_n1(input("Physics/"+PhysicsNaming::spalart_allmaras()+"/Parameters/c_n1",16.0))
  {
    this->set_parameter(this->_kappa ,input, "Physics/"+PhysicsNaming::spalart_allmaras()+"/Parameters/kappa" , this->_kappa );
    this->set_parameter(this->_cv1 ,input, "Physics/"+PhysicsNaming::spalart_allmaras()+"/Parameters/cv1", this->_cv1 );
    this->set_parameter(this->_cv2 ,input, "Physics/"+PhysicsNaming::spalart_allmaras()+"/Parameters/cv2", this->_cv2 );
    this->set_parameter(this->_cv3 ,input, "Physics/"+PhysicsNaming::spalart_allmaras()+"/Parameters/cv3", this->_cv3 );
    this->set_parameter(this->_cb1 ,input, "Physics/"+PhysicsNaming::spalart_allmaras()+"/Parameters/cb1", this->_cb1 );
    this->set_parameter(this->_sigma ,input, "Physics/"+PhysicsNaming::spalart_allmaras()+"/Parameters/sigma", this->_sigma );
    this->set_parameter(this->_cb2 ,input, "Physics/"+PhysicsNaming::spalart_allmaras()+"/Parameters/cb2" , this->_cb2 );
    this->set_parameter(this->_r_lin ,input, "Physics/"+PhysicsNaming::spalart_allmaras()+"/Parameters/r_lin", this->_r_lin );
    this->set_parameter(this->_c_w2 ,input, "Physics/"+PhysicsNaming::spalart_allmaras()+"/Parameters/c_w2", this->_c_w2 );
    this->set_parameter(this->_c_w3 ,input, "Physics/"+PhysicsNaming::spalart_allmaras()+"/Parameters/c_w3", this->_c_w3 );
    this->set_parameter(this->_c_t3 ,input, "Physics/"+PhysicsNaming::spalart_allmaras()+"/Parameters/c_t3", this->_c_t3 );
    this->set_parameter(this->_c_t4 ,input, "Physics/"+PhysicsNaming::spalart_allmaras()+"/Parameters/c_t4", this->_c_t4 );
    this->set_parameter(this->_c_n1 ,input, "Physics/"+PhysicsNaming::spalart_allmaras()+"/Parameters/c_n1", this->_c_n1 );
  }

GRINS::SpalartAllmarasParameters::~SpalartAllmarasParameters ( )

inline

Definition at line 46 of file spalart_allmaras_parameters.h.

{};

GRINS::SpalartAllmarasParameters::SpalartAllmarasParameters ( )

private

Member Function Documentation

libMesh::Real GRINS::SpalartAllmarasParameters::destruction_fn	(	libMesh::Number	nu,
		libMesh::Real	wall_distance,
		libMesh::Real	S_tilde,
		bool	infinite_distance
	)		const

Definition at line 109 of file spalart_allmaras_parameters.C.

References _c_w2, _c_w3, _kappa, and _r_lin.

Referenced by GRINS::SpalartAllmarasStabilizationHelper::compute_res_spalart_steady().

  {
    // Step 1
    libMesh::Real r = 0.0;
    if(infinite_distance)
      {
        r = 0.0;
      }
    else
      {
        r = std::min(nu/(S_tilde*pow(this->_kappa,2.0)*pow(wall_distance,2.0)), this->_r_lin);
      }

    // Step 2
    libMesh::Real g = r + this->_c_w2*(pow(r,6.0) - r);

    // Step 3
    libMesh::Real fw = g*pow(((1 + pow(this->_c_w3,6.0))/(pow(g,6.0) + pow(this->_c_w3,6.0))), 1.0/6.0);

    return fw;
  }

libMesh::Real GRINS::SpalartAllmarasParameters::fv1 ( libMesh::Real  chi ) const

inline

Helper function.

This expression appears in a couple of places so we provide a function for it

Definition at line 124 of file spalart_allmaras_parameters.h.

References get_cv1().

Referenced by source_fn().

  {
    libMesh::Real chi3 = chi*chi*chi;
    libMesh::Real cv1 = this->get_cv1();
    libMesh::Real cv13 = cv1*cv1*cv1;

    return chi3/(chi3 + cv13);
  }

libMesh::Real GRINS::SpalartAllmarasParameters::get_c_n1 ( ) const

inline

Definition at line 96 of file spalart_allmaras_parameters.h.

References _c_n1.

    { return _c_n1;}

libMesh::Real GRINS::SpalartAllmarasParameters::get_c_t3 ( ) const

inline

Definition at line 90 of file spalart_allmaras_parameters.h.

References _c_t3.

    { return _c_t3;}

libMesh::Real GRINS::SpalartAllmarasParameters::get_c_t4 ( ) const

inline

Definition at line 93 of file spalart_allmaras_parameters.h.

References _c_t4.

    { return _c_t4;}

libMesh::Real GRINS::SpalartAllmarasParameters::get_c_w2 ( ) const

inline

Definition at line 81 of file spalart_allmaras_parameters.h.

References _c_w2.

    { return _c_w2;}

libMesh::Real GRINS::SpalartAllmarasParameters::get_c_w3 ( ) const

inline

Definition at line 84 of file spalart_allmaras_parameters.h.

References _c_w3.

    { return _c_w3;}

libMesh::Real GRINS::SpalartAllmarasParameters::get_cb1 ( ) const

inline

Definition at line 72 of file spalart_allmaras_parameters.h.

References _cb1.

Referenced by GRINS::SpalartAllmarasStabilizationHelper::compute_res_spalart_steady().

    { return _cb1;}

libMesh::Real GRINS::SpalartAllmarasParameters::get_cb2 ( ) const

inline

Definition at line 75 of file spalart_allmaras_parameters.h.

References _cb2.

Referenced by GRINS::SpalartAllmarasStabilizationHelper::compute_res_spalart_steady().

    { return _cb2;}

libMesh::Real GRINS::SpalartAllmarasParameters::get_cv1 ( ) const

inline

Definition at line 63 of file spalart_allmaras_parameters.h.

References _cv1.

Referenced by fv1().

    { return _cv1;}

libMesh::Real GRINS::SpalartAllmarasParameters::get_cv2 ( ) const

inline

Definition at line 66 of file spalart_allmaras_parameters.h.

References _cv2.

    { return _cv2;}

libMesh::Real GRINS::SpalartAllmarasParameters::get_cv3 ( ) const

inline

Definition at line 69 of file spalart_allmaras_parameters.h.

References _cv3.

    { return _cv3;}

libMesh::Real GRINS::SpalartAllmarasParameters::get_kappa ( ) const

inline

Definition at line 60 of file spalart_allmaras_parameters.h.

References _kappa.

Referenced by GRINS::SpalartAllmarasStabilizationHelper::compute_res_spalart_steady().

    { return _kappa;}

libMesh::Real GRINS::SpalartAllmarasParameters::get_r_lin ( ) const

inline

Definition at line 87 of file spalart_allmaras_parameters.h.

References _r_lin.

    { return _r_lin;}

libMesh::Real GRINS::SpalartAllmarasParameters::get_sigma ( ) const

inline

Definition at line 78 of file spalart_allmaras_parameters.h.

References _sigma.

Referenced by GRINS::SpalartAllmarasStabilizationHelper::compute_res_spalart_steady().

    { return _sigma;}

libMesh::Real GRINS::SpalartAllmarasParameters::source_fn	(	libMesh::Number	nu,
		libMesh::Real	mu,
		libMesh::Real	wall_distance,
		libMesh::Real	vorticity_value,
		bool	infinite_distance
	)		const

Definition at line 69 of file spalart_allmaras_parameters.C.

References _cv2, _cv3, _kappa, and fv1().

Referenced by GRINS::SpalartAllmarasStabilizationHelper::compute_res_spalart_steady().

  {
    // Step 1
    libMesh::Real chi = nu/mu;

    // Step 2
    libMesh::Real fv1 = this->fv1(chi);

    // Step 3
    libMesh::Real fv2 = 1 - (chi/(1 + chi*fv1));

    libMesh::Real S_bar = 0.0;
    // Step 4
    if(infinite_distance)
      {
        S_bar = 0.0;
      }
    else
      {
        S_bar = nu/(pow(_kappa, 2.0) * pow(wall_distance, 2.0))*(fv2) ;
      }

    // Step 5, the absolute value of the vorticity
    libMesh::Real S = vorticity_value;

    // Step 6
    libMesh::Real S_tilde = 0.0;
    if(S_bar >= -this->_cv2*S)
      {
        S_tilde = S + S_bar;
      }
    else
      {
        S_tilde = S + (S*(pow(this->_cv2,2.0)*S + this->_cv3*S_bar))/((this->_cv3 - (2*this->_cv2))*S - S_bar);
      }

    return S_tilde;
  }

Member Data Documentation

libMesh::Real GRINS::SpalartAllmarasParameters::_c_n1

protected

Constants specific to the calculation of the negative S-A model.

Definition at line 115 of file spalart_allmaras_parameters.h.

Referenced by get_c_n1(), and SpalartAllmarasParameters().

libMesh::Real GRINS::SpalartAllmarasParameters::_c_t3

protected

Constants specific to the calculation of the trip function (but used in.

Definition at line 112 of file spalart_allmaras_parameters.h.

Referenced by get_c_t3(), and SpalartAllmarasParameters().

libMesh::Real GRINS::SpalartAllmarasParameters::_c_t4

protected

Definition at line 112 of file spalart_allmaras_parameters.h.

Referenced by get_c_t4(), and SpalartAllmarasParameters().

libMesh::Real GRINS::SpalartAllmarasParameters::_c_w2

protected

Definition at line 108 of file spalart_allmaras_parameters.h.

Referenced by destruction_fn(), get_c_w2(), and SpalartAllmarasParameters().

libMesh::Real GRINS::SpalartAllmarasParameters::_c_w3

protected

Definition at line 108 of file spalart_allmaras_parameters.h.

Referenced by destruction_fn(), get_c_w3(), and SpalartAllmarasParameters().

libMesh::Real GRINS::SpalartAllmarasParameters::_cb1

protected

Spalart Allmaras model constants, the constant _cw1 are calculated, not cached.

Definition at line 105 of file spalart_allmaras_parameters.h.

Referenced by get_cb1(), and SpalartAllmarasParameters().

libMesh::Real GRINS::SpalartAllmarasParameters::_cb2

protected

Definition at line 105 of file spalart_allmaras_parameters.h.

Referenced by get_cb2(), and SpalartAllmarasParameters().

libMesh::Real GRINS::SpalartAllmarasParameters::_cv1

protected

Definition at line 102 of file spalart_allmaras_parameters.h.

Referenced by get_cv1(), and SpalartAllmarasParameters().

libMesh::Real GRINS::SpalartAllmarasParameters::_cv2

protected

Definition at line 102 of file spalart_allmaras_parameters.h.

Referenced by get_cv2(), source_fn(), and SpalartAllmarasParameters().

libMesh::Real GRINS::SpalartAllmarasParameters::_cv3

protected

Definition at line 102 of file spalart_allmaras_parameters.h.

Referenced by get_cv3(), source_fn(), and SpalartAllmarasParameters().

libMesh::Real GRINS::SpalartAllmarasParameters::_kappa

protected

Constants specific to the calculation of the source function.

Definition at line 102 of file spalart_allmaras_parameters.h.

Referenced by destruction_fn(), get_kappa(), source_fn(), and SpalartAllmarasParameters().

libMesh::Real GRINS::SpalartAllmarasParameters::_r_lin

protected

Constants specific to the calculation of the destruction function.

Definition at line 108 of file spalart_allmaras_parameters.h.

Referenced by destruction_fn(), get_r_lin(), and SpalartAllmarasParameters().

libMesh::Real GRINS::SpalartAllmarasParameters::_sigma

protected

Definition at line 105 of file spalart_allmaras_parameters.h.

Referenced by get_sigma(), and SpalartAllmarasParameters().

---

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

• src/physics/include/grins/spalart_allmaras_parameters.h
• src/physics/src/spalart_allmaras_parameters.C