Tempus::StepperBDF2AppAction< Scalar > Class Template Reference

Application Action for StepperBDF2. More...

#include <Tempus_StepperBDF2AppAction.hpp>

Inheritance diagram for Tempus::StepperBDF2AppAction< Scalar >:

Public Types
enum	ACTION_LOCATION { BEGIN_STEP, BEFORE_SOLVE, AFTER_SOLVE, END_STEP }
	Indicates the location of application action (see algorithm). More...

Public Member Functions
	StepperBDF2AppAction ()
	Constructor. More...
virtual	~StepperBDF2AppAction ()
	Destructor. More...
virtual void	execute (Teuchos::RCP< SolutionHistory< Scalar > > sh, Teuchos::RCP< StepperBDF2< Scalar > > stepper, const typename StepperBDF2AppAction< Scalar >::ACTION_LOCATION actLoc)=0
	Execute application action for BDF2 Stepper. More...

Detailed Description

template<class Scalar>
class Tempus::StepperBDF2AppAction< Scalar >

Application Action for StepperBDF2.

This class provides a means to apply various actions with the BDF2 time step. The data available to this class is solution variables (through SolutionHistory), and stepper data (through the Stepper). It allows the application to just observe this data, i.e., use but not change any of it (USER BEWARE!).

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

Definition at line 34 of file Tempus_StepperBDF2AppAction.hpp.

Member Enumeration Documentation

template<class Scalar>

enum Tempus::StepperBDF2AppAction::ACTION_LOCATION

Indicates the location of application action (see algorithm).

Enumerator
BEGIN_STEP	At the beginning of the step.
BEFORE_SOLVE	Before the solve.
AFTER_SOLVE	After the solve.
END_STEP	At the end of the step.

Definition at line 39 of file Tempus_StepperBDF2AppAction.hpp.

Constructor & Destructor Documentation

template<class Scalar>

Tempus::StepperBDF2AppAction< Scalar >::StepperBDF2AppAction ( )

inline

Constructor.

Definition at line 47 of file Tempus_StepperBDF2AppAction.hpp.

template<class Scalar>

virtual Tempus::StepperBDF2AppAction< Scalar >::~StepperBDF2AppAction ( )

inlinevirtual

Destructor.

Definition at line 50 of file Tempus_StepperBDF2AppAction.hpp.

Member Function Documentation

template<class Scalar>

virtual void Tempus::StepperBDF2AppAction< Scalar >::execute ( Teuchos::RCP< SolutionHistory< Scalar > >  sh, Teuchos::RCP< StepperBDF2< Scalar > >  stepper, const typename StepperBDF2AppAction< Scalar >::ACTION_LOCATION  actLoc  )

pure virtual

Execute application action for BDF2 Stepper.

Implemented in Tempus::StepperBDF2ModifierXBase< Scalar >, Tempus::StepperBDF2ModifierXBase< double >, Tempus::StepperBDF2ModifierBase< Scalar >, Tempus::StepperBDF2ObserverBase< Scalar >, Tempus::StepperBDF2ModifierBase< double >, Tempus::StepperBDF2ObserverBase< double >, and Tempus::StepperBDF2AppActionComposite< Scalar >.

---

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

• Tempus_StepperBDF2AppAction.hpp