9#ifndef Tempus_StepperIMEX_RK_decl_hpp
10#define Tempus_StepperIMEX_RK_decl_hpp
12#include "Tempus_config.hpp"
14#include "Tempus_StepperImplicit.hpp"
15#include "Tempus_WrapperModelEvaluatorPairIMEX_Basic.hpp"
288template<
class Scalar>
304 const Teuchos::RCP<Thyra::NonlinearSolverBase<Scalar> >& solver,
306 std::string ICConsistency,
307 bool ICConsistencyCheck,
308 bool zeroInitialGuess,
309 const Teuchos::RCP<StepperRKAppAction<Scalar> >& stepperRKAppAction,
310 std::string stepperType,
311 Teuchos::RCP<
const RKButcherTableau<Scalar> > explicitTableau,
312 Teuchos::RCP<
const RKButcherTableau<Scalar> > implicitTableau,
319 virtual Teuchos::RCP<const RKButcherTableau<Scalar> >
getTableau()
const
323 virtual void setTableaus( std::string stepperType =
"",
324 Teuchos::RCP<
const RKButcherTableau<Scalar> > explicitTableau = Teuchos::null,
325 Teuchos::RCP<
const RKButcherTableau<Scalar> > implicitTableau = Teuchos::null);
328 Teuchos::RCP<Teuchos::ParameterList> stepperPL,
329 std::string stepperType);
337 Teuchos::RCP<
const RKButcherTableau<Scalar> > explicitTableau);
345 Teuchos::RCP<
const RKButcherTableau<Scalar> > implicitTableau);
350 virtual Teuchos::RCP<const Thyra::ModelEvaluator<Scalar> >
getModel()
const
354 const Teuchos::RCP<WrapperModelEvaluatorPairIMEX_Basic<Scalar> >& mePair);
365 const Teuchos::RCP<SolutionHistory<Scalar> >& solutionHistory);
369 const Teuchos::RCP<SolutionHistory<Scalar> >& solutionHistory);
393 return Scalar(1.0)/(dt*A(0,0));
396 virtual Scalar
getBeta (
const Scalar )
const {
return Scalar(1.0); }
402 virtual void describe(Teuchos::FancyOStream & out,
403 const Teuchos::EVerbosityLevel verbLevel)
const;
406 virtual bool isValidSetup(Teuchos::FancyOStream & out)
const;
410 Scalar time, Scalar stepSize, Scalar stageNumber,
415 Scalar time, Scalar stepSize, Scalar stageNumber,
427 std::vector<Teuchos::RCP<Thyra::VectorBase<Scalar> > >
stageF_;
428 std::vector<Teuchos::RCP<Thyra::VectorBase<Scalar> > >
stageG_;
430 Teuchos::RCP<Thyra::VectorBase<Scalar> >
xTilde_;
447template <
typename Scalar>
467 xDotDot = Teuchos::null;
483 Teuchos::RCP<const Thyra::VectorBase<Scalar> >
xTilde_;
490template<
class Scalar>
491Teuchos::RCP<StepperIMEX_RK<Scalar> >
494 std::string stepperType,
495 Teuchos::RCP<Teuchos::ParameterList> pl);
Time-derivative interface for IMEX RK.
StepperIMEX_RKTimeDerivative(Scalar s, Teuchos::RCP< const Thyra::VectorBase< Scalar > > xTilde)
Constructor.
virtual ~StepperIMEX_RKTimeDerivative()
Destructor.
virtual void compute(Teuchos::RCP< const Thyra::VectorBase< Scalar > > x, Teuchos::RCP< Thyra::VectorBase< Scalar > > xDot, Teuchos::RCP< Thyra::VectorBase< Scalar > > xDotDot=Teuchos::null)
Compute the time derivative.
Teuchos::RCP< const Thyra::VectorBase< Scalar > > xTilde_
virtual void initialize(Scalar s, Teuchos::RCP< const Thyra::VectorBase< Scalar > > xTilde)
Implicit-Explicit Runge-Kutta (IMEX-RK) time stepper.
virtual void setInitialConditions(const Teuchos::RCP< SolutionHistory< Scalar > > &solutionHistory)
Set the initial conditions and make them consistent.
virtual Teuchos::RCP< const RKButcherTableau< Scalar > > getTableau() const
Returns the explicit tableau!
virtual Teuchos::RCP< const RKButcherTableau< Scalar > > getImplicitTableau() const
Return implicit tableau.
std::vector< Teuchos::RCP< Thyra::VectorBase< Scalar > > > stageG_
Teuchos::RCP< const Teuchos::ParameterList > getValidParameters() const
virtual Scalar getOrder() const
virtual Scalar getBeta(const Scalar) const
Return beta = d(x)/dx.
virtual bool isImplicit() const
virtual void setExplicitTableau(Teuchos::RCP< const RKButcherTableau< Scalar > > explicitTableau)
Set the explicit tableau from tableau.
Teuchos::RCP< const RKButcherTableau< Scalar > > explicitTableau_
virtual void initialize()
Initialize during construction and after changing input parameters.
virtual bool isValidSetup(Teuchos::FancyOStream &out) const
virtual bool isExplicit() const
virtual void setTableaus(std::string stepperType="", Teuchos::RCP< const RKButcherTableau< Scalar > > explicitTableau=Teuchos::null, Teuchos::RCP< const RKButcherTableau< Scalar > > implicitTableau=Teuchos::null)
Set both the explicit and implicit tableau from ParameterList.
virtual void setImplicitTableau(Teuchos::RCP< const RKButcherTableau< Scalar > > implicitTableau)
Set the implicit tableau from tableau.
virtual void describe(Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel) const
virtual Scalar getOrderMin() const
virtual bool isExplicitImplicit() const
std::vector< Teuchos::RCP< Thyra::VectorBase< Scalar > > > stageF_
std::vector< Teuchos::RCP< Thyra::VectorBase< Scalar > > > & getStageF()
virtual void takeStep(const Teuchos::RCP< SolutionHistory< Scalar > > &solutionHistory)
Take the specified timestep, dt, and return true if successful.
virtual Teuchos::RCP< Tempus::StepperState< Scalar > > getDefaultStepperState()
Provide a StepperState to the SolutionState. This Stepper does not have any special state data,...
virtual Scalar getAlpha(const Scalar dt) const
Return alpha = d(xDot)/dx.
Teuchos::RCP< const RKButcherTableau< Scalar > > implicitTableau_
void setOrder(Scalar order)
void evalExplicitModel(const Teuchos::RCP< const Thyra::VectorBase< Scalar > > &X, Scalar time, Scalar stepSize, Scalar stageNumber, const Teuchos::RCP< Thyra::VectorBase< Scalar > > &F) const
Teuchos::RCP< Thyra::VectorBase< Scalar > > xTilde_
std::vector< Teuchos::RCP< Thyra::VectorBase< Scalar > > > & getStageG()
virtual Scalar getOrderMax() const
virtual void setModelPair(const Teuchos::RCP< WrapperModelEvaluatorPairIMEX_Basic< Scalar > > &mePair)
Create WrapperModelPairIMEX from user-supplied ModelEvaluator pair.
virtual void setModel(const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &appModel)
Set the model.
StepperIMEX_RK(std::string stepperType="IMEX RK SSP2")
Default constructor.
virtual bool isOneStepMethod() const
Teuchos::RCP< Thyra::VectorBase< Scalar > > & getXTilde()
virtual bool isMultiStepMethod() const
virtual Teuchos::RCP< const RKButcherTableau< Scalar > > getExplicitTableau() const
Return explicit tableau.
virtual Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > getModel() const
virtual OrderODE getOrderODE() const
void evalImplicitModelExplicitly(const Teuchos::RCP< const Thyra::VectorBase< Scalar > > &X, Scalar time, Scalar stepSize, Scalar stageNumber, const Teuchos::RCP< Thyra::VectorBase< Scalar > > &G) const
Thyra Base interface for implicit time steppers.
Teuchos::RCP< WrapperModelEvaluator< Scalar > > wrapperModel_
Base class for Runge-Kutta methods, ExplicitRK, DIRK and IMEX.
This interface defines the time derivative connection between an implicit Stepper and WrapperModelEva...
Teuchos::RCP< StepperIMEX_RK< Scalar > > createStepperIMEX_RK(const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &model, std::string stepperType, Teuchos::RCP< Teuchos::ParameterList > pl)
Nonmember constructor - ModelEvaluator and ParameterList.
@ FIRST_ORDER_ODE
Stepper integrates first-order ODEs.