SAMRAI::solv::NonlinearSolverStrategy< DIM > Class Template Reference

Abstract base class defining interface between an algs::ImplicitIntegrator object and a nonlinear solver used to advance the solution in time. More...

#include <source/solvers/nonlinear/NonlinearSolverStrategy.h>

Inheritance diagram for SAMRAI::solv::NonlinearSolverStrategy< DIM >:

[legend]List of all members.

Public Member Functions
	NonlinearSolverStrategy ()
virtual	~NonlinearSolverStrategy ()
virtual void	initialize (const tbox::Pointer< SAMRAIVectorReal< DIM, double > > solution)=0
virtual int	solve ()=0

---

Detailed Description

template<int DIM>
class SAMRAI::solv::NonlinearSolverStrategy< DIM >

Abstract base class defining interface between an algs::ImplicitIntegrator object and a nonlinear solver used to advance the solution in time.

The interface follows the Strategy design pattern. The methods declared in the interface are provided in a concrete solver derived from this base class.

See also:

algs::ImplicitIntegrator

---

Constructor & Destructor Documentation

template<int DIM> SAMRAI::solv::NonlinearSolverStrategy< DIM >::NonlinearSolverStrategy (   )

Empty constructor for algs::NonlinearSolverStrategy.

template<int DIM> SAMRAI::solv::NonlinearSolverStrategy< DIM >::~NonlinearSolverStrategy (   )  [virtual]

Empty constructor for algs::NonlinearSolverStrategy.

---

Member Function Documentation

template<int DIM> virtual void SAMRAI::solv::NonlinearSolverStrategy< DIM >::initialize (  const tbox::Pointer< SAMRAIVectorReal< DIM, double > >  solution  )  [pure virtual]

Initialize the solver state. The vector argument represents the solution of the nonlinear system. In general, this routine must be called before the solve() routine is invoked. Implemented in SAMRAI::solv::SNES_SAMRAIContext< DIM >, and SAMRAI::solv::KINSOL_SAMRAIContext< DIM >.

template<int DIM> virtual int SAMRAI::solv::NonlinearSolverStrategy< DIM >::solve (   )  [pure virtual]

Solve the nonlinear problem and return the integer code defined by the particular nonlinear solver package in use (e.g., indicating success or failure of solution process). In general, the initialize() routine must be called before this solve function. Implemented in SAMRAI::solv::SNES_SAMRAIContext< DIM >, and SAMRAI::solv::KINSOL_SAMRAIContext< DIM >.

---

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

• source/solvers/nonlinear/NonlinearSolverStrategy.h
• source/solvers/nonlinear/NonlinearSolverStrategy.C

---