FuncTerm Class Reference

#include <FuncTerm.h>

Collaboration diagram for FuncTerm:

Public Member Functions
void	evalPool (double *s, double t) const
	FuncTerm ()
const string &	getExpr () const
const vector< unsigned int > &	getReactantIndex () const
const unsigned int	getTarget () const
double	getVolScale () const
double	operator() (const double *S, double t) const
const FuncTerm &	operator= (const FuncTerm &other)
void	setExpr (const string &e)
void	setReactantIndex (const vector< unsigned int > &mol)
void	setTarget (unsigned int tgt)
void	setVolScale (double vs)
	~FuncTerm ()

Private Attributes
double *	args_
string	expr_
mu::Parser	parser_
vector< unsigned int >	reactantIndex_
unsigned int	target_
double	volScale_

Detailed Description

Definition at line 15 of file FuncTerm.h.

Constructor & Destructor Documentation

FuncTerm::FuncTerm

(

)

Definition at line 30 of file FuncTerm.cpp.

References args_, M_E, M_PI, and parser_.

    : reactantIndex_( 1, 0 ),
        volScale_( 1.0 ),
        target_( ~0U)
{
    args_ = 0;
    parser_.DefineConst(_T("pi"), (mu::value_type)M_PI);
    parser_.DefineConst(_T("e"), (mu::value_type)M_E);
}

FuncTerm::~FuncTerm

(

)

Definition at line 40 of file FuncTerm.cpp.

References args_.

{
    if (args_) {
        delete[] args_;
    }
}

Member Function Documentation

void FuncTerm::evalPool	(	double *	s,
		double	t
	)		const

Definition at line 156 of file FuncTerm.cpp.

References args_, parser_, reactantIndex_, showError(), target_, and volScale_.

{
    if ( !args_ || target_ == ~0U )
        return;
    unsigned int i;
    for ( i = 0; i < reactantIndex_.size(); ++i )
        args_[i] = S[reactantIndex_[i]];
    args_[i] = t;
        try
        {
            S[ target_] = parser_.Eval() * volScale_;
        }
        catch ( mu::Parser::exception_type & e )
        {
            showError( e );
            //throw e;
        }
}

Here is the call graph for this function:

const string & FuncTerm::getExpr

(

)

const

Definition at line 95 of file FuncTerm.cpp.

References expr_.

Referenced by FuncRate::getExpr().

{
    return expr_;
}

Here is the caller graph for this function:

const vector< unsigned int > & FuncTerm::getReactantIndex

(

)

const

Definition at line 67 of file FuncTerm.cpp.

References reactantIndex_.

Referenced by Gsolve::fillPoolFuncDep(), and FuncRate::getFuncArgIndex().

{
    return reactantIndex_;
}

Here is the caller graph for this function:

const unsigned int FuncTerm::getTarget

(

)

const

Definition at line 105 of file FuncTerm.cpp.

References target_.

Referenced by FuncRate::copyWithVolScaling(), Gsolve::fillPoolFuncDep(), and FuncRate::getReactants().

{
    return target_;
}

Here is the caller graph for this function:

double FuncTerm::getVolScale

(

)

const

Definition at line 115 of file FuncTerm.cpp.

References volScale_.

{
    return volScale_;
}

double FuncTerm::operator()	(	const double *	S,
		double	t
	)		const

This computes the value. The time t is an argument needed by some functions.

Definition at line 135 of file FuncTerm.cpp.

References args_, parser_, reactantIndex_, and volScale_.

{
    if ( !args_ )
        return 0.0;
    unsigned int i;
    for ( i = 0; i < reactantIndex_.size(); ++i )
        args_[i] = S[reactantIndex_[i]];
    args_[i] = t;
        try
        {
            double result = parser_.Eval() * volScale_;
            return result;
        }
        catch (mu::Parser::exception_type &e )
        {
            cerr << "Error: " << e.GetMsg() << endl;
            throw e;
        }

}

const FuncTerm & FuncTerm::operator=

(

const FuncTerm &

other

)

Definition at line 120 of file FuncTerm.cpp.

References args_, expr_, parser_, reactantIndex_, setReactantIndex(), target_, and volScale_.

{
    args_ = 0; // Don't delete it, the original one is still using it.
    parser_ = other.parser_;
    expr_ = other.expr_;
    volScale_ = other.volScale_;
    target_ = other.target_;
    setReactantIndex( other.reactantIndex_ );
    return *this;
}

Here is the call graph for this function:

void FuncTerm::setExpr

(

const string &

e

)

Definition at line 83 of file FuncTerm.cpp.

References expr_, parser_, and showError().

Referenced by Stoich::installAndUnschedFunc(), FuncRate::setExpr(), Stoich::setFunctionExpr(), and testFuncTerm().

{
    try {
        parser_.SetExpr( expr );
        expr_ = expr;
    } catch(mu::Parser::exception_type &e) {
        showError(e);
        //return;
                throw(e);
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

void FuncTerm::setReactantIndex

(

const vector< unsigned int > &

mol

)

This function finds the reactant indices in the vector S. It returns the number of indices found, which are the entries in molIndex.

Definition at line 47 of file FuncTerm.cpp.

References args_, parser_, and reactantIndex_.

Referenced by Stoich::installAndUnschedFunc(), operator=(), FuncRate::setFuncArgIndex(), and testFuncTerm().

{
    reactantIndex_ = mol;
    if ( args_ ) {
        delete[] args_;
        args_ = 0;
    }
    args_ = new double[ mol.size() + 1 ];
    // args_.resize( mol.size() + 1, 0.0 );
    for ( unsigned int i = 0; i < mol.size(); ++i ) {
        stringstream ss;
        args_[i] = 0.0;
        ss << "x" << i;
        parser_.DefineVar( ss.str(), &args_[i] );
    }
    // Define a 't' variable even if we don't always use it.
    args_[mol.size()] = 0.0;
    parser_.DefineVar( "t", &args_[mol.size()] );
}

Here is the caller graph for this function:

void FuncTerm::setTarget

(

unsigned int

tgt

)

Definition at line 100 of file FuncTerm.cpp.

References target_.

Referenced by FuncRate::FuncRate(), Stoich::installAndUnschedFunc(), and FuncRate::setReactants().

{
    target_ = t;
}

Here is the caller graph for this function:

void FuncTerm::setVolScale

(

double

vs

)

Definition at line 110 of file FuncTerm.cpp.

References volScale_.

Referenced by Stoich::installAndUnschedFunc().

{
    volScale_ = vs;
}

Here is the caller graph for this function:

Member Data Documentation

double* FuncTerm::args_

private

Definition at line 43 of file FuncTerm.h.

Referenced by evalPool(), FuncTerm(), operator()(), operator=(), setReactantIndex(), and ~FuncTerm().

string FuncTerm::expr_

private

Definition at line 47 of file FuncTerm.h.

Referenced by getExpr(), operator=(), and setExpr().

mu::Parser FuncTerm::parser_

private

Definition at line 46 of file FuncTerm.h.

Referenced by evalPool(), FuncTerm(), operator()(), operator=(), setExpr(), and setReactantIndex().

vector< unsigned int > FuncTerm::reactantIndex_

private

Definition at line 45 of file FuncTerm.h.

Referenced by evalPool(), getReactantIndex(), operator()(), operator=(), and setReactantIndex().

unsigned int FuncTerm::target_

private

Definition at line 54 of file FuncTerm.h.

Referenced by evalPool(), getTarget(), operator=(), and setTarget().

double FuncTerm::volScale_

private

Scale factor to account for pool volume if we are assigning conc rather than N. Note that this conc will not be further updated so this is an undesirable option.

Definition at line 53 of file FuncTerm.h.

Referenced by evalPool(), getVolScale(), operator()(), operator=(), and setVolScale().

---

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

• moose-core/ksolve/FuncTerm.h
• moose-core/ksolve/FuncTerm.cpp