Main Page   Class Hierarchy   Compound List   File List   Compound Members   File Members  

ODE_NUMERIC Class Reference

Specification of the numerical IVP. More...

#include <odenum.h>

Inheritance diagram for ODE_NUMERIC:

ODE_PROBLEM NAME List of all members.

Public Methods

 ODE_NUMERIC ( int n, FCN fcn, const string & name )
 Constructor. More...

void SetTend ( double tEnd )
 Sets the end point. More...

void SetAtol ( double abstol )
 Sets absolute error tolerance. More...

void SetRtol ( double reltol )
 Sets relative error tolerance. More...

void SetTcur ( double t )
 Sets the current integration point. More...

void SetInitEncl ( const INTERVAL_VECTOR & Y )
 Sets an priori enclosure. More...

void SetTightEncl ( const INTERVAL_VECTOR & Y )
 Sets a tight enclosure. More...

void SetSolution ( const PtrSolution Sol )
 Sets a solution object. More...

double GetTend () const
 Returns the end point.

double GetAtol () const
 Returns the absolute tolerance.

double GetRtol () const
 Returns the relative tolerance.

double GetTcur () const
 Returns the current integration point.

double GetTprev () const
 Returns the previous integration point.

const INTERVAL_VECTOR& GetInitEncl () const
 Returns the initial enclosure.

const INTERVAL_VECTOR& GetTightEncl () const
 Returns the tight enclosure.

const PtrSolution GetSolution () const
 Returns a pointer to the solution object.

virtual void LoadProblemParam ( int ParamSet )
 Set problem parameters. More...

void DisplaySolution ( int comp, const char *file = 0 ) const
 Plot a solution component. More...

void DisplayPhase ( int comp1, int comp2, const char * file = 0 ) const
 Produce a phase plot. More...

virtual ~ODE_NUMERIC ()
 Destructor.

Detailed Description

Specification of the numerical IVP.

This class inherits from ODE_PROBLEM the specification of the IVP problem and provides the end integration point, absolute and relative error tolerances, and an object for storing the solution.

Author(s):
Ned Nedialkov
Date:
28 April 2001

Constructor & Destructor Documentation

ODE_NUMERIC::ODE_NUMERIC ( int n,
FCN fcn,
const string & name ) [inline]
 

Constructor.

It sets the size of the problem, the function for computing the right side, a name for the problem, and default values for the absolute and relative error tolerances.

Parameters:
n   size of the problem
fcn   pointer to a function for computing the right side
name   name for the ODE problem

Precondition:
n>0 && NotNull(f) && !name.empty()

ODE_NUMERIC::~ODE_NUMERIC ( ) [inline, virtual]
 

Destructor.

Member Function Documentation

void ODE_NUMERIC::SetTend ( double tEnd ) [inline]
 

Sets the end point.

Precondition:
tEnd != GetT0() || NotNull(Solution) && tEnd != Solution->GetTcur()

void ODE_NUMERIC::SetAtol ( double abstol ) [inline]
 

Sets absolute error tolerance.

Precondition:
abstol >= 0

void ODE_NUMERIC::SetRtol ( double reltol ) [inline]
 

Sets relative error tolerance.

Precondition:
reltol >= 0

void ODE_NUMERIC::SetTcur ( double t ) [inline]
 

Sets the current integration point.

Precondition:
GetTcur() <= t && t <= GetTend() || GetTend() <= t && t <= GetTcur()

void ODE_NUMERIC::SetInitEncl ( const INTERVAL_VECTOR & Y ) [inline]
 

Sets an priori enclosure.

Precondition:
GetSize() == Dimension(Y)

void ODE_NUMERIC::SetTightEncl ( const INTERVAL_VECTOR & Y ) [inline]
 

Sets a tight enclosure.

Precondition:
GetSize() == Dimension(Y)

void ODE_NUMERIC::SetSolution ( const PtrSolution Sol ) [inline]
 

Sets a solution object.

Parameters:
Sol   pointer to a solution object
Precondition:
NotNull(Sol ) && GetSize() == Sol->GetDim()

double ODE_NUMERIC::GetTend ( ) const [inline]
 

Returns the end point.

double ODE_NUMERIC::GetAtol ( ) const [inline]
 

Returns the absolute tolerance.

double ODE_NUMERIC::GetRtol ( ) const [inline]
 

Returns the relative tolerance.

double ODE_NUMERIC::GetTcur ( ) const [inline]
 

Returns the current integration point.

double ODE_NUMERIC::GetTprev ( ) const [inline]
 

Returns the previous integration point.

const INTERVAL_VECTOR & ODE_NUMERIC::GetInitEncl ( ) const [inline]
 

Returns the initial enclosure.

const INTERVAL_VECTOR & ODE_NUMERIC::GetTightEncl ( ) const [inline]
 

Returns the tight enclosure.

const PtrSolution ODE_NUMERIC::GetSolution ( ) const [inline]
 

Returns a pointer to the solution object.

void ODE_NUMERIC::LoadProblemParam ( int ParamSet ) [inline, virtual]
 

Set problem parameters.

Depending on the value of the parameter, different sets of parameters, e.g. initial condition, integration interval, and tolerances, can be set.

Parameters:
ParamSet   encodes the parameter set.

void ODE_NUMERIC::DisplaySolution ( int comp,
const char * file = 0 ) const
 

Plot a solution component.

This function plots a solution component versus the time and displays the plot on the screen (default). If a file name is specified, the plot is saved in an encapsulated postscript file under this file name.

Parameters:
comp   component to be plotted
file   file name

Precondition:
comp <= GetSize() && comp >= 1

void ODE_NUMERIC::DisplayPhase ( int comp1,
int comp2,
const char * file = 0 ) const
 

Produce a phase plot.

This function plots comp2 versus comp1. By default, the result is displayed on the screen. If a file name is given, the plot is stored into an encapsulated postscript file under this file name.

Parameters:
comp1   first component
comp2   second component
file   file name

Precondition:
comp1 <= GetSize() && comp1 >= 1 &&
comp2 <= GetSize() && comp2 >= 1 && comp1 != comp2

The documentation for this class was generated from the following file:
Generated at Sun Oct 14 12:45:41 2001 for VNODE by doxygen1.2.0 written by Dimitri van Heesch, © 1997-2000