Tempus  Version of the Day
Time Integration
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Types | Public Member Functions | List of all members
Tempus::StepperHHTAlphaAppAction< Scalar > Class Template Referenceabstract

Application Action for HHT Alpha. More...

#include <Tempus_StepperHHTAlphaAppAction.hpp>

Inheritance diagram for Tempus::StepperHHTAlphaAppAction< Scalar >:
Tempus::StepperHHTAlphaAppActionComposite< Scalar > Tempus::StepperHHTAlphaModifierBase< Scalar > Tempus::StepperHHTAlphaModifierXBase< Scalar > Tempus::StepperHHTAlphaObserverBase< Scalar > Tempus::StepperHHTAlphaModifierDefault< Scalar > Tempus::StepperHHTAlphaModifierXDefault< Scalar > Tempus::StepperHHTAlphaObserverDefault< 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

 StepperHHTAlphaAppAction ()
 Constructor. More...
 
virtual ~StepperHHTAlphaAppAction ()
 Destructor. More...
 
virtual void execute (Teuchos::RCP< SolutionHistory< Scalar > > sh, Teuchos::RCP< StepperHHTAlpha< Scalar > > stepper, const typename StepperHHTAlphaAppAction< Scalar >::ACTION_LOCATION actLoc)=0
 Execute application action for HHTAlpha Stepper. More...
 

Detailed Description

template<class Scalar>
class Tempus::StepperHHTAlphaAppAction< Scalar >

Application Action for HHT Alpha.

This class provides a means to apply various actions with the HHT Alpha 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!).

Definition at line 31 of file Tempus_StepperHHTAlphaAppAction.hpp.

Member Enumeration Documentation

Indicates the location of application action (see algorithm).

Enumerator
BEGIN_STEP 

At the beginning of the step.

BEFORE_SOLVE 

Before the implicit solve.

AFTER_SOLVE 

After the implicit solve.

END_STEP 

At the end of the step.

Definition at line 34 of file Tempus_StepperHHTAlphaAppAction.hpp.

Constructor & Destructor Documentation

template<class Scalar>
Tempus::StepperHHTAlphaAppAction< Scalar >::StepperHHTAlphaAppAction ( )
inline

Constructor.

Definition at line 42 of file Tempus_StepperHHTAlphaAppAction.hpp.

template<class Scalar>
virtual Tempus::StepperHHTAlphaAppAction< Scalar >::~StepperHHTAlphaAppAction ( )
inlinevirtual

Destructor.

Definition at line 45 of file Tempus_StepperHHTAlphaAppAction.hpp.

Member Function Documentation

template<class Scalar>
virtual void Tempus::StepperHHTAlphaAppAction< Scalar >::execute ( Teuchos::RCP< SolutionHistory< Scalar > >  sh,
Teuchos::RCP< StepperHHTAlpha< Scalar > >  stepper,
const typename StepperHHTAlphaAppAction< Scalar >::ACTION_LOCATION  actLoc 
)
pure virtual

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