Diffpack Documentation

---

              Search  

---

SuccessiveSubst Class Reference

successive substitution iteration for nonlinear systems. More...

#include <SuccessiveSubst.h>

Inheritance diagram for SuccessiveSubst::

List of all members.

Public Methods
	SuccessiveSubst (const NonLinEqSolver_prm &pm)
	~SuccessiveSubst ()
virtual bool	ordinarySolve ()
virtual bool	singleStep ()

---

Detailed Description

successive substitution iteration for nonlinear systems.

NAME: SuccessiveSubst - successive substitution iteration for nonlinear systems

DESCRIPTION:

See class "NonLinEqSolver".

---

Constructor & Destructor Documentation

SuccessiveSubst::SuccessiveSubst ( const NonLinEqSolver_prm & pm )

See class "NonLinEqSolver".

SuccessiveSubst::~SuccessiveSubst ( ) [inline]

---

Member Function Documentation

bool SuccessiveSubst::ordinarySolve ( ) [virtual]

Reimplemented from NonLinEqSolver.

bool SuccessiveSubst::singleStep ( ) [virtual]

this function is like "ordinarySolve", but a return is performed after each step in the iteration. Hence the user can check the development of the nonlinear iterations. This may be useful is convergence problems occur. The function returns "true" as long as the convergence criteria are not satisified, and "false" when the stopping criteria are satisfied. Note this difference in comparison with "solve". The user must implement the loop, usually in terms of a "while(performSingleStep)" type of construction. Prior to the loop, a call to "initSingleSteps" must be performed. Reimplemented from NonLinEqSolver.

---

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

• SuccessiveSubst.h

---