AdaptiveEulerSolver Class Reference
[ODE Solvers]

Adaptive Euler solver. More...

#include <eulersolver.h>

Inheritance diagram for AdaptiveEulerSolver:

GenericEulerSolver 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 setDimension (int dimension)
void setStepSize (double stepSize)
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
virtual void setFunction (Function function)
void * params () const
virtual void setParams (void *params)
double toleranceAbs () const
virtual void setToleranceAbs (double toleranceAbs)
double toleranceRel () const
virtual void setToleranceRel (double toleranceRel)
double localError () const
double localErrorRatio () const
const QString & name () const
void setName (const QString &name)

Detailed Description

Adaptive Euler solver.


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]

Set step size

Reimplemented from GenericEulerSolver.

void setDimension ( int  dimension  )  [virtual, inherited]

Set ODE dimension

Reimplemented from Solver.

void setStepSize ( double  stepSize  )  [inline, inherited]

Get step size

Reimplemented in EulerSolver.

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

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

Set callback function

void* params (  )  const [inline, inherited]

Get callback function params

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

Set callback function params

Reimplemented in GslGenericSolver.

double toleranceAbs (  )  const [inline, inherited]

Get absolute allowed local tolerance

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

Set absolute allowed local tolerance

Reimplemented in GslGenericSolver.

double toleranceRel (  )  const [inline, inherited]

Get relative allowed local tolerance

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

Set relative allowed local tolerance

Reimplemented in GslGenericSolver.

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