Rythmos - Transient Integration for Differential Equations Version of the Day
Public Types | Related Functions
Rythmos::BackwardEulerStepper< Scalar > Class Template Reference

Simple concrete stepper subclass implementing an implicit backward Euler method. More...

#include <Rythmos_BackwardEulerStepper_decl.hpp>

Inheritance diagram for Rythmos::BackwardEulerStepper< Scalar >:
Inheritance graph
[legend]

List of all members.

Public Types

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

Related Functions

(Note that these are not member functions.)

template<class Scalar >
RCP< BackwardEulerStepper
< Scalar > > 
backwardEulerStepper ()
 Nonmember constructor.
template<class Scalar >
RCP< BackwardEulerStepper
< Scalar > > 
backwardEulerStepper (const RCP< Thyra::ModelEvaluator< Scalar > > &model, const RCP< Thyra::NonlinearSolverBase< Scalar > > &solver)
 Nonmember constructor.

Constructors, initializers, Misc.

 BackwardEulerStepper ()
 
 BackwardEulerStepper (const RCP< Thyra::ModelEvaluator< Scalar > > &model, const RCP< Thyra::NonlinearSolverBase< Scalar > > &solver)
 

Overridden from InterpolatorAcceptingObjectBase

void setInterpolator (const RCP< InterpolatorBase< Scalar > > &interpolator)
 
RCP< InterpolatorBase< Scalar > > getNonconstInterpolator ()
 
RCP< const InterpolatorBase
< Scalar > > 
getInterpolator () const
 
RCP< InterpolatorBase< Scalar > > unSetInterpolator ()
 

Overridden from StepControlStrategyAcceptingStepperBase

void setStepControlStrategy (const RCP< StepControlStrategyBase< Scalar > > &stepControlStrategy)
 
RCP< StepControlStrategyBase
< Scalar > > 
getNonconstStepControlStrategy ()
 
RCP< const
StepControlStrategyBase
< Scalar > > 
getStepControlStrategy () const
 

Overridden from SolverAcceptingStepperBase

void setSolver (const RCP< Thyra::NonlinearSolverBase< Scalar > > &solver)
 
RCP
< Thyra::NonlinearSolverBase
< Scalar > > 
getNonconstSolver ()
 
RCP< const
Thyra::NonlinearSolverBase
< Scalar > > 
getSolver () const
 

Overridden from StepperBase

bool supportsCloning () const
 Returns true.
RCP< StepperBase< Scalar > > cloneStepperAlgorithm () const
 Creates copies of all internal data (including the parameter list) except the model which is assumed to stateless.
bool isImplicit () const
 
void setModel (const RCP< const Thyra::ModelEvaluator< Scalar > > &model)
 
void setNonconstModel (const RCP< Thyra::ModelEvaluator< Scalar > > &model)
 
RCP< const
Thyra::ModelEvaluator< Scalar > > 
getModel () const
 
RCP< Thyra::ModelEvaluator
< Scalar > > 
getNonconstModel ()
 
void setInitialCondition (const Thyra::ModelEvaluatorBase::InArgs< Scalar > &initialCondition)
 
Thyra::ModelEvaluatorBase::InArgs
< Scalar > 
getInitialCondition () const
 
Scalar takeStep (Scalar dt, StepSizeType flag)
 
const StepStatus< Scalar > getStepStatus () const
 

Overridden from InterpolationBufferBase

RCP< const
Thyra::VectorSpaceBase< Scalar > > 
get_x_space () const
 
void addPoints (const Array< Scalar > &time_vec, const Array< RCP< const Thyra::VectorBase< Scalar > > > &x_vec, const Array< RCP< const Thyra::VectorBase< Scalar > > > &xdot_vec)
 
TimeRange< Scalar > getTimeRange () const
 
void getPoints (const Array< Scalar > &time_vec, Array< RCP< const Thyra::VectorBase< Scalar > > > *x_vec, Array< RCP< const Thyra::VectorBase< Scalar > > > *xdot_vec, Array< ScalarMag > *accuracy_vec) const
 
void getNodes (Array< Scalar > *time_vec) const
 
void removeNodes (Array< Scalar > &time_vec)
 
int getOrder () const
 

Overridden from Teuchos::ParameterListAcceptor

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

Overridden from Teuchos::Describable

void describe (Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel) const
 

Momento functions.

RCP< const MomentoBase< Scalar > > getMomento () const
 Get momento object for use in restarts.
void setMomento (const Ptr< const MomentoBase< Scalar > > &momentoPtr, const RCP< Thyra::ModelEvaluator< Scalar > > &model, const RCP< Thyra::NonlinearSolverBase< Scalar > > &solver)
 Set momento object for use in restarts.

Detailed Description

template<class Scalar>
class Rythmos::BackwardEulerStepper< Scalar >

Simple concrete stepper subclass implementing an implicit backward Euler method.

This class exists primarily as a simple example of an implicit time stepper and as a vehicle for experimentation. The ImplicitBDFStepper also implements backward Euler and is a more powerful stepper class. This class does not implement a local truncation error test and therefore also does not handle the automatic step size selection. Therefore, if you need these features, you should really use the ImplicitBDFStepper class.

Definition at line 283 of file Rythmos_BackwardEulerStepper_decl.hpp.


Member Typedef Documentation

template<class Scalar >
typedef Teuchos::ScalarTraits<Scalar>::magnitudeType Rythmos::BackwardEulerStepper< Scalar >::ScalarMag

Constructor & Destructor Documentation

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

Definition at line 77 of file Rythmos_BackwardEulerStepper_def.hpp.

template<class Scalar >
Rythmos::BackwardEulerStepper< Scalar >::BackwardEulerStepper ( const RCP< Thyra::ModelEvaluator< Scalar > > &  model,
const RCP< Thyra::NonlinearSolverBase< Scalar > > &  solver 
)

Definition at line 87 of file Rythmos_BackwardEulerStepper_def.hpp.


Member Function Documentation

template<class Scalar >
void Rythmos::BackwardEulerStepper< Scalar >::setInterpolator ( const RCP< InterpolatorBase< Scalar > > &  interpolator) [virtual]
template<class Scalar >
RCP< InterpolatorBase< Scalar > > Rythmos::BackwardEulerStepper< Scalar >::getNonconstInterpolator ( ) [virtual]
template<class Scalar >
RCP< const InterpolatorBase< Scalar > > Rythmos::BackwardEulerStepper< Scalar >::getInterpolator ( ) const [virtual]
template<class Scalar >
RCP< InterpolatorBase< Scalar > > Rythmos::BackwardEulerStepper< Scalar >::unSetInterpolator ( ) [virtual]
template<class Scalar >
void Rythmos::BackwardEulerStepper< Scalar >::setStepControlStrategy ( const RCP< StepControlStrategyBase< Scalar > > &  stepControlStrategy)

Definition at line 359 of file Rythmos_BackwardEulerStepper_def.hpp.

template<class Scalar >
RCP< StepControlStrategyBase< Scalar > > Rythmos::BackwardEulerStepper< Scalar >::getNonconstStepControlStrategy ( ) [virtual]
template<class Scalar >
RCP< const StepControlStrategyBase< Scalar > > Rythmos::BackwardEulerStepper< Scalar >::getStepControlStrategy ( ) const [virtual]
template<class Scalar >
void Rythmos::BackwardEulerStepper< Scalar >::setSolver ( const RCP< Thyra::NonlinearSolverBase< Scalar > > &  solver)

Definition at line 169 of file Rythmos_BackwardEulerStepper_def.hpp.

template<class Scalar >
RCP< Thyra::NonlinearSolverBase< Scalar > > Rythmos::BackwardEulerStepper< Scalar >::getNonconstSolver ( ) [virtual]
template<class Scalar >
RCP< const Thyra::NonlinearSolverBase< Scalar > > Rythmos::BackwardEulerStepper< Scalar >::getSolver ( ) const [virtual]
template<class Scalar >
bool Rythmos::BackwardEulerStepper< Scalar >::supportsCloning ( ) const [virtual]

Returns true.

Reimplemented from Rythmos::StepperBase< Scalar >.

Definition at line 213 of file Rythmos_BackwardEulerStepper_def.hpp.

template<class Scalar >
RCP< StepperBase< Scalar > > Rythmos::BackwardEulerStepper< Scalar >::cloneStepperAlgorithm ( ) const [virtual]

Creates copies of all internal data (including the parameter list) except the model which is assumed to stateless.

If a shallow copy of the model is not appropirate for some reasone, then the client can simply reset the model using returnVal->setModel().

Reimplemented from Rythmos::StepperBase< Scalar >.

Definition at line 221 of file Rythmos_BackwardEulerStepper_def.hpp.

template<class Scalar >
bool Rythmos::BackwardEulerStepper< Scalar >::isImplicit ( ) const [virtual]

Reimplemented from Rythmos::StepperBase< Scalar >.

Definition at line 254 of file Rythmos_BackwardEulerStepper_def.hpp.

template<class Scalar >
void Rythmos::BackwardEulerStepper< Scalar >::setModel ( const RCP< const Thyra::ModelEvaluator< Scalar > > &  model) [virtual]
template<class Scalar >
void Rythmos::BackwardEulerStepper< Scalar >::setNonconstModel ( const RCP< Thyra::ModelEvaluator< Scalar > > &  model) [virtual]
template<class Scalar >
RCP< const Thyra::ModelEvaluator< Scalar > > Rythmos::BackwardEulerStepper< Scalar >::getModel ( ) const [virtual]
template<class Scalar >
RCP< Thyra::ModelEvaluator< Scalar > > Rythmos::BackwardEulerStepper< Scalar >::getNonconstModel ( ) [virtual]
template<class Scalar >
void Rythmos::BackwardEulerStepper< Scalar >::setInitialCondition ( const Thyra::ModelEvaluatorBase::InArgs< Scalar > &  initialCondition) [virtual]
template<class Scalar >
Thyra::ModelEvaluatorBase::InArgs< Scalar > Rythmos::BackwardEulerStepper< Scalar >::getInitialCondition ( ) const [virtual]
template<class Scalar >
Scalar Rythmos::BackwardEulerStepper< Scalar >::takeStep ( Scalar  dt,
StepSizeType  flag 
) [virtual]
template<class Scalar >
const StepStatus< Scalar > Rythmos::BackwardEulerStepper< Scalar >::getStepStatus ( ) const [virtual]
template<class Scalar >
RCP< const Thyra::VectorSpaceBase< Scalar > > Rythmos::BackwardEulerStepper< Scalar >::get_x_space ( ) const [virtual]
template<class Scalar >
void Rythmos::BackwardEulerStepper< Scalar >::addPoints ( const Array< Scalar > &  time_vec,
const Array< RCP< const Thyra::VectorBase< Scalar > > > &  x_vec,
const Array< RCP< const Thyra::VectorBase< Scalar > > > &  xdot_vec 
) [virtual]
template<class Scalar >
TimeRange< Scalar > Rythmos::BackwardEulerStepper< Scalar >::getTimeRange ( ) const [virtual]
template<class Scalar >
void Rythmos::BackwardEulerStepper< Scalar >::getPoints ( const Array< Scalar > &  time_vec,
Array< RCP< const Thyra::VectorBase< Scalar > > > *  x_vec,
Array< RCP< const Thyra::VectorBase< Scalar > > > *  xdot_vec,
Array< ScalarMag > *  accuracy_vec 
) const [virtual]
template<class Scalar >
void Rythmos::BackwardEulerStepper< Scalar >::getNodes ( Array< Scalar > *  time_vec) const [virtual]
template<class Scalar >
void Rythmos::BackwardEulerStepper< Scalar >::removeNodes ( Array< Scalar > &  time_vec) [virtual]
template<class Scalar >
int Rythmos::BackwardEulerStepper< Scalar >::getOrder ( ) const [virtual]
template<class Scalar >
void Rythmos::BackwardEulerStepper< Scalar >::setParameterList ( RCP< Teuchos::ParameterList > const &  paramList)

Definition at line 877 of file Rythmos_BackwardEulerStepper_def.hpp.

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

Definition at line 890 of file Rythmos_BackwardEulerStepper_def.hpp.

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

Definition at line 898 of file Rythmos_BackwardEulerStepper_def.hpp.

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

Definition at line 909 of file Rythmos_BackwardEulerStepper_def.hpp.

template<class Scalar >
void Rythmos::BackwardEulerStepper< Scalar >::describe ( Teuchos::FancyOStream &  out,
const Teuchos::EVerbosityLevel  verbLevel 
) const

Definition at line 928 of file Rythmos_BackwardEulerStepper_def.hpp.

template<class Scalar >
RCP< const MomentoBase< Scalar > > Rythmos::BackwardEulerStepper< Scalar >::getMomento ( ) const

Get momento object for use in restarts.

Definition at line 1035 of file Rythmos_BackwardEulerStepper_def.hpp.

template<class Scalar >
void Rythmos::BackwardEulerStepper< Scalar >::setMomento ( const Ptr< const MomentoBase< Scalar > > &  momentoPtr,
const RCP< Thyra::ModelEvaluator< Scalar > > &  model,
const RCP< Thyra::NonlinearSolverBase< Scalar > > &  solver 
)

Set momento object for use in restarts.

Definition at line 1061 of file Rythmos_BackwardEulerStepper_def.hpp.


Friends And Related Function Documentation

template<class Scalar >
RCP< BackwardEulerStepper< Scalar > > backwardEulerStepper ( ) [related]

Nonmember constructor.

Definition at line 63 of file Rythmos_BackwardEulerStepper_def.hpp.

template<class Scalar >
RCP< BackwardEulerStepper< Scalar > > backwardEulerStepper ( const RCP< Thyra::ModelEvaluator< Scalar > > &  model,
const RCP< Thyra::NonlinearSolverBase< Scalar > > &  solver 
) [related]

Nonmember constructor.

Definition at line 53 of file Rythmos_BackwardEulerStepper_def.hpp.


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