Tempus  Version of the Day
Time Integration
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Tempus_StepperBackwardEulerModifierBase.hpp
Go to the documentation of this file.
1 //@HEADER
2 // *****************************************************************************
3 // Tempus: Time Integration and Sensitivity Analysis Package
4 //
5 // Copyright 2017 NTESS and the Tempus contributors.
6 // SPDX-License-Identifier: BSD-3-Clause
7 // *****************************************************************************
8 //@HEADER
9 
10 #ifndef Tempus_StepperBackwardEulerModifierBase_hpp
11 #define Tempus_StepperBackwardEulerModifierBase_hpp
12 
13 #include "Tempus_config.hpp"
14 #include "Tempus_SolutionHistory.hpp"
16 
17 namespace Tempus {
18 
36 template <class Scalar>
38  : virtual public Tempus::StepperBackwardEulerAppAction<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  actLoc)
54  {
55  this->modify(sh, stepper, actLoc);
56  }
57 
58  public:
60  virtual void modify(
64  actLoc) = 0;
65 };
66 
67 } // namespace Tempus
68 
69 #endif // Tempus_StepperBackwardEulerModifierBase_hpp
ACTION_LOCATION
Indicates the location of application action (see algorithm).
Application Action for StepperBackwardEuler.
virtual void modify(Teuchos::RCP< SolutionHistory< Scalar > >, Teuchos::RCP< StepperBackwardEuler< Scalar > >, const typename StepperBackwardEulerAppAction< Scalar >::ACTION_LOCATION actLoc)=0
Modify BackwardEuler Stepper.
SolutionHistory is basically a container of SolutionStates. SolutionHistory maintains a collection of...
void execute(Teuchos::RCP< SolutionHistory< Scalar > > sh, Teuchos::RCP< StepperBackwardEuler< Scalar > > stepper, const typename StepperBackwardEulerAppAction< Scalar >::ACTION_LOCATION actLoc)
Execute application action for BackwardEuler Stepper.