Tempus  Version of the Day
Time Integration
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Tempus::TimeStepControlStrategy< Scalar > Class Template Reference

TimeStepControlStrategy class for TimeStepControl. More...

#include <Tempus_TimeStepControlStrategy.hpp>

Inheritance diagram for Tempus::TimeStepControlStrategy< Scalar >:
Inheritance graph
[legend]

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

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< FancyOStreamgetDefaultOStream ()
 
- 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

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  
)
inlinevirtual
template<class Scalar >
virtual void Tempus::TimeStepControlStrategy< Scalar >::initialize ( ) const
inlinevirtual
template<class Scalar >
virtual bool Tempus::TimeStepControlStrategy< Scalar >::isInitialized ( )
inlinevirtual

Definition at line 64 of file Tempus_TimeStepControlStrategy.hpp.

template<class Scalar >
virtual void Tempus::TimeStepControlStrategy< Scalar >::checkInitialized ( )
inlinevirtual

Definition at line 65 of file Tempus_TimeStepControlStrategy.hpp.

template<class Scalar >
virtual void Tempus::TimeStepControlStrategy< Scalar >::setName ( std::string  s)
inlinevirtual

Definition at line 74 of file Tempus_TimeStepControlStrategy.hpp.

template<class Scalar >
virtual std::string Tempus::TimeStepControlStrategy< Scalar >::getStrategyType ( ) const
inlinevirtual

Definition at line 76 of file Tempus_TimeStepControlStrategy.hpp.

template<class Scalar >
virtual std::string Tempus::TimeStepControlStrategy< Scalar >::getStepType ( ) const
inlinevirtual

Definition at line 77 of file Tempus_TimeStepControlStrategy.hpp.

template<class Scalar >
virtual std::string Tempus::TimeStepControlStrategy< Scalar >::getName ( ) const
inlinevirtual

Definition at line 78 of file Tempus_TimeStepControlStrategy.hpp.

template<class Scalar >
virtual Teuchos::RCP<const Teuchos::ParameterList> Tempus::TimeStepControlStrategy< Scalar >::getValidParameters ( ) const
inlinevirtual
template<class Scalar >
virtual void Tempus::TimeStepControlStrategy< Scalar >::setStrategyType ( std::string  s)
inlineprotectedvirtual

Definition at line 86 of file Tempus_TimeStepControlStrategy.hpp.

template<class Scalar >
virtual void Tempus::TimeStepControlStrategy< Scalar >::setStepType ( std::string  s)
inlineprotectedvirtual

Definition at line 87 of file Tempus_TimeStepControlStrategy.hpp.

Member Data Documentation

template<class Scalar >
std::string Tempus::TimeStepControlStrategy< Scalar >::strategyType_
protected

Strategy type.

Definition at line 89 of file Tempus_TimeStepControlStrategy.hpp.

template<class Scalar >
std::string Tempus::TimeStepControlStrategy< Scalar >::stepType_
protected

Step Type - "Constant" or "Variable".

Definition at line 90 of file Tempus_TimeStepControlStrategy.hpp.

template<class Scalar >
std::string Tempus::TimeStepControlStrategy< Scalar >::name_
protected

Name of strategy.

Definition at line 91 of file Tempus_TimeStepControlStrategy.hpp.

template<class Scalar >
bool Tempus::TimeStepControlStrategy< Scalar >::isInitialized_
mutableprotected

Bool if strategy is initialized.

Definition at line 92 of file Tempus_TimeStepControlStrategy.hpp.


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