Base modifier for StepperLeapfrog. More...

#include <Tempus_StepperLeapfrogModifierBase.hpp>

Inheritance diagram for Tempus::StepperLeapfrogModifierBase< Scalar >:

Public Member Functions
virtual void	modify (Teuchos::RCP< SolutionHistory< Scalar > >, Teuchos::RCP< StepperLeapfrog< Scalar > >, const typename StepperLeapfrogAppAction< Scalar >::ACTION_LOCATION actLoc)=0
	Modify Leapfrog Stepper. More...

Public Member Functions inherited from Tempus::StepperLeapfrogAppAction< Scalar >
	StepperLeapfrogAppAction ()
	Constructor. More...

virtual	~StepperLeapfrogAppAction ()
	Destructor. More...

Private Member Functions
void	execute (Teuchos::RCP< SolutionHistory< Scalar > > sh, Teuchos::RCP< StepperLeapfrog< Scalar > > stepper, const typename StepperLeapfrogAppAction< Scalar >::ACTION_LOCATION actLoc)
	Execute application action for Leapfrog Stepper. More...

Additional Inherited Members
Public Types inherited from Tempus::StepperLeapfrogAppAction< Scalar >
enum	ACTION_LOCATION { BEGIN_STEP, BEFORE_X_UPDATE, BEFORE_EXPLICIT_EVAL, BEFORE_XDOT_UPDATE, END_STEP }
	Indicates the location of application action (see algorithm). More...

Detailed Description

template<class Scalar>
class Tempus::StepperLeapfrogModifierBase< Scalar >

Base modifier for StepperLeapfrog.

This class provides a means to modify values (e.g., solution variables through SolutionHistory, and stepper member data through the Stepper), and can be very powerful and easy to make changes to the stepper and the solution.

Users deriving from this class can access a lot of data, and it is expected that those users know what changes are allowable without affecting the Stepper correctness, performance, accuracy and stability. Thus the user should be careful when accessing data through classes derived from the default modifier (i.e., USER BEWARE!!).

The locations for these AppAction calls (StepperLeapfrogAppAction::ACTION_LOCATION) are shown in the algorithm documentation of the StepperLeapfrog.

Definition at line 37 of file Tempus_StepperLeapfrogModifierBase.hpp.

Member Function Documentation

template<class Scalar>

void Tempus::StepperLeapfrogModifierBase< Scalar >::execute	(	Teuchos::RCP< SolutionHistory< Scalar > >	sh,
		Teuchos::RCP< StepperLeapfrog< Scalar > >	stepper,
		const typename StepperLeapfrogAppAction< Scalar >::ACTION_LOCATION	actLoc
	)

inlineprivatevirtual

Execute application action for Leapfrog Stepper.

Implements Tempus::StepperLeapfrogAppAction< Scalar >.

Definition at line 51 of file Tempus_StepperLeapfrogModifierBase.hpp.

template<class Scalar>

virtual void Tempus::StepperLeapfrogModifierBase< Scalar >::modify	(	Teuchos::RCP< SolutionHistory< Scalar > >	,
		Teuchos::RCP< StepperLeapfrog< Scalar > >	,
		const typename StepperLeapfrogAppAction< Scalar >::ACTION_LOCATION	actLoc
	)

pure virtual

Modify Leapfrog Stepper.

Implemented in Tempus::StepperLeapfrogModifierDefault< Scalar >.

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

Tempus_StepperLeapfrogModifierBase.hpp

Public Member Functions

Private Member Functions

Additional Inherited Members

Detailed Description

template<class Scalar> class Tempus::StepperLeapfrogModifierBase< Scalar >

Member Function Documentation

template<class Scalar>
class Tempus::StepperLeapfrogModifierBase< Scalar >