Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages  

MODEL::VectorFunction Class Template Reference

#include <vectorfunction.h>

Inheritance diagram for MODEL::VectorFunction:

Inheritance graph
List of all members.

Public Types

typedef NT NT_outside
typedef NT::number numT
typedef NT::vect vect
typedef NT::vf vf
typedef NT::matrix matrix

Public Methods

 VectorFunction ()
virtual ~VectorFunction ()
 VectorFunction (const VectorFunction &vf)
virtual VectorFunction* clone () const=0
vect operator() (const vect &u)
virtual const vect& function (vect &fu, const vect &u)=0
void define_parameter (const string &name, number &p)
number& get_parameter (const string &name)
number& get_parameter (const string &name) const
map<string,number*>& get_parlist (void)
const map<string,number*>& get_parlist (void) const

Private Attributes

map<string,number*> parlist

Detailed Description

template<integer dims, typename nelem = number, class NT = NumericTraits<nelem,dims>> class MODEL::VectorFunction

Base class for vectorfunctions: derived from this if you want to implement one. Just override/implement the function() part. The function has as input: a vector u. The time dependence of any parameter is left to the implementor (if needed).

Definition at line 44 of file vectorfunction.h.

Member Typedef Documentation

typedef NT NT_outside

Really weird def. to be able to use NT outside

Definition at line 48 of file vectorfunction.h.

Constructor & Destructor Documentation

VectorFunction ( const VectorFunction<dims, nelem, NT> & vf ) [inline]

gigantic BUG: parlist should never be copied - this is just a quick fix

Definition at line 60 of file vectorfunction.h.

Member Function Documentation

VectorFunction * clone ( void ) const [pure virtual]

Virtual Copy Constructor

Reimplemented in MODEL::CVR3DFunc, MODEL::Minus, MODEL::NegFunc, MODEL::NewtonRoot, MODEL::RadPotFunction, MODEL::VFAmputation, and MODEL::VFwithBump.

const vect & function ( vect & fu,
const vect & u ) [pure virtual]

Implement this function to create the return vector. fu is a reference to where the values should be stored. This is for efficiency in internal routines. Inherited classes should return fu too.

Reimplemented in MODEL::CVR3DFunc, MODEL::Minus, MODEL::NegFunc, MODEL::NewtonRoot, MODEL::RadPotFunction, MODEL::ReservoirFunction, MODEL::VFAmputation, and MODEL::VFwithBump.

Referenced by operator()().

vect operator() ( const vect & u ) [inline]

Overloaded operator(), so the object can be presented as a function.

Definition at line 69 of file vectorfunction.h.

The documentation for this class was generated from the following file:
To get the sources or tarballs, please go to SourceForge or you can use the CVS repository.

More Info? Michael Peeters. Also, check our research website:

Last update: June 2002.

Looking for Open Source? Check out SourceForge Logo !