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::StepperNewmarkExplicitAFormAppAction< Scalar > Class Template Referenceabstract

Application Action for StepperNewmarkExplicitAForm. More...

#include <Tempus_StepperNewmarkExplicitAFormAppAction.hpp>

Inheritance diagram for Tempus::StepperNewmarkExplicitAFormAppAction< Scalar >:
Tempus::StepperNewmarkExplicitAFormAppActionComposite< Scalar > Tempus::StepperNewmarkExplicitAFormModifierBase< Scalar > Tempus::StepperNewmarkExplicitAFormModifierXBase< Scalar > Tempus::StepperNewmarkExplicitAFormModifierDefault< Scalar > Tempus::StepperNewmarkExplicitAFormModifierXDefault< Scalar >

Public Types

enum  ACTION_LOCATION { BEGIN_STEP, BEFORE_EXPLICIT_EVAL, AFTER_EXPLICIT_EVAL, END_STEP }
 Indicates the location of application action (see algorithm). More...
 

Public Member Functions

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

Detailed Description

template<class Scalar>
class Tempus::StepperNewmarkExplicitAFormAppAction< Scalar >

Application Action for StepperNewmarkExplicitAForm.

This class provides a means to apply various actions with the NewmarkExplicitAForm 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 (StepperNewmarkExplicitAFormAppAction::ACTION_LOCATION) are shown in the algorithm documentation of the StepperNewmarkExplicitAForm.

Definition at line 34 of file Tempus_StepperNewmarkExplicitAFormAppAction.hpp.

Member Enumeration Documentation

Indicates the location of application action (see algorithm).

Enumerator
BEGIN_STEP 

At the beginning of the step.

BEFORE_EXPLICIT_EVAL 

Before the explicit evaluation.

AFTER_EXPLICIT_EVAL 

After the explicit evaluation.

END_STEP 

At the end of the step.

Definition at line 37 of file Tempus_StepperNewmarkExplicitAFormAppAction.hpp.

Constructor & Destructor Documentation

Constructor.

Definition at line 45 of file Tempus_StepperNewmarkExplicitAFormAppAction.hpp.

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

Destructor.

Definition at line 48 of file Tempus_StepperNewmarkExplicitAFormAppAction.hpp.

Member Function Documentation

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

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