Concrete nonlinear solver for linear equations. More...

#include <Thyra_LinearNonlinearSolver.hpp>

Inheritance diagram for Thyra::LinearNonlinearSolver< Scalar >:

[legend]

Related Symbols
(Note that these are not member symbols.)
template<class Scalar>
RCP< LinearNonlinearSolver< Scalar > >	linearNonlinearSolver ()
Related Symbols inherited from Thyra::NonlinearSolverBase< Scalar >
template<class Scalar>
const SolveStatus< Scalar >	solve (NonlinearSolverBase< Scalar > &nonlinearSolver, VectorBase< Scalar > x, const SolveCriteria< Scalar > solveCriteria=NULL, VectorBase< Scalar > *delta=NULL)

Overridden from NonlinearSolverBase
void	setModel (const RCP< const ModelEvaluator< Scalar > > &model)
RCP< const ModelEvaluator< Scalar > >	getModel () const
SolveStatus< Scalar >	solve (VectorBase< Scalar > x, const SolveCriteria< Scalar > solveCriteria, VectorBase< Scalar > *delta)
RCP< LinearOpWithSolveBase< Scalar > >	get_nonconst_W (const bool forceUpToDate)
RCP< const LinearOpWithSolveBase< Scalar > >	get_W () const

Overridden from ParameterListAcceptor
void	setParameterList (RCP< Teuchos::ParameterList > const &paramList)
RCP< Teuchos::ParameterList >	getNonconstParameterList ()
RCP< Teuchos::ParameterList >	unsetParameterList ()
RCP< const Teuchos::ParameterList >	getParameterList () const
RCP< const Teuchos::ParameterList >	getValidParameters () const

Additional Inherited Members
virtual bool	supportsCloning () const
	Return if this solver object supports cloning or not.
virtual RCP< NonlinearSolverBase< Scalar > >	cloneNonlinearSolver () const
	Clone the solver algorithm if supported.
virtual RCP< const VectorBase< Scalar > >	get_current_x () const
	Return the current value of the solution x as computed in the last solve() operation if supported.
virtual bool	is_W_current () const
	Returns true if get_W() is current with respect to get_current_x().
virtual void	set_W_is_current (bool W_is_current)
	Set if get_W() is current with respect to get_current_x().

Detailed Description

template<class Scalar>
class Thyra::LinearNonlinearSolver< Scalar >

Concrete nonlinear solver for linear equations.

This class basically implements a Newton method with one iteration and never checks the final tolerence. Otherwise, it is identical to a Newton method with one iteration.

Definition at line 33 of file Thyra_LinearNonlinearSolver.hpp.

Member Function Documentation

◆ setParameterList()

template<class Scalar>

void Thyra::LinearNonlinearSolver< Scalar >::setParameterList ( RCP< Teuchos::ParameterList > const & paramList )

virtual

Implements Teuchos::ParameterListAcceptor.

Definition at line 102 of file Thyra_LinearNonlinearSolver.hpp.

◆ getNonconstParameterList()

template<class Scalar>

RCP< Teuchos::ParameterList > Thyra::LinearNonlinearSolver< Scalar >::getNonconstParameterList ( )

virtual

Implements Teuchos::ParameterListAcceptor.

Definition at line 120 of file Thyra_LinearNonlinearSolver.hpp.

◆ unsetParameterList()

template<class Scalar>

RCP< Teuchos::ParameterList > Thyra::LinearNonlinearSolver< Scalar >::unsetParameterList ( )

virtual

Implements Teuchos::ParameterListAcceptor.

Definition at line 128 of file Thyra_LinearNonlinearSolver.hpp.

◆ getParameterList()

template<class Scalar>

RCP< const Teuchos::ParameterList > Thyra::LinearNonlinearSolver< Scalar >::getParameterList ( ) const

virtual

Reimplemented from Teuchos::ParameterListAcceptor.

Definition at line 138 of file Thyra_LinearNonlinearSolver.hpp.

◆ getValidParameters()

template<class Scalar>

RCP< const Teuchos::ParameterList > Thyra::LinearNonlinearSolver< Scalar >::getValidParameters ( ) const

virtual

Reimplemented from Teuchos::ParameterListAcceptor.

Definition at line 146 of file Thyra_LinearNonlinearSolver.hpp.

◆ setModel()

template<class Scalar>

void Thyra::LinearNonlinearSolver< Scalar >::setModel ( const RCP< const ModelEvaluator< Scalar > > & model )

virtual

Implements Thyra::NonlinearSolverBase< Scalar >.

Definition at line 165 of file Thyra_LinearNonlinearSolver.hpp.

◆ getModel()

template<class Scalar>

RCP< const ModelEvaluator< Scalar > > Thyra::LinearNonlinearSolver< Scalar >::getModel ( ) const

virtual

Implements Thyra::NonlinearSolverBase< Scalar >.

Definition at line 177 of file Thyra_LinearNonlinearSolver.hpp.

◆ solve()

template<class Scalar>

SolveStatus< Scalar > Thyra::LinearNonlinearSolver< Scalar >::solve	(	VectorBase< Scalar > *	x,
		const SolveCriteria< Scalar > *	solveCriteria,
		VectorBase< Scalar > *	delta )