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

More...

#include <Rythmos_ImplicitRKStepper_decl.hpp>

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

List of all members.

Public Types

typedef ScalarTraits< Scalar >
::magnitudeType 
ScalarMag
 

Public Member Functions

void setDirk (bool isDirk)
 

Related Functions

(Note that these are not member functions.)

template<class Scalar >
RCP< ImplicitRKStepper< Scalar > > implicitRKStepper ()
 Nonmember constructor.

Constructors, intializers, Misc.

 ImplicitRKStepper ()
 
void set_W_factory (const RCP< Thyra::LinearOpWithSolveFactoryBase< Scalar > > &irk_W_factory)
RCP< const
Thyra::LinearOpWithSolveFactoryBase
< Scalar > > 
get_W_factory () const
 

Overridden from RKButcherTableauAcceptingStepperBase

void setRKButcherTableau (const RCP< const RKButcherTableauBase< Scalar > > &rkButcherTableau)
 
RCP< const
RKButcherTableauBase< Scalar > > 
getRKButcherTableau () 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 isImplicit () const
 Returns true.
bool supportsCloning () const
 Returns true.
RCP< StepperBase< Scalar > > cloneStepperAlgorithm () 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< ParameterList > const &paramList)
 
RCP< ParameterList > getNonconstParameterList ()
 
RCP< ParameterList > unsetParameterList ()
 
RCP< const ParameterList > getValidParameters () const
 

Overridden from Teuchos::Describable

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

Detailed Description

template<class Scalar>
class Rythmos::ImplicitRKStepper< Scalar >

Definition at line 48 of file Rythmos_ImplicitRKStepper_decl.hpp.


Member Typedef Documentation

template<class Scalar >
typedef ScalarTraits<Scalar>::magnitudeType Rythmos::ImplicitRKStepper< Scalar >::ScalarMag

Reimplemented from Rythmos::InterpolationBufferBase< Scalar >.

Definition at line 55 of file Rythmos_ImplicitRKStepper_decl.hpp.


Constructor & Destructor Documentation

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

Definition at line 91 of file Rythmos_ImplicitRKStepper_def.hpp.


Member Function Documentation

template<class Scalar >
RCP< const Thyra::LinearOpWithSolveFactoryBase< Scalar > > Rythmos::ImplicitRKStepper< Scalar >::get_W_factory ( ) const

Definition at line 129 of file Rythmos_ImplicitRKStepper_def.hpp.

template<class Scalar >
void Rythmos::ImplicitRKStepper< Scalar >::setRKButcherTableau ( const RCP< const RKButcherTableauBase< Scalar > > &  rkButcherTableau)

Definition at line 628 of file Rythmos_ImplicitRKStepper_def.hpp.

template<class Scalar >
RCP< const RKButcherTableauBase< Scalar > > Rythmos::ImplicitRKStepper< Scalar >::getRKButcherTableau ( ) const [virtual]
template<class Scalar >
void Rythmos::ImplicitRKStepper< Scalar >::setDirk ( bool  isDirk)

Definition at line 654 of file Rythmos_ImplicitRKStepper_def.hpp.

template<class Scalar >
void Rythmos::ImplicitRKStepper< Scalar >::setSolver ( const RCP< Thyra::NonlinearSolverBase< Scalar > > &  solver)

Definition at line 138 of file Rythmos_ImplicitRKStepper_def.hpp.

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

Returns true.

Reimplemented from Rythmos::StepperBase< Scalar >.

Definition at line 167 of file Rythmos_ImplicitRKStepper_def.hpp.

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

Returns true.

Reimplemented from Rythmos::StepperBase< Scalar >.

Definition at line 173 of file Rythmos_ImplicitRKStepper_def.hpp.

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

Reimplemented from Rythmos::StepperBase< Scalar >.

Definition at line 181 of file Rythmos_ImplicitRKStepper_def.hpp.

template<class Scalar >
void Rythmos::ImplicitRKStepper< Scalar >::setModel ( const RCP< const Thyra::ModelEvaluator< Scalar > > &  model) [virtual]

Implements Rythmos::StepperBase< Scalar >.

Definition at line 215 of file Rythmos_ImplicitRKStepper_def.hpp.

template<class Scalar >
void Rythmos::ImplicitRKStepper< Scalar >::setNonconstModel ( const RCP< Thyra::ModelEvaluator< Scalar > > &  model) [virtual]

Implements Rythmos::StepperBase< Scalar >.

Definition at line 226 of file Rythmos_ImplicitRKStepper_def.hpp.

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

Implements Rythmos::StepperBase< Scalar >.

Definition at line 236 of file Rythmos_ImplicitRKStepper_def.hpp.

template<class Scalar >
RCP< Thyra::ModelEvaluator< Scalar > > Rythmos::ImplicitRKStepper< Scalar >::getNonconstModel ( ) [virtual]

Implements Rythmos::StepperBase< Scalar >.

Definition at line 244 of file Rythmos_ImplicitRKStepper_def.hpp.

template<class Scalar >
void Rythmos::ImplicitRKStepper< Scalar >::setInitialCondition ( const Thyra::ModelEvaluatorBase::InArgs< Scalar > &  initialCondition) [virtual]

Implements Rythmos::StepperBase< Scalar >.

Definition at line 251 of file Rythmos_ImplicitRKStepper_def.hpp.

template<class Scalar >
Thyra::ModelEvaluatorBase::InArgs< Scalar > Rythmos::ImplicitRKStepper< Scalar >::getInitialCondition ( ) const [virtual]

Implements Rythmos::StepperBase< Scalar >.

Definition at line 308 of file Rythmos_ImplicitRKStepper_def.hpp.

template<class Scalar >
Scalar Rythmos::ImplicitRKStepper< Scalar >::takeStep ( Scalar  dt,
StepSizeType  flag 
) [virtual]

Implements Rythmos::StepperBase< Scalar >.

Definition at line 315 of file Rythmos_ImplicitRKStepper_def.hpp.

template<class Scalar >
const StepStatus< Scalar > Rythmos::ImplicitRKStepper< Scalar >::getStepStatus ( ) const [virtual]

Implements Rythmos::StepperBase< Scalar >.

Definition at line 397 of file Rythmos_ImplicitRKStepper_def.hpp.

template<class Scalar >
RCP< const Thyra::VectorSpaceBase< Scalar > > Rythmos::ImplicitRKStepper< Scalar >::get_x_space ( ) const [virtual]
template<class Scalar >
void Rythmos::ImplicitRKStepper< 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::ImplicitRKStepper< Scalar >::getTimeRange ( ) const [virtual]
template<class Scalar >
void Rythmos::ImplicitRKStepper< 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

Definition at line 450 of file Rythmos_ImplicitRKStepper_def.hpp.

template<class Scalar >
void Rythmos::ImplicitRKStepper< Scalar >::getNodes ( Array< Scalar > *  time_vec) const [virtual]
template<class Scalar >
void Rythmos::ImplicitRKStepper< Scalar >::removeNodes ( Array< Scalar > &  time_vec) [virtual]
template<class Scalar >
int Rythmos::ImplicitRKStepper< Scalar >::getOrder ( ) const [virtual]
template<class Scalar >
void Rythmos::ImplicitRKStepper< Scalar >::setParameterList ( RCP< ParameterList > const &  paramList)

Definition at line 505 of file Rythmos_ImplicitRKStepper_def.hpp.

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

Definition at line 518 of file Rythmos_ImplicitRKStepper_def.hpp.

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

Definition at line 526 of file Rythmos_ImplicitRKStepper_def.hpp.

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

Definition at line 537 of file Rythmos_ImplicitRKStepper_def.hpp.

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

Definition at line 553 of file Rythmos_ImplicitRKStepper_def.hpp.


Friends And Related Function Documentation

template<class Scalar >
RCP< ImplicitRKStepper< Scalar > > implicitRKStepper ( ) [related]

Nonmember constructor.

Definition at line 58 of file Rythmos_ImplicitRKStepper_def.hpp.


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