Rythmos - Transient Integration for Differential Equations  Version of the Day
 All Classes Functions Variables Typedefs Pages
Public Member Functions | List of all members
Rythmos::StepControlStrategyBase< Scalar > Class Template Referenceabstract

The member functions in the StepControlStrategyBase move you between these states in the following fashion: More...

#include <Rythmos_StepControlStrategyBase.hpp>

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

Public Member Functions

virtual void initialize (const StepperBase< Scalar > &stepper)=0
 
virtual void setRequestedStepSize (const StepperBase< Scalar > &stepper, const Scalar &stepSize, const StepSizeType &stepSizeType)=0
 
virtual void nextStepSize (const StepperBase< Scalar > &stepper, Scalar *stepSize, StepSizeType *stepSizeType, int *order)=0
 
virtual void setCorrection (const StepperBase< Scalar > &stepper, const RCP< const Thyra::VectorBase< Scalar > > &soln, const RCP< const Thyra::VectorBase< Scalar > > &ee, int solveStatus)=0
 
virtual bool acceptStep (const StepperBase< Scalar > &stepper, Scalar *LETValue)=0
 
virtual void completeStep (const StepperBase< Scalar > &stepper)=0
 
virtual AttemptedStepStatusFlag rejectStep (const StepperBase< Scalar > &stepper)=0
 
virtual StepControlStrategyState getCurrentState ()=0
 
virtual int getMaxOrder () const =0
 
virtual void setStepControlData (const StepperBase< Scalar > &stepper)=0
 
virtual bool supportsCloning () const
 
virtual RCP
< StepControlStrategyBase
< Scalar > > 		cloneStepControlStrategyAlgorithm () const
 

Detailed Description

template<class Scalar>
class Rythmos::StepControlStrategyBase< Scalar >

The member functions in the StepControlStrategyBase move you between these states in the following fashion:

setRequestedStepSize: valid in UNINITIALIZED and BEFORE_FIRST_STEP and READY_FOR_NEXT_STEP changes state: UNINITIALIZED -> BEFORE_FIRST_STEP

nextStepSize: valid in BEFORE_FIRST_STEP and READY_FOR_NEXT_STEP changes state: BEFORE_FIRST_STEP -> MID_STEP READY_FOR_NEXT_STEP -> MID_STEP

setCorrection: valid in MID_STEP changes state: MID_STEP -> AFTER_CORRECTION

acceptStep: valid in AFTER_CORRECTION

completeStep: valid in AFTER_CORRECTION changes state: AFTER_CORRECTION -> READY_FOR_NEXT_STEP

rejectStep: valid in AFTER_CORRECTION changes state: AFTER_CORRECTION -> READY_FOR_NEXT_STEP

Definition at line 106 of file Rythmos_StepControlStrategyBase.hpp.

Member Function Documentation

template<class Scalar >
virtual void Rythmos::StepControlStrategyBase< Scalar >::initialize ( const StepperBase< Scalar > &  stepper)
pure virtual

Implemented in Rythmos::FirstOrderErrorStepControlStrategy< Scalar >, and Rythmos::ImplicitBDFStepperRampingStepControl< Scalar >.

template<class Scalar >
virtual void Rythmos::StepControlStrategyBase< Scalar >::setRequestedStepSize ( const StepperBase< Scalar > &  stepper,
const Scalar &  stepSize,
const StepSizeType &  stepSizeType 
)
pure virtual

Implemented in Rythmos::FirstOrderErrorStepControlStrategy< Scalar >, and Rythmos::ImplicitBDFStepperRampingStepControl< Scalar >.

template<class Scalar >
virtual void Rythmos::StepControlStrategyBase< Scalar >::nextStepSize ( const StepperBase< Scalar > &  stepper,
Scalar *  stepSize,
StepSizeType *  stepSizeType,
int *  order 
)
pure virtual

Implemented in Rythmos::FirstOrderErrorStepControlStrategy< Scalar >, and Rythmos::ImplicitBDFStepperRampingStepControl< Scalar >.

template<class Scalar >
virtual void Rythmos::StepControlStrategyBase< Scalar >::setCorrection ( const StepperBase< Scalar > &  stepper,
const RCP< const Thyra::VectorBase< Scalar > > &  soln,
const RCP< const Thyra::VectorBase< Scalar > > &  ee,
int  solveStatus 
)
pure virtual

Implemented in Rythmos::FirstOrderErrorStepControlStrategy< Scalar >, and Rythmos::ImplicitBDFStepperRampingStepControl< Scalar >.

template<class Scalar >
virtual bool Rythmos::StepControlStrategyBase< Scalar >::acceptStep ( const StepperBase< Scalar > &  stepper,
Scalar *  LETValue 
)
pure virtual

Implemented in Rythmos::FirstOrderErrorStepControlStrategy< Scalar >, and Rythmos::ImplicitBDFStepperRampingStepControl< Scalar >.

template<class Scalar >
virtual void Rythmos::StepControlStrategyBase< Scalar >::completeStep ( const StepperBase< Scalar > &  stepper)
pure virtual

Implemented in Rythmos::FirstOrderErrorStepControlStrategy< Scalar >, and Rythmos::ImplicitBDFStepperRampingStepControl< Scalar >.

template<class Scalar >
virtual AttemptedStepStatusFlag Rythmos::StepControlStrategyBase< Scalar >::rejectStep ( const StepperBase< Scalar > &  stepper)
pure virtual

Implemented in Rythmos::FirstOrderErrorStepControlStrategy< Scalar >, and Rythmos::ImplicitBDFStepperRampingStepControl< Scalar >.

template<class Scalar >
virtual StepControlStrategyState Rythmos::StepControlStrategyBase< Scalar >::getCurrentState ( )
pure virtual

Implemented in Rythmos::FirstOrderErrorStepControlStrategy< Scalar >, and Rythmos::ImplicitBDFStepperRampingStepControl< Scalar >.

template<class Scalar >
virtual int Rythmos::StepControlStrategyBase< Scalar >::getMaxOrder ( ) const
pure virtual

Implemented in Rythmos::FirstOrderErrorStepControlStrategy< Scalar >, and Rythmos::ImplicitBDFStepperRampingStepControl< Scalar >.

template<class Scalar >
virtual void Rythmos::StepControlStrategyBase< Scalar >::setStepControlData ( const StepperBase< Scalar > &  stepper)
pure virtual

Implemented in Rythmos::FirstOrderErrorStepControlStrategy< Scalar >, and Rythmos::ImplicitBDFStepperRampingStepControl< Scalar >.

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

Reimplemented in Rythmos::FirstOrderErrorStepControlStrategy< Scalar >, and Rythmos::ImplicitBDFStepperRampingStepControl< Scalar >.

Definition at line 174 of file Rythmos_StepControlStrategyBase.hpp.

template<class Scalar >
RCP< StepControlStrategyBase< Scalar > > Rythmos::StepControlStrategyBase< Scalar >::cloneStepControlStrategyAlgorithm ( ) const
virtual

Reimplemented in Rythmos::FirstOrderErrorStepControlStrategy< Scalar >, and Rythmos::ImplicitBDFStepperRampingStepControl< Scalar >.

Definition at line 182 of file Rythmos_StepControlStrategyBase.hpp.

The documentation for this class was generated from the following file:
Generated by   doxygen 1.8.5