GslSolver Class Reference
[ODE Solvers]

Non-adaptive solvers from GSL library. More...

#include <gslsolver.h>

Inheritance diagram for GslSolver:

GslGenericSolver Solver Object List of all members.

Public Types

typedef int(*) Function (double t, const double y[], double f[], void *params)

Public Member Functions

double stepSize () const
void setStepSize (double stepSize)
void setDimension (int dimension)
void setToleranceAbs (double toleranceAbs)
void setToleranceRel (double toleranceRel)
virtual void setFunction (Function function)
void setParams (void *params)
void doCalcFn (double *t, double y[], double f[]=0)
bool doEvolve (double *t, double t1, double y[], double yerr[])
QString solverType () const
int dimension () const
Function function () const
void * params () const
double toleranceAbs () const
double toleranceRel () const
double localError () const
double localErrorRatio () const
const QString & name () const
void setName (const QString &name)

Detailed Description

Non-adaptive solvers from GSL library.


Member Typedef Documentation

typedef int(*) Function(double t, const double y[], double f[], void *params) [inherited]

Callback function type


Member Function Documentation

double stepSize (  )  const [inline]

Get step size

Reimplemented from GslGenericSolver.

void setStepSize ( double  stepSize  )  [inline]

Set step size

Reimplemented from GslGenericSolver.

void setDimension ( int  dimension  )  [inline, virtual, inherited]

Set ODE dimension

Reimplemented from Solver.

void setToleranceAbs ( double  toleranceAbs  )  [inline, virtual, inherited]

Set absolute allowed local tolerance

Reimplemented from Solver.

void setToleranceRel ( double  toleranceRel  )  [inline, virtual, inherited]

Set relative allowed local tolerance

Reimplemented from Solver.

virtual void setFunction ( Function  function  )  [inline, virtual, inherited]

Set callback function

void setParams ( void *  params  )  [inline, virtual, inherited]

Set callback function params

Reimplemented from Solver.

void doCalcFn ( double *  t,
double  y[],
double  f[] = 0 
) [virtual, inherited]

Calculate function value

Implements Solver.

bool doEvolve ( double *  t,
double  t1,
double  y[],
double  yerr[] 
) [virtual, inherited]

Integrate.

Parameters:
t Current time (will be updated by the new value)
t1 Target time
y[] Current function value
yerr[] Array to store local errors
Returns:
true on success, false on failure (too big local error)
Todo:
Provide error message

Implements Solver.

QString solverType (  )  const [inline, inherited]

Get solver type

int dimension (  )  const [inline, inherited]

Get ODE dimension

Function function (  )  const [inline, inherited]

Get callback function

void* params (  )  const [inline, inherited]

Get callback function params

double toleranceAbs (  )  const [inline, inherited]

Get absolute allowed local tolerance

double toleranceRel (  )  const [inline, inherited]

Get relative allowed local tolerance

double localError (  )  const [inline, inherited]

Get error estimation from last step

double localErrorRatio (  )  const [inline, inherited]

Get local tolerance calculated at last step

const QString& name (  )  const [inline, inherited]

Returns name of the object

void setName ( const QString &  name  )  [inline, inherited]

Set name of the object


The documentation for this class was generated from the following file:
Generated on Thu Mar 15 14:23:37 2007 for StepCore by  doxygen 1.5.1