Tempus Version of the Day
Time Integration
Loading...
Searching...
No Matches
Public Member Functions | Private Attributes | List of all members
Tempus::StepperLeapfrogAppActionComposite< Scalar > Class Template Reference

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

#include <Tempus_StepperLeapfrogAppActionComposite.hpp>

Inheritance diagram for Tempus::StepperLeapfrogAppActionComposite< Scalar >:
Tempus::StepperLeapfrogAppAction< Scalar >

Public Member Functions

 StepperLeapfrogAppActionComposite ()
 Default constructor.
 
virtual ~StepperLeapfrogAppActionComposite ()
 Destructor.
 
virtual 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.
 
void addLeapfrogAppAction (Teuchos::RCP< StepperLeapfrogAppAction< Scalar > > appAction)
 
void clearLeapfrogAppActions ()
 
std::size_t getSize () const
 
- Public Member Functions inherited from Tempus::StepperLeapfrogAppAction< Scalar >
 StepperLeapfrogAppAction ()
 Constructor.
 
virtual ~StepperLeapfrogAppAction ()
 Destructor.
 
virtual void execute (Teuchos::RCP< SolutionHistory< Scalar > > sh, Teuchos::RCP< StepperLeapfrog< Scalar > > stepper, const typename StepperLeapfrogAppAction< Scalar >::ACTION_LOCATION actLoc)=0
 Execute application action for Leapfrog Stepper.
 

Private Attributes

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

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::StepperLeapfrogAppActionComposite< Scalar >

This composite AppAction loops over added AppActions.

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

Definition at line 25 of file Tempus_StepperLeapfrogAppActionComposite.hpp.

Constructor & Destructor Documentation

◆ StepperLeapfrogAppActionComposite()

template<class Scalar >
Tempus::StepperLeapfrogAppActionComposite< Scalar >::StepperLeapfrogAppActionComposite ( )

Default constructor.

◆ ~StepperLeapfrogAppActionComposite()

template<class Scalar >
virtual Tempus::StepperLeapfrogAppActionComposite< Scalar >::~StepperLeapfrogAppActionComposite ( )
virtual

Destructor.

Member Function Documentation

◆ execute()

template<class Scalar >
virtual void Tempus::StepperLeapfrogAppActionComposite< Scalar >::execute ( Teuchos::RCP< SolutionHistory< Scalar > >  sh,
Teuchos::RCP< StepperLeapfrog< Scalar > >  stepper,
const typename StepperLeapfrogAppAction< Scalar >::ACTION_LOCATION  actLoc 
)
inlinevirtual

Execute application action for Leapfrog Stepper.

Implements Tempus::StepperLeapfrogAppAction< Scalar >.

Definition at line 37 of file Tempus_StepperLeapfrogAppActionComposite.hpp.

◆ addLeapfrogAppAction()

template<class Scalar >
void Tempus::StepperLeapfrogAppActionComposite< Scalar >::addLeapfrogAppAction ( Teuchos::RCP< StepperLeapfrogAppAction< Scalar > >  appAction)
inline

Definition at line 47 of file Tempus_StepperLeapfrogAppActionComposite.hpp.

◆ clearLeapfrogAppActions()

template<class Scalar >
void Tempus::StepperLeapfrogAppActionComposite< Scalar >::clearLeapfrogAppActions ( )
inline

Definition at line 53 of file Tempus_StepperLeapfrogAppActionComposite.hpp.

◆ getSize()

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

Definition at line 57 of file Tempus_StepperLeapfrogAppActionComposite.hpp.

Member Data Documentation

◆ appActions_

template<class Scalar >
std::vector<Teuchos::RCP<StepperLeapfrogAppAction<Scalar > > > Tempus::StepperLeapfrogAppActionComposite< Scalar >::appActions_
private

Definition at line 61 of file Tempus_StepperLeapfrogAppActionComposite.hpp.


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