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

Public Member Functions inherited from Teuchos::Describable
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::StepperState< 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

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

Overridden from Teuchos::Describable
virtual std::string	description () const

virtual void	describe (Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel) const

Additional Inherited Members
Static Public Member Functions inherited from Teuchos::VerboseObject< Tempus::StepperState< 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::StepperState< 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::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 37 of file Tempus_StepperState.hpp.

Constructor & Destructor Documentation

template<class Scalar >

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

inline

Constructor.

Definition at line 44 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 47 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 55 of file Tempus_StepperState.hpp.

template<class Scalar >

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

inlinevirtual

Reimplemented from Teuchos::Describable.

Definition at line 62 of file Tempus_StepperState.hpp.

template<class Scalar >

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

inlinevirtual

Reimplemented from Teuchos::Describable.

Definition at line 64 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 72 of file Tempus_StepperState.hpp.

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

Tempus_StepperState.hpp

Public Member Functions

Public Attributes

Overridden from Teuchos::Describable

Additional Inherited Members

Detailed Description

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

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

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