Tempus Version of the Day
Time Integration
Loading...
Searching...
No Matches
List of all members
Tempus::Integrator< Scalar > Class Template Referenceabstract

Thyra Base interface for time integrators. Time integrators are designed to advance the solution from an initial time, $t_0$, to a final time, $t_f$. More...

#include <Tempus_Integrator.hpp>

Inheritance diagram for Tempus::Integrator< Scalar >:
Tempus::IntegratorAdjointSensitivity< Scalar > Tempus::IntegratorBasic< Scalar > Tempus::IntegratorForwardSensitivity< Scalar > Tempus::IntegratorPseudoTransientAdjointSensitivity< Scalar > Tempus::IntegratorPseudoTransientForwardSensitivity< Scalar >

Basic integrator methods

virtual bool advanceTime (const Scalar time_final)=0
 Advance the solution to time, and return true if successful.
 
virtual Scalar getTime () const =0
 Get current time.
 
virtual int getIndex () const =0
 Get current index.
 
virtual Tempus::Status getStatus () const =0
 Get the Status.
 
virtual void setStatus (const Tempus::Status st)=0
 Set the Status.
 
virtual Teuchos::RCP< Stepper< Scalar > > getStepper () const =0
 Get the stepper.
 
virtual Teuchos::RCP< const SolutionHistory< Scalar > > getSolutionHistory () const =0
 Returns the SolutionHistory for this Integrator.
 
virtual Teuchos::RCP< SolutionHistory< Scalar > > getNonConstSolutionHistory ()=0
 Returns the SolutionHistory for this Integrator.
 
virtual Teuchos::RCP< const TimeStepControl< Scalar > > getTimeStepControl () const =0
 Returns the TimeStepControl for this Integrator.
 
virtual Teuchos::RCP< TimeStepControl< Scalar > > getNonConstTimeStepControl ()=0
 
virtual Teuchos::RCP< Teuchos::Time > getIntegratorTimer () const =0
 Returns the IntegratorTimer_ for this Integrator.
 
virtual Teuchos::RCP< Teuchos::Time > getStepperTimer () const =0
 

Detailed Description

template<class Scalar>
class Tempus::Integrator< Scalar >

Thyra Base interface for time integrators. Time integrators are designed to advance the solution from an initial time, $t_0$, to a final time, $t_f$.

Design Considerations

CS Design Considerations

Definition at line 62 of file Tempus_Integrator.hpp.

Member Function Documentation

◆ advanceTime()

template<class Scalar >
virtual bool Tempus::Integrator< Scalar >::advanceTime ( const Scalar time_final)
pure virtual

◆ getTime()

template<class Scalar >
virtual Scalar Tempus::Integrator< Scalar >::getTime ( ) const
pure virtual

◆ getIndex()

template<class Scalar >
virtual int Tempus::Integrator< Scalar >::getIndex ( ) const
pure virtual

◆ getStatus()

template<class Scalar >
virtual Tempus::Status Tempus::Integrator< Scalar >::getStatus ( ) const
pure virtual

◆ setStatus()

template<class Scalar >
virtual void Tempus::Integrator< Scalar >::setStatus ( const Tempus::Status st)
pure virtual

◆ getStepper()

template<class Scalar >
virtual Teuchos::RCP< Stepper< Scalar > > Tempus::Integrator< Scalar >::getStepper ( ) const
pure virtual

◆ getSolutionHistory()

template<class Scalar >
virtual Teuchos::RCP< const SolutionHistory< Scalar > > Tempus::Integrator< Scalar >::getSolutionHistory ( ) const
pure virtual

◆ getNonConstSolutionHistory()

template<class Scalar >
virtual Teuchos::RCP< SolutionHistory< Scalar > > Tempus::Integrator< Scalar >::getNonConstSolutionHistory ( )
pure virtual

◆ getTimeStepControl()

template<class Scalar >
virtual Teuchos::RCP< const TimeStepControl< Scalar > > Tempus::Integrator< Scalar >::getTimeStepControl ( ) const
pure virtual

◆ getNonConstTimeStepControl()

template<class Scalar >
virtual Teuchos::RCP< TimeStepControl< Scalar > > Tempus::Integrator< Scalar >::getNonConstTimeStepControl ( )
pure virtual

◆ getIntegratorTimer()

template<class Scalar >
virtual Teuchos::RCP< Teuchos::Time > Tempus::Integrator< Scalar >::getIntegratorTimer ( ) const
pure virtual

◆ getStepperTimer()

template<class Scalar >
virtual Teuchos::RCP< Teuchos::Time > Tempus::Integrator< Scalar >::getStepperTimer ( ) const
pure virtual

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