Tempus Version of the Day
Time Integration
|
TimeStepControlStrategy class for TimeStepControl. More...
#include <Tempus_TimeStepControlStrategy.hpp>
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. | |
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.
|
inline |
Constructor.
Definition at line 38 of file Tempus_TimeStepControlStrategy.hpp.
|
inlinevirtual |
Destructor.
Definition at line 44 of file Tempus_TimeStepControlStrategy.hpp.
|
inlinevirtual |
Set the time step size.
Reimplemented in Tempus::TimeStepControlStrategyComposite< Scalar >, Tempus::TimeStepControlStrategyBasicVS< Scalar >, Tempus::TimeStepControlStrategyIntegralController< Scalar >, and Tempus::TimeStepControlStrategyConstant< Scalar >.
Definition at line 47 of file Tempus_TimeStepControlStrategy.hpp.
|
inlinevirtual |
Reimplemented in Tempus::TimeStepControlStrategyBasicVS< Scalar >, Tempus::TimeStepControlStrategyComposite< Scalar >, Tempus::TimeStepControlStrategyConstant< Scalar >, and Tempus::TimeStepControlStrategyIntegralController< Scalar >.
Definition at line 52 of file Tempus_TimeStepControlStrategy.hpp.
|
inlinevirtual |
Definition at line 53 of file Tempus_TimeStepControlStrategy.hpp.
|
inlinevirtual |
Definition at line 54 of file Tempus_TimeStepControlStrategy.hpp.
|
inlinevirtual |
Definition at line 63 of file Tempus_TimeStepControlStrategy.hpp.
|
inlinevirtual |
Definition at line 65 of file Tempus_TimeStepControlStrategy.hpp.
|
inlinevirtual |
Definition at line 66 of file Tempus_TimeStepControlStrategy.hpp.
|
inlinevirtual |
Definition at line 67 of file Tempus_TimeStepControlStrategy.hpp.
|
inlinevirtual |
Return ParameterList with current values.
Reimplemented in Tempus::TimeStepControlStrategyBasicVS< Scalar >, Tempus::TimeStepControlStrategyComposite< Scalar >, Tempus::TimeStepControlStrategyConstant< Scalar >, and Tempus::TimeStepControlStrategyIntegralController< Scalar >.
Definition at line 70 of file Tempus_TimeStepControlStrategy.hpp.
|
inlineprotectedvirtual |
Definition at line 75 of file Tempus_TimeStepControlStrategy.hpp.
|
inlineprotectedvirtual |
Definition at line 76 of file Tempus_TimeStepControlStrategy.hpp.
|
protected |
Strategy type.
Definition at line 78 of file Tempus_TimeStepControlStrategy.hpp.
|
protected |
Step Type - "Constant" or "Variable".
Definition at line 79 of file Tempus_TimeStepControlStrategy.hpp.
|
protected |
Name of strategy.
Definition at line 80 of file Tempus_TimeStepControlStrategy.hpp.
|
mutableprotected |
Bool if strategy is initialized.
Definition at line 81 of file Tempus_TimeStepControlStrategy.hpp.