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

ORDER_CTRL Class Reference

Abstract order control class. More...

#include <orderctrl.h>

Inheritance diagram for ORDER_CTRL:

NAME CONST_ORDER List of all members.

Public Methods

 ORDER_CTRL ( int kmax, const string & name )
 Constructor. More...

virtual int CompOrder ( PtrODESolver Solver ) = 0
 Computes order. More...

int GetMaxOrder () const
 Gets the maximum order. More...

void SetCurOrder ( int k )
 Sets the current order. More...

int GetCurOrder () const
 Gets the current order. More...

virtual ~ORDER_CTRL ()
 Destructor.

Detailed Description

Abstract order control class.

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

Constructor & Destructor Documentation

ORDER_CTRL::ORDER_CTRL ( int kmax,
const string & name ) [inline]
 

Constructor.

It sets the maximum order allowed, kmax, the value for the current order to kmax, and a name for the order control method.

Parameters:
kmax   maximum order allowed
name   name for the order control method

Precondition:
kmax > 0 && !name.empty()

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

Destructor.

Member Function Documentation

int ORDER_CTRL::CompOrder ( PtrODESolver Solver ) [pure virtual]
 

Computes order.

Parameters:
Solver   pointer to a solver

Returns:
a value for the order of a method
Precondition:
NotNull(Solver)

Reimplemented in CONST_ORDER.

int ORDER_CTRL::GetMaxOrder ( ) const [inline]
 

Gets the maximum order.

This function returns the maximum value for the order that is set in the constructor.

void ORDER_CTRL::SetCurOrder ( int k ) [inline]
 

Sets the current order.

This function stores a value for the current order.

Parameters:
k   order
Precondition:
k > 0 && k <= GetMaxOrder()

int ORDER_CTRL::GetCurOrder ( ) const [inline]
 

Gets the current order.

This function returns the order that is set by the most recent call to SetCurOrder() or the order that is set in the constructor, if SetCurOrder() has not been called.

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