GRINS::CatalycityBase Class Reference

#include <catalycity_base.h>

Inheritance diagram for GRINS::CatalycityBase:

Collaboration diagram for GRINS::CatalycityBase:

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

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 39 of file catalycity_base.h.

Constructor & Destructor Documentation

GRINS::CatalycityBase::CatalycityBase

(

)

Definition at line 31 of file catalycity_base.C.

    : ParameterUser("CatalycityBase")
  {
    return;
  }

GRINS::CatalycityBase::~CatalycityBase ( )

virtual

Definition at line 37 of file catalycity_base.C.

  {
    return;
  }

Member Function Documentation

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

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

Implemented in GRINS::ArrheniusCatalycity, GRINS::ConstantCatalycity, and GRINS::PowerLawCatalycity.

virtual libMesh::Real GRINS::CatalycityBase::dT ( const libMesh::Real  T ) const

pure virtual

Implemented in GRINS::ArrheniusCatalycity, GRINS::ConstantCatalycity, and GRINS::PowerLawCatalycity.

virtual libMesh::Real GRINS::CatalycityBase::operator() ( const libMesh::Real  T ) const

pure virtual

Implemented in GRINS::ArrheniusCatalycity, GRINS::ConstantCatalycity, and GRINS::PowerLawCatalycity.

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

pure virtual

Sets parameters for use in sensitivity analysis.

Implemented in GRINS::ArrheniusCatalycity, GRINS::ConstantCatalycity, and GRINS::PowerLawCatalycity.

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

pure virtual

Implemented in GRINS::ArrheniusCatalycity, GRINS::ConstantCatalycity, and GRINS::PowerLawCatalycity.

---

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

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