Tempus Version of the Day
Time Integration
Loading...
Searching...
No Matches
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
18namespace Tempus {
19
20
21template<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),
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
41 Teuchos::RCP<TimeDerivative<Scalar> > timeDer_;
43 Scalar alpha_;
44 Scalar beta_;
47};
48
225template<class Scalar>
226class StepperImplicit : virtual public Tempus::Stepper<Scalar>
227{
228public:
229
231
232
233 virtual void setModel(
234 const Teuchos::RCP<const Thyra::ModelEvaluator<Scalar> >& appModel) override;
235
236 virtual Teuchos::RCP<const Thyra::ModelEvaluator<Scalar> > getModel() const override
237 {
238 Teuchos::RCP<const Thyra::ModelEvaluator<Scalar> > model;
239 if (wrapperModel_ != Teuchos::null) model = wrapperModel_->getAppModel();
240 return model;
241 }
242
243 virtual Teuchos::RCP<const WrapperModelEvaluator<Scalar> >
245
246 virtual void setDefaultSolver();
247
249 virtual void setSolver(
250 Teuchos::RCP<Thyra::NonlinearSolverBase<Scalar> > solver) override;
251
252 virtual Teuchos::RCP<Thyra::NonlinearSolverBase<Scalar> > getSolver() const override
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
266 const Thyra::SolveStatus<Scalar> solveImplicitODE(
267 const Teuchos::RCP<Thyra::VectorBase<Scalar> > & x,
268 const Teuchos::RCP<Thyra::VectorBase<Scalar> > & xDot,
269 const Scalar time,
270 const Teuchos::RCP<ImplicitODEParameters<Scalar> > & p,
271 const Teuchos::RCP<Thyra::VectorBase<Scalar> > & y = Teuchos::null,
272 const int index = 0 /* index and y are for IMEX_RK_Partition */ );
273
276 Teuchos::RCP<Thyra::VectorBase<Scalar> > & f,
277 const Teuchos::RCP<Thyra::VectorBase<Scalar> > & x,
278 const Teuchos::RCP<Thyra::VectorBase<Scalar> > & xDot,
279 const Scalar time,
280 const Teuchos::RCP<ImplicitODEParameters<Scalar> > & p );
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
311 virtual Teuchos::RCP<const Teuchos::ParameterList> getValidParameters() const override;
312
313 Teuchos::RCP<Teuchos::ParameterList> getValidParametersBasicImplicit() const;
314
316 void setStepperImplicitValues(Teuchos::RCP<Teuchos::ParameterList> pl);
317
319 void setStepperSolverValues(Teuchos::RCP<Teuchos::ParameterList> pl);
320
322 void setSolverName(std::string i) { solverName_ = i; }
324 std::string getSolverName() const { return solverName_; }
325
326protected:
327
328 Teuchos::RCP<WrapperModelEvaluator<Scalar> > wrapperModel_;
329 Teuchos::RCP<Thyra::NonlinearSolverBase<Scalar> > solver_;
330 Teuchos::RCP<const Thyra::VectorBase<Scalar> > initialGuess_;
332 std::string solverName_;
333
334};
335
336} // namespace Tempus
337#endif // Tempus_StepperImplicit_decl_hpp
Teuchos::RCP< TimeDerivative< Scalar > > timeDer_
ImplicitODEParameters(Teuchos::RCP< TimeDerivative< Scalar > > timeDer, Scalar timeStepSize, Scalar alpha, Scalar beta, EVALUATION_TYPE evaluationType=SOLVE_FOR_X, int stageNumber=0)
Constructor.
SolutionHistory is basically a container of SolutionStates. SolutionHistory maintains a collection of...
Thyra Base interface for implicit time steppers.
virtual void setInitialConditions(const Teuchos::RCP< SolutionHistory< Scalar > > &solutionHistory) override
Set the initial conditions and make them consistent.
std::string getSolverName() const
Get the Solver Name.
Teuchos::RCP< WrapperModelEvaluator< Scalar > > wrapperModel_
Teuchos::RCP< const Thyra::VectorBase< Scalar > > initialGuess_
Teuchos::RCP< Teuchos::ParameterList > getValidParametersBasicImplicit() const
void setStepperImplicitValues(Teuchos::RCP< Teuchos::ParameterList > pl)
Set StepperImplicit member data from the ParameterList.
virtual Teuchos::RCP< const Teuchos::ParameterList > getValidParameters() const override
virtual void setInitialGuess(Teuchos::RCP< const Thyra::VectorBase< Scalar > > initialGuess) override
Pass initial guess to Newton solver (only relevant for implicit solvers)
void setStepperSolverValues(Teuchos::RCP< Teuchos::ParameterList > pl)
Set solver from ParameterList.
Teuchos::RCP< Thyra::NonlinearSolverBase< Scalar > > solver_
virtual Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > getModel() const override
virtual Teuchos::RCP< const WrapperModelEvaluator< Scalar > > getWrapperModel()
virtual void setSolver(Teuchos::RCP< Thyra::NonlinearSolverBase< Scalar > > solver) override
Set solver.
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).
virtual void describe(Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel) const override
virtual Scalar getInitTimeStep(const Teuchos::RCP< SolutionHistory< Scalar > > &) const override
virtual Teuchos::RCP< Thyra::NonlinearSolverBase< Scalar > > getSolver() const override
Get solver.
void setSolverName(std::string i)
Set the Solver Name.
virtual void setModel(const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &appModel) override
Set the model.
virtual Scalar getBeta(const Scalar dt) const =0
Return beta = d(x)/dx.
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.
virtual bool isValidSetup(Teuchos::FancyOStream &out) const override
virtual void setZeroInitialGuess(bool zIG)
Set parameter so that the initial guess is set to zero (=True) or use last timestep (=False).
virtual Scalar getAlpha(const Scalar dt) const =0
Return alpha = d(xDot)/dx.
Thyra Base interface for time steppers.
bool isInitialized_
True if stepper's member data is initialized.
This interface defines the time derivative connection between an implicit Stepper and WrapperModelEva...
EVALUATION_TYPE
EVALUATION_TYPE indicates the evaluation to apply to the implicit ODE.
@ SOLVE_FOR_X
Solve for x and determine xDot from x.