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 >:

[legend]

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 Teuchos::RCP< Stepper < Scalar > >	getStepper () const =0
	Get the stepper. More...

virtual Teuchos::RCP < Teuchos::ParameterList >	getTempusParameterList ()=0
	Return a copy of the Tempus ParameterList. More...

virtual void	setTempusParameterList (Teuchos::RCP< Teuchos::ParameterList > pl)=0

virtual Teuchos::RCP< const SolutionHistory< Scalar > >	getSolutionHistory () const =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 VerboseObject &	setVerbLevel (const EVerbosityLevel verbLevel) const

virtual const VerboseObject &	setOverridingVerbLevel (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 VerboseObjectBase &	setOStream (const RCP< FancyOStream > &oStream) const

virtual const VerboseObjectBase &	setOverridingOStream (const RCP< FancyOStream > &oStream) const

virtual VerboseObjectBase &	setLinePrefix (const std::string &linePrefix)

virtual RCP< FancyOStream >	getOStream () const

virtual RCP< FancyOStream >	getOverridingOStream () 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< FancyOStream >	getDefaultOStream ()

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

Integrators manage multiple time steps
Integrators have a single Stepper
Time-step ramping and startup are handled by TimeStepControl.
Solution output, e.g., solution plotting and check pointing, is coordinated in the Integrator.
Solution stability is handled in the timeStepControl, e.g., CFL constraint.
Error control over multiple time steps is handled in the Integrators, while error control over a single time step is handled in the Steppers.
Integrators will collect error control information from the Stepper and determine the next time step size and order.
Integrator maintains its own copy of the time history in the SolutionHistory, which may be just a single time step up to the entire solution history.
Integrators should compute the next time, and after accepting the time step advance the solution. This allows a simple undo capability, if a solution is not acceptable.

CS Design Considerations

Integrators will be fully constructed with input or default parameters.
All input parameters (i.e., ParameterList) can be set by public methods.
The Integrator ParameterList must be consistent.
- The "set" methods which update parameters in the ParameterList must update the Integrator ParameterList.

Definition at line 62 of file Tempus_Integrator.hpp.