Rythmos - Transient Integration for Differential Equations Version of the Day
Loading...
Searching...
No Matches
Public Member Functions | List of all members
Rythmos::ForwardEulerStepper< Scalar > Class Template Reference

More...

#include <Rythmos_ForwardEulerStepper_decl.hpp>

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

Public Member Functions

 ForwardEulerStepper ()
 
bool supportsCloning () const
 
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
 
RCP< const Thyra::VectorSpaceBase< Scalar > > get_x_space () const
 
 ~ForwardEulerStepper ()
 
Scalar takeStep (Scalar dt, StepSizeType flag)
 
const StepStatus< Scalar > getStepStatus () const
 
std::string description () const
 
void describe (Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel) 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)
 
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
 Get values from buffer.
 
void setRange (const TimeRange< Scalar > &range, const InterpolationBufferBase< Scalar > &IB)
 Fill data in from another interpolation buffer.
 
TimeRange< Scalar > getTimeRange () const
 
void getNodes (Array< Scalar > *time_vec) const
 Get interpolation nodes.
 
void removeNodes (Array< Scalar > &time_vec)
 Remove interpolation nodes.
 
int getOrder () const
 Get order of interpolation.
 
void setParameterList (RCP< Teuchos::ParameterList > const &paramList)
 Redefined from Teuchos::ParameterListAcceptor.
 
RCP< Teuchos::ParameterList > getNonconstParameterList ()
 
RCP< Teuchos::ParameterList > unsetParameterList ()
 
RCP< const Teuchos::ParameterList > getValidParameters () const
 
RCP< const MomentoBase< Scalar > > getMomento () const
 Get momento object for use in restarts.
 
void setMomento (const Ptr< const MomentoBase< Scalar > > &momentoPtr)
 Set momento object for use in restarts.
 
- Public Member Functions inherited from Rythmos::StepperBase< Scalar >
virtual bool isImplicit () const
 Return if this stepper is an implicit stepper.
 
virtual bool acceptsModel () const
 Return if this stepper accepts a model.
 
virtual bool modelIsConst () const
 Return of the model is only const or can be returned as a non-const object.
 
virtual void setStepControlData (const StepperBase &stepper)
 Set step control data from another stepper.
 

Additional Inherited Members

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

Detailed Description

template<class Scalar>
class Rythmos::ForwardEulerStepper< Scalar >

Definition at line 327 of file Rythmos_ForwardEulerStepper_decl.hpp.

Constructor & Destructor Documentation

◆ ForwardEulerStepper()

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

Definition at line 344 of file Rythmos_ForwardEulerStepper_def.hpp.

◆ ~ForwardEulerStepper()

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

Definition at line 381 of file Rythmos_ForwardEulerStepper_def.hpp.

Member Function Documentation

◆ supportsCloning()

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

Reimplemented from Rythmos::StepperBase< Scalar >.

Definition at line 639 of file Rythmos_ForwardEulerStepper_def.hpp.

◆ cloneStepperAlgorithm()

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

Reimplemented from Rythmos::StepperBase< Scalar >.

Definition at line 646 of file Rythmos_ForwardEulerStepper_def.hpp.

◆ setModel()

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

◆ setNonconstModel()

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

◆ getModel()

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

◆ getNonconstModel()

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

◆ setInitialCondition()

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

◆ getInitialCondition()

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

◆ get_x_space()

template<class Scalar >
RCP< const Thyra::VectorSpaceBase< Scalar > > Rythmos::ForwardEulerStepper< Scalar >::get_x_space ( ) const
virtual

◆ takeStep()

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

◆ getStepStatus()

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

◆ description()

template<class Scalar >
std::string Rythmos::ForwardEulerStepper< Scalar >::description ( ) const

Definition at line 446 of file Rythmos_ForwardEulerStepper_def.hpp.

◆ describe()

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

Definition at line 453 of file Rythmos_ForwardEulerStepper_def.hpp.

◆ addPoints()

template<class Scalar >
void Rythmos::ForwardEulerStepper< 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

Redefined from InterpolationBufferBase Add points to buffer

Implements Rythmos::InterpolationBufferBase< Scalar >.

Definition at line 476 of file Rythmos_ForwardEulerStepper_def.hpp.

◆ getPoints()

template<class Scalar >
void Rythmos::ForwardEulerStepper< 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

Get values from buffer.

Implements Rythmos::InterpolationBufferBase< Scalar >.

Definition at line 486 of file Rythmos_ForwardEulerStepper_def.hpp.

◆ setRange()

template<class Scalar >
void Rythmos::ForwardEulerStepper< Scalar >::setRange ( const TimeRange< Scalar > & range,
const InterpolationBufferBase< Scalar > & IB )

Fill data in from another interpolation buffer.

◆ getTimeRange()

template<class Scalar >
TimeRange< Scalar > Rythmos::ForwardEulerStepper< Scalar >::getTimeRange ( ) const
virtual

◆ getNodes()

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

Get interpolation nodes.

Implements Rythmos::InterpolationBufferBase< Scalar >.

Definition at line 521 of file Rythmos_ForwardEulerStepper_def.hpp.

◆ removeNodes()

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

Remove interpolation nodes.

Implements Rythmos::InterpolationBufferBase< Scalar >.

Definition at line 536 of file Rythmos_ForwardEulerStepper_def.hpp.

◆ getOrder()

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

Get order of interpolation.

Implements Rythmos::InterpolationBufferBase< Scalar >.

Definition at line 542 of file Rythmos_ForwardEulerStepper_def.hpp.

◆ setParameterList()

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

Redefined from Teuchos::ParameterListAcceptor.

Definition at line 548 of file Rythmos_ForwardEulerStepper_def.hpp.

◆ getNonconstParameterList()

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

Definition at line 557 of file Rythmos_ForwardEulerStepper_def.hpp.

◆ unsetParameterList()

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

Definition at line 563 of file Rythmos_ForwardEulerStepper_def.hpp.

◆ getValidParameters()

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

Definition at line 573 of file Rythmos_ForwardEulerStepper_def.hpp.

◆ getMomento()

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

Get momento object for use in restarts.

Definition at line 669 of file Rythmos_ForwardEulerStepper_def.hpp.

◆ setMomento()

template<class Scalar >
void Rythmos::ForwardEulerStepper< Scalar >::setMomento ( const Ptr< const MomentoBase< Scalar > > & momentoPtr)

Set momento object for use in restarts.

Definition at line 689 of file Rythmos_ForwardEulerStepper_def.hpp.


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