Rythmos::TimeStepNonlinearSolver< Scalar > Class Template Reference

Simple undampended Newton solver designed to solve time step equations in accurate times-tepping methods. More...

#include <Rythmos_TimeStepNonlinearSolver.hpp>

Inheritance diagram for Rythmos::TimeStepNonlinearSolver< Scalar >:

Public Types
typedef Teuchos::ScalarTraits < Scalar >	ST

typedef ST::magnitudeType	ScalarMag

typedef Teuchos::ScalarTraits < ScalarMag >	SMT

Related Functions
(Note that these are not member functions.)
template<class Scalar >
RCP< TimeStepNonlinearSolver < Scalar > >	timeStepNonlinearSolver ()
	Nonmember constructor.
Constructors/Intializers/Misc

	TimeStepNonlinearSolver ()
	Sets parameter defaults .
Overridden from ParameterListAcceptor

void	setParameterList (RCP< ParameterList > const &paramList)

RCP< ParameterList >	getNonconstParameterList ()

RCP< ParameterList >	unsetParameterList ()

RCP< const ParameterList >	getParameterList () const

RCP< const ParameterList >	getValidParameters () const

Overridden from NonlinearSolverBase

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

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

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

bool	supportsCloning () const

RCP < Thyra::NonlinearSolverBase < Scalar > >	cloneNonlinearSolver () const

RCP< const Thyra::VectorBase < Scalar > >	get_current_x () const

bool	is_W_current () const

RCP < Thyra::LinearOpWithSolveBase < Scalar > >	get_nonconst_W (const bool forceUpToDate)

RCP< const Thyra::LinearOpWithSolveBase < Scalar > >	get_W () const

void	set_W_is_current (bool W_is_current)

Detailed Description

template<class Scalar>
class Rythmos::TimeStepNonlinearSolver< Scalar >

Simple undampended Newton solver designed to solve time step equations in accurate times-tepping methods.

ToDo: Finish documentation.

2007/05/18: rabartl: ToDo: Derive NonlinearSolverBase from ParameterListAcceptor and accept options through a validated parameter list! Then remove these STANDARD_MEMBER_COMPOSITION_MEMBERS() macros.

Definition at line 56 of file Rythmos_TimeStepNonlinearSolver.hpp.

Member Typedef Documentation

template<class Scalar >

typedef Teuchos::ScalarTraits<Scalar> Rythmos::TimeStepNonlinearSolver< Scalar >::ST

Definition at line 60 of file Rythmos_TimeStepNonlinearSolver.hpp.

template<class Scalar >

typedef ST::magnitudeType Rythmos::TimeStepNonlinearSolver< Scalar >::ScalarMag

Definition at line 62 of file Rythmos_TimeStepNonlinearSolver.hpp.

template<class Scalar >

typedef Teuchos::ScalarTraits<ScalarMag> Rythmos::TimeStepNonlinearSolver< Scalar >::SMT

Definition at line 64 of file Rythmos_TimeStepNonlinearSolver.hpp.

Constructor & Destructor Documentation

template<class Scalar >

Rythmos::TimeStepNonlinearSolver< Scalar >::TimeStepNonlinearSolver ( ) [inline]

Sets parameter defaults .

Definition at line 242 of file Rythmos_TimeStepNonlinearSolver.hpp.

Member Function Documentation

template<class Scalar >

void Rythmos::TimeStepNonlinearSolver< Scalar >::setParameterList ( RCP< ParameterList > const & paramList ) [inline, virtual]

Implements Teuchos::ParameterListAcceptor.

Definition at line 257 of file Rythmos_TimeStepNonlinearSolver.hpp.

template<class Scalar >

RCP< ParameterList > Rythmos::TimeStepNonlinearSolver< Scalar >::getNonconstParameterList ( ) [inline, virtual]

Implements Teuchos::ParameterListAcceptor.

Definition at line 281 of file Rythmos_TimeStepNonlinearSolver.hpp.

template<class Scalar >

RCP< ParameterList > Rythmos::TimeStepNonlinearSolver< Scalar >::unsetParameterList ( ) [inline, virtual]

Implements Teuchos::ParameterListAcceptor.

Definition at line 289 of file Rythmos_TimeStepNonlinearSolver.hpp.

template<class Scalar >

RCP< const ParameterList > Rythmos::TimeStepNonlinearSolver< Scalar >::getParameterList ( ) const [inline, virtual]

Reimplemented from Teuchos::ParameterListAcceptor.

Definition at line 299 of file Rythmos_TimeStepNonlinearSolver.hpp.

template<class Scalar >

RCP< const ParameterList > Rythmos::TimeStepNonlinearSolver< Scalar >::getValidParameters ( ) const [inline, virtual]

Reimplemented from Teuchos::ParameterListAcceptor.

Definition at line 307 of file Rythmos_TimeStepNonlinearSolver.hpp.

template<class Scalar >

void Rythmos::TimeStepNonlinearSolver< Scalar >::setModel ( const RCP< const Thyra::ModelEvaluator< Scalar > > & model ) [inline]

Definition at line 359 of file Rythmos_TimeStepNonlinearSolver.hpp.

template<class Scalar >

RCP< const Thyra::ModelEvaluator< Scalar > > Rythmos::TimeStepNonlinearSolver< Scalar >::getModel ( ) const [inline, virtual]

Implements Thyra::NonlinearSolverBase< Scalar >.

Definition at line 373 of file Rythmos_TimeStepNonlinearSolver.hpp.

template<class Scalar >

Thyra::SolveStatus< Scalar > Rythmos::TimeStepNonlinearSolver< Scalar >::solve	(	Thyra::VectorBase< Scalar > *	x,
		const Thyra::SolveCriteria< Scalar > *	solveCriteria,
		Thyra::VectorBase< Scalar > *	delta = `NULL`
	)			`[inline, virtual]`

Implements Thyra::NonlinearSolverBase< Scalar >.

Definition at line 380 of file Rythmos_TimeStepNonlinearSolver.hpp.

template<class Scalar >

bool Rythmos::TimeStepNonlinearSolver< Scalar >::supportsCloning ( ) const [inline, virtual]

Reimplemented from Thyra::NonlinearSolverBase< Scalar >.

Definition at line 596 of file Rythmos_TimeStepNonlinearSolver.hpp.

template<class Scalar >

RCP< Thyra::NonlinearSolverBase< Scalar > > Rythmos::TimeStepNonlinearSolver< Scalar >::cloneNonlinearSolver ( ) const [inline, virtual]

Reimplemented from Thyra::NonlinearSolverBase< Scalar >.

Definition at line 604 of file Rythmos_TimeStepNonlinearSolver.hpp.

template<class Scalar >

RCP< const Thyra::VectorBase< Scalar > > Rythmos::TimeStepNonlinearSolver< Scalar >::get_current_x ( ) const [inline, virtual]

Reimplemented from Thyra::NonlinearSolverBase< Scalar >.

Definition at line 624 of file Rythmos_TimeStepNonlinearSolver.hpp.

template<class Scalar >

bool Rythmos::TimeStepNonlinearSolver< Scalar >::is_W_current ( ) const [inline, virtual]

Reimplemented from Thyra::NonlinearSolverBase< Scalar >.

Definition at line 631 of file Rythmos_TimeStepNonlinearSolver.hpp.

template<class Scalar >

RCP< Thyra::LinearOpWithSolveBase< Scalar > > Rythmos::TimeStepNonlinearSolver< Scalar >::get_nonconst_W ( const bool forceUpToDate ) [inline, virtual]