Tempus  Version of the Day
Time Integration
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
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 >:
Teuchos::Describable Teuchos::VerboseObject< Tempus::Integrator< Scalar > > Teuchos::LabeledObject Teuchos::VerboseObjectBase 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. More...
 
virtual Scalar getTime () const =0
 Get current time. More...
 
virtual int getIndex () const =0
 Get current index. More...
 
virtual Tempus::Status getStatus () const =0
 Get the Status. More...
 
virtual void setStatus (const Tempus::Status st)=0
 Set the Status. More...
 
virtual Teuchos::RCP< Stepper
< Scalar > > 
getStepper () const =0
 Get the stepper. More...
 
virtual Teuchos::RCP< const
SolutionHistory< Scalar > > 
getSolutionHistory () const =0
 Returns the SolutionHistory for this Integrator. More...
 
virtual Teuchos::RCP
< SolutionHistory< Scalar > > 
getNonConstSolutionHistory ()=0
 Returns the SolutionHistory for this Integrator. More...
 
virtual Teuchos::RCP< const
TimeStepControl< Scalar > > 
getTimeStepControl () const =0
 Returns the TimeStepControl for this Integrator. More...
 
virtual Teuchos::RCP
< TimeStepControl< Scalar > > 
getNonConstTimeStepControl ()=0
 
virtual Teuchos::RCP
< Teuchos::Time
getIntegratorTimer () const =0
 Returns the IntegratorTimer_ for this Integrator. More...
 
virtual Teuchos::RCP
< Teuchos::Time
getStepperTimer () const =0
 

Additional Inherited Members

- Public Member Functions inherited from Teuchos::Describable
virtual std::string description () const
 
virtual void describe (FancyOStream &out, const EVerbosityLevel verbLevel=verbLevel_default) const
 
void describe (std::ostream &out, const EVerbosityLevel verbLevel=verbLevel_default) const
 
virtual ~Describable ()
 
 LabeledObject ()
 
virtual ~LabeledObject ()
 
virtual void setObjectLabel (const std::string &objectLabel)
 
virtual std::string getObjectLabel () const
 
DescribableStreamManipulatorState describe (const Describable &describable, const EVerbosityLevel verbLevel=Describable::verbLevel_default)
 
std::ostream & operator<< (std::ostream &os, const DescribableStreamManipulatorState &d)
 
- Public Member Functions inherited from Teuchos::VerboseObject< Tempus::Integrator< Scalar > >
 VerboseObject (const EVerbosityLevel verbLevel=VERB_DEFAULT, const RCP< FancyOStream > &oStream=Teuchos::null)
 
virtual const VerboseObjectsetVerbLevel (const EVerbosityLevel verbLevel) const
 
virtual const VerboseObjectsetOverridingVerbLevel (const EVerbosityLevel verbLevel) const
 
virtual EVerbosityLevel getVerbLevel () const
 
TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT
RCP< const ParameterList
getValidVerboseObjectSublist ()
 
TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT
void 
setupVerboseObjectSublist (ParameterList *paramList)
 
TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT
void 
readVerboseObjectSublist (ParameterList *paramList, RCP< FancyOStream > *oStream, EVerbosityLevel *verbLevel)
 
void readVerboseObjectSublist (ParameterList *paramList, VerboseObject< ObjectType > *verboseObject)
 
- Public Member Functions inherited from Teuchos::VerboseObjectBase
virtual ~VerboseObjectBase ()
 
 VerboseObjectBase (const RCP< FancyOStream > &oStream=Teuchos::null)
 
virtual const VerboseObjectBasesetOStream (const RCP< FancyOStream > &oStream) const
 
virtual const VerboseObjectBasesetOverridingOStream (const RCP< FancyOStream > &oStream) const
 
virtual VerboseObjectBasesetLinePrefix (const std::string &linePrefix)
 
virtual RCP< FancyOStreamgetOStream () const
 
virtual RCP< FancyOStreamgetOverridingOStream () const
 
virtual std::string getLinePrefix () const
 
virtual OSTab getOSTab (const int tabs=1, const std::string &linePrefix="") const
 
- Static Public Member Functions inherited from Teuchos::VerboseObject< Tempus::Integrator< Scalar > >
static void setDefaultVerbLevel (const EVerbosityLevel defaultVerbLevel)
 
static EVerbosityLevel getDefaultVerbLevel ()
 
- Static Public Member Functions inherited from Teuchos::VerboseObjectBase
static void setDefaultOStream (const RCP< FancyOStream > &defaultOStream)
 
static RCP< FancyOStreamgetDefaultOStream ()
 
- Static Public Attributes inherited from Teuchos::Describable
static const EVerbosityLevel verbLevel_default
 
- Protected Member Functions inherited from Teuchos::VerboseObject< Tempus::Integrator< Scalar > >
void initializeVerboseObject (const EVerbosityLevel verbLevel=VERB_DEFAULT, const RCP< FancyOStream > &oStream=Teuchos::null)
 
- Protected Member Functions inherited from Teuchos::VerboseObjectBase
void initializeVerboseObjectBase (const RCP< FancyOStream > &oStream=Teuchos::null)
 
virtual void informUpdatedVerbosityState () const
 

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

template<class Scalar>
virtual bool Tempus::Integrator< Scalar >::advanceTime ( const Scalar  time_final)
pure virtual
template<class Scalar>
virtual Scalar Tempus::Integrator< Scalar >::getTime ( ) const
pure virtual
template<class Scalar>
virtual int Tempus::Integrator< Scalar >::getIndex ( ) const
pure virtual
template<class Scalar>
virtual Tempus::Status Tempus::Integrator< Scalar >::getStatus ( ) const
pure virtual
template<class Scalar>
virtual void Tempus::Integrator< Scalar >::setStatus ( const Tempus::Status  st)
pure virtual
template<class Scalar>
virtual Teuchos::RCP<Stepper<Scalar> > Tempus::Integrator< Scalar >::getStepper ( ) const
pure virtual
template<class Scalar>
virtual Teuchos::RCP<const SolutionHistory<Scalar> > Tempus::Integrator< Scalar >::getSolutionHistory ( ) const
pure virtual
template<class Scalar>
virtual Teuchos::RCP<SolutionHistory<Scalar> > Tempus::Integrator< Scalar >::getNonConstSolutionHistory ( )
pure virtual
template<class Scalar>
virtual Teuchos::RCP<const TimeStepControl<Scalar> > Tempus::Integrator< Scalar >::getTimeStepControl ( ) const
pure virtual
template<class Scalar>
virtual Teuchos::RCP<TimeStepControl<Scalar> > Tempus::Integrator< Scalar >::getNonConstTimeStepControl ( )
pure virtual
template<class Scalar>
virtual Teuchos::RCP<Teuchos::Time> Tempus::Integrator< Scalar >::getIntegratorTimer ( ) const
pure virtual
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: