---

SOLVER_STATS Class Reference

Statistics class. More...

#include <vndstat.h>

List of all members.

Public Methods
	SOLVER_STATS ()
	Constructor.
void	Reset ()
	Resets the statistics.
void	SetRelError ( double t, double e )
	Sets relative error. More...
void	SetAbsError ( double t, const double e )
	Sets absolute error. More...
double	GetMaxRelError () const
	Returns the maximum relative error. More...
double	GetMaxAbsError () const
	Returns the maximum absolute error. More...
double	GetWhereMaxRelError () const
	Returns the point of the maximum relative error. More...
double	GetWhereMaxAbsError () const
	Returns the point of the maximum absolute error. More...
double	GetRelError () const
	Returns the current relative error. More...
double	GetAbsError () const
	Returns the current absolute error. More...
double	GetWhereRelError () const
	Returns the point of the current relative error. More...
double	GetWhereAbsError () const
	Returns the point of the current absolute error. More...
void	AddUserTime ( double time )
	Adds CPU time. More...
double	GetUserTime () const
	Returns the CPU time.
unsigned int	GetAcceptedSteps () const
	Returns the number of accepted steps.
unsigned int	GetRejectedSteps () const
	Returns the number of rejected steps.
unsigned int	GetTotalSteps () const
	Returns the number of accepted and rejected steps.
void	AccRejStep ( bool b )
	Keeps track of the accepted and rejected steps. More...

---

Detailed Description

Statistics class.

The purpose of this class is to store statistics collected during an integration.

Author(s):

Ned Nedialkov

Date:

8 June 2001

---

Constructor & Destructor Documentation

SOLVER_STATS::SOLVER_STATS ( ) [inline]

Constructor.

---

Member Function Documentation

void SOLVER_STATS::Reset ( )

Resets the statistics.

void SOLVER_STATS::SetRelError ( double t, double e ) [inline]

Sets relative error. This function sets the relative error at a given point and also sets the maximum relative error. Parameters: t   integration point e   relative error at t Precondition: e >= 0

void SOLVER_STATS::SetAbsError ( double t, const double e ) [inline]

Sets absolute error. This function sets the absolute error at a given point and also sets the maximum absolute error. Parameters: t   integration point e   absolute error at t. Precondition: e >= 0

double SOLVER_STATS::GetMaxRelError ( ) const [inline]

Returns the maximum relative error. Returns: the maximum relative error or -1, if SetRelError() has not been called.

double SOLVER_STATS::GetMaxAbsError ( ) const [inline]

Returns the maximum absolute error. Returns: the maximum absolute error or -1, if SetAbsError() has not been called.

double SOLVER_STATS::GetWhereMaxRelError ( ) const [inline]

Returns the point of the maximum relative error. Returns: the point where the maximum relative error occurs or 0, if SetRelError() has not been called.

double SOLVER_STATS::GetWhereMaxAbsError ( ) const [inline]

Returns the point of the maximum absolute error. Returns: the point where the maximum absolute error occurs or 0, if SetAbsError() has not been called.

double SOLVER_STATS::GetRelError ( ) const [inline]

Returns the current relative error. Returns: the relative error that is set by the most recent call to SetRelError(), or -1, if SetRelError() has not been called.

double SOLVER_STATS::GetAbsError ( ) const [inline]

Returns the current absolute error. Returns: the absolute error that is set by the most recent call to SetAbsError(), or -1, if SetAbsError() has not been called.

double SOLVER_STATS::GetWhereRelError ( ) const [inline]

Returns the point of the current relative error. Returns: the point that is set by the most recent call to SetRelError(), or 0 if SetRelError() has not been called.

double SOLVER_STATS::GetWhereAbsError ( ) const [inline]

Returns the point of the current absolute error. Returns: the point that is set by the most recent call to SetAbsError(), or 0 if SetAbsError() has not been called.

void SOLVER_STATS::AddUserTime ( double time ) [inline]

Adds CPU time. This function adds time to the current CPU time. Parameters: time   CPU time. Precondition: time >= 0

double SOLVER_STATS::GetUserTime ( ) const [inline]

Returns the CPU time.

unsigned int SOLVER_STATS::GetAcceptedSteps ( ) const [inline]

Returns the number of accepted steps.

unsigned int SOLVER_STATS::GetRejectedSteps ( ) const [inline]

Returns the number of rejected steps.

unsigned int SOLVER_STATS::GetTotalSteps ( ) const [inline]

Returns the number of accepted and rejected steps.

void SOLVER_STATS::AccRejStep ( bool b ) [inline]

Keeps track of the accepted and rejected steps. Parameters: b   if true, the number of accepted steps is incremented by one; otherwise, the number of rejected steps is incremented by one.

---

The documentation for this class was generated from the following file:

• vndstat.h

---