Tempus Version of the Day
Time Integration
Loading...
Searching...
No Matches
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 >:
Tempus::TimeStepControlStrategyBasicVS< Scalar > Tempus::TimeStepControlStrategyComposite< Scalar > Tempus::TimeStepControlStrategyConstant< Scalar > Tempus::TimeStepControlStrategyIntegralController< Scalar >

Public Member Functions

 TimeStepControlStrategy ()
 Constructor.
 
virtual ~TimeStepControlStrategy ()
 Destructor.
 
virtual void setNextTimeStep (const TimeStepControl< Scalar > &, Teuchos::RCP< SolutionHistory< Scalar > >, Status &)
 Set the time step size.
 
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.
 

Protected Member Functions

virtual void setStrategyType (std::string s)
 
virtual void setStepType (std::string s)
 

Protected Attributes

std::string strategyType_
 Strategy type.
 
std::string stepType_
 Step Type - "Constant" or "Variable".
 
std::string name_
 Name of strategy.
 
bool isInitialized_
 Bool if strategy is initialized.
 

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

◆ TimeStepControlStrategy()

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

Constructor.

Definition at line 38 of file Tempus_TimeStepControlStrategy.hpp.

◆ ~TimeStepControlStrategy()

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

Destructor.

Definition at line 44 of file Tempus_TimeStepControlStrategy.hpp.

Member Function Documentation

◆ setNextTimeStep()

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

◆ initialize()

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

◆ isInitialized()

template<class Scalar >
virtual bool Tempus::TimeStepControlStrategy< Scalar >::isInitialized ( )
inlinevirtual

Definition at line 53 of file Tempus_TimeStepControlStrategy.hpp.

◆ checkInitialized()

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

Definition at line 54 of file Tempus_TimeStepControlStrategy.hpp.

◆ setName()

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

Definition at line 63 of file Tempus_TimeStepControlStrategy.hpp.

◆ getStrategyType()

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

Definition at line 65 of file Tempus_TimeStepControlStrategy.hpp.

◆ getStepType()

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

Definition at line 66 of file Tempus_TimeStepControlStrategy.hpp.

◆ getName()

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

Definition at line 67 of file Tempus_TimeStepControlStrategy.hpp.

◆ getValidParameters()

template<class Scalar >
virtual Teuchos::RCP< const Teuchos::ParameterList > Tempus::TimeStepControlStrategy< Scalar >::getValidParameters ( ) const
inlinevirtual

◆ setStrategyType()

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

Definition at line 75 of file Tempus_TimeStepControlStrategy.hpp.

◆ setStepType()

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

Definition at line 76 of file Tempus_TimeStepControlStrategy.hpp.

Member Data Documentation

◆ strategyType_

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

Strategy type.

Definition at line 78 of file Tempus_TimeStepControlStrategy.hpp.

◆ stepType_

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

Step Type - "Constant" or "Variable".

Definition at line 79 of file Tempus_TimeStepControlStrategy.hpp.

◆ name_

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

Name of strategy.

Definition at line 80 of file Tempus_TimeStepControlStrategy.hpp.

◆ isInitialized_

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

Bool if strategy is initialized.

Definition at line 81 of file Tempus_TimeStepControlStrategy.hpp.


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