Thyra::TimeStepNewtonNonlinearSolver< Scalar > Class Template Reference

Simple undampended Newton solver :-). More...

#include <Thyra_TimeStepNewtonNonlinearSolver.hpp>

Inheritance diagram for Thyra::TimeStepNewtonNonlinearSolver< Scalar >:

[legend]
List of all members.

Overridden from NonlinearSolverBase

void setModel (const Teuchos::RefCountPtr< const ModelEvaluator< Scalar > > &model)
 
Teuchos::RefCountPtr< const
ModelEvaluator< Scalar > > 
getModel () const
 
SolveStatus< Scalar > solve (VectorBase< Scalar > *x, const SolveCriteria< Scalar > *solveCriteria, VectorBase< Scalar > *delta=NULL)
 
Teuchos::RefCountPtr< const
VectorBase< Scalar > > 
get_current_x () const
 
bool is_W_current () const
 
Teuchos::RefCountPtr< LinearOpWithSolveBase<
Scalar > > 
get_nonconst_W ()
 
Teuchos::RefCountPtr< const
LinearOpWithSolveBase< Scalar > > 
get_W () const
 
void set_W_is_current (bool W_is_current)
 

Public Types

typedef Teuchos::ScalarTraits<
Scalar > 
ST
 
typedef ST::magnitudeType ScalarMag
 
typedef Teuchos::ScalarTraits<
ScalarMag
SMT
 

Public Member Functions

void defaultMaxIterations (const int &defaultMaxIterations)
 The default maximum number of iterations.
void defaultTol (const ScalarMag &defaultTol)
 The default solution tolerance.
void set_warningOut (const Teuchos::RefCountPtr< std::ostream > &warningOut)
 Stream that warnings are printed to.

Detailed Description

template<class Scalar>
class Thyra::TimeStepNewtonNonlinearSolver< Scalar >

Simple undampended Newton solver :-).

ToDo: Finish documentation.

Definition at line 43 of file Thyra_TimeStepNewtonNonlinearSolver.hpp.


Member Typedef Documentation

template<class Scalar>
typedef Teuchos::ScalarTraits<Scalar> Thyra::TimeStepNewtonNonlinearSolver< Scalar >::ST
 

Definition at line 47 of file Thyra_TimeStepNewtonNonlinearSolver.hpp.

template<class Scalar>
typedef ST::magnitudeType Thyra::TimeStepNewtonNonlinearSolver< Scalar >::ScalarMag
 

Definition at line 49 of file Thyra_TimeStepNewtonNonlinearSolver.hpp.

template<class Scalar>
typedef Teuchos::ScalarTraits<ScalarMag> Thyra::TimeStepNewtonNonlinearSolver< Scalar >::SMT
 

Definition at line 51 of file Thyra_TimeStepNewtonNonlinearSolver.hpp.


Member Function Documentation

template<class Scalar>
void Thyra::TimeStepNewtonNonlinearSolver< Scalar >::defaultMaxIterations const int &  defaultMaxIterations  )  [inline]
 

The default maximum number of iterations.

Definition at line 54 of file Thyra_TimeStepNewtonNonlinearSolver.hpp.

template<class Scalar>
void Thyra::TimeStepNewtonNonlinearSolver< Scalar >::defaultTol const ScalarMag defaultTol  )  [inline]
 

The default solution tolerance.

Definition at line 57 of file Thyra_TimeStepNewtonNonlinearSolver.hpp.

template<class Scalar>
void Thyra::TimeStepNewtonNonlinearSolver< Scalar >::set_warningOut const Teuchos::RefCountPtr< std::ostream > &  warningOut  )  [inline]
 

Stream that warnings are printed to.

Definition at line 60 of file Thyra_TimeStepNewtonNonlinearSolver.hpp.

template<class Scalar>
void Thyra::TimeStepNewtonNonlinearSolver< Scalar >::setModel const Teuchos::RefCountPtr< const ModelEvaluator< Scalar > > &  model  )  [virtual]
 

Implements Thyra::NonlinearSolverBase< Scalar >.

Definition at line 124 of file Thyra_TimeStepNewtonNonlinearSolver.hpp.

template<class Scalar>
Teuchos::RefCountPtr< const ModelEvaluator< Scalar > > Thyra::TimeStepNewtonNonlinearSolver< Scalar >::getModel  )  const [virtual]
 

Implements Thyra::NonlinearSolverBase< Scalar >.

Definition at line 137 of file Thyra_TimeStepNewtonNonlinearSolver.hpp.

template<class Scalar>
SolveStatus< Scalar > Thyra::TimeStepNewtonNonlinearSolver< Scalar >::solve VectorBase< Scalar > *  x,
const SolveCriteria< Scalar > *  solveCriteria,
VectorBase< Scalar > *  delta = NULL
[virtual]
 

Implements Thyra::NonlinearSolverBase< Scalar >.

Definition at line 143 of file Thyra_TimeStepNewtonNonlinearSolver.hpp.

template<class Scalar>
Teuchos::RefCountPtr< const VectorBase< Scalar > > Thyra::TimeStepNewtonNonlinearSolver< Scalar >::get_current_x  )  const [virtual]
 

Reimplemented from Thyra::NonlinearSolverBase< Scalar >.

Definition at line 240 of file Thyra_TimeStepNewtonNonlinearSolver.hpp.

template<class Scalar>
bool Thyra::TimeStepNewtonNonlinearSolver< Scalar >::is_W_current  )  const [virtual]
 

Reimplemented from Thyra::NonlinearSolverBase< Scalar >.

Definition at line 246 of file Thyra_TimeStepNewtonNonlinearSolver.hpp.

template<class Scalar>
Teuchos::RefCountPtr< LinearOpWithSolveBase< Scalar > > Thyra::TimeStepNewtonNonlinearSolver< Scalar >::get_nonconst_W  )  [virtual]
 

Reimplemented from Thyra::NonlinearSolverBase< Scalar >.

Definition at line 253 of file Thyra_TimeStepNewtonNonlinearSolver.hpp.

template<class Scalar>
Teuchos::RefCountPtr< const LinearOpWithSolveBase< Scalar > > Thyra::TimeStepNewtonNonlinearSolver< Scalar >::get_W  )  const [virtual]
 

Reimplemented from Thyra::NonlinearSolverBase< Scalar >.

Definition at line 260 of file Thyra_TimeStepNewtonNonlinearSolver.hpp.

template<class Scalar>
void Thyra::TimeStepNewtonNonlinearSolver< Scalar >::set_W_is_current bool  W_is_current  )  [virtual]
 

Reimplemented from Thyra::NonlinearSolverBase< Scalar >.

Definition at line 266 of file Thyra_TimeStepNewtonNonlinearSolver.hpp.


The documentation for this class was generated from the following file:
Generated on Thu Sep 18 12:32:51 2008 for Thyra Nonlinear Solver Support by doxygen 1.3.9.1