Tempus  Version of the Day
Time Integration
List of all members
Tempus::Stepper< Scalar > Class Template Referenceabstract

Thyra Base interface for time steppers. More...

#include <Tempus_Integrator.hpp>

Inheritance diagram for Tempus::Stepper< Scalar >:
Tempus::StepperExplicitRK< Scalar > Tempus::StepperForwardEuler< Scalar > Tempus::StepperImplicit< Scalar > Tempus::StepperLeapfrog< Scalar > Tempus::StepperNewmarkExplicitAForm< Scalar > Tempus::StepperOperatorSplit< Scalar > Tempus::StepperStaggeredForwardSensitivity< Scalar > Tempus_Test::PhysicsStateTest_StepperForwardEuler< Scalar > Tempus::StepperBackwardEuler< Scalar > Tempus::StepperBDF2< Scalar > Tempus::StepperDIRK< Scalar > Tempus::StepperHHTAlpha< Scalar > Tempus::StepperIMEX_RK< Scalar > Tempus::StepperIMEX_RK_Partition< Scalar > Tempus::StepperNewmarkImplicitAForm< Scalar > Tempus::StepperNewmarkImplicitDForm< Scalar > Tempus::StepperTrapezoidal< Scalar >

Public Member Functions

Basic stepper methods
virtual void setModel (const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &appModel)=0
 
virtual void setNonConstModel (const Teuchos::RCP< Thyra::ModelEvaluator< Scalar > > &appModel)=0
 
virtual Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > getModel ()=0
 
virtual void setSolver (std::string solverName)=0
 Set solver via ParameterList solver name. More...
 
virtual void setSolver (Teuchos::RCP< Teuchos::ParameterList > solverPL=Teuchos::null)=0
 Set solver via solver ParameterList. More...
 
virtual void setSolver (Teuchos::RCP< Thyra::NonlinearSolverBase< Scalar > > solver)=0
 Set solver. More...
 
virtual Teuchos::RCP< Thyra::NonlinearSolverBase< Scalar > > getSolver () const =0
 Get solver. More...
 
virtual void setObserver (Teuchos::RCP< StepperObserver< Scalar > > obs=Teuchos::null)=0
 Set Observer. More...
 
virtual void initialize ()=0
 Initialize during construction and after changing input parameters. More...
 
virtual void takeStep (const Teuchos::RCP< SolutionHistory< Scalar > > &solutionHistory)=0
 Take the specified timestep, dt, and return true if successful. More...
 
virtual void setInitialGuess (Teuchos::RCP< const Thyra::VectorBase< Scalar > > initial_guess=Teuchos::null)=0
 Pass initial guess to Newton solver (for implicit schemes) More...
 
virtual std::string getStepperType () const =0
 
virtual Teuchos::RCP< Tempus::StepperState< Scalar > > getDefaultStepperState ()=0
 
virtual Scalar getOrder () const =0
 
virtual Scalar getOrderMin () const =0
 
virtual Scalar getOrderMax () const =0
 
virtual Scalar getInitTimeStep (const Teuchos::RCP< SolutionHistory< Scalar > > &solutionHistory) const =0
 
virtual Teuchos::RCP< Teuchos::ParameterList > getDefaultParameters () const =0
 
virtual bool isExplicit () const =0
 
virtual bool isImplicit () const =0
 
virtual bool isExplicitImplicit () const =0
 
virtual bool isOneStepMethod () const =0
 
virtual bool isMultiStepMethod () const =0
 
Functions for Steppers with subSteppers (e.g., OperatorSplit)
virtual void createSubSteppers (std::vector< Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > > models)
 
Helper functions
void validExplicitODE (const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &model) const
 Validate that the model supports explicit ODE evaluation, f(x,t) [=xdot]. More...
 
void validSecondOrderExplicitODE (const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &model) const
 Validate that the model supports explicit second order ODE evaluation, f(x,xdot,t) [=xdotdot]. More...
 
void validImplicitODE_DAE (const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &model) const
 Validate ME supports implicit ODE/DAE evaluation, f(xdot,x,t) [= 0]. More...
 
void validSecondOrderODE_DAE (const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &model) const
 Validate ME supports 2nd order implicit ODE/DAE evaluation, f(xdotdot,xdot,x,t) [= 0]. More...
 
Teuchos::RCP< Teuchos::ParameterList > defaultSolverParameters () const
 

Detailed Description

template<class Scalar>
class Tempus::Stepper< Scalar >

Thyra Base interface for time steppers.

Design Considerations

  • Time steppers are designed to take a single time step.
    • a single implicit solve for a time step
    • a single solve for a IMEX time step
  • Multiple time steps should be managed by Integrators.
  • Steppers can be built from other Sub-Steppers.
    • An operator-split Stepper is possible with interoperable Steppers.
  • For explicit steppers, only one ModelEvaluator and one solution vector are required.
  • For implicit steppers, only one ModelEvaluator, one solution vector, and one solver are required.
  • Steppers will PASS/FAIL the time step based on Solver, error and order requirements, and not adjust the time step size.
  • Steppers can provide a suggested time step size for the next time step.
  • For more complex steppers, multiple ModelEvaluators, solution vectors, and solvers are possible when a common single time-integration method is desired for all solutions. Examples:
    • Solution A with ModelEvaluator A and Solution B with ModelEvaluator B using the same solver
    • Solution A with ModelEvaluator A using Solver A and Solution B with ModelEvaluator B using Solver B
    • Solution A with ModelEvaluator A using Solver A and Solutions A and B with ModelEvaluator C using Solver B
  • Steppers may maintain their own time history of the solution, e.g., BDF steppers.

CS Design Considerations

  • All input parameters (i.e., ParameterList) can be set by public methods.
  • The Stepper ParameterList must be consistent.
    • The "set" methods which update parameters in the ParameterList must update the Stepper ParameterList.

Definition at line 24 of file Tempus_Integrator.hpp.

Member Function Documentation

◆ createSubSteppers()

template<class Scalar>
virtual void Tempus::Stepper< Scalar >::createSubSteppers ( std::vector< Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > >  models)
inlinevirtual

Reimplemented in Tempus::StepperOperatorSplit< Scalar >.

Definition at line 130 of file Tempus_Stepper.hpp.

◆ defaultSolverParameters()

template<class Scalar>
Teuchos::RCP<Teuchos::ParameterList> Tempus::Stepper< Scalar >::defaultSolverParameters ( ) const
inline

Definition at line 293 of file Tempus_Stepper.hpp.

◆ getDefaultParameters()

template<class Scalar>
virtual Teuchos::RCP<Teuchos::ParameterList> Tempus::Stepper< Scalar >::getDefaultParameters ( ) const
pure virtual

Implemented in Tempus::StepperIMEX_RK< Scalar >, Tempus::StepperIMEX_RK_Partition< Scalar >, Tempus::StepperDIRK< Scalar >, Tempus::StepperExplicitRK< Scalar >, Tempus::StepperOperatorSplit< Scalar >, Tempus::StepperLeapfrog< Scalar >, Tempus::StepperStaggeredForwardSensitivity< Scalar >, Tempus::StepperForwardEuler< Scalar >, Tempus::StepperBDF2< Scalar >, Tempus::StepperNewmarkImplicitDForm< Scalar >, Tempus::StepperNewmarkImplicitAForm< Scalar >, Tempus::StepperBackwardEuler< Scalar >, Tempus::StepperHHTAlpha< Scalar >, Tempus::StepperNewmarkExplicitAForm< Scalar >, and Tempus::StepperTrapezoidal< Scalar >.

◆ getDefaultStepperState()

template<class Scalar>
virtual Teuchos::RCP<Tempus::StepperState<Scalar> > Tempus::Stepper< Scalar >::getDefaultStepperState ( )
pure virtual

Implemented in Tempus::StepperIMEX_RK< Scalar >, Tempus::StepperIMEX_RK_Partition< Scalar >, Tempus::StepperExplicitRK< Scalar >, Tempus::StepperDIRK< Scalar >, Tempus::StepperLeapfrog< Scalar >, Tempus::StepperStaggeredForwardSensitivity< Scalar >, Tempus::StepperOperatorSplit< Scalar >, Tempus::StepperForwardEuler< Scalar >, Tempus::StepperBDF2< Scalar >, Tempus::StepperHHTAlpha< Scalar >, Tempus::StepperNewmarkImplicitAForm< Scalar >, Tempus::StepperNewmarkExplicitAForm< Scalar >, Tempus::StepperNewmarkImplicitDForm< Scalar >, Tempus::StepperBackwardEuler< Scalar >, and Tempus::StepperTrapezoidal< Scalar >.

◆ getInitTimeStep()

template<class Scalar>
virtual Scalar Tempus::Stepper< Scalar >::getInitTimeStep ( const Teuchos::RCP< SolutionHistory< Scalar > > &  solutionHistory) const
pure virtual

Implemented in Tempus::StepperExplicitRK< Scalar >, Tempus::StepperLeapfrog< Scalar >, Tempus::StepperStaggeredForwardSensitivity< Scalar >, Tempus::StepperOperatorSplit< Scalar >, Tempus::StepperForwardEuler< Scalar >, Tempus::StepperNewmarkExplicitAForm< Scalar >, and Tempus::StepperImplicit< Scalar >.

◆ getModel()

template<class Scalar>
virtual Teuchos::RCP<const Thyra::ModelEvaluator<Scalar> > Tempus::Stepper< Scalar >::getModel ( )
pure virtual

Implemented in Tempus::StepperIMEX_RK< Scalar >, Tempus::StepperIMEX_RK_Partition< Scalar >, Tempus::StepperExplicitRK< Scalar >, Tempus::StepperLeapfrog< Scalar >, Tempus::StepperStaggeredForwardSensitivity< Scalar >, Tempus::StepperForwardEuler< Scalar >, Tempus::StepperOperatorSplit< Scalar >, Tempus::StepperNewmarkExplicitAForm< Scalar >, and Tempus::StepperImplicit< Scalar >.

◆ getOrder()

template<class Scalar>
virtual Scalar Tempus::Stepper< Scalar >::getOrder ( ) const
pure virtual

Implemented in Tempus::StepperIMEX_RK< Scalar >, Tempus::StepperIMEX_RK_Partition< Scalar >, Tempus::StepperExplicitRK< Scalar >, Tempus::StepperDIRK< Scalar >, Tempus::StepperLeapfrog< Scalar >, Tempus::StepperStaggeredForwardSensitivity< Scalar >, Tempus::StepperOperatorSplit< Scalar >, Tempus::StepperForwardEuler< Scalar >, Tempus::StepperBDF2< Scalar >, Tempus::StepperHHTAlpha< Scalar >, Tempus::StepperNewmarkImplicitAForm< Scalar >, Tempus::StepperNewmarkImplicitDForm< Scalar >, Tempus::StepperNewmarkExplicitAForm< Scalar >, Tempus::StepperBackwardEuler< Scalar >, and Tempus::StepperTrapezoidal< Scalar >.

◆ getOrderMax()

template<class Scalar>
virtual Scalar Tempus::Stepper< Scalar >::getOrderMax ( ) const
pure virtual

Implemented in Tempus::StepperIMEX_RK< Scalar >, Tempus::StepperIMEX_RK_Partition< Scalar >, Tempus::StepperExplicitRK< Scalar >, Tempus::StepperDIRK< Scalar >, Tempus::StepperLeapfrog< Scalar >, Tempus::StepperStaggeredForwardSensitivity< Scalar >, Tempus::StepperOperatorSplit< Scalar >, Tempus::StepperForwardEuler< Scalar >, Tempus::StepperNewmarkImplicitDForm< Scalar >, Tempus::StepperHHTAlpha< Scalar >, Tempus::StepperNewmarkImplicitAForm< Scalar >, Tempus::StepperBDF2< Scalar >, Tempus::StepperNewmarkExplicitAForm< Scalar >, Tempus::StepperBackwardEuler< Scalar >, and Tempus::StepperTrapezoidal< Scalar >.

◆ getOrderMin()

template<class Scalar>
virtual Scalar Tempus::Stepper< Scalar >::getOrderMin ( ) const
pure virtual

Implemented in Tempus::StepperIMEX_RK< Scalar >, Tempus::StepperIMEX_RK_Partition< Scalar >, Tempus::StepperExplicitRK< Scalar >, Tempus::StepperDIRK< Scalar >, Tempus::StepperLeapfrog< Scalar >, Tempus::StepperStaggeredForwardSensitivity< Scalar >, Tempus::StepperOperatorSplit< Scalar >, Tempus::StepperForwardEuler< Scalar >, Tempus::StepperNewmarkImplicitDForm< Scalar >, Tempus::StepperHHTAlpha< Scalar >, Tempus::StepperNewmarkImplicitAForm< Scalar >, Tempus::StepperBDF2< Scalar >, Tempus::StepperNewmarkExplicitAForm< Scalar >, Tempus::StepperBackwardEuler< Scalar >, and Tempus::StepperTrapezoidal< Scalar >.

◆ getSolver()

template<class Scalar>
virtual Teuchos::RCP<Thyra::NonlinearSolverBase<Scalar> > Tempus::Stepper< Scalar >::getSolver ( ) const
pure virtual

Get solver.

Implemented in Tempus::StepperExplicitRK< Scalar >, Tempus::StepperLeapfrog< Scalar >, Tempus::StepperStaggeredForwardSensitivity< Scalar >, Tempus::StepperForwardEuler< Scalar >, Tempus::StepperOperatorSplit< Scalar >, Tempus::StepperNewmarkExplicitAForm< Scalar >, and Tempus::StepperImplicit< Scalar >.

◆ getStepperType()

template<class Scalar>
virtual std::string Tempus::Stepper< Scalar >::getStepperType ( ) const
pure virtual

Implemented in Tempus::StepperExplicitRK< Scalar >, Tempus::StepperLeapfrog< Scalar >, Tempus::StepperStaggeredForwardSensitivity< Scalar >, Tempus::StepperOperatorSplit< Scalar >, Tempus::StepperForwardEuler< Scalar >, Tempus::StepperNewmarkExplicitAForm< Scalar >, and Tempus::StepperImplicit< Scalar >.

◆ initialize()

template<class Scalar>
virtual void Tempus::Stepper< Scalar >::initialize ( )
pure virtual

Initialize during construction and after changing input parameters.

Implemented in Tempus::StepperIMEX_RK< Scalar >, Tempus::StepperIMEX_RK_Partition< Scalar >, Tempus::StepperDIRK< Scalar >, Tempus::StepperExplicitRK< Scalar >, Tempus::StepperLeapfrog< Scalar >, Tempus::StepperStaggeredForwardSensitivity< Scalar >, Tempus::StepperForwardEuler< Scalar >, Tempus::StepperOperatorSplit< Scalar >, Tempus::StepperBDF2< Scalar >, Tempus::StepperNewmarkImplicitAForm< Scalar >, Tempus::StepperHHTAlpha< Scalar >, Tempus::StepperNewmarkImplicitDForm< Scalar >, Tempus::StepperBackwardEuler< Scalar >, Tempus::StepperNewmarkExplicitAForm< Scalar >, and Tempus::StepperTrapezoidal< Scalar >.

◆ isExplicit()

template<class Scalar>
virtual bool Tempus::Stepper< Scalar >::isExplicit ( ) const
pure virtual

Implemented in Tempus::StepperIMEX_RK< Scalar >, Tempus::StepperIMEX_RK_Partition< Scalar >, Tempus::StepperExplicitRK< Scalar >, Tempus::StepperDIRK< Scalar >, Tempus::StepperLeapfrog< Scalar >, Tempus::StepperStaggeredForwardSensitivity< Scalar >, Tempus::StepperOperatorSplit< Scalar >, Tempus::StepperForwardEuler< Scalar >, Tempus::StepperNewmarkImplicitDForm< Scalar >, Tempus::StepperHHTAlpha< Scalar >, Tempus::StepperNewmarkExplicitAForm< Scalar >, Tempus::StepperNewmarkImplicitAForm< Scalar >, Tempus::StepperBDF2< Scalar >, Tempus::StepperBackwardEuler< Scalar >, and Tempus::StepperTrapezoidal< Scalar >.

◆ isExplicitImplicit()

template<class Scalar>
virtual bool Tempus::Stepper< Scalar >::isExplicitImplicit ( ) const
pure virtual

Implemented in Tempus::StepperIMEX_RK< Scalar >, Tempus::StepperIMEX_RK_Partition< Scalar >, Tempus::StepperDIRK< Scalar >, Tempus::StepperExplicitRK< Scalar >, Tempus::StepperLeapfrog< Scalar >, Tempus::StepperOperatorSplit< Scalar >, Tempus::StepperStaggeredForwardSensitivity< Scalar >, Tempus::StepperForwardEuler< Scalar >, Tempus::StepperNewmarkImplicitDForm< Scalar >, Tempus::StepperHHTAlpha< Scalar >, Tempus::StepperNewmarkExplicitAForm< Scalar >, Tempus::StepperNewmarkImplicitAForm< Scalar >, Tempus::StepperBDF2< Scalar >, Tempus::StepperBackwardEuler< Scalar >, and Tempus::StepperTrapezoidal< Scalar >.

◆ isImplicit()

template<class Scalar>
virtual bool Tempus::Stepper< Scalar >::isImplicit ( ) const
pure virtual

Implemented in Tempus::StepperIMEX_RK< Scalar >, Tempus::StepperIMEX_RK_Partition< Scalar >, Tempus::StepperDIRK< Scalar >, Tempus::StepperExplicitRK< Scalar >, Tempus::StepperLeapfrog< Scalar >, Tempus::StepperStaggeredForwardSensitivity< Scalar >, Tempus::StepperOperatorSplit< Scalar >, Tempus::StepperForwardEuler< Scalar >, Tempus::StepperNewmarkImplicitDForm< Scalar >, Tempus::StepperHHTAlpha< Scalar >, Tempus::StepperNewmarkExplicitAForm< Scalar >, Tempus::StepperNewmarkImplicitAForm< Scalar >, Tempus::StepperBDF2< Scalar >, Tempus::StepperBackwardEuler< Scalar >, and Tempus::StepperTrapezoidal< Scalar >.

◆ isMultiStepMethod()

template<class Scalar>
virtual bool Tempus::Stepper< Scalar >::isMultiStepMethod ( ) const
pure virtual

Implemented in Tempus::StepperIMEX_RK< Scalar >, Tempus::StepperIMEX_RK_Partition< Scalar >, Tempus::StepperDIRK< Scalar >, Tempus::StepperExplicitRK< Scalar >, Tempus::StepperOperatorSplit< Scalar >, Tempus::StepperLeapfrog< Scalar >, Tempus::StepperStaggeredForwardSensitivity< Scalar >, Tempus::StepperForwardEuler< Scalar >, Tempus::StepperNewmarkImplicitDForm< Scalar >, Tempus::StepperHHTAlpha< Scalar >, Tempus::StepperNewmarkExplicitAForm< Scalar >, Tempus::StepperNewmarkImplicitAForm< Scalar >, Tempus::StepperBDF2< Scalar >, Tempus::StepperBackwardEuler< Scalar >, and Tempus::StepperTrapezoidal< Scalar >.

◆ isOneStepMethod()

template<class Scalar>
virtual bool Tempus::Stepper< Scalar >::isOneStepMethod ( ) const
pure virtual

Implemented in Tempus::StepperIMEX_RK< Scalar >, Tempus::StepperIMEX_RK_Partition< Scalar >, Tempus::StepperDIRK< Scalar >, Tempus::StepperExplicitRK< Scalar >, Tempus::StepperLeapfrog< Scalar >, Tempus::StepperOperatorSplit< Scalar >, Tempus::StepperStaggeredForwardSensitivity< Scalar >, Tempus::StepperForwardEuler< Scalar >, Tempus::StepperNewmarkImplicitDForm< Scalar >, Tempus::StepperHHTAlpha< Scalar >, Tempus::StepperNewmarkExplicitAForm< Scalar >, Tempus::StepperNewmarkImplicitAForm< Scalar >, Tempus::StepperBDF2< Scalar >, Tempus::StepperBackwardEuler< Scalar >, and Tempus::StepperTrapezoidal< Scalar >.

◆ setInitialGuess()

template<class Scalar>
virtual void Tempus::Stepper< Scalar >::setInitialGuess ( Teuchos::RCP< const Thyra::VectorBase< Scalar > >  initial_guess = Teuchos::null)
pure virtual

Pass initial guess to Newton solver (for implicit schemes)

Implemented in Tempus::StepperIMEX_RK_Partition< Scalar >, Tempus::StepperIMEX_RK< Scalar >, Tempus::StepperDIRK< Scalar >, Tempus::StepperStaggeredForwardSensitivity< Scalar >, Tempus::StepperExplicitRK< Scalar >, Tempus::StepperLeapfrog< Scalar >, Tempus::StepperForwardEuler< Scalar >, Tempus::StepperBDF2< Scalar >, Tempus::StepperNewmarkImplicitAForm< Scalar >, Tempus::StepperOperatorSplit< Scalar >, Tempus::StepperTrapezoidal< Scalar >, Tempus::StepperHHTAlpha< Scalar >, Tempus::StepperNewmarkImplicitDForm< Scalar >, Tempus::StepperBackwardEuler< Scalar >, Tempus::StepperNewmarkExplicitAForm< Scalar >, and Tempus::StepperImplicit< Scalar >.

◆ setModel()

template<class Scalar>
virtual void Tempus::Stepper< Scalar >::setModel ( const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &  appModel)
pure virtual

Implemented in Tempus::StepperIMEX_RK< Scalar >, Tempus::StepperIMEX_RK_Partition< Scalar >, Tempus::StepperExplicitRK< Scalar >, Tempus::StepperLeapfrog< Scalar >, Tempus::StepperStaggeredForwardSensitivity< Scalar >, Tempus::StepperForwardEuler< Scalar >, Tempus::StepperNewmarkImplicitAForm< Scalar >, Tempus::StepperHHTAlpha< Scalar >, Tempus::StepperOperatorSplit< Scalar >, Tempus::StepperNewmarkExplicitAForm< Scalar >, and Tempus::StepperImplicit< Scalar >.

◆ setNonConstModel()

template<class Scalar>
virtual void Tempus::Stepper< Scalar >::setNonConstModel ( const Teuchos::RCP< Thyra::ModelEvaluator< Scalar > > &  appModel)
pure virtual

Implemented in Tempus::StepperExplicitRK< Scalar >, Tempus::StepperLeapfrog< Scalar >, Tempus::StepperStaggeredForwardSensitivity< Scalar >, Tempus::StepperForwardEuler< Scalar >, Tempus::StepperOperatorSplit< Scalar >, Tempus::StepperNewmarkExplicitAForm< Scalar >, and Tempus::StepperImplicit< Scalar >.

◆ setObserver()

template<class Scalar>
virtual void Tempus::Stepper< Scalar >::setObserver ( Teuchos::RCP< StepperObserver< Scalar > >  obs = Teuchos::null)
pure virtual

Set Observer.

Implemented in Tempus::StepperIMEX_RK< Scalar >, Tempus::StepperIMEX_RK_Partition< Scalar >, Tempus::StepperDIRK< Scalar >, Tempus::StepperExplicitRK< Scalar >, Tempus::StepperLeapfrog< Scalar >, Tempus::StepperStaggeredForwardSensitivity< Scalar >, Tempus::StepperForwardEuler< Scalar >, Tempus::StepperOperatorSplit< Scalar >, Tempus::StepperNewmarkImplicitAForm< Scalar >, Tempus::StepperBDF2< Scalar >, Tempus::StepperHHTAlpha< Scalar >, Tempus::StepperNewmarkImplicitDForm< Scalar >, Tempus::StepperNewmarkExplicitAForm< Scalar >, Tempus::StepperBackwardEuler< Scalar >, and Tempus::StepperTrapezoidal< Scalar >.

◆ setSolver() [1/3]

template<class Scalar>
virtual void Tempus::Stepper< Scalar >::setSolver ( std::string  solverName)
pure virtual

Set solver via ParameterList solver name.

Implemented in Tempus::StepperExplicitRK< Scalar >, Tempus::StepperLeapfrog< Scalar >, Tempus::StepperStaggeredForwardSensitivity< Scalar >, Tempus::StepperForwardEuler< Scalar >, Tempus::StepperOperatorSplit< Scalar >, Tempus::StepperNewmarkExplicitAForm< Scalar >, and Tempus::StepperImplicit< Scalar >.

◆ setSolver() [2/3]

template<class Scalar>
virtual void Tempus::Stepper< Scalar >::setSolver ( Teuchos::RCP< Teuchos::ParameterList >  solverPL = Teuchos::null)
pure virtual

Set solver via solver ParameterList.

Implemented in Tempus::StepperExplicitRK< Scalar >, Tempus::StepperLeapfrog< Scalar >, Tempus::StepperStaggeredForwardSensitivity< Scalar >, Tempus::StepperForwardEuler< Scalar >, Tempus::StepperOperatorSplit< Scalar >, Tempus::StepperNewmarkExplicitAForm< Scalar >, and Tempus::StepperImplicit< Scalar >.

◆ setSolver() [3/3]

template<class Scalar>
virtual void Tempus::Stepper< Scalar >::setSolver ( Teuchos::RCP< Thyra::NonlinearSolverBase< Scalar > >  solver)
pure virtual

Set solver.

Implemented in Tempus::StepperExplicitRK< Scalar >, Tempus::StepperLeapfrog< Scalar >, Tempus::StepperStaggeredForwardSensitivity< Scalar >, Tempus::StepperForwardEuler< Scalar >, Tempus::StepperOperatorSplit< Scalar >, Tempus::StepperNewmarkExplicitAForm< Scalar >, and Tempus::StepperImplicit< Scalar >.

◆ takeStep()

template<class Scalar>
virtual void Tempus::Stepper< Scalar >::takeStep ( const Teuchos::RCP< SolutionHistory< Scalar > > &  solutionHistory)
pure virtual

Take the specified timestep, dt, and return true if successful.

Implemented in Tempus::StepperIMEX_RK< Scalar >, Tempus::StepperIMEX_RK_Partition< Scalar >, Tempus::StepperDIRK< Scalar >, Tempus::StepperExplicitRK< Scalar >, Tempus::StepperLeapfrog< Scalar >, Tempus::StepperStaggeredForwardSensitivity< Scalar >, Tempus::StepperForwardEuler< Scalar >, Tempus::StepperOperatorSplit< Scalar >, Tempus::StepperBDF2< Scalar >, Tempus::StepperNewmarkImplicitAForm< Scalar >, Tempus::StepperHHTAlpha< Scalar >, Tempus::StepperBackwardEuler< Scalar >, Tempus::StepperNewmarkExplicitAForm< Scalar >, and Tempus::StepperTrapezoidal< Scalar >.

◆ validExplicitODE()

template<class Scalar>
void Tempus::Stepper< Scalar >::validExplicitODE ( const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &  model) const
inline

Validate that the model supports explicit ODE evaluation, f(x,t) [=xdot].

Currently the convention to evaluate f(x,t) is to set xdot=null! There is no InArgs support to test if xdot is null, so we set xdot=null and hopefully the ModelEvaluator can handle it.

Definition at line 141 of file Tempus_Stepper.hpp.

◆ validImplicitODE_DAE()

template<class Scalar>
void Tempus::Stepper< Scalar >::validImplicitODE_DAE ( const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &  model) const
inline

Validate ME supports implicit ODE/DAE evaluation, f(xdot,x,t) [= 0].

Definition at line 202 of file Tempus_Stepper.hpp.

◆ validSecondOrderExplicitODE()

template<class Scalar>
void Tempus::Stepper< Scalar >::validSecondOrderExplicitODE ( const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &  model) const
inline

Validate that the model supports explicit second order ODE evaluation, f(x,xdot,t) [=xdotdot].

Currently the convention to evaluate f(x,xdot,t) is to set xdotdot=null! There is no InArgs support to test if xdotdot is null, so we set xdotdot=null and hopefully the ModelEvaluator can handle it.

Definition at line 171 of file Tempus_Stepper.hpp.

◆ validSecondOrderODE_DAE()

template<class Scalar>
void Tempus::Stepper< Scalar >::validSecondOrderODE_DAE ( const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &  model) const
inline

Validate ME supports 2nd order implicit ODE/DAE evaluation, f(xdotdot,xdot,x,t) [= 0].

Definition at line 246 of file Tempus_Stepper.hpp.

The documentation for this class was generated from the following files: