Tempus  Version of the Day
Time Integration
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Tempus_StepperBDF2ObserverBase.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_StepperBDF2ObserverBase_hpp
11 #define Tempus_StepperBDF2ObserverBase_hpp
12 
13 #include "Tempus_config.hpp"
14 #include "Tempus_SolutionHistory.hpp"
16 
17 namespace Tempus {
18 
34 template <class Scalar>
36  : virtual public Tempus::StepperBDF2AppAction<Scalar> {
37  private:
38  /* \brief Adaptor execute function
39  *
40  * This is an adaptor function to bridge between the AppAction
41  * interface and this derived interface. It is meant to be private
42  * and non-virtual as deriving from this class should only need to
43  * implement the observe function.
44  *
45  * For the Observer interface, this adaptor simply "applies" constantness
46  * to the arguments.
47  */
48  void execute(
52  {
53  this->observe(sh, stepper, actLoc);
54  }
55 
56  public:
58  virtual void observe(
59  Teuchos::RCP<const SolutionHistory<Scalar> > /* sh */,
60  Teuchos::RCP<const StepperBDF2<Scalar> > /* stepper */,
61  const typename StepperBDF2AppAction<Scalar>::ACTION_LOCATION actLoc) = 0;
62 };
63 
64 } // namespace Tempus
65 
66 #endif // Tempus_StepperBDF2ObserverBase_hpp
BDF2 (Backward-Difference-Formula-2) time stepper.
ACTION_LOCATION
Indicates the location of application action (see algorithm).
SolutionHistory is basically a container of SolutionStates. SolutionHistory maintains a collection of...
void execute(Teuchos::RCP< SolutionHistory< Scalar > > sh, Teuchos::RCP< StepperBDF2< Scalar > > stepper, const typename StepperBDF2AppAction< Scalar >::ACTION_LOCATION actLoc)
Execute application action for BDF2 Stepper.
virtual void observe(Teuchos::RCP< const SolutionHistory< Scalar > >, Teuchos::RCP< const StepperBDF2< Scalar > >, const typename StepperBDF2AppAction< Scalar >::ACTION_LOCATION actLoc)=0
Observe BDF2 Stepper.
Application Action for StepperBDF2.