TimeStepControlStrategy class for TimeStepControl. More...

#include <Tempus_TimeStepControlStrategy.hpp>

Inheritance diagram for Tempus::TimeStepControlStrategy< Scalar >:

Public Member Functions
	TimeStepControlStrategy ()
	Constructor. More...

virtual	~TimeStepControlStrategy ()
	Destructor. More...

virtual void	getNextTimeStep (const TimeStepControl< Scalar > tsc, Teuchos::RCP< SolutionHistory< Scalar > > sh, Status &integratorStatus)
	Deprecated get the time step size. More...

virtual void	setNextTimeStep (const TimeStepControl< Scalar > &, Teuchos::RCP< SolutionHistory< Scalar > >, Status &)
	Set the time step size. More...

virtual void	initialize () const

virtual bool	isInitialized ()

virtual void	checkInitialized ()

virtual void	setName (std::string s)

virtual std::string	getStrategyType () const

virtual std::string	getStepType () const

virtual std::string	getName () const

virtual Teuchos::RCP< const Teuchos::ParameterList >	getValidParameters () const
	Return ParameterList with current values. More...

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

Protected Member Functions
virtual void	setStrategyType (std::string s)

virtual void	setStepType (std::string s)

Protected Member Functions inherited from Teuchos::VerboseObject< Tempus::TimeStepControlStrategy< 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

Protected Attributes
std::string	strategyType_
	Strategy type. More...

std::string	stepType_
	Step Type - "Constant" or "Variable". More...

std::string	name_
	Name of strategy. More...

bool	isInitialized_
	Bool if strategy is initialized. More...

Additional Inherited Members
Static Public Member Functions inherited from Teuchos::VerboseObject< Tempus::TimeStepControlStrategy< 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

Detailed Description

template<class Scalar>
class Tempus::TimeStepControlStrategy< Scalar >

TimeStepControlStrategy class for TimeStepControl.

This is the base class for TimeStepControlStrategies. The primary function required from derived classes is setNextTimeStep(), which will

determine the next step from information in the TimeStepControl and SolutionHistory (i.e., SolutionStates)
set the next time step on the workingState in the SolutionHistory If a valid timestep can not be determined the Status is set to FAILED.

Definition at line 31 of file Tempus_TimeStepControlStrategy.hpp.

Constructor & Destructor Documentation

template<class Scalar >

Tempus::TimeStepControlStrategy< Scalar >::TimeStepControlStrategy ( )

inline

Constructor.

Definition at line 38 of file Tempus_TimeStepControlStrategy.hpp.

template<class Scalar >

virtual Tempus::TimeStepControlStrategy< Scalar >::~TimeStepControlStrategy ( )

inlinevirtual

Destructor.

Definition at line 44 of file Tempus_TimeStepControlStrategy.hpp.

Member Function Documentation

template<class Scalar >

virtual void Tempus::TimeStepControlStrategy< Scalar >::getNextTimeStep	(	const TimeStepControl< Scalar >	tsc,
		Teuchos::RCP< SolutionHistory< Scalar > >	sh,
		Status &	integratorStatus
	)

inlinevirtual

Deprecated get the time step size.

Definition at line 48 of file Tempus_TimeStepControlStrategy.hpp.

template<class Scalar >

virtual void Tempus::TimeStepControlStrategy< Scalar >::setNextTimeStep	(	const TimeStepControl< Scalar > &	,
		Teuchos::RCP< SolutionHistory< Scalar > >	,
		Status &
	)