9#ifndef Tempus_StepperIMEX_RK_Partition_decl_hpp
10#define Tempus_StepperIMEX_RK_Partition_decl_hpp
12#include "Tempus_config.hpp"
14#include "Tempus_StepperImplicit.hpp"
15#include "Tempus_WrapperModelEvaluatorPairPartIMEX_Basic.hpp"
319template<
class Scalar>
335 const Teuchos::RCP<Thyra::NonlinearSolverBase<Scalar> >& solver,
337 std::string ICConsistency,
338 bool ICConsistencyCheck,
339 bool zeroInitialGuess,
340 const Teuchos::RCP<StepperRKAppAction<Scalar> >& stepperRKAppAction,
341 std::string stepperType,
342 Teuchos::RCP<
const RKButcherTableau<Scalar> > explicitTableau,
343 Teuchos::RCP<
const RKButcherTableau<Scalar> > implicitTableau,
349 virtual Teuchos::RCP<const RKButcherTableau<Scalar> >
getTableau()
const
353 virtual void setTableaus(std::string stepperType =
"",
354 Teuchos::RCP<
const RKButcherTableau<Scalar> > explicitTableau = Teuchos::null,
355 Teuchos::RCP<
const RKButcherTableau<Scalar> > implicitTableau = Teuchos::null);
358 Teuchos::RCP<Teuchos::ParameterList> pl,
359 std::string stepperType);
367 Teuchos::RCP<
const RKButcherTableau<Scalar> > explicitTableau);
375 Teuchos::RCP<
const RKButcherTableau<Scalar> > implicitTableau);
380 virtual Teuchos::RCP<const Thyra::ModelEvaluator<Scalar> >
getModel()
const
384 const Teuchos::RCP<WrapperModelEvaluatorPairPartIMEX_Basic<Scalar> > &
396 const Teuchos::RCP<SolutionHistory<Scalar> >& solutionHistory);
400 const Teuchos::RCP<SolutionHistory<Scalar> >& solutionHistory);
424 return Scalar(1.0)/(dt*A(0,0));
427 virtual Scalar
getBeta (
const Scalar )
const {
return Scalar(1.0); }
433 virtual void describe(Teuchos::FancyOStream & out,
434 const Teuchos::EVerbosityLevel verbLevel)
const;
437 virtual bool isValidSetup(Teuchos::FancyOStream & out)
const;
442 Scalar time, Scalar stepSize, Scalar stageNumber,
447 Scalar time, Scalar stepSize, Scalar stageNumber,
459 std::vector<Teuchos::RCP<Thyra::VectorBase<Scalar> > >
stageF_;
460 std::vector<Teuchos::RCP<Thyra::VectorBase<Scalar> > >
stageGx_;
462 Teuchos::RCP<Thyra::VectorBase<Scalar> >
xTilde_;
479template <
typename Scalar>
499 xDotDot = Teuchos::null;
515 Teuchos::RCP<const Thyra::VectorBase<Scalar> >
xTilde_;
522template<
class Scalar>
523Teuchos::RCP<StepperIMEX_RK_Partition<Scalar> >
526 std::string stepperType,
527 Teuchos::RCP<Teuchos::ParameterList> pl);
Time-derivative interface for Partitioned IMEX RK.
Teuchos::RCP< const Thyra::VectorBase< Scalar > > xTilde_
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.
virtual ~StepperIMEX_RKPartTimeDerivative()
Destructor.
StepperIMEX_RKPartTimeDerivative(Scalar s, Teuchos::RCP< const Thyra::VectorBase< Scalar > > xTilde)
Constructor.
virtual void initialize(Scalar s, Teuchos::RCP< const Thyra::VectorBase< Scalar > > xTilde)
Partitioned Implicit-Explicit Runge-Kutta (IMEX-RK) time stepper.
Teuchos::RCP< Thyra::VectorBase< Scalar > > & getXTilde()
virtual bool isExplicitImplicit() const
virtual void setModelPair(const Teuchos::RCP< WrapperModelEvaluatorPairPartIMEX_Basic< Scalar > > &modelPair)
Create WrapperModelPairIMEX from user-supplied ModelEvaluator pair.
virtual Scalar getBeta(const Scalar) const
Return beta = d(x)/dx.
void setOrder(Scalar order)
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.
StepperIMEX_RK_Partition(std::string stepperType="Partitioned IMEX RK SSP2")
Default constructor.
virtual Teuchos::RCP< Tempus::StepperState< Scalar > > getDefaultStepperState()
Provide a StepperState to the SolutionState. This Stepper does not have any special state data,...
virtual Teuchos::RCP< const RKButcherTableau< Scalar > > getExplicitTableau() const
Return explicit tableau.
virtual bool isImplicit() const
virtual bool isOneStepMethod() const
virtual void describe(Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel) const
std::vector< Teuchos::RCP< Thyra::VectorBase< Scalar > > > & getStageF()
virtual Teuchos::RCP< const RKButcherTableau< Scalar > > getImplicitTableau() const
Return implicit tableau.
virtual void setExplicitTableau(Teuchos::RCP< const RKButcherTableau< Scalar > > explicitTableau)
Set the explicit tableau from tableau.
virtual Scalar getAlpha(const Scalar dt) const
Return alpha = d(xDot)/dx.
virtual Teuchos::RCP< const RKButcherTableau< Scalar > > getTableau() const
Returns the explicit tableau!
Teuchos::RCP< Thyra::VectorBase< Scalar > > xTilde_
virtual Scalar getOrderMin() const
virtual bool isExplicit() const
std::vector< Teuchos::RCP< Thyra::VectorBase< Scalar > > > & getStageGx()
Teuchos::RCP< const RKButcherTableau< Scalar > > explicitTableau_
virtual Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > getModel() const
virtual void setInitialConditions(const Teuchos::RCP< SolutionHistory< Scalar > > &solutionHistory)
Set the initial conditions and make them consistent.
virtual OrderODE getOrderODE() const
std::vector< Teuchos::RCP< Thyra::VectorBase< Scalar > > > stageF_
virtual void setModel(const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &appModel)
Set the model.
virtual bool isMultiStepMethod() const
virtual void setTableausPartition(Teuchos::RCP< Teuchos::ParameterList > pl, std::string stepperType)
virtual bool isValidSetup(Teuchos::FancyOStream &out) const
void evalImplicitModelExplicitly(const Teuchos::RCP< const Thyra::VectorBase< Scalar > > &X, const Teuchos::RCP< const Thyra::VectorBase< Scalar > > &Y, Scalar time, Scalar stepSize, Scalar stageNumber, const Teuchos::RCP< Thyra::VectorBase< Scalar > > &G) const
Teuchos::RCP< const Teuchos::ParameterList > getValidParameters() const
virtual void initialize()
Initialize during construction and after changing input parameters.
virtual void setImplicitTableau(Teuchos::RCP< const RKButcherTableau< Scalar > > implicitTableau)
Set the implicit tableau from tableau.
virtual void takeStep(const Teuchos::RCP< SolutionHistory< Scalar > > &solutionHistory)
Take the specified timestep, dt, and return true if successful.
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< const RKButcherTableau< Scalar > > implicitTableau_
virtual Scalar getOrder() const
std::vector< Teuchos::RCP< Thyra::VectorBase< Scalar > > > stageGx_
virtual Scalar getOrderMax() 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_Partition< Scalar > > createStepperIMEX_RK_Partition(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.