#include <spalart_allmaras_viscosity.h>

Inheritance diagram for GRINS::SpalartAllmarasViscosity< Viscosity >:

Collaboration diagram for GRINS::SpalartAllmarasViscosity< Viscosity >:

Public Member Functions
	SpalartAllmarasViscosity (const GetPot &input, const std::string &material)
	Constructor with specified material. More...

	SpalartAllmarasViscosity (const GetPot &input)
	Deprecated constructor. More...

	~SpalartAllmarasViscosity ()

libMesh::Real	operator() (AssemblyContext &context, unsigned int qp) const

libMesh::Real	operator() (const libMesh::Point &p, const libMesh::Real time=0)

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

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

Protected Attributes
Viscosity	_mu
	Viscosity object (so we have access to the physical viscosity) More...

TurbulenceFEVariables &	_turbulence_vars

SpalartAllmarasParameters	_sa_params

Private Member Functions
	SpalartAllmarasViscosity ()

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

template<class Viscosity>
class GRINS::SpalartAllmarasViscosity< Viscosity >

Definition at line 51 of file spalart_allmaras_viscosity.h.

Constructor & Destructor Documentation

template<class Mu >

GRINS::SpalartAllmarasViscosity< Mu >::SpalartAllmarasViscosity	(	const GetPot &	input,
		const std::string &	material
	)

Constructor with specified material.

Definition at line 59 of file spalart_allmaras_viscosity.C.

                                                                                                         :
     ParameterUser("SpalartAllmarasViscosity"),
     _mu(input,material),
     _turbulence_vars(GRINSPrivate::VariableWarehouse::get_variable_subclass<TurbulenceFEVariables>(VariablesParsing::turb_variable_name(input,PhysicsNaming::spalart_allmaras(),VariablesParsing::PHYSICS))),
     _sa_params(input)
   {}

template<class Mu >

GRINS::SpalartAllmarasViscosity< Mu >::SpalartAllmarasViscosity ( const GetPot & input )

Deprecated constructor.

Definition at line 36 of file spalart_allmaras_viscosity.C.

References grins_warning.

     : ParameterUser("SpalartAllmarasViscosity"),
       _mu(input),
       _turbulence_vars(GRINSPrivate::VariableWarehouse::get_variable_subclass<TurbulenceFEVariables>(VariablesParsing::turb_variable_name(input,PhysicsNaming::spalart_allmaras(),VariablesParsing::PHYSICS))),
       _sa_params(input)
   {
     // Warning about this constructor being deprecated
     {
       std::string warning = "WARNING: Use of this constructor is DEPRECATED.\n";
       warning += "         Please update to use constructor with input material name.\n";
       grins_warning(warning);
     }
 
     if( !input.have_variable("Materials/Viscosity/mu") )
       {
         std::cerr<<"No viscosity has been specified."<<std::endl;
 
         libmesh_error();
       }
     return;
   }

template<class Viscosity >

GRINS::SpalartAllmarasViscosity< Viscosity >::~SpalartAllmarasViscosity ( )

inline

Definition at line 60 of file spalart_allmaras_viscosity.h.

60 {};

template<class Viscosity >

GRINS::SpalartAllmarasViscosity< Viscosity >::SpalartAllmarasViscosity ( )

private

Member Function Documentation

template<class Mu >

libMesh::Real GRINS::SpalartAllmarasViscosity< Mu >::operator()	(	AssemblyContext &	context,
		unsigned int	qp
	)		const

Definition at line 78 of file spalart_allmaras_viscosity.C.

   {
     // The physical viscosity
     libMesh::Real mu_physical = this->_mu(context, qp);
 
     // The unscaled turbulent viscosity (the nu the SA physics solves for)
     libMesh::Real nu = context.interior_value(this->_turbulence_vars.nu(),qp);
 
     // Assert that mu_value is greater than 0
     if(nu < 0.0)
       {
         libmesh_warning("Negative turbulent viscosity encountered !");
 
         // We are using a negative S-A model, so will set eddy viscosity to zero
         // if the turbulent viscosity nu < 0.0
         nu = 0.0;
       }
 
     // Step 1
     libMesh::Real chi = nu/mu_physical;
 
     // Step 2
     libMesh::Real fv1 = _sa_params.fv1(chi);
 
     // Step 3
     libMesh::Real mu_turbulent = nu*fv1;
 
     // Compute the value of the total viscosity and return it
     libMesh::Number mu_value = mu_turbulent + mu_physical; // Turbulent viscosity + physical viscosity
 
     return mu_value;
   }

template<class Viscosity >

libMesh::Real GRINS::SpalartAllmarasViscosity< Viscosity >::operator()	(	const libMesh::Point &	p,
		const libMesh::Real	time = `0`
	)

inline

Definition at line 64 of file spalart_allmaras_viscosity.h.

References GRINS::SpalartAllmarasViscosity< Viscosity >::_mu.

65 { return _mu(p,time); }

GRINS::SpalartAllmarasViscosity::_mu

Viscosity _mu

Viscosity object (so we have access to the physical viscosity)

Definition: spalart_allmaras_viscosity.h:77

template<class Mu >

void GRINS::SpalartAllmarasViscosity< Mu >::register_parameter	(	const std::string &	param_name,
		libMesh::ParameterMultiAccessor< libMesh::Number > &	param_pointer
	)		const

virtual

Each subclass will register its copy of an independent.

Reimplemented from GRINS::ParameterUser.

Definition at line 68 of file spalart_allmaras_viscosity.C.

References GRINS::ParameterUser::register_parameter().

   {
     ParameterUser::register_parameter(param_name, param_pointer);
     this->_mu.register_parameter(param_name, param_pointer);
     this->_sa_params.register_parameter(param_name, param_pointer);
   }