Tempus  Version of the Day
Time Integration
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Tempus_StepperExplicitRK_decl.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_StepperExplicitRK_decl_hpp
10 #define Tempus_StepperExplicitRK_decl_hpp
11 
12 #include "Tempus_config.hpp"
13 #include "Tempus_StepperRKBase.hpp"
14 #include "Tempus_StepperExplicit.hpp"
15 
16 
17 namespace Tempus {
18 
99 template<class Scalar>
100 class StepperExplicitRK : virtual public Tempus::StepperExplicit<Scalar>,
101  virtual public Tempus::StepperRKBase<Scalar>
102 {
103 
104 public:
105 
107 
108  virtual void initialize();
110 
112  virtual void setModel(
113  const Teuchos::RCP<const Thyra::ModelEvaluator<Scalar> >& appModel);
114 
116  virtual void setInitialConditions (
117  const Teuchos::RCP<SolutionHistory<Scalar> >& solutionHistory);
118 
120  virtual void takeStep(
121  const Teuchos::RCP<SolutionHistory<Scalar> >& solutionHistory);
122 
125  virtual Scalar getInitTimeStep(
126  const Teuchos::RCP<SolutionHistory<Scalar> >& solutionHistory) const;
127 
128  virtual bool isExplicit() const {return true;}
129  virtual bool isImplicit() const {return false;}
130  virtual bool isExplicitImplicit() const
131  {return isExplicit() && isImplicit();}
132  virtual bool isOneStepMethod() const {return true;}
133  virtual bool isMultiStepMethod() const {return !isOneStepMethod();}
134 
135  virtual OrderODE getOrderODE() const {return FIRST_ORDER_ODE;}
136 
137  virtual std::string getDescription() const = 0;
139 
141 
143 
145 
146  virtual void describe(Teuchos::FancyOStream & out,
147  const Teuchos::EVerbosityLevel verbLevel) const;
149 
150  virtual bool isValidSetup(Teuchos::FancyOStream & out) const;
151 
152 
153 protected:
154 
156  virtual void setupDefault();
157 
159  virtual void setup(
160  const Teuchos::RCP<const Thyra::ModelEvaluator<Scalar> >& appModel,
161  bool useFSAL,
162  std::string ICConsistency,
163  bool ICConsistencyCheck,
164  bool useEmbedded,
165  const Teuchos::RCP<StepperRKAppAction<Scalar> >& stepperRKAppAction);
166 
167  virtual void setupTableau() = 0;
168 
169  virtual void setEmbeddedMemory();
170 
171 
172  std::vector<Teuchos::RCP<Thyra::VectorBase<Scalar> > > stageXDot_;
173 
174 };
175 
176 } // namespace Tempus
177 
178 #endif // Tempus_StepperExplicitRK_decl_hpp
virtual void setModel(const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &appModel)
Set model.
Explicit Runge-Kutta time stepper.
virtual std::string getDescription() const =0
virtual void setupDefault()
Default setup for constructor.
virtual Scalar getInitTimeStep(const Teuchos::RCP< SolutionHistory< Scalar > > &solutionHistory) const
virtual void describe(Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel) const
std::vector< Teuchos::RCP< Thyra::VectorBase< Scalar > > > stageXDot_
virtual bool isValidSetup(Teuchos::FancyOStream &out) const
virtual void setInitialConditions(const Teuchos::RCP< SolutionHistory< Scalar > > &solutionHistory)
Set the initial conditions and make them consistent.
Base class for Runge-Kutta methods, ExplicitRK, DIRK and IMEX.
virtual void setupTableau()=0
Application Action for StepperRKBase.
virtual Teuchos::RCP< const Teuchos::ParameterList > getValidParameters() const
SolutionHistory is basically a container of SolutionStates. SolutionHistory maintains a collection of...
Teuchos::RCP< Teuchos::ParameterList > getValidParametersBasicERK() const
Stepper integrates first-order ODEs.
virtual void takeStep(const Teuchos::RCP< SolutionHistory< Scalar > > &solutionHistory)
Take the specified timestep, dt, and return true if successful.
virtual void initialize()
Initialize during construction and after changing input parameters.
virtual Teuchos::RCP< Tempus::StepperState< Scalar > > getDefaultStepperState()
Get a default (initial) StepperState.
Thyra Base interface for implicit time steppers.
virtual void setup(const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &appModel, bool useFSAL, std::string ICConsistency, bool ICConsistencyCheck, bool useEmbedded, const Teuchos::RCP< StepperRKAppAction< Scalar > > &stepperRKAppAction)
Setup for constructor.