Tempus  Version of the Day
Time Integration
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Tempus_StepperDIRKObserver.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_StepperDIRKObserver_hpp
10 #define Tempus_StepperDIRKObserver_hpp
11 
12 #include "Tempus_SolutionHistory.hpp"
13 
14 
15 namespace Tempus {
16 
17 // Forward Declaration for recursive includes (this Observer <--> Stepper)
18 template<class Scalar> class StepperDIRK;
19 
20 /** \brief StepperDIRKObserver class for StepperDIRK.
21  *
22  * This is a means for application developers to perform tasks
23  * during the time steps, e.g.,
24  * - Compute specific quantities
25  * - Output information
26  * - "Massage" the working solution state
27  * - ...
28  *
29  * <b>Design Considerations</b>
30  * - StepperDIRKObserver is not stateless! Developers may touch the
31  * solution state! Developers need to be careful not to break the
32  * restart (checkpoint) capability.
33  */
34 template<class Scalar>
36  : virtual public Tempus::StepperObserver<Scalar>
37 {
38 public:
39 
40  /// Constructor
42 
43  /// Destructor
45 
46  /// Observe Stepper at beginning of takeStep.
47  virtual void observeBeginTakeStep(
48  Teuchos::RCP<SolutionHistory<Scalar> > /* sh */,
49  Stepper<Scalar> & /* stepper */){}
50 
51  /// Observe Stepper at beginning of each stage.
52  virtual void observeBeginStage(
53  Teuchos::RCP<SolutionHistory<Scalar> > /* sh */,
54  StepperDIRK<Scalar> & /* stepperDIRK */){}
55 
56  /// Observe Stepper before Explicit evaluation of Implicit ODE ME.
57  virtual void observeBeforeExplicit(
58  Teuchos::RCP<SolutionHistory<Scalar> > /* sh */,
59  StepperDIRK<Scalar> & /* stepperDIRK */){}
60 
61  /// Observe Stepper before nonlinear solve.
62  virtual void observeBeforeSolve(
63  Teuchos::RCP<SolutionHistory<Scalar> > /* sh */,
64  StepperDIRK<Scalar> & /* stepperDIRK */){}
65 
66  /// Observe Stepper after nonlinear solve.
67  virtual void observeAfterSolve(
68  Teuchos::RCP<SolutionHistory<Scalar> > /* sh */,
69  StepperDIRK<Scalar> & /* stepperDIRK */){}
70 
71  /// Observe Stepper at end of each stage.
72  virtual void observeEndStage(
73  Teuchos::RCP<SolutionHistory<Scalar> > /* sh */,
74  StepperDIRK<Scalar> & /* stepperDIRK */){}
75 
76  /// Observe Stepper at end of takeStep.
77  virtual void observeEndTakeStep(
78  Teuchos::RCP<SolutionHistory<Scalar> > /* sh */,
79  Stepper<Scalar> & /* stepper */){}
80 };
81 } // namespace Tempus
82 #endif // Tempus_StepperDIRKObserver_hpp
StepperDIRKObserver class for StepperDIRK.
virtual void observeBeforeSolve(Teuchos::RCP< SolutionHistory< Scalar > >, StepperDIRK< Scalar > &)
Observe Stepper before nonlinear solve.
virtual void observeEndTakeStep(Teuchos::RCP< SolutionHistory< Scalar > >, Stepper< Scalar > &)
Observe Stepper at end of takeStep.
virtual void observeBeginStage(Teuchos::RCP< SolutionHistory< Scalar > >, StepperDIRK< Scalar > &)
Observe Stepper at beginning of each stage.
virtual void observeBeginTakeStep(Teuchos::RCP< SolutionHistory< Scalar > >, Stepper< Scalar > &)
Observe Stepper at beginning of takeStep.
Thyra Base interface for time steppers.
Diagonally Implicit Runge-Kutta (DIRK) time stepper.
StepperObserver class for Stepper class.
SolutionHistory is basically a container of SolutionStates. SolutionHistory maintains a collection of...
virtual void observeBeforeExplicit(Teuchos::RCP< SolutionHistory< Scalar > >, StepperDIRK< Scalar > &)
Observe Stepper before Explicit evaluation of Implicit ODE ME.
virtual void observeEndStage(Teuchos::RCP< SolutionHistory< Scalar > >, StepperDIRK< Scalar > &)
Observe Stepper at end of each stage.
virtual void observeAfterSolve(Teuchos::RCP< SolutionHistory< Scalar > >, StepperDIRK< Scalar > &)
Observe Stepper after nonlinear solve.