Rythmos - Transient Integration for Differential Equations Version of the Day
Public Types | Related Functions
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_decl.hpp>

List of all members.

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.
template<class Scalar >
RCP< TimeStepNonlinearSolver
< Scalar > > 
timeStepNonlinearSolver (const RCP< ParameterList > &pl)
 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 50 of file Rythmos_TimeStepNonlinearSolver_decl.hpp.


Member Typedef Documentation

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

Definition at line 54 of file Rythmos_TimeStepNonlinearSolver_decl.hpp.

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

Definition at line 56 of file Rythmos_TimeStepNonlinearSolver_decl.hpp.

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

Definition at line 58 of file Rythmos_TimeStepNonlinearSolver_decl.hpp.


Constructor & Destructor Documentation

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

Sets parameter defaults .

Definition at line 111 of file Rythmos_TimeStepNonlinearSolver_def.hpp.


Member Function Documentation

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

Definition at line 126 of file Rythmos_TimeStepNonlinearSolver_def.hpp.

template<class Scalar >
RCP< ParameterList > Rythmos::TimeStepNonlinearSolver< Scalar >::getNonconstParameterList ( )

Definition at line 150 of file Rythmos_TimeStepNonlinearSolver_def.hpp.

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

Definition at line 158 of file Rythmos_TimeStepNonlinearSolver_def.hpp.

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

Definition at line 168 of file Rythmos_TimeStepNonlinearSolver_def.hpp.

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

Definition at line 176 of file Rythmos_TimeStepNonlinearSolver_def.hpp.

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

Definition at line 390 of file Rythmos_ExplicitRKStepper_def.hpp.

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

Definition at line 242 of file Rythmos_TimeStepNonlinearSolver_def.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 
)

Definition at line 249 of file Rythmos_TimeStepNonlinearSolver_def.hpp.

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

Definition at line 468 of file Rythmos_TimeStepNonlinearSolver_def.hpp.

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

Definition at line 476 of file Rythmos_TimeStepNonlinearSolver_def.hpp.

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

Definition at line 496 of file Rythmos_TimeStepNonlinearSolver_def.hpp.

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

Definition at line 503 of file Rythmos_TimeStepNonlinearSolver_def.hpp.

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

Definition at line 511 of file Rythmos_TimeStepNonlinearSolver_def.hpp.

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

Definition at line 528 of file Rythmos_TimeStepNonlinearSolver_def.hpp.

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

Definition at line 535 of file Rythmos_TimeStepNonlinearSolver_def.hpp.


Friends And Related Function Documentation

template<class Scalar >
RCP< TimeStepNonlinearSolver< Scalar > > timeStepNonlinearSolver ( ) [related]

Nonmember constructor.

template<class Scalar >
RCP< TimeStepNonlinearSolver< Scalar > > timeStepNonlinearSolver ( const RCP< ParameterList > &  pl) [related]

Nonmember constructor.


The documentation for this class was generated from the following files:
 All Classes Functions Variables Typedefs Friends