Tempus  Version of the Day
Time Integration
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Tempus_Integrator.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_Integrator_hpp
10 #define Tempus_Integrator_hpp
11 
12 #include "Tempus_config.hpp"
13 #include "Tempus_Types.hpp"
14 #include "Teuchos_VerboseObject.hpp"
15 #include "Teuchos_Describable.hpp"
16 
17 #include <string>
18 
19 namespace Teuchos {
20  class Time;
21 }
22 
23 namespace Tempus {
24  template<typename Scalar> class Stepper;
25  template<typename Scalar> class SolutionHistory;
26  template<typename Scalar> class TimeStepControl;
27 }
28 
29 namespace Tempus {
30 
61 template<class Scalar>
63  : virtual public Teuchos::Describable,
64  virtual public Teuchos::VerboseObject<Tempus::Integrator<Scalar> >
65 {
66 public:
67 
69 
70  virtual bool advanceTime(const Scalar time_final) = 0;
73  virtual Scalar getTime() const = 0;
75  virtual int getIndex() const = 0;
77  virtual Tempus::Status getStatus() const = 0;
79  virtual Teuchos::RCP<Stepper<Scalar> > getStepper() const = 0;
90  virtual Teuchos::RCP<Teuchos::Time> getStepperTimer() const = 0;
92 
93 };
94 
95 
96 } // namespace Tempus
97 #endif // Tempus_Integrator_hpp
virtual Teuchos::RCP< Teuchos::ParameterList > getTempusParameterList()=0
Return a copy of the Tempus ParameterList.
virtual Teuchos::RCP< Teuchos::Time > getStepperTimer() const =0
virtual Teuchos::RCP< Teuchos::Time > getIntegratorTimer() const =0
Returns the IntegratorTimer_ for this Integrator.
virtual Teuchos::RCP< const TimeStepControl< Scalar > > getTimeStepControl() const =0
Returns the TimeStepControl for this Integrator.
virtual Teuchos::RCP< TimeStepControl< Scalar > > getNonConstTimeStepControl()=0
virtual Tempus::Status getStatus() const =0
Get the Status.
Thyra Base interface for time steppers.
Status
Status for the Integrator, the Stepper and the SolutionState.
virtual Scalar getTime() const =0
Get current time.
TimeStepControl manages the time step size. There several mechanisms that effect the time step size a...
SolutionHistory is basically a container of SolutionStates. SolutionHistory maintains a collection of...
virtual bool advanceTime(const Scalar time_final)=0
Advance the solution to time, and return true if successful.
Thyra Base interface for time integrators. Time integrators are designed to advance the solution from...
virtual Teuchos::RCP< Stepper< Scalar > > getStepper() const =0
Get the stepper.
virtual void setTempusParameterList(Teuchos::RCP< Teuchos::ParameterList > pl)=0
virtual int getIndex() const =0
Get current index.
virtual Teuchos::RCP< const SolutionHistory< Scalar > > getSolutionHistory() const =0
Returns the SolutionHistory for this Integrator.