#include <Rythmos_ImplicitBDFStepperRampingStepControl_decl.hpp>

Inheritance diagram for Rythmos::ImplicitBDFStepperRampingStepControl< Scalar >:

Public Member Functions
void	initialize (const StepperBase< Scalar > &stepper)

Overridden from StepControlStrategyBase
void	setRequestedStepSize (const StepperBase< Scalar > &stepper, const Scalar &stepSize, const StepSizeType &stepSizeType)

void	nextStepSize (const StepperBase< Scalar > &stepper, Scalar stepSize, StepSizeType stepSizeType, int *order)

void	setCorrection (const StepperBase< Scalar > &stepper, const RCP< const Thyra::VectorBase< Scalar > > &soln, const RCP< const Thyra::VectorBase< Scalar > > &ee, int solveStatus)

bool	acceptStep (const StepperBase< Scalar > &stepper, Scalar *LETValue)

void	completeStep (const StepperBase< Scalar > &stepper)

AttemptedStepStatusFlag	rejectStep (const StepperBase< Scalar > &stepper)

StepControlStrategyState	getCurrentState ()

int	getMinOrder () const

int	getMaxOrder () const

void	setStepControlData (const StepperBase< Scalar > &stepper)

bool	supportsCloning () const

RCP< StepControlStrategyBase < Scalar > >	cloneStepControlStrategyAlgorithm () const

Overridden from ErrWtVecCalcAcceptingStepControlStrategyBase
void	setErrWtVecCalc (const RCP< ErrWtVecCalcBase< Scalar > > &errWtVecCalc)

RCP< const ErrWtVecCalcBase < Scalar > >	getErrWtVecCalc () const

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

Overridden from ParameterListAcceptor
void	setParameterList (RCP< Teuchos::ParameterList > const &paramList)

RCP< Teuchos::ParameterList >	getNonconstParameterList ()

RCP< Teuchos::ParameterList >	unsetParameterList ()

RCP< const Teuchos::ParameterList >	getValidParameters () const

Accessor functions (used for testing)
int	numberOfSteps () const

int	numberOfFailedSteps () const

Scalar	currentStepSize () const

int	currentOrder () const

Detailed Description

template<class Scalar>
class Rythmos::ImplicitBDFStepperRampingStepControl< Scalar >

Ramping Step Control Strategy object for ImplicitBDFStpper

This object is a special step control strategy to manage the startup of simulations form an inconsistent state or to startup a simulation for an order of accuracy study. The strategy follows the pattern:

An initial startup phase with constant initial time step (failures can reduce the time step) at 1st order.
A second phase with constant time step that increases the order to max order.
A ramping phase that runs at max order and increases the time step up to the max time step. LTE control during the ramping phase is optional.
Time integration phase that runs at max step size and max order.

Order of calls: setRequestedStepSize() nextStepSize() optional: nextStepOrder() setCorrection acceptStep completeStep or rejectStep repeat

08/16/07 tscoffe: This order of operations must be enforced through preconditions or I need to re-think how to set up the interface for this strategy object.

Definition at line 69 of file Rythmos_ImplicitBDFStepperRampingStepControl_decl.hpp.

Member Function Documentation

template<class Scalar >

void Rythmos::ImplicitBDFStepperRampingStepControl< Scalar >::setRequestedStepSize	(	const StepperBase< Scalar > &	stepper,
		const Scalar &	stepSize,
		const StepSizeType &	stepSizeType
	)

virtual

Implements Rythmos::StepControlStrategyBase< Scalar >.

Definition at line 152 of file Rythmos_ImplicitBDFStepperRampingStepControl_def.hpp.

template<class Scalar >

void Rythmos::ImplicitBDFStepperRampingStepControl< Scalar >::nextStepSize	(	const StepperBase< Scalar > &	stepper,
		Scalar *	stepSize,
		StepSizeType *	stepSizeType,
		int *	order
	)

virtual

Implements Rythmos::StepControlStrategyBase< Scalar >.

Definition at line 190 of file Rythmos_ImplicitBDFStepperRampingStepControl_def.hpp.

template<class Scalar >

void Rythmos::ImplicitBDFStepperRampingStepControl< Scalar >::setCorrection	(	const StepperBase< Scalar > &	stepper,
		const RCP< const Thyra::VectorBase< Scalar > > &	soln,
		const RCP< const Thyra::VectorBase< Scalar > > &	ee,
		int	solveStatus
	)

virtual

Implements Rythmos::StepControlStrategyBase< Scalar >.

Definition at line 257 of file Rythmos_ImplicitBDFStepperRampingStepControl_def.hpp.

template<class Scalar >

bool Rythmos::ImplicitBDFStepperRampingStepControl< Scalar >::acceptStep	(	const StepperBase< Scalar > &	stepper,
		Scalar *	LETValue
	)

virtual

Implements Rythmos::StepControlStrategyBase< Scalar >.

Definition at line 283 of file Rythmos_ImplicitBDFStepperRampingStepControl_def.hpp.

template<class Scalar >

void Rythmos::ImplicitBDFStepperRampingStepControl< Scalar >::completeStep ( const StepperBase< Scalar > & stepper )

virtual

Implements Rythmos::StepControlStrategyBase< Scalar >.

Definition at line 335 of file Rythmos_ImplicitBDFStepperRampingStepControl_def.hpp.

template<class Scalar >

AttemptedStepStatusFlag Rythmos::ImplicitBDFStepperRampingStepControl< Scalar >::rejectStep ( const StepperBase< Scalar > & stepper )

virtual

Implements Rythmos::StepControlStrategyBase< Scalar >.

Definition at line 450 of file Rythmos_ImplicitBDFStepperRampingStepControl_def.hpp.

template<class Scalar >

StepControlStrategyState Rythmos::ImplicitBDFStepperRampingStepControl< Scalar >::getCurrentState ( )

virtual

Implements Rythmos::StepControlStrategyBase< Scalar >.

Definition at line 68 of file Rythmos_ImplicitBDFStepperRampingStepControl_def.hpp.

template<class Scalar >

int Rythmos::ImplicitBDFStepperRampingStepControl< Scalar >::getMinOrder ( ) const

Definition at line 765 of file Rythmos_ImplicitBDFStepperRampingStepControl_def.hpp.

template<class Scalar >

int Rythmos::ImplicitBDFStepperRampingStepControl< Scalar >::getMaxOrder ( ) const

virtual

Implements Rythmos::StepControlStrategyBase< Scalar >.

Definition at line 775 of file Rythmos_ImplicitBDFStepperRampingStepControl_def.hpp.

template<class Scalar >

void Rythmos::ImplicitBDFStepperRampingStepControl< Scalar >::setStepControlData ( const StepperBase< Scalar > & stepper )

virtual

Implements Rythmos::StepControlStrategyBase< Scalar >.

Definition at line 691 of file Rythmos_ImplicitBDFStepperRampingStepControl_def.hpp.

template<class Scalar >

bool Rythmos::ImplicitBDFStepperRampingStepControl< Scalar >::supportsCloning ( ) const

virtual

Reimplemented from Rythmos::StepControlStrategyBase< Scalar >.

Definition at line 720 of file Rythmos_ImplicitBDFStepperRampingStepControl_def.hpp.

template<class Scalar >

RCP< StepControlStrategyBase< Scalar > > Rythmos::ImplicitBDFStepperRampingStepControl< Scalar >::cloneStepControlStrategyAlgorithm ( ) const

virtual

Reimplemented from Rythmos::StepControlStrategyBase< Scalar >.

Definition at line 728 of file Rythmos_ImplicitBDFStepperRampingStepControl_def.hpp.

template<class Scalar >

void Rythmos::ImplicitBDFStepperRampingStepControl< Scalar >::setErrWtVecCalc ( const RCP< ErrWtVecCalcBase< Scalar > > & errWtVecCalc )

virtual

Implements Rythmos::ErrWtVecCalcAcceptingStepControlStrategyBase< Scalar >.

Definition at line 742 of file Rythmos_ImplicitBDFStepperRampingStepControl_def.hpp.

template<class Scalar >

RCP< const ErrWtVecCalcBase< Scalar > > Rythmos::ImplicitBDFStepperRampingStepControl< Scalar >::getErrWtVecCalc ( ) const

virtual

Implements Rythmos::ErrWtVecCalcAcceptingStepControlStrategyBase< Scalar >.

Definition at line 751 of file Rythmos_ImplicitBDFStepperRampingStepControl_def.hpp.

template<class Scalar >

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

Definition at line 474 of file Rythmos_ImplicitBDFStepperRampingStepControl_def.hpp.

template<class Scalar >

void Rythmos::ImplicitBDFStepperRampingStepControl< Scalar >::setParameterList ( RCP< Teuchos::ParameterList > const & paramList )

Definition at line 516 of file Rythmos_ImplicitBDFStepperRampingStepControl_def.hpp.

template<class Scalar >

RCP< Teuchos::ParameterList > Rythmos::ImplicitBDFStepperRampingStepControl< Scalar >::getNonconstParameterList ( )

Definition at line 685 of file Rythmos_ImplicitBDFStepperRampingStepControl_def.hpp.

template<class Scalar >

RCP< Teuchos::ParameterList > Rythmos::ImplicitBDFStepperRampingStepControl< Scalar >::unsetParameterList ( )

Definition at line 676 of file Rythmos_ImplicitBDFStepperRampingStepControl_def.hpp.

template<class Scalar >

RCP< const Teuchos::ParameterList > Rythmos::ImplicitBDFStepperRampingStepControl< Scalar >::getValidParameters ( ) const

Definition at line 616 of file Rythmos_ImplicitBDFStepperRampingStepControl_def.hpp.

template<class Scalar >

void Rythmos::ImplicitBDFStepperRampingStepControl< Scalar >::initialize ( const StepperBase< Scalar > & stepper )

virtual

Implements Rythmos::StepControlStrategyBase< Scalar >.

Definition at line 84 of file Rythmos_ImplicitBDFStepperRampingStepControl_def.hpp.

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

Public Member Functions

Overridden from StepControlStrategyBase

Overridden from ErrWtVecCalcAcceptingStepControlStrategyBase

Overridden from Teuchos::Describable

Overridden from ParameterListAcceptor

Accessor functions (used for testing)

Detailed Description

template<class Scalar> class Rythmos::ImplicitBDFStepperRampingStepControl< Scalar >

Member Function Documentation

template<class Scalar>
class Rythmos::ImplicitBDFStepperRampingStepControl< Scalar >