Tempus  Version of the Day
Time Integration
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Tempus_StepperForwardEulerModifierDefault.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_StepperForwardEulerModifierDefault_hpp
10 #define Tempus_StepperForwardEulerModifierDefault_hpp
11 
12 #include "Tempus_config.hpp"
14 
15 // Applications can uncomment this include in their implementation,
16 // if they need access to the stepper methods.
17 //#include "Tempus_StepperForwardEuler.hpp"
18 
19 
20 namespace Tempus {
21 
22 /** \brief Default modifier for StepperForwardEuler.
23  *
24  * The default modifier provides no-op functionality for the modifier.
25  * See StepperForwardEulerModifierBase for details on the algorithm.
26  *
27  * Applications can copy this implementation, rename, implement their
28  * action, and set on the stepper to get app-specific functionality.
29  */
30 template<class Scalar>
32  : virtual public Tempus::StepperForwardEulerModifierBase<Scalar>
33 {
34 public:
35 
36  /// Constructor
38 
39  /// Destructor
41 
42  /// Modify ForwardEuler Stepper.
43  virtual void modify(
44  Teuchos::RCP<SolutionHistory<Scalar> > /* sh */,
45  Teuchos::RCP<StepperForwardEuler<Scalar> > /* stepper */,
47  {
48  switch(actLoc) {
52  {
53  // No-op.
54  break;
55  }
56  default:
57  TEUCHOS_TEST_FOR_EXCEPTION(true, std::logic_error,
58  "Error - unknown action location.\n");
59  }
60  }
61 
62 };
63 
64 } // namespace Tempus
65 
66 #endif // Tempus_StepperForwardEulerModifierDefault_hpp
ACTION_LOCATION
Indicates the location of application action (see algorithm).
Application Action for StepperForwardEuler.
SolutionHistory is basically a container of SolutionStates. SolutionHistory maintains a collection of...
virtual void modify(Teuchos::RCP< SolutionHistory< Scalar > >, Teuchos::RCP< StepperForwardEuler< Scalar > >, const typename StepperForwardEulerAppAction< Scalar >::ACTION_LOCATION actLoc)
Modify ForwardEuler Stepper.