Rythmos - Transient Integration for Differential Equations  Version of the Day
Public Member Functions | List of all members
Rythmos::ExplicitRKStepper< Scalar > Class Template Reference

More...

#include <Rythmos_ExplicitRKStepper_decl.hpp>

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

Public Member Functions

 ExplicitRKStepper ()
 
Teuchos::RCP< const Thyra::VectorSpaceBase< Scalar > > get_x_space () const
 
void setModel (const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &model)
 
void setNonconstModel (const Teuchos::RCP< Thyra::ModelEvaluator< Scalar > > &model)
 
Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > getModel () const
 
RCP< Thyra::ModelEvaluator< Scalar > > getNonconstModel ()
 
 ~ExplicitRKStepper ()
 
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
 
void describe (Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel) const
 
void addPoints (const Array< Scalar > &time_vec, const Array< Teuchos::RCP< const Thyra::VectorBase< Scalar > > > &x_vec, const Array< Teuchos::RCP< const Thyra::VectorBase< Scalar > > > &xdot_vec)
 
void getPoints (const Array< Scalar > &time_vec, Array< RCP< const VectorBase< Scalar > > > *x_vec, Array< RCP< const VectorBase< Scalar > > > *xdot_vec, Array< ScalarMag > *accuracy_vec) const
 Get values from buffer. More...
 
TimeRange< Scalar > getTimeRange () const
 
void getNodes (Array< Scalar > *time_vec) const
 Get interpolation nodes. More...
 
void removeNodes (Array< Scalar > &time_vec)
 Remove interpolation nodes. More...
 
int getOrder () const
 Get order of interpolation. More...
 
void setParameterList (Teuchos::RCP< Teuchos::ParameterList > const &paramList)
 Redefined from Teuchos::ParameterListAcceptor. More...
 
Teuchos::RCP< Teuchos::ParameterList > getNonconstParameterList ()
 
Teuchos::RCP< Teuchos::ParameterList > unsetParameterList ()
 
RCP< const Teuchos::ParameterList > getValidParameters () const
 
- Public Member Functions inherited from Rythmos::RKButcherTableauAcceptingStepperBase< Scalar >
virtual void setRKButcherTableau (const Teuchos::RCP< const RKButcherTableauBase< Scalar > > &rkbt)=0
 
- Public Member Functions inherited from Rythmos::StepperBase< Scalar >
virtual bool isImplicit () const
 Return if this stepper is an implicit stepper. More...
 
virtual bool acceptsModel () const
 Return if this stepper accepts a model. More...
 
virtual void setModel (const RCP< const Thyra::ModelEvaluator< Scalar > > &model)=0
 Specify the model problem to integrate. More...
 
virtual void setNonconstModel (const RCP< Thyra::ModelEvaluator< Scalar > > &model)=0
 Accept a nonconst model. More...
 
virtual bool modelIsConst () const
 Return of the model is only const or can be returned as a non-const object. More...
 
virtual void setStepControlData (const StepperBase &stepper)
 Set step control data from another stepper. More...
 
- Public Member Functions inherited from Rythmos::InterpolationBufferBase< Scalar >
virtual 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)=0
 Add points to the buffer. More...
 
virtual 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 =0
 Get values from the buffer at different time points. More...
 

Overridden from StepperBase

bool supportsCloning () const
 
RCP< StepperBase< Scalar > > cloneStepperAlgorithm () const
 

Overridden from RKButcherTableauAcceptingStepperBase

void setRKButcherTableau (const RCP< const RKButcherTableauBase< Scalar > > &rkbt)
 
RCP< const RKButcherTableauBase< Scalar > > getRKButcherTableau () const
 

Additional Inherited Members

- Public Types inherited from Rythmos::InterpolationBufferBase< Scalar >
typedef Teuchos::ScalarTraits< Scalar >::magnitudeType ScalarMag
 

Detailed Description

template<class Scalar>
class Rythmos::ExplicitRKStepper< Scalar >

Definition at line 41 of file Rythmos_ExplicitRKStepper_decl.hpp.

Constructor & Destructor Documentation

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

Definition at line 84 of file Rythmos_ExplicitRKStepper_def.hpp.

template<class Scalar >
Rythmos::ExplicitRKStepper< Scalar >::~ExplicitRKStepper ( )

Definition at line 168 of file Rythmos_ExplicitRKStepper_def.hpp.

Member Function Documentation

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

Reimplemented from Rythmos::StepperBase< Scalar >.

Definition at line 465 of file Rythmos_ExplicitRKStepper_def.hpp.

template<class Scalar >
RCP< StepperBase< Scalar > > Rythmos::ExplicitRKStepper< Scalar >::cloneStepperAlgorithm ( ) const
virtual

Reimplemented from Rythmos::StepperBase< Scalar >.

Definition at line 471 of file Rythmos_ExplicitRKStepper_def.hpp.

template<class Scalar >
void Rythmos::ExplicitRKStepper< Scalar >::setRKButcherTableau ( const RCP< const RKButcherTableauBase< Scalar > > &  rkbt)

Definition at line 113 of file Rythmos_ExplicitRKStepper_def.hpp.

template<class Scalar >
RCP< const RKButcherTableauBase< Scalar > > Rythmos::ExplicitRKStepper< Scalar >::getRKButcherTableau ( ) const
virtual
template<class Scalar >
Teuchos::RCP< const Thyra::VectorSpaceBase< Scalar > > Rythmos::ExplicitRKStepper< Scalar >::get_x_space ( ) const
virtual
template<class Scalar >
void Rythmos::ExplicitRKStepper< Scalar >::setModel ( const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &  model)

Definition at line 390 of file Rythmos_ExplicitRKStepper_def.hpp.

template<class Scalar >
void Rythmos::ExplicitRKStepper< Scalar >::setNonconstModel ( const Teuchos::RCP< Thyra::ModelEvaluator< Scalar > > &  model)

Definition at line 400 of file Rythmos_ExplicitRKStepper_def.hpp.

template<class Scalar >
Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > Rythmos::ExplicitRKStepper< Scalar >::getModel ( ) const
virtual

Implements Rythmos::StepperBase< Scalar >.

Definition at line 408 of file Rythmos_ExplicitRKStepper_def.hpp.

template<class Scalar >
Teuchos::RCP< Thyra::ModelEvaluator< Scalar > > Rythmos::ExplicitRKStepper< Scalar >::getNonconstModel ( )
virtual

Implements Rythmos::StepperBase< Scalar >.

Definition at line 416 of file Rythmos_ExplicitRKStepper_def.hpp.

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

Implements Rythmos::StepperBase< Scalar >.

Definition at line 423 of file Rythmos_ExplicitRKStepper_def.hpp.

template<class Scalar >
Thyra::ModelEvaluatorBase::InArgs< Scalar > Rythmos::ExplicitRKStepper< Scalar >::getInitialCondition ( ) const
virtual

Implements Rythmos::StepperBase< Scalar >.

Definition at line 459 of file Rythmos_ExplicitRKStepper_def.hpp.

template<class Scalar >
Scalar Rythmos::ExplicitRKStepper< Scalar >::takeStep ( Scalar  dt,
StepSizeType  flag 
)
virtual

Implements Rythmos::StepperBase< Scalar >.

Definition at line 180 of file Rythmos_ExplicitRKStepper_def.hpp.

template<class Scalar >
const StepStatus< Scalar > Rythmos::ExplicitRKStepper< Scalar >::getStepStatus ( ) const
virtual

Implements Rythmos::StepperBase< Scalar >.

Definition at line 230 of file Rythmos_ExplicitRKStepper_def.hpp.

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

Definition at line 253 of file Rythmos_ExplicitRKStepper_def.hpp.

template<class Scalar >
void Rythmos::ExplicitRKStepper< Scalar >::addPoints ( const Array< Scalar > &  time_vec,
const Array< Teuchos::RCP< const Thyra::VectorBase< Scalar > > > &  x_vec,
const Array< Teuchos::RCP< const Thyra::VectorBase< Scalar > > > &  xdot_vec 
)

Redefined from InterpolationBufferBase Add points to buffer

Definition at line 286 of file Rythmos_ExplicitRKStepper_def.hpp.

template<class Scalar >
void Rythmos::ExplicitRKStepper< Scalar >::getPoints ( const Array< Scalar > &  time_vec,
Array< RCP< const VectorBase< Scalar > > > *  x_vec,
Array< RCP< const VectorBase< Scalar > > > *  xdot_vec,
Array< ScalarMag > *  accuracy_vec 
) const

Get values from buffer.

Definition at line 306 of file Rythmos_ExplicitRKStepper_def.hpp.

template<class Scalar >
TimeRange< Scalar > Rythmos::ExplicitRKStepper< Scalar >::getTimeRange ( ) const
virtual
template<class Scalar >
void Rythmos::ExplicitRKStepper< Scalar >::getNodes ( Array< Scalar > *  time_vec) const
virtual

Get interpolation nodes.

Implements Rythmos::InterpolationBufferBase< Scalar >.

Definition at line 327 of file Rythmos_ExplicitRKStepper_def.hpp.

template<class Scalar >
void Rythmos::ExplicitRKStepper< Scalar >::removeNodes ( Array< Scalar > &  time_vec)
virtual

Remove interpolation nodes.

Implements Rythmos::InterpolationBufferBase< Scalar >.

Definition at line 341 of file Rythmos_ExplicitRKStepper_def.hpp.

template<class Scalar >
int Rythmos::ExplicitRKStepper< Scalar >::getOrder ( ) const
virtual

Get order of interpolation.

Implements Rythmos::InterpolationBufferBase< Scalar >.

Definition at line 347 of file Rythmos_ExplicitRKStepper_def.hpp.

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

Redefined from Teuchos::ParameterListAcceptor.

Definition at line 353 of file Rythmos_ExplicitRKStepper_def.hpp.

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

Definition at line 362 of file Rythmos_ExplicitRKStepper_def.hpp.

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

Definition at line 368 of file Rythmos_ExplicitRKStepper_def.hpp.

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

Definition at line 377 of file Rythmos_ExplicitRKStepper_def.hpp.


The documentation for this class was generated from the following files: