NewtonLineSearch< T > Class Template Reference

The line-search strategy base class template. More...

#include <NewtonSolver.hpp>

Inheritance diagram for NewtonLineSearch< T >:

[legend]Collaboration diagram for NewtonLineSearch< T >:

[legend]List of all members.

Public Member Functions
virtual void	PrintParam ()=0
virtual void	PreProcess (GridVec< T > &u)=0
	Allocates memory, ...
virtual double	Run (NonLinSys< T > &p, GridVec< T > &u, double old_d_norm, GridVec< T > &update, T damp, GridVec< T > &new_defect)=0
	Computes the update for the solution and the defect of the updated solution.
virtual void	PostProcess ()=0
	Releases the memory, ...
virtual	~NewtonLineSearch ()
	Virtual destructor.

---

Detailed Description

template<typename T>
class NewtonLineSearch< T >

The line-search strategy base class template.

This is a base class template for line-search strategies for the Newton-like iterative linear solvers. This is a virtual class. The algorithm of the line search should be implemented in NewtonLineSearch<T>Run.

The templates depend on a type T. This type should satisfy the conditions listed in 'small_matrix.hpp' for small matrices.

---

Constructor & Destructor Documentation

template<typename T>

virtual NewtonLineSearch< T >::~NewtonLineSearch

(

)

[inline, virtual]

Virtual destructor.

---

Member Function Documentation

template<typename T>

virtual void NewtonLineSearch< T >::PrintParam

(

)

[pure virtual]

Prints the name and parameters of the strategy

Implemented in NewtonStdLSearch< T >.

template<typename T>

virtual void NewtonLineSearch< T >::PreProcess

(

GridVec< T > &

u

)

[pure virtual]

Allocates memory, ...

Parameters:

[in]

u

Vector with the same sizes as the solution

Implemented in NewtonStdLSearch< T >.

template<typename T>

virtual double NewtonLineSearch< T >::Run	(	NonLinSys< T > &	p,
		GridVec< T > &	u,
		double	old_d_norm,
		GridVec< T > &	update,
		T	damp,
		GridVec< T > &	new_defect
	)			[pure virtual]

Computes the update for the solution and the defect of the updated solution.

Parameters:

[in]	p	The non-linear system
[in]	u	The current guess (the updated guess is saved here, too)
[in]	old_d_norm	The 2-norm of the current defect
[in]	update	The search direction
[in]	damp	The damping factor
[in]	new_defect	To save the new defect

Returns:

The 2-norm of the new defect

Implemented in NewtonStdLSearch< T >.

template<typename T>

virtual void NewtonLineSearch< T >::PostProcess

(

)

[pure virtual]

Releases the memory, ...

Implemented in NewtonStdLSearch< T >.

---

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

• NewtonSolver.hpp

---