Tempus::StepperState< Scalar > Class Template Reference

StepperState is a simple class to hold state information about the stepper. More...

#include <Tempus_StepperState.hpp>

Inheritance diagram for Tempus::StepperState< Scalar >:

Public Member Functions
	StepperState (std::string name="Default")
	Constructor. More...
virtual Teuchos::RCP < StepperState< Scalar > >	clone () const
	Clone copy constructor. More...
virtual void	copy (const Teuchos::RCP< const StepperState< Scalar > > &ss)
	This is a deep copy. More...
Overridden from Teuchos::Describable
virtual std::string	description () const
virtual void	describe (Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel) const

Public Attributes
std::string	stepperName_
	Name of the creating Stepper. More...

Detailed Description

template<class Scalar>
class Tempus::StepperState< Scalar >

StepperState is a simple class to hold state information about the stepper.

Design Considerations

• The purpose of StepperState is to provide a means to store any stepper information that is required to restart from a checkpoint.
• The StepperState should be held by the SolutionState so that it has all the information needed to restart the solution.
• Many Steppers will simply need this base class, because they do not have any other additional state information.
• StepperState can be inherited to expand the state information.
• Examples of other information that could be included in derived StepperStates:
  • Metadata and SolutionHistory for a BDF method
• The base class currently has the Stepper name so the Stepper can check if the StepperState is usable.

Definition at line 36 of file Tempus_StepperState.hpp.

Constructor & Destructor Documentation

template<class Scalar >

Tempus::StepperState< Scalar >::StepperState ( std::string  name = "Default" )

inline

Constructor.

Definition at line 43 of file Tempus_StepperState.hpp.

Member Function Documentation

template<class Scalar >

virtual Teuchos::RCP<StepperState<Scalar> > Tempus::StepperState< Scalar >::clone ( ) const

inlinevirtual

Clone copy constructor.

Definition at line 46 of file Tempus_StepperState.hpp.

template<class Scalar >

virtual void Tempus::StepperState< Scalar >::copy ( const Teuchos::RCP< const StepperState< Scalar > > &  ss )

inlinevirtual

This is a deep copy.

Definition at line 54 of file Tempus_StepperState.hpp.

template<class Scalar >

virtual void Tempus::StepperState< Scalar >::describe ( Teuchos::FancyOStream &  out, const Teuchos::EVerbosityLevel    ) const

inlinevirtual

Definition at line 63 of file Tempus_StepperState.hpp.

template<class Scalar >

virtual std::string Tempus::StepperState< Scalar >::description ( ) const

inlinevirtual

Definition at line 61 of file Tempus_StepperState.hpp.

Member Data Documentation

template<class Scalar >

std::string Tempus::StepperState< Scalar >::stepperName_

Name of the creating Stepper.

Definition at line 71 of file Tempus_StepperState.hpp.

---

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

• http://docs.trilinos.org/r13.0/packages/tempus/src/Tempus_StepperState.hpp