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

This composite AppAction loops over added AppActions. More...

#include <Tempus_StepperRKAppActionComposite.hpp>

Inheritance diagram for Tempus::StepperRKAppActionComposite< Scalar >:
Tempus::StepperRKAppAction< Scalar >

Public Member Functions

 StepperRKAppActionComposite ()
 Default constructor. More...
 
virtual ~StepperRKAppActionComposite ()
 Destructor. More...
 
virtual void execute (Teuchos::RCP< SolutionHistory< Scalar > > sh, Teuchos::RCP< StepperRKBase< Scalar > > stepper, const typename StepperRKAppAction< Scalar >::ACTION_LOCATION actLoc)
 Execute application action for RK Stepper. More...
 
void addRKAppAction (Teuchos::RCP< StepperRKAppAction< Scalar > > appAction)
 
void clearRKAppActions ()
 
std::size_t getSize () const
 
- Public Member Functions inherited from Tempus::StepperRKAppAction< Scalar >
 StepperRKAppAction ()
 Constructor. More...
 
virtual ~StepperRKAppAction ()
 Destructor. More...
 

Private Attributes

std::vector< Teuchos::RCP
< StepperRKAppAction< Scalar > > > 
appActions_
 

Additional Inherited Members

- Public Types inherited from Tempus::StepperRKAppAction< Scalar >
enum  ACTION_LOCATION {
  BEGIN_STEP, BEGIN_STAGE, BEFORE_SOLVE, AFTER_SOLVE,
  BEFORE_EXPLICIT_EVAL, END_STAGE, END_STEP
}
 Indicates the location of application action (see algorithm). More...
 

Detailed Description

template<class Scalar>
class Tempus::StepperRKAppActionComposite< Scalar >

This composite AppAction loops over added AppActions.

Individual AppActions are executed in the order in which they were added.

Definition at line 24 of file Tempus_StepperRKAppActionComposite.hpp.

Constructor & Destructor Documentation

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

Default constructor.

Definition at line 28 of file Tempus_StepperRKAppActionComposite.hpp.

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

Destructor.

Definition at line 31 of file Tempus_StepperRKAppActionComposite.hpp.

Member Function Documentation

template<class Scalar >
virtual void Tempus::StepperRKAppActionComposite< Scalar >::execute ( Teuchos::RCP< SolutionHistory< Scalar > >  sh,
Teuchos::RCP< StepperRKBase< Scalar > >  stepper,
const typename StepperRKAppAction< Scalar >::ACTION_LOCATION  actLoc 
)
inlinevirtual

Execute application action for RK Stepper.

Implements Tempus::StepperRKAppAction< Scalar >.

Definition at line 34 of file Tempus_StepperRKAppActionComposite.hpp.

template<class Scalar >
void Tempus::StepperRKAppActionComposite< Scalar >::addRKAppAction ( Teuchos::RCP< StepperRKAppAction< Scalar > >  appAction)
inline

Definition at line 43 of file Tempus_StepperRKAppActionComposite.hpp.

template<class Scalar >
void Tempus::StepperRKAppActionComposite< Scalar >::clearRKAppActions ( )
inline

Definition at line 49 of file Tempus_StepperRKAppActionComposite.hpp.

template<class Scalar >
std::size_t Tempus::StepperRKAppActionComposite< Scalar >::getSize ( ) const
inline

Definition at line 52 of file Tempus_StepperRKAppActionComposite.hpp.

Member Data Documentation

template<class Scalar >
std::vector<Teuchos::RCP<StepperRKAppAction<Scalar> > > Tempus::StepperRKAppActionComposite< Scalar >::appActions_
private

Definition at line 55 of file Tempus_StepperRKAppActionComposite.hpp.


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