Tempus  Version of the Day
Time Integration
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Tempus_StepperSubcyclingModifierBase.hpp
Go to the documentation of this file.
1 // @HEADER
2 // ****************************************************************************
3 // Tempus: Copyright (2017) Sandia Corporation
4 //
5 // Distributed under BSD 3-clause license (See accompanying file Copyright.txt)
6 // ****************************************************************************
7 // @HEADER
8 
9 #ifndef Tempus_StepperSubcyclingModifierBase_hpp
10 #define Tempus_StepperSubcyclingModifierBase_hpp
11 
12 #include "Tempus_config.hpp"
13 #include "Tempus_SolutionHistory.hpp"
15 
16 namespace Tempus {
17 
36 template <class Scalar>
38  : virtual public Tempus::StepperSubcyclingAppAction<Scalar> {
39  private:
40  /* \brief Adaptor execute function
41  *
42  * This is an adaptor function to bridge between the AppAction
43  * interface and the Modifier interface. It is meant to be private
44  * and non-virtual as deriving from this class should only need to
45  * implement the modify function.
46  *
47  * For the Modifier interface, this adaptor is a "simple pass through".
48  */
49  void execute(
53  {
54  this->modify(sh, stepper, actLoc);
55  }
56 
57  public:
59  virtual void modify(
63  actLoc) = 0;
64 };
65 
66 } // namespace Tempus
67 
68 #endif // Tempus_StepperSubcyclingModifierBase_hpp
void execute(Teuchos::RCP< SolutionHistory< Scalar > > sh, Teuchos::RCP< StepperSubcycling< Scalar > > stepper, const typename StepperSubcyclingAppAction< Scalar >::ACTION_LOCATION actLoc)
Execute application action for Subcycling Stepper.
Application Action for StepperSubcycling.
virtual void modify(Teuchos::RCP< SolutionHistory< Scalar > >, Teuchos::RCP< StepperSubcycling< Scalar > >, const typename StepperSubcyclingAppAction< Scalar >::ACTION_LOCATION actLoc)=0
Modify Subcycling Stepper.
SolutionHistory is basically a container of SolutionStates. SolutionHistory maintains a collection of...
ACTION_LOCATION
Indicates the location of application action (see algorithm).