GRINS::ConstantCatalycity Class Reference

#include <constant_catalycity.h>

Inheritance diagram for GRINS::ConstantCatalycity:

Collaboration diagram for GRINS::ConstantCatalycity:

Public Member Functions
	ConstantCatalycity (const libMesh::Real gamma)
virtual	~ConstantCatalycity ()
virtual libMesh::Real	operator() (const libMesh::Real T) const
virtual libMesh::Real	dT (const libMesh::Real T) const
virtual void	set_params (const std::vector< libMesh::Real > &params)
virtual CatalycityBase *	clone () const
	Creates a new copy of the current class. More...
virtual void	set_parameters (const GetPot &input, const std::string &param_base)
	Sets parameters for use in sensitivity analysis. More...
Public Member Functions inherited from GRINS::CatalycityBase
	CatalycityBase ()
virtual	~CatalycityBase ()
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	_gamma

Private Member Functions
	ConstantCatalycity ()

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

Definition at line 33 of file constant_catalycity.h.

Constructor & Destructor Documentation

GRINS::ConstantCatalycity::ConstantCatalycity

(

const libMesh::Real

gamma

)

Definition at line 30 of file constant_catalycity.C.

    : _gamma(gamma)
  {
    return;
  }

GRINS::ConstantCatalycity::~ConstantCatalycity ( )

virtual

Definition at line 36 of file constant_catalycity.C.

  {
    return;
  }

GRINS::ConstantCatalycity::ConstantCatalycity ( )

private

Referenced by clone().

Member Function Documentation

CatalycityBase * GRINS::ConstantCatalycity::clone ( ) const

virtual

Creates a new copy of the current class.

A raw pointer is returned and it is assumed the user will take ownership and worry about memory management.

Implements GRINS::CatalycityBase.

Definition at line 60 of file constant_catalycity.C.

References ConstantCatalycity().

  {
    return new ConstantCatalycity( *this );
  }

libMesh::Real GRINS::ConstantCatalycity::dT ( const libMesh::Real  T ) const

virtual

Implements GRINS::CatalycityBase.

Definition at line 46 of file constant_catalycity.C.

Referenced by main().

  {
    return 0.0;
  }

libMesh::Real GRINS::ConstantCatalycity::operator() ( const libMesh::Real  T ) const

virtual

Implements GRINS::CatalycityBase.

Definition at line 41 of file constant_catalycity.C.

References _gamma.

  {
    return _gamma;
  }

void GRINS::ConstantCatalycity::set_parameters ( const GetPot &  input, const std::string &  param_base  )

virtual

Sets parameters for use in sensitivity analysis.

Implements GRINS::CatalycityBase.

Definition at line 65 of file constant_catalycity.C.

References _gamma, and GRINS::ParameterUser::set_parameter().

  {
    std::string gamma_str = param_base+"gamma";
    this->set_parameter(_gamma,input,gamma_str,_gamma);
  }

void GRINS::ConstantCatalycity::set_params ( const std::vector< libMesh::Real > &  params )

virtual

Implements GRINS::CatalycityBase.

Definition at line 51 of file constant_catalycity.C.

References _gamma.

Referenced by main().

  {
    libmesh_assert_equal_to( params.size(), 1 );

    _gamma = params[0];

    return;
  }

Member Data Documentation

libMesh::Real GRINS::ConstantCatalycity::_gamma

protected

Definition at line 56 of file constant_catalycity.h.

Referenced by operator()(), set_parameters(), and set_params().

---

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

• src/boundary_conditions/include/grins/constant_catalycity.h
• src/boundary_conditions/src/constant_catalycity.C