GRINS-0.8.0
List of all members | Public Member Functions | Protected Attributes
GRINS::ConstantSourceFunction Class Reference

#include <constant_source_func.h>

Inheritance diagram for GRINS::ConstantSourceFunction:
Inheritance graph
[legend]
Collaboration diagram for GRINS::ConstantSourceFunction:
Collaboration graph
[legend]

Public Member Functions

 ConstantSourceFunction (const GetPot &input)
 
 ~ConstantSourceFunction ()
 
libMesh::Real operator() (const libMesh::Point &) const
 
libMesh::Gradient grad (const libMesh::Point &) 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 _value
 

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

Constructor & Destructor Documentation

GRINS::ConstantSourceFunction::ConstantSourceFunction ( const GetPot &  input)

Definition at line 31 of file constant_source_func.C.

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

32  : ParameterUser("ConstantSourceFunction"),
33  _value(0.0)
34  {
35  this->set_parameter
36  (_value, input, "Physics/SourceFunction/value", _value);
37  }
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.
ParameterUser(const std::string &user_name)
GRINS::ConstantSourceFunction::~ConstantSourceFunction ( )

Definition at line 39 of file constant_source_func.C.

40  {
41  return;
42  }

Member Function Documentation

libMesh::Gradient GRINS::ConstantSourceFunction::grad ( const libMesh::Point &  ) const
inline

Definition at line 52 of file constant_source_func.h.

53  {
54  return libMesh::Gradient();
55  }
libMesh::Real GRINS::ConstantSourceFunction::operator() ( const libMesh::Point &  ) const
inline

Definition at line 47 of file constant_source_func.h.

References _value.

48  {
49  return _value;
50  }

Member Data Documentation

libMesh::Real GRINS::ConstantSourceFunction::_value
protected

Definition at line 59 of file constant_source_func.h.

Referenced by ConstantSourceFunction(), and operator()().


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

Generated on Tue Dec 19 2017 12:47:30 for GRINS-0.8.0 by  doxygen 1.8.9.1