Tempus Version of the Day
Time Integration
Loading...
Searching...
No Matches
Tempus_StepperExplicit_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_StepperExplicit_decl_hpp
10#define Tempus_StepperExplicit_decl_hpp
11
12// Tempus
13#include "Tempus_config.hpp"
14#include "Tempus_Stepper.hpp"
15
16
17template<class Scalar>
19{
20 public:
23 : timeStepSize_(Scalar(0.0)), stageNumber_(0)
24 {}
25
27 ExplicitODEParameters(Scalar timeStepSize, int stageNumber = 0)
28 : timeStepSize_(timeStepSize), stageNumber_(stageNumber)
29 {}
30
33};
34
35
36namespace Tempus {
37
38
42template<class Scalar>
43class StepperExplicit : virtual public Tempus::Stepper<Scalar>
44{
45public:
46
48
49
50 virtual void setModel(
51 const Teuchos::RCP<const Thyra::ModelEvaluator<Scalar> >& appModel);
52
54 virtual Teuchos::RCP<const Thyra::ModelEvaluator<Scalar> >
55 getModel() const {return appModel_;}
56
57 virtual Scalar getInitTimeStep(
58 const Teuchos::RCP<SolutionHistory<Scalar> >& /* solutionHistory */) const
59 {return std::numeric_limits<Scalar>::max();}
60
62 virtual void setInitialConditions (
63 const Teuchos::RCP<SolutionHistory<Scalar> >& solutionHistory);
64
65 virtual void setSolver(
66 Teuchos::RCP<Thyra::NonlinearSolverBase<Scalar> > solver);
67
68 virtual Teuchos::RCP<Thyra::NonlinearSolverBase<Scalar> > getSolver() const
69 { return Teuchos::null; }
70
72 // thus a no-op for explicit steppers.
73 virtual void setInitialGuess(
74 Teuchos::RCP<const Thyra::VectorBase<Scalar> > /* initial_guess */){}
75
76 virtual bool isExplicit() const {return true;}
77 virtual bool isImplicit() const {return false;}
78 virtual bool isExplicitImplicit() const
79 {return isExplicit() && isImplicit();}
80 virtual bool isOneStepMethod() const {return true;}
81 virtual bool isMultiStepMethod() const {return !isOneStepMethod();}
82
84 virtual void evaluateExplicitODE(
85 Teuchos::RCP< Thyra::VectorBase<Scalar> > xDot,
86 Teuchos::RCP<const Thyra::VectorBase<Scalar> > x,
87 const Scalar time,
88 const Teuchos::RCP<ExplicitODEParameters<Scalar> > & p );
89
91 virtual void evaluateExplicitODE(
92 Teuchos::RCP< Thyra::VectorBase<Scalar> > xDotDot,
93 Teuchos::RCP<const Thyra::VectorBase<Scalar> > x,
94 Teuchos::RCP<const Thyra::VectorBase<Scalar> > xDot,
95 const Scalar time,
96 const Teuchos::RCP<ExplicitODEParameters<Scalar> > & p );
98
100
101 virtual void describe(Teuchos::FancyOStream & out,
102 const Teuchos::EVerbosityLevel verbLevel) const;
104
105 virtual bool isValidSetup(Teuchos::FancyOStream & out) const;
106
108 void setStepperExplicitValues(Teuchos::RCP<Teuchos::ParameterList> pl);
109
110protected:
111
113 Teuchos::RCP<const Thyra::ModelEvaluator<Scalar> > appModel_;
114
115 Thyra::ModelEvaluatorBase::InArgs<Scalar> inArgs_;
116 Thyra::ModelEvaluatorBase::OutArgs<Scalar> outArgs_;
117
118};
119
120
121} // namespace Tempus
122#endif // Tempus_StepperExplicit_decl_hpp
ExplicitODEParameters(Scalar timeStepSize, int stageNumber=0)
Constructor.
Thyra Base interface for implicit time steppers.
virtual void evaluateExplicitODE(Teuchos::RCP< Thyra::VectorBase< Scalar > > xDot, Teuchos::RCP< const Thyra::VectorBase< Scalar > > x, const Scalar time, const Teuchos::RCP< ExplicitODEParameters< Scalar > > &p)
Evaluate xDot = f(x,t).
virtual Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > getModel() const
Return the application ModelEvaluator.
virtual void setInitialConditions(const Teuchos::RCP< SolutionHistory< Scalar > > &solutionHistory)
Set the initial conditions, make them consistent, and set needed memory.
virtual void setInitialGuess(Teuchos::RCP< const Thyra::VectorBase< Scalar > >)
Pass initial guess to Newton solver (only relevant for implicit solvers)
virtual Teuchos::RCP< Thyra::NonlinearSolverBase< Scalar > > getSolver() const
Get solver.
Thyra::ModelEvaluatorBase::InArgs< Scalar > inArgs_
Thyra::ModelEvaluatorBase::OutArgs< Scalar > outArgs_
Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > appModel_
Explicit ODE ModelEvaluator.
virtual Scalar getInitTimeStep(const Teuchos::RCP< SolutionHistory< Scalar > > &) const
virtual void setModel(const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &appModel)
Set model.
void setStepperExplicitValues(Teuchos::RCP< Teuchos::ParameterList > pl)
Set StepperExplicit member data from the ParameterList.
virtual bool isValidSetup(Teuchos::FancyOStream &out) const
virtual void describe(Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel) const
virtual void setSolver(Teuchos::RCP< Thyra::NonlinearSolverBase< Scalar > > solver)
Set solver.
Thyra Base interface for time steppers.