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

StepControlStrategy class for TimeStepControl. More...

#include <Tempus_TimeStepControlStrategyConstant.hpp>

Inheritance diagram for Tempus::TimeStepControlStrategyConstant< Scalar >:
Tempus::TimeStepControlStrategy< Scalar > Teuchos::Describable Teuchos::VerboseObject< Tempus::TimeStepControlStrategy< Scalar > > Teuchos::LabeledObject Teuchos::VerboseObjectBase

Public Member Functions

 TimeStepControlStrategyConstant ()
 Default Constructor. More...
 
 TimeStepControlStrategyConstant (Scalar constantTimeStep, std::string name="Constant")
 Full Constructor. More...
 
virtual ~TimeStepControlStrategyConstant ()
 Destructor. More...
 
virtual void setNextTimeStep (const TimeStepControl< Scalar > &tsc, Teuchos::RCP< SolutionHistory< Scalar > > solutionHistory, Status &integratorStatus) override
 Determine the time step size. More...
 
virtual Teuchos::RCP< const
Teuchos::ParameterList
getValidParameters () const override
 Return ParameterList with current values. More...
 
virtual void initialize () const override
 
virtual Scalar getConstantTimeStep () const
 
virtual void setConstantTimeStep (Scalar dt)
 
- Public Member Functions inherited from Tempus::TimeStepControlStrategy< Scalar >
 TimeStepControlStrategy ()
 Constructor. More...
 
virtual ~TimeStepControlStrategy ()
 Destructor. More...
 
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
 
- 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::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
 

Private Attributes

Scalar constantTimeStep_
 Constant time step size. More...
 

Overridden from Teuchos::Describable

std::string description () const override
 
void describe (Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel) const override
 

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

Detailed Description

template<class Scalar>
class Tempus::TimeStepControlStrategyConstant< Scalar >

StepControlStrategy class for TimeStepControl.

Definition at line 25 of file Tempus_TimeStepControlStrategyConstant.hpp.

Constructor & Destructor Documentation

template<class Scalar >
Tempus::TimeStepControlStrategyConstant< Scalar >::TimeStepControlStrategyConstant ( )
inline

Default Constructor.

Definition at line 29 of file Tempus_TimeStepControlStrategyConstant.hpp.

template<class Scalar >
Tempus::TimeStepControlStrategyConstant< Scalar >::TimeStepControlStrategyConstant ( Scalar  constantTimeStep,
std::string  name = "Constant" 
)
inline

Full Constructor.

Definition at line 38 of file Tempus_TimeStepControlStrategyConstant.hpp.

template<class Scalar >
virtual Tempus::TimeStepControlStrategyConstant< Scalar >::~TimeStepControlStrategyConstant ( )
inlinevirtual

Destructor.

Definition at line 49 of file Tempus_TimeStepControlStrategyConstant.hpp.

Member Function Documentation

template<class Scalar >
virtual void Tempus::TimeStepControlStrategyConstant< Scalar >::setNextTimeStep ( const TimeStepControl< Scalar > &  tsc,
Teuchos::RCP< SolutionHistory< Scalar > >  solutionHistory,
Status integratorStatus 
)
inlineoverridevirtual

Determine the time step size.

Reimplemented from Tempus::TimeStepControlStrategy< Scalar >.

Definition at line 52 of file Tempus_TimeStepControlStrategyConstant.hpp.

template<class Scalar >
std::string Tempus::TimeStepControlStrategyConstant< Scalar >::description ( ) const
inlineoverridevirtual

Reimplemented from Teuchos::Describable.

Definition at line 120 of file Tempus_TimeStepControlStrategyConstant.hpp.

template<class Scalar >
void Tempus::TimeStepControlStrategyConstant< Scalar >::describe ( Teuchos::FancyOStream out,
const Teuchos::EVerbosityLevel  verbLevel 
) const
inlineoverridevirtual

Reimplemented from Teuchos::Describable.

Definition at line 125 of file Tempus_TimeStepControlStrategyConstant.hpp.

template<class Scalar >
virtual Teuchos::RCP<const Teuchos::ParameterList> Tempus::TimeStepControlStrategyConstant< Scalar >::getValidParameters ( ) const
inlineoverridevirtual

Return ParameterList with current values.

Reimplemented from Tempus::TimeStepControlStrategy< Scalar >.

Definition at line 145 of file Tempus_TimeStepControlStrategyConstant.hpp.

template<class Scalar >
virtual void Tempus::TimeStepControlStrategyConstant< Scalar >::initialize ( ) const
inlineoverridevirtual
template<class Scalar >
virtual Scalar Tempus::TimeStepControlStrategyConstant< Scalar >::getConstantTimeStep ( ) const
inlinevirtual

Definition at line 162 of file Tempus_TimeStepControlStrategyConstant.hpp.

template<class Scalar >
virtual void Tempus::TimeStepControlStrategyConstant< Scalar >::setConstantTimeStep ( Scalar  dt)
inlinevirtual

Definition at line 164 of file Tempus_TimeStepControlStrategyConstant.hpp.

Member Data Documentation

template<class Scalar >
Scalar Tempus::TimeStepControlStrategyConstant< Scalar >::constantTimeStep_
private

Constant time step size.

Definition at line 171 of file Tempus_TimeStepControlStrategyConstant.hpp.


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