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

MODEL::ODESystem Class Template Reference

#include <odesystem.h>

Inheritance diagram for MODEL::ODESystem:

Inheritance graph
[legend]
Collaboration diagram for MODEL::ODESystem:

Collaboration graph
[legend]
List of all members.

Public Types

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

Public Methods

 ODESystem (TimeFrame &T, vf &detpart, vf &stochpart, vect &initial, Integration it=Euler, time res=1E-3)
 ODESystem (TimeFrame &T, vect &initial, Integrator< dims, nelem, NT > *i, time res=1e-3)
 ODESystem (TimeFrame &T, vf &detpart, vect &initial, Integration it, time res)
virtual ~ODESystem ()
virtual void tick ()
const vect& get_current (void)
void set_current (const vect &hereandnow)
const vect& operator() (void)
void reset (void)
void reset (const vect &fromhere)
time relax (number goal=DEFAULT_RELAX)
time relax_independent (number goal=DEFAULT_RELAX)

Private Attributes

vect init
vect current
Integrator<dims,nelem,NT>* integ
vf* deter
vf* stoch

Static Private Attributes

const number DEFAULT_RELAX = 1E-7

Detailed Description

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

Integration of a system of ordinary differential equations. The system is split into a deterministic and a stochastic part. Different integration methods take these into account in different ways. You should move any effect due to a nonzero mean of the noise into the deterministic part

Todo:
Things to be added (wish list): Full solution of the stationary problem (using the NewtonRoot solver), stability of a certain point (or the nearest stable one, anyway).

Definition at line 49 of file odesystem.h.


Constructor & Destructor Documentation

ODESystem ( TimeFrame & T,
vf & detpart,
vf & stochpart,
vect & initial,
Integration it = Euler,
time res = 1E-3 )
 

dt is only a guiding value: Once linked to a timeframe, will recalculate it so it ends up fitting a whole number of times inside the resolution of the timeframe

Definition at line 166 of file odesystem.h.

ODESystem ( TimeFrame & T,
vect & initial,
Integrator< dims, nelem, NT > * i,
time res = 1e-3 )
 

The full constructor. You can pass your own integrator with parts, which will be deleted at the end of time

Definition at line 202 of file odesystem.h.

ODESystem ( TimeFrame & T,
vf & detpart,
vect & initial,
Integration it,
time res )
 

A shortcut if you do not want to add a stochastic part

Definition at line 226 of file odesystem.h.


Member Function Documentation

const vect & get_current ( void ) [inline]
 

Get current values

Definition at line 84 of file odesystem.h.

Referenced by operator()().

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

Overloaded for ease of use.

Todo:
This should be removed as it promoted confusion. current should be used instead.

Definition at line 98 of file odesystem.h.

time relax ( number goal = DEFAULT_RELAX )
 

Calculate statitionairy value for current parameters. Returns time taken to relax Note: You cannot relax to a level smaller than the noise level.

Parameters:
goal   accurary required.

Definition at line 298 of file odesystem.h.

time relax_independent ( number goal = DEFAULT_RELAX )
 

Use this function to relax to a stable state, without using the TimeFrame

Definition at line 265 of file odesystem.h.

void reset ( const vect & fromhere ) [inline]
 

Reset everything - find a stable state to start from

Definition at line 108 of file odesystem.h.

void reset ( void ) [inline]
 

A reset without specifying a new point

Definition at line 101 of file odesystem.h.

Referenced by ODESystem().

void tick ( ) [inline, virtual]
 

Whatever should be done when the time changes. This is where the resolution of the ODESystem is passed to the Integrator

Reimplemented from MODEL::TickTock.

Definition at line 77 of file odesystem.h.


Member Data Documentation

const number DEFAULT_RELAX = 1E-7 [static, private]
 

Scanning a certain parameter

Definition at line 145 of file odesystem.h.

vect current [private]
 

Current values

Definition at line 151 of file odesystem.h.

vf * deter [private]
 

Deterministic Function

Definition at line 157 of file odesystem.h.

vect init [private]
 

Initial values

Definition at line 148 of file odesystem.h.

Integrator< dims, nelem, NT > * integ [private]
 

Integrator

Definition at line 154 of file odesystem.h.

vf * stoch [private]
 

Stocastic Multiplier

Definition at line 159 of file odesystem.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: www.alna.vub.ac.be

Last update: June 2002.


Looking for Open Source? Check out SourceForge Logo !