#include <Function.h>

Inheritance diagram for Function:

Collaboration diagram for Function:

Public Member Functions
unsigned int	addVar ()

	Function ()

	Function (const Function &rhs)

double	getConst (string name) const

double	getDerivative () const

bool	getDoEvalAtReinit () const

string	getExpr (const Eref &e) const

string	getIndependent () const

unsigned int	getMode () const

unsigned int	getNumVar () const

double	getRate () const

bool	getUseTrigger () const

double	getValue () const

Variable *	getVar (unsigned int ii)

vector< string >	getVars () const

vector< double >	getY () const

virtual void	innerSetExpr (const Eref &e, string expr)

Function &	operator= (const Function rhs)

void	process (const Eref &e, ProcPtr p)

void	reinit (const Eref &e, ProcPtr p)

void	setConst (string name, double value)

void	setDoEvalAtReinit (bool doEvalAtReinit)

void	setExpr (const Eref &e, string expr)

void	setIndependent (string index)

void	setMode (unsigned int mode)

void	setNumVar (unsigned int num)

void	setUseTrigger (bool useTrigger)

void	setVar (unsigned int index, double value)

void	setVarValues (vector< string > vars, vector< double > vals)

	~Function ()

Static Public Member Functions
static const Cinfo *	initCinfo ()

Static Public Attributes
static const int	VARMAX

Protected Member Functions
void	_clearBuffer ()

void	_showError (mu::Parser::exception_type &e) const

Protected Attributes
map< string, double * >	_constbuf

bool	_doEvalAtReinit

string	_independent

double	_lastValue

unsigned int	_mode

unsigned int	_numVar

mu::Parser	_parser

vector< double * >	_pullbuf

double	_rate

char *	_stoich

double	_t

bool	_useTrigger

bool	_valid

double	_value

vector< Variable * >	_varbuf

Friends
double *	_functionAddVar (const char name, void data)

Detailed Description

Definition at line 60 of file Function.h.

Constructor & Destructor Documentation

Function::Function ( )

Definition at line 329 of file Function.cpp.

References _clearBuffer(), _functionAddVar, _independent, _parser, _showError(), and _valid.

                   : _t(0.0), _valid(false), _numVar(0), _lastValue(0.0),
     _value(0.0), _rate(0.0), _mode(1),
     _useTrigger( false ), _doEvalAtReinit( false ), _stoich(0)
 {
     _parser.SetVarFactory(_functionAddVar, this);
     _independent = "x0";
     //extendMuParser( );
 
     // Adding this default expression by default to avoid complains from GUI
     try{
         _parser.SetExpr("0");
     } catch (mu::Parser::exception_type &e) {
         _showError(e);
         _clearBuffer();
         return;
     }
     _valid = true;
 }

Here is the call graph for this function:

Function::Function ( const Function & rhs )

Definition at line 360 of file Function.cpp.

References _functionAddVar, _independent, _parser, _pullbuf, _varbuf, getExpr(), and setExpr().

                                      : _numVar(rhs._numVar),
     _lastValue(rhs._lastValue),
     _value(rhs._value), _rate(rhs._rate),
     _mode(rhs._mode),
     _useTrigger( rhs._useTrigger),
     _stoich(0)
 {
     static Eref er;
     _independent = rhs._independent;
 
     _parser.SetVarFactory(_functionAddVar, this);
     //extendMuParser( );
 
     // Copy the constants
     mu::valmap_type cmap = rhs._parser.GetConst();
     if (cmap.size()){
         mu::valmap_type::const_iterator item = cmap.begin();
         for (; item!=cmap.end(); ++item){
             _parser.DefineConst(item->first, item->second);
         }
     }
 
 
     setExpr(er, rhs.getExpr( er ));
     // Copy the values from the var pointers in rhs
     assert(_varbuf.size() == rhs._varbuf.size());
     for (unsigned int ii = 0; ii < rhs._varbuf.size(); ++ii){
         _varbuf[ii]->value = rhs._varbuf[ii]->value;
     }
     assert(_pullbuf.size() == rhs._pullbuf.size());
     for (unsigned int ii = 0; ii < rhs._pullbuf.size(); ++ii){
         *_pullbuf[ii] = *(rhs._pullbuf[ii]);
     }
 }

Here is the call graph for this function:

Function::~Function ( )

Definition at line 428 of file Function.cpp.

References _clearBuffer().

 {
         _clearBuffer();
  }

Here is the call graph for this function:

Member Function Documentation

void Function::_clearBuffer ( )

protected

Definition at line 435 of file Function.cpp.

References _numVar, _parser, _pullbuf, and _varbuf.

Referenced by Function(), innerSetExpr(), operator=(), setNumVar(), and ~Function().

 {
     _numVar = 0;
     _parser.ClearVar();
     for (unsigned int ii = 0; ii < _varbuf.size(); ++ii){
         if ( _varbuf[ii] ){
             delete _varbuf[ii];
         }
     }
     _varbuf.clear();
     for (unsigned int ii = 0; ii < _pullbuf.size(); ++ii){
         if ( _pullbuf[ii] ){
             delete _pullbuf[ii];
         }
     }
     _pullbuf.clear();
 }

Here is the caller graph for this function:

void Function::_showError ( mu::Parser::exception_type & e ) const

protected

Definition at line 453 of file Function.cpp.

Referenced by Function(), getDerivative(), getValue(), and innerSetExpr().

 {
     cout << "Error occurred in parser.\n"
          << "Message:  " << e.GetMsg() << "\n"
          << "Formula:  " << e.GetExpr() << "\n"
          << "Token:    " << e.GetToken() << "\n"
          << "Position: " << e.GetPos() << "\n"
          << "Error code:     " << e.GetCode() << endl;
 }

Here is the caller graph for this function:

unsigned int Function::addVar ( )

This function is for automatically adding variables when setVar messages are connected.

There are two ways new variables can be created :

(1) When the user sets the expression, muParser calls _functionAddVar to get the address of the storage for each variable name in the expression.

(2) When the user connects a setVar message to a Variable. ??

This is called by Variable::addMsgCallback - which is unused.

Definition at line 539 of file Function.cpp.

 {
 //     unsigned int newVarIndex = _numVar;
 //     ++_numVar;
 //     stringstream name;
 //     name << "x" << newVarIndex;
 //     _functionAddVar(name.str().c_str(), this);
     //     return newVarIndex;
     return 0;
 }

double Function::getConst ( string name ) const

Definition at line 729 of file Function.cpp.

References _parser.

Referenced by initCinfo().

 {
     mu::valmap_type cmap = _parser.GetConst();
     if (cmap.size()){
         mu::valmap_type::const_iterator it = cmap.find(name);
         if (it != cmap.end()){
             return it->second;
         }
     }
     return 0;
 }

Here is the caller graph for this function:

double Function::getDerivative ( ) const

Definition at line 668 of file Function.cpp.

References _independent, _parser, _showError(), _valid, and value.

Referenced by initCinfo(), and process().

 {
     double value = 0.0;
     if (!_valid){
         cout << "Error: Function::getDerivative() - invalid state" << endl;
         return value;
     }
     mu::varmap_type variables = _parser.GetVar();
     mu::varmap_type::const_iterator item = variables.find(_independent);
     if (item != variables.end()){
         try{
             value = _parser.Diff(item->second, *(item->second));
         } catch (mu::Parser::exception_type &e){
             _showError(e);
         }
     }
     return value;
 }

Here is the call graph for this function:

Here is the caller graph for this function:

bool Function::getDoEvalAtReinit ( ) const

Definition at line 621 of file Function.cpp.

References _doEvalAtReinit.

Referenced by initCinfo().

 {
     return _doEvalAtReinit;
 }

Here is the caller graph for this function:

string Function::getExpr ( const Eref & e ) const

Definition at line 587 of file Function.cpp.

References _parser, _valid, Eref::objId(), and ObjId::path().

Referenced by Function(), initCinfo(), and operator=().

 {
     if (!_valid){
         cout << "Error: " << e.objId().path() << "::getExpr() - invalid parser state" << endl;
         return "";
     }
     return _parser.GetExpr();
 }

Here is the call graph for this function:

Here is the caller graph for this function:

string Function::getIndependent ( ) const

Definition at line 654 of file Function.cpp.

References _independent.

Referenced by initCinfo().

 {
     return _independent;
 }

Here is the caller graph for this function:

unsigned int Function::getMode ( ) const

Definition at line 601 of file Function.cpp.

References _mode.

Referenced by initCinfo().

 {
     return _mode;
 }

Here is the caller graph for this function:

unsigned int Function::getNumVar ( ) const

Definition at line 697 of file Function.cpp.

References _numVar.

Referenced by initCinfo().

 {
     return _numVar;
 }

Here is the caller graph for this function:

double Function::getRate ( ) const

Definition at line 641 of file Function.cpp.

References _rate, and _valid.

Referenced by initCinfo().

 {
     if (!_valid){
         cout << "Error: Function::getValue() - invalid state" << endl;
     }
     return _rate;
 }

Here is the caller graph for this function:

bool Function::getUseTrigger ( ) const

Definition at line 611 of file Function.cpp.

References _useTrigger.

Referenced by initCinfo().

 {
     return _useTrigger;
 }

Here is the caller graph for this function:

double Function::getValue ( ) const

Definition at line 626 of file Function.cpp.

References _parser, _showError(), _valid, and value.

Referenced by initCinfo(), process(), and reinit().

 {
     double value = 0.0;
     if (!_valid){
         cout << "Error: Function::getValue() - invalid state" << endl;
         return value;
     }
     try{
         value = _parser.Eval();
     } catch (mu::Parser::exception_type &e){
         _showError(e);
     }
     return value;
 }

Here is the call graph for this function:

Here is the caller graph for this function:

Variable * Function::getVar ( unsigned int ii )

Definition at line 712 of file Function.cpp.

References _varbuf, and dummy.

Referenced by initCinfo().

 {
     static Variable dummy;
     if ( ii < _varbuf.size()){
         return _varbuf[ii];
     }
     cout << "Warning: Function::getVar: index: "
          << ii << " is out of range: "
          << _varbuf.size() << endl;
     return &dummy;
 }

Here is the caller graph for this function:

vector<string> Function::getVars ( ) const

vector< double > Function::getY ( ) const

Definition at line 659 of file Function.cpp.

References _pullbuf.

Referenced by initCinfo().

 {
     vector < double > ret(_pullbuf.size());
     for (unsigned int ii = 0; ii < ret.size(); ++ii){
         ret[ii] = *_pullbuf[ii];
     }
     return ret;
 }

Here is the caller graph for this function:

const Cinfo * Function::initCinfo ( )

static

Definition at line 91 of file Function.cpp.

References derivativeOut(), functionCinfo, getConst(), getDerivative(), getDoEvalAtReinit(), getExpr(), getIndependent(), getMode(), getNumVar(), getRate(), getUseTrigger(), getValue(), getVar(), getY(), Variable::initCinfo(), Neutral::initCinfo(), process(), rateOut(), reinit(), requestOut(), setConst(), setDoEvalAtReinit(), setExpr(), setIndependent(), setMode(), setNumVar(), setUseTrigger(), value, and valueOut().

Referenced by ZombieFunction::initCinfo().

 {
     // Value fields
     static  ReadOnlyValueFinfo< Function, double > value(
         "value",
         "Result of the function evaluation with current variable values.",
         &Function::getValue);
     static ReadOnlyValueFinfo< Function, double > derivative(
         "derivative",
         "Derivative of the function at given variable values. This is calulated"
         " using 5-point stencil "
         " <http://en.wikipedia.org/wiki/Five-point_stencil> at current value of"
         " independent variable. Note that unlike hand-calculated derivatives,"
         " numerical derivatives are not exact.",
         &Function::getDerivative);
     static ReadOnlyValueFinfo< Function, double > rate(
         "rate",
         "Derivative of the function at given variable values. This is computed"
         " as the difference of the current and previous value of the function"
         " divided by the time step.",
         &Function::getRate);
     static ValueFinfo< Function, unsigned int > mode(
         "mode",
         "Mode of operation: \n"
         " 1: only the function value will be sent out.\n"
         " 2: only the derivative with respect to the independent variable will be sent out.\n"
         " 3: only rate (time derivative) will be sent out.\n"
         " anything else: all three, value, derivative and rate will be sent out.\n",
         &Function::setMode,
         &Function::getMode);
     static ValueFinfo< Function, bool > useTrigger(
         "useTrigger",
         "When *false*, disables event-driven calculation and turns on "
         "Process-driven calculations. \n"
         "When *true*, enables event-driven calculation and turns off "
         "Process-driven calculations. \n"
         "Defaults to *false*. \n",
         &Function::setUseTrigger,
         &Function::getUseTrigger);
     static ValueFinfo< Function, bool > doEvalAtReinit(
         "doEvalAtReinit",
         "When *false*, disables function evaluation at reinit, and "
         "just emits a value of zero to any message targets. \n"
         "When *true*, does a function evaluation at reinit and sends "
         "the computed value to any message targets. \n"
         "Defaults to *false*. \n",
         &Function::setDoEvalAtReinit,
         &Function::getDoEvalAtReinit);
     static ElementValueFinfo< Function, string > expr(
         "expr",
         "Mathematical expression defining the function. The underlying parser\n"
         "is muParser. In addition to the available functions and operators  from\n"
         "muParser, some more functions are added.\n"
         "\nFunctions\n"
         "Name        args    explanation\n"
         "sin         1       sine function\n"
         "cos         1       cosine function\n"
         "tan         1       tangens function\n"
         "asin        1       arcus sine function\n"
         "acos        1       arcus cosine function\n"
         "atan        1       arcus tangens function\n"
         "sinh        1       hyperbolic sine function\n"
         "cosh        1       hyperbolic cosine\n"
         "tanh        1       hyperbolic tangens function\n"
         "asinh       1       hyperbolic arcus sine function\n"
         "acosh       1       hyperbolic arcus tangens function\n"
         "atanh       1       hyperbolic arcur tangens function\n"
         "log2        1       logarithm to the base 2\n"
         "log10       1       logarithm to the base 10\n"
         "log         1       logarithm to the base 10\n"
         "ln          1       logarithm to base e (2.71828...)\n"
         "exp         1       e raised to the power of x\n"
         "sqrt        1       square root of a value\n"
         "sign        1       sign function -1 if x<0; 1 if x>0\n"
         "rint        1       round to nearest integer\n"
         "abs         1       absolute value\n"
         "min         var.    min of all arguments\n"
         "max         var.    max of all arguments\n"
         "sum         var.    sum of all arguments\n"
         "avg         var.    mean value of all arguments\n"
         "rand        1       rand(seed), random float between 0 and 1, \n"
         "                    if seed = -1, then a 'random' seed is created.\n"
         "rand2       3       rand(a, b, seed), random float between a and b, \n"
         "                    if seed = -1, a 'random' seed is created using either\n"
         "                    by random_device or by reading system clock\n"
         "\nOperators\n"
         "Op  meaning                priority\n"
         "=   assignment             -1\n"
         "&&  logical and            1\n"
         "||  logical or             2\n"
         "<=  less or equal          4\n"
         ">=  greater or equal       4\n"
         "!=  not equal              4\n"
         "==  equal              4\n"
         ">   greater than           4\n"
         "<   less than              4\n"
         "+   addition               5\n"
         "-   subtraction            5\n"
         "*   multiplication         6\n"
         "/   division               6\n"
         "^   raise x to the power of y  7\n"
         "%   floating point modulo      7\n"
         "\n"
         "?:  if then else operator      C++ style syntax\n",
         &Function::setExpr,
         &Function::getExpr
     );
 
     static ValueFinfo< Function, unsigned int > numVars(
         "numVars",
         "Number of variables used by Function.",
         &Function::setNumVar,
         &Function::getNumVar
     );
 
     static FieldElementFinfo< Function, Variable > inputs(
         "x",
         "Input variables to the function. These can be passed via messages.",
         Variable::initCinfo(),
         &Function::getVar,
         &Function::setNumVar,
         &Function::getNumVar
     );
 
     static LookupValueFinfo < Function, string, double > constants(
         "c",
         "Constants used in the function. These must be assigned before"
         " specifying the function expression.",
         &Function::setConst,
         &Function::getConst);
 
     static ReadOnlyValueFinfo< Function, vector < double > > y(
         "y",
         "Variable values received from target fields by requestOut",
         &Function::getY);
 
     static ValueFinfo< Function, string > independent(
         "independent",
         "Index of independent variable. Differentiation is done based on this. Defaults"
         " to the first assigned variable.",
         &Function::setIndependent,
         &Function::getIndependent);
 
     // Shared messages
     static DestFinfo process( "process",
                               "Handles process call, updates internal time stamp.",
                               new ProcOpFunc< Function >( &Function::process ) );
     static DestFinfo reinit( "reinit",
                              "Handles reinit call.",
                              new ProcOpFunc< Function >( &Function::reinit ) );
     static Finfo* processShared[] = { &process, &reinit };
 
     static SharedFinfo proc( "proc",
                              "This is a shared message to receive Process messages "
                              "from the scheduler objects."
                              "The first entry in the shared msg is a MsgDest "
                              "for the Process operation. It has a single argument, "
                              "ProcInfo, which holds lots of information about current "
                              "time, thread, dt and so on. The second entry is a MsgDest "
                              "for the Reinit operation. It also uses ProcInfo. ",
                              processShared, sizeof( processShared ) / sizeof( Finfo* )
                              );
     /*
     static DestFinfo trigger( "trigger",
         "Handles trigger input. Argument is timestamp of event. This is "
         "compatible with spike events as well as chemical ones. ",
         new OpFunc1< Function, double >( &Function::trigger ) );
         */
 
     static Finfo *functionFinfos[] =
             {
                 &value,
                 &rate,
                 &derivative,
                 &mode,
                 &useTrigger,
                 &doEvalAtReinit,
                 &expr,
                 &numVars,
                 &inputs,
                 &constants,
                 &independent,
                 &proc,
                 requestOut(),
                 valueOut(),
                 rateOut(),
                 derivativeOut(),
             };
 
     static string doc[] =
             {
                 "Name", "Function",
                 "Author", "Subhasis Ray",
                 "Description",
                 "General purpose function calculator using real numbers.\n"
                 "It can parse mathematical expression defining a function and evaluate"
                 " it and/or its derivative for specified variable values."
                 "You can assign expressions of the form::\n"
                 "\n"
                 "f(c0, c1, ..., cM, x0, x1, ..., xN, y0,..., yP ) \n"
                 "\n"
                 " where `ci`'s are constants and `xi`'s and `yi`'s are variables."
 
                 "The constants must be defined before setting the expression and"
                 " variables are connected via messages. The constants can have any"
                 " name, but the variable names must be of the form x{i} or y{i}"
                 "  where i is increasing integer starting from 0.\n"
                 " The variables can be input from other moose objects."
                 " Such variables must be named `x{i}` in the expression and the source"
                 " field is connected to Function.x[i]'s `input` destination field.\n"
                 " In case the input variable is not available as a source field, but is"
                 " a value field, then the value can be requested by connecting the"
                 " `requestOut` message to the `get{Field}` destination on the target"
                 " object. Such variables must be specified in the expression as y{i}"
                 " and connecting the messages should happen in the same order as the"
                 " y indices.\n"
                 " This class handles only real numbers (C-double). Predefined constants"
                 " are: pi=3.141592..., e=2.718281..."
             };
 
     static Dinfo< Function > dinfo;
     static Cinfo functionCinfo("Function",
                                Neutral::initCinfo(),
                                functionFinfos,
                                sizeof(functionFinfos) / sizeof(Finfo*),
                                &dinfo,
                                doc,
                                sizeof(doc)/sizeof(string));
     return &functionCinfo;
 
 }

Here is the call graph for this function:

Here is the caller graph for this function:

void Function::innerSetExpr	(	const Eref &	e,
		string	expr
	)

virtual

Reimplemented in ZombieFunction.

Definition at line 562 of file Function.cpp.

References _clearBuffer(), _numVar, _parser, _showError(), _valid, _varbuf, Eref::objId(), and ObjId::path().

Referenced by ZombieFunction::innerSetExpr(), and setExpr().

 {
     _valid = false;
     _clearBuffer();
     _varbuf.resize(_numVar);
     // _pullbuf.resize(_num
     mu::varmap_type vars;
     try{
         _parser.SetExpr(expr);
     } catch (mu::Parser::exception_type &e) {
         cerr << "Error setting expression on: " << eref.objId().path() << endl;
         _showError(e);
         _clearBuffer();
         return;
     }
     // Force variable creation right away. Otherwise numVar does not
     // get set properly
     try{
         _parser.Eval();
         _valid = true;
     } catch (mu::Parser::exception_type &e){
         _showError(e);
     }
 }

Here is the call graph for this function:

Here is the caller graph for this function:

Function & Function::operator= ( const Function rhs )

Definition at line 395 of file Function.cpp.

References _clearBuffer(), _independent, _lastValue, _mode, _parser, _pullbuf, _rate, _value, _varbuf, getExpr(), and setExpr().

 {
     static Eref er;
     _clearBuffer();
     _mode = rhs._mode;
     _lastValue = rhs._lastValue;
     _value = rhs._value;
     _rate = rhs._rate;
     _independent = rhs._independent;
     // Adding pi and e, the defaults are `_pi` and `_e`
     _parser.DefineConst(_T("pi"), (mu::value_type)M_PI);
     _parser.DefineConst(_T("e"), (mu::value_type)M_E);
     // Copy the constants
     mu::valmap_type cmap = rhs._parser.GetConst();
     if (cmap.size()){
         mu::valmap_type::const_iterator item = cmap.begin();
         for (; item!=cmap.end(); ++item){
             _parser.DefineConst(item->first, item->second);
         }
     }
     // Copy the values from the var pointers in rhs
     setExpr(er, rhs.getExpr( er ));
     assert(_varbuf.size() == rhs._varbuf.size());
     for (unsigned int ii = 0; ii < rhs._varbuf.size(); ++ii){
         _varbuf[ii]->value = rhs._varbuf[ii]->value;
     }
     assert(_pullbuf.size() == rhs._pullbuf.size());
     for (unsigned int ii = 0; ii < rhs._pullbuf.size(); ++ii){
         *_pullbuf[ii] = *(rhs._pullbuf[ii]);
     }
     return *this;
 }

Here is the call graph for this function:

void Function::process	(	const Eref &	e,
		ProcPtr	p
	)

Definition at line 741 of file Function.cpp.

References _lastValue, _mode, _pullbuf, _rate, _t, _useTrigger, _valid, _value, ProcInfo::currTime, derivativeOut(), ProcInfo::dt, getDerivative(), getValue(), rateOut(), requestOut(), TriggerThreshold, and valueOut().

Referenced by initCinfo().

 {
     if (!_valid){
         return;
     }
     vector < double > databuf;
     requestOut()->send(e, &databuf);
     for (unsigned int ii = 0;
          (ii < databuf.size()) && (ii < _pullbuf.size());
          ++ii){
         *_pullbuf[ii] = databuf[ii];
     }
     _t = p->currTime;
     _value = getValue();
     _rate = (_value - _lastValue) / p->dt;
     if ( _useTrigger && _value < TriggerThreshold ) {
         _lastValue = _value;
         return;
     }
     switch (_mode){
         case 1: {
             valueOut()->send(e, _value);
             break;
         }
         case 2: {
             derivativeOut()->send(e, getDerivative());
             break;
         }
         case 3: {
             rateOut()->send(e, _rate);
             break;
         }
         default: {
             valueOut()->send(e, _value);
             derivativeOut()->send(e, getDerivative());
             rateOut()->send(e, _rate);
             break;
         }
     }
     _lastValue = _value;
 }

Here is the call graph for this function:

Here is the caller graph for this function:

void Function::reinit	(	const Eref &	e,
		ProcPtr	p
	)

Definition at line 783 of file Function.cpp.

References _doEvalAtReinit, _lastValue, _mode, _parser, _rate, _t, _valid, _value, ProcInfo::currTime, derivativeOut(), getValue(), rateOut(), setExpr(), moose::trim(), and valueOut().

Referenced by initCinfo().

 {
     if (!_valid){
         cout << "Error: Function::reinit() - invalid parser state. Will do nothing." << endl;
         return;
     }
     if (moose::trim(_parser.GetExpr(), " \t\n\r").length() == 0){
         cout << "Error: no expression set. Will do nothing." << endl;
         setExpr(e, "0.0");
         _valid = false;
     }
     _t = p->currTime;
     if (_doEvalAtReinit) {
         _lastValue = _value = getValue();
     } else {
         _lastValue = _value = 0.0;
     }
     _rate = 0.0;
     switch (_mode){
         case 1: {
             valueOut()->send(e, _value);
             break;
         }
         case 2: {
             derivativeOut()->send(e, 0.0);
             break;
         }
         case 3: {
             rateOut()->send(e, _rate);
             break;
         }
         default: {
             valueOut()->send(e, _value);
             derivativeOut()->send(e, 0.0);
             rateOut()->send(e, _rate);
             break;
         }
     }
 }

Here is the call graph for this function:

Here is the caller graph for this function:

void Function::setConst	(	string	name,
		double	value
	)

Definition at line 724 of file Function.cpp.

References _parser.

Referenced by initCinfo().

 {
     _parser.DefineConst(name, value);
 }

Here is the caller graph for this function:

void Function::setDoEvalAtReinit ( bool doEvalAtReinit )

Definition at line 616 of file Function.cpp.

References _doEvalAtReinit.

Referenced by initCinfo().

 {
     _doEvalAtReinit = doEvalAtReinit;
 }

Here is the caller graph for this function:

void Function::setExpr	(	const Eref &	e,
		string	expr
	)

Definition at line 556 of file Function.cpp.

References innerSetExpr().

Referenced by Function(), initCinfo(), operator=(), and reinit().

 {
     this->innerSetExpr( eref, expr ); // Refer to the virtual function here.
 }

Here is the call graph for this function:

Here is the caller graph for this function:

void Function::setIndependent ( string index )

Definition at line 649 of file Function.cpp.

References _independent.

Referenced by initCinfo().

 {
     _independent = var;
 }

Here is the caller graph for this function:

void Function::setMode ( unsigned int mode )

Definition at line 596 of file Function.cpp.

References _mode.

Referenced by initCinfo().

 {
     _mode = mode;
 }

Here is the caller graph for this function:

void Function::setNumVar ( unsigned int num )

Definition at line 687 of file Function.cpp.

References _clearBuffer(), _functionAddVar, and name.

Referenced by initCinfo().

 {
     _clearBuffer();
     for (unsigned int ii = 0; ii < num; ++ii){
         stringstream name;
         name << "x" << ii;
         _functionAddVar(name.str().c_str(), this);
     }
 }

Here is the call graph for this function:

Here is the caller graph for this function:

void Function::setUseTrigger ( bool useTrigger )

Definition at line 606 of file Function.cpp.

References _useTrigger.

Referenced by initCinfo().

 {
     _useTrigger = useTrigger;
 }

Here is the caller graph for this function:

void Function::setVar	(	unsigned int	index,
		double	value
	)

Definition at line 702 of file Function.cpp.

References _varbuf.

 {
     cout << "varbuf[" << index << "]->setValue(" << value << ")\n";
     if (index < _varbuf.size()){
         _varbuf[index]->setValue(value);
     } else {
         cerr << "Function: index " << index << " out of bounds." << endl;
     }
 }

void Function::setVarValues	(	vector< string >	vars,
		vector< double >	vals
	)

Friends And Related Function Documentation

double* _functionAddVar	(	const char *	name,
		void *	data
	)

friend

Call-back to add variables to parser automatically.

We use different storage for constants and variables. Variables are stored in a vector of Variable object pointers. They must have the name x{index} where index is any non-negative integer. Note that the vector is resized to whatever the maximum index is. It is up to the user to make sure that indices are sequential without any gap. In case there is a gap in indices, those entries will remain unused.

If the name starts with anything other than x or y, then it is taken to be a named constant, which must be set before any expression or variables and error is thrown.

NOTE: this is called not on setting expression but on first attempt at evaluation of the same, i.e. when you access value of the Function object.

Simple function parser and evaluator for MOOSE. This can take a mathematical expression in standard C form and a list of variables values and evaluate the results.

Definition at line 482 of file Function.cpp.

Referenced by Function(), and setNumVar().

 {
     Function* function = reinterpret_cast< Function * >(data);
     double * ret = NULL;
     string strname(name);
     // Names starting with x are variables, everything else is constant.
     if (strname[0] == 'x'){
         int index = atoi(strname.substr(1).c_str());
         if ((unsigned)index >= function->_varbuf.size()){
             function->_varbuf.resize(index+1, 0);
             for (int ii = 0; ii <= index; ++ii){
                 if (function->_varbuf[ii] == 0){
                     function->_varbuf[ii] = new Variable();
                 }
             }
             function->_numVar = function->_varbuf.size();
         }
         ret = &(function->_varbuf[index]->value);
     } else if (strname[0] == 'y'){
         int index = atoi(strname.substr(1).c_str());
         if ((unsigned)index >= function->_pullbuf.size()){
             function->_pullbuf.resize(index+1, 0 );
             for (int ii = 0; ii <= index; ++ii){
                 if (function->_pullbuf[ii] == 0){
                     function->_pullbuf[ii] = new double();
                 }
             }
         }
         ret = function->_pullbuf[index];
     } else if (strname == "t"){
         ret = &function->_t;
     } else {
         cerr << "Got an undefined symbol: " << name << endl
              << "Variables must be named xi, yi, where i is integer index."
          << " You must define the constants beforehand using LookupField c: c[name]"
                 " = value"
              << endl;
         throw mu::ParserError("Undefined constant.");
     }
 
     return ret;
 }