Tempus  Version of the Day
Time Integration
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Tempus_StepperImplicit_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_StepperImplicit_decl_hpp
10 #define Tempus_StepperImplicit_decl_hpp
11 
12 // Tempus
13 #include "Tempus_config.hpp"
14 #include "Tempus_Stepper.hpp"
15 #include "Tempus_WrapperModelEvaluatorBasic.hpp"
16 
17 
18 namespace Tempus {
19 
20 
21 template<class Scalar>
23 {
24  public:
27  : timeDer_(Teuchos::null), timeStepSize_(Scalar(0.0)),
28  alpha_(Scalar(0.0)), beta_(Scalar(0.0)), evaluationType_(SOLVE_FOR_X),
29  stageNumber_(0)
30  {}
33  Scalar timeStepSize, Scalar alpha, Scalar beta,
34  EVALUATION_TYPE evaluationType = SOLVE_FOR_X,
35  int stageNumber = 0)
36  : timeDer_(timeDer), timeStepSize_(timeStepSize),
37  alpha_(alpha), beta_(beta), evaluationType_(evaluationType),
38  stageNumber_(stageNumber)
39  {}
40 
42  Scalar timeStepSize_;
43  Scalar alpha_;
44  Scalar beta_;
47 };
48 
225 template<class Scalar>
226 class StepperImplicit : virtual public Tempus::Stepper<Scalar>
227 {
228 public:
229 
231 
232  virtual void setModel(
234  const Teuchos::RCP<const Thyra::ModelEvaluator<Scalar> >& appModel) override;
235 
237  {
239  if (wrapperModel_ != Teuchos::null) model = wrapperModel_->getAppModel();
240  return model;
241  }
242 
245 
246  virtual void setDefaultSolver();
247 
249  virtual void setSolver(
251 
253  { return solver_; }
254 
256  virtual void setInitialConditions (
257  const Teuchos::RCP<SolutionHistory<Scalar> >& solutionHistory) override;
258 
260  virtual Scalar getAlpha(const Scalar dt) const = 0;
261 
263  virtual Scalar getBeta (const Scalar dt) const = 0;
264 
269  const Scalar time,
271  const Teuchos::RCP<Thyra::VectorBase<Scalar> > & y = Teuchos::null,
272  const int index = 0 /* index and y are for IMEX_RK_Partition */ );
273 
275  void evaluateImplicitODE(
279  const Scalar time,
281 
283  virtual void setInitialGuess(
284  Teuchos::RCP<const Thyra::VectorBase<Scalar> > initialGuess) override
285  {
286  initialGuess_ = initialGuess;
287  this->isInitialized_ = false;
288  }
289 
291  virtual void setZeroInitialGuess(bool zIG) {
292  zeroInitialGuess_ = zIG;
293  this->isInitialized_ = false;
294  }
295 
296  virtual bool getZeroInitialGuess() const { return zeroInitialGuess_; }
297 
298  virtual Scalar getInitTimeStep(
299  const Teuchos::RCP<SolutionHistory<Scalar> >& /* solutionHistory */) const override
300  {return Scalar(1.0e+99);}
302 
304 
305  virtual void describe(Teuchos::FancyOStream & out,
306  const Teuchos::EVerbosityLevel verbLevel) const override;
308 
309  virtual bool isValidSetup(Teuchos::FancyOStream & out) const override;
310 
312 
314 
317 
320 
322  void setSolverName(std::string i) { solverName_ = i; }
324  std::string getSolverName() const { return solverName_; }
325 
326 protected:
327 
332  std::string solverName_;
333 
334 };
335 
336 } // namespace Tempus
337 #endif // Tempus_StepperImplicit_decl_hpp
virtual Teuchos::RCP< const Teuchos::ParameterList > getValidParameters() const override
ImplicitODEParameters(Teuchos::RCP< TimeDerivative< Scalar > > timeDer, Scalar timeStepSize, Scalar alpha, Scalar beta, EVALUATION_TYPE evaluationType=SOLVE_FOR_X, int stageNumber=0)
Constructor.
virtual void setSolver(Teuchos::RCP< Thyra::NonlinearSolverBase< Scalar > > solver) override
Set solver.
virtual Teuchos::RCP< Thyra::NonlinearSolverBase< Scalar > > getSolver() const override
Get solver.
EVALUATION_TYPE
EVALUATION_TYPE indicates the evaluation to apply to the implicit ODE.
virtual bool isValidSetup(Teuchos::FancyOStream &out) const override
Teuchos::RCP< const Thyra::VectorBase< Scalar > > initialGuess_
Teuchos::RCP< WrapperModelEvaluator< Scalar > > wrapperModel_
const Thyra::SolveStatus< Scalar > solveImplicitODE(const Teuchos::RCP< Thyra::VectorBase< Scalar > > &x, const Teuchos::RCP< Thyra::VectorBase< Scalar > > &xDot, const Scalar time, const Teuchos::RCP< ImplicitODEParameters< Scalar > > &p, const Teuchos::RCP< Thyra::VectorBase< Scalar > > &y=Teuchos::null, const int index=0)
Solve implicit ODE, f(x, xDot, t, p) = 0.
void setStepperImplicitValues(Teuchos::RCP< Teuchos::ParameterList > pl)
Set StepperImplicit member data from the ParameterList.
virtual Scalar getInitTimeStep(const Teuchos::RCP< SolutionHistory< Scalar > > &) const override
virtual void setInitialGuess(Teuchos::RCP< const Thyra::VectorBase< Scalar > > initialGuess) override
Pass initial guess to Newton solver (only relevant for implicit solvers)
virtual Teuchos::RCP< const WrapperModelEvaluator< Scalar > > getWrapperModel()
virtual void describe(Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel) const override
bool isInitialized_
True if stepper&#39;s member data is initialized.
virtual Scalar getBeta(const Scalar dt) const =0
Return beta = d(x)/dx.
Teuchos::RCP< TimeDerivative< Scalar > > timeDer_
virtual void setModel(const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &appModel) override
Set the model.
Thyra Base interface for time steppers.
virtual void setInitialConditions(const Teuchos::RCP< SolutionHistory< Scalar > > &solutionHistory) override
Set the initial conditions and make them consistent.
void evaluateImplicitODE(Teuchos::RCP< Thyra::VectorBase< Scalar > > &f, const Teuchos::RCP< Thyra::VectorBase< Scalar > > &x, const Teuchos::RCP< Thyra::VectorBase< Scalar > > &xDot, const Scalar time, const Teuchos::RCP< ImplicitODEParameters< Scalar > > &p)
Evaluate implicit ODE residual, f(x, xDot, t, p).
Thyra Base interface for implicit time steppers.
void setSolverName(std::string i)
Set the Solver Name.
void setStepperSolverValues(Teuchos::RCP< Teuchos::ParameterList > pl)
Set solver from ParameterList.
virtual void setZeroInitialGuess(bool zIG)
Set parameter so that the initial guess is set to zero (=True) or use last timestep (=False)...
SolutionHistory is basically a container of SolutionStates. SolutionHistory maintains a collection of...
virtual Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > getModel() const override
Teuchos::RCP< Teuchos::ParameterList > getValidParametersBasicImplicit() const
This interface defines the time derivative connection between an implicit Stepper and WrapperModelEva...
std::string getSolverName() const
Get the Solver Name.
virtual Scalar getAlpha(const Scalar dt) const =0
Return alpha = d(xDot)/dx.
Solve for x and determine xDot from x.
Teuchos::RCP< Thyra::NonlinearSolverBase< Scalar > > solver_
virtual bool getZeroInitialGuess() const