Tempus Version of the Day
Time Integration
Loading...
Searching...
No Matches
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
19namespace Teuchos {
20 class Time;
21}
22
23namespace Tempus {
24 template<typename Scalar> class Stepper;
25 template<typename Scalar> class SolutionHistory;
26 template<typename Scalar> class TimeStepControl;
27}
28
29namespace Tempus {
30
61template<class Scalar>
63 : virtual public Teuchos::Describable,
64 virtual public Teuchos::VerboseObject<Tempus::Integrator<Scalar> >
65{
66public:
67
69
70
71 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 void setStatus(const Tempus::Status st) = 0;
81 virtual Teuchos::RCP<Stepper<Scalar> > getStepper() const = 0;
83 virtual Teuchos::RCP<const SolutionHistory<Scalar> > getSolutionHistory() const = 0;
85 virtual Teuchos::RCP<SolutionHistory<Scalar> > getNonConstSolutionHistory() = 0;
87 virtual Teuchos::RCP<const TimeStepControl<Scalar> > getTimeStepControl() const = 0;
88 virtual Teuchos::RCP<TimeStepControl<Scalar> > getNonConstTimeStepControl() = 0;
90 virtual Teuchos::RCP<Teuchos::Time> getIntegratorTimer() const = 0;
91 virtual Teuchos::RCP<Teuchos::Time> getStepperTimer() const = 0;
93
94};
95
96
97} // namespace Tempus
98#endif // Tempus_Integrator_hpp
Thyra Base interface for time integrators. Time integrators are designed to advance the solution from...
virtual void setStatus(const Tempus::Status st)=0
Set the Status.
virtual Teuchos::RCP< Teuchos::Time > getIntegratorTimer() const =0
Returns the IntegratorTimer_ for this Integrator.
virtual int getIndex() const =0
Get current index.
virtual Teuchos::RCP< SolutionHistory< Scalar > > getNonConstSolutionHistory()=0
Returns the SolutionHistory for this Integrator.
virtual Teuchos::RCP< const SolutionHistory< Scalar > > getSolutionHistory() const =0
Returns the SolutionHistory for this Integrator.
virtual bool advanceTime(const Scalar time_final)=0
Advance the solution to time, and return true if successful.
virtual Teuchos::RCP< const TimeStepControl< Scalar > > getTimeStepControl() const =0
Returns the TimeStepControl for this Integrator.
virtual Teuchos::RCP< TimeStepControl< Scalar > > getNonConstTimeStepControl()=0
virtual Teuchos::RCP< Stepper< Scalar > > getStepper() const =0
Get the stepper.
virtual Tempus::Status getStatus() const =0
Get the Status.
virtual Teuchos::RCP< Teuchos::Time > getStepperTimer() const =0
virtual Scalar getTime() const =0
Get current time.
Status
Status for the Integrator, the Stepper and the SolutionState.