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 >:

[legend]
List of all members.

Constructors/Intializers/Misc

 TimeStepNonlinearSolver ()
 Sets parameter defaults .

Overridden from ParameterListAcceptor

void setParameterList (RCP< ParameterList > const &paramList)
 
RCP< ParameterListgetParameterList ()
 
RCP< ParameterListunsetParameterList ()
 
RCP< const ParameterListgetParameterList () const
 
RCP< const ParameterListgetValidParameters () 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)
 

Public Types

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

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 55 of file Rythmos_TimeStepNonlinearSolver.hpp.


Member Typedef Documentation

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

Definition at line 59 of file Rythmos_TimeStepNonlinearSolver.hpp.

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

Definition at line 61 of file Rythmos_TimeStepNonlinearSolver.hpp.

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

Definition at line 63 of file Rythmos_TimeStepNonlinearSolver.hpp.


Constructor & Destructor Documentation

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

Sets parameter defaults .

Definition at line 230 of file Rythmos_TimeStepNonlinearSolver.hpp.


Member Function Documentation

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

Implements Teuchos::ParameterListAcceptor.

Definition at line 245 of file Rythmos_TimeStepNonlinearSolver.hpp.

template<class Scalar>
RCP< ParameterList > Rythmos::TimeStepNonlinearSolver< Scalar >::getParameterList (  )  [virtual]

Implements Teuchos::ParameterListAcceptor.

Definition at line 269 of file Rythmos_TimeStepNonlinearSolver.hpp.

template<class Scalar>
RCP< ParameterList > Rythmos::TimeStepNonlinearSolver< Scalar >::unsetParameterList (  )  [virtual]

Implements Teuchos::ParameterListAcceptor.

Definition at line 277 of file Rythmos_TimeStepNonlinearSolver.hpp.

template<class Scalar>
RCP< const ParameterList > Rythmos::TimeStepNonlinearSolver< Scalar >::getParameterList (  )  const [virtual]

Reimplemented from Teuchos::ParameterListAcceptor.

Definition at line 287 of file Rythmos_TimeStepNonlinearSolver.hpp.

template<class Scalar>
RCP< const ParameterList > Rythmos::TimeStepNonlinearSolver< Scalar >::getValidParameters (  )  const [virtual]

Reimplemented from Teuchos::ParameterListAcceptor.

Definition at line 295 of file Rythmos_TimeStepNonlinearSolver.hpp.

template<class Scalar>
void Rythmos::TimeStepNonlinearSolver< Scalar >::setModel ( const RCP< const Thyra::ModelEvaluator< Scalar > > &  model  ) 

Definition at line 347 of file Rythmos_TimeStepNonlinearSolver.hpp.

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

Implements Thyra::NonlinearSolverBase< Scalar >.

Definition at line 361 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 
) [virtual]

Implements Thyra::NonlinearSolverBase< Scalar >.

Definition at line 368 of file Rythmos_TimeStepNonlinearSolver.hpp.

template<class Scalar>
bool Rythmos::TimeStepNonlinearSolver< Scalar >::supportsCloning (  )  const [virtual]

Reimplemented from Thyra::NonlinearSolverBase< Scalar >.

Definition at line 584 of file Rythmos_TimeStepNonlinearSolver.hpp.

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

Reimplemented from Thyra::NonlinearSolverBase< Scalar >.

Definition at line 592 of file Rythmos_TimeStepNonlinearSolver.hpp.

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

Reimplemented from Thyra::NonlinearSolverBase< Scalar >.

Definition at line 612 of file Rythmos_TimeStepNonlinearSolver.hpp.

template<class Scalar>
bool Rythmos::TimeStepNonlinearSolver< Scalar >::is_W_current (  )  const [virtual]

Reimplemented from Thyra::NonlinearSolverBase< Scalar >.

Definition at line 619 of file Rythmos_TimeStepNonlinearSolver.hpp.

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

Reimplemented from Thyra::NonlinearSolverBase< Scalar >.

Definition at line 627 of file Rythmos_TimeStepNonlinearSolver.hpp.

template<class Scalar>
RCP< const Thyra::LinearOpWithSolveBase< Scalar > > Rythmos::TimeStepNonlinearSolver< Scalar >::get_W (  )  const [virtual]

Reimplemented from Thyra::NonlinearSolverBase< Scalar >.

Definition at line 644 of file Rythmos_TimeStepNonlinearSolver.hpp.

template<class Scalar>
void Rythmos::TimeStepNonlinearSolver< Scalar >::set_W_is_current ( bool  W_is_current  )  [virtual]

Reimplemented from Thyra::NonlinearSolverBase< Scalar >.

Definition at line 651 of file Rythmos_TimeStepNonlinearSolver.hpp.


The documentation for this class was generated from the following file:
Generated on Tue Oct 20 12:46:10 2009 for Rythmos - Transient Integration for Differential Equations by doxygen 1.4.7