Tempus Version of the Day
Time Integration
|
StepControlStrategy class for TimeStepControl. More...
#include <Tempus_TimeStepControlStrategyIntegralController.hpp>
Public Member Functions | |
TimeStepControlStrategyIntegralController () | |
Default Constructor. | |
TimeStepControlStrategyIntegralController (std::string controller, Scalar KI, Scalar KP, Scalar KD, Scalar safetyFactor, Scalar safetyFactorAfterReject, Scalar facMax, Scalar facMin, std::string name="Integral Controller") | |
Full Constructor. | |
virtual | ~TimeStepControlStrategyIntegralController () |
Destructor. | |
virtual void | setNextTimeStep (const TimeStepControl< Scalar > &tsc, Teuchos::RCP< SolutionHistory< Scalar > > solutionHistory, Status &) override |
Set the time step size. | |
![]() | |
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. | |
Overridden from Teuchos::Describable | |
std::string | controller_ |
Control type ['I', 'PI', 'PID']. | |
Scalar | KI_ |
Integral gain. | |
Scalar | KP_ |
Proportional gain. | |
Scalar | KD_ |
Derivative gain. | |
Scalar | safetyFactor_ |
Safety Factor. | |
Scalar | safetyFactorAfterReject_ |
Safety Factor Following Step Rejection. | |
Scalar | facMaxINPUT_ |
Maximum Safety Factor from input. | |
Scalar | facMax_ |
Maximum Safety Factor. | |
Scalar | facMin_ |
Minimum Safety Factor. | |
bool | firstSuccessfulStep_ = false |
bool | lastStepRejected_ = false |
std::string | description () const override |
void | describe (Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel) const override |
virtual Teuchos::RCP< const Teuchos::ParameterList > | getValidParameters () const override |
Return ParameterList with current values. | |
virtual void | initialize () const override |
virtual std::string | getController () const |
virtual Scalar | getKI () const |
virtual Scalar | getKP () const |
virtual Scalar | getKD () const |
virtual Scalar | getSafetyFactor () const |
virtual Scalar | getSafetyFactorAfterReject () const |
virtual Scalar | getFacMax () const |
virtual Scalar | getFacMin () const |
virtual void | setController (std::string c) |
virtual void | setKI (Scalar k) |
virtual void | setKP (Scalar k) |
virtual void | setKD (Scalar k) |
virtual void | setSafetyFactor (Scalar f) |
virtual void | setSafetyFactorAfterReject (Scalar f) |
virtual void | setFacMax (Scalar f) |
virtual void | setFacMin (Scalar f) |
Additional Inherited Members | |
![]() | |
virtual void | setStrategyType (std::string s) |
virtual void | setStepType (std::string s) |
![]() | |
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. | |
StepControlStrategy class for TimeStepControl.
Gustaf Soderlind. Automatic control and adaptive time-stepping. Numerical Algorithms, 31(1):281–310, Dec 2002.
The step size is chosen based on "Controller Type":
PID = Proportional-Integral-Derivative Controller
PI = Proportional-Integral Controller
I = Integral Controller
where
Appropriate for Explicit Methods
Definition at line 59 of file Tempus_TimeStepControlStrategyIntegralController.hpp.
|
inline |
Default Constructor.
Definition at line 65 of file Tempus_TimeStepControlStrategyIntegralController.hpp.
|
inline |
Full Constructor.
Definition at line 79 of file Tempus_TimeStepControlStrategyIntegralController.hpp.
|
inlinevirtual |
Destructor.
Definition at line 98 of file Tempus_TimeStepControlStrategyIntegralController.hpp.
|
inlineoverridevirtual |
Set the time step size.
Reimplemented from Tempus::TimeStepControlStrategy< Scalar >.
Definition at line 101 of file Tempus_TimeStepControlStrategyIntegralController.hpp.
|
inlineoverride |
Definition at line 173 of file Tempus_TimeStepControlStrategyIntegralController.hpp.
|
inlineoverride |
Definition at line 176 of file Tempus_TimeStepControlStrategyIntegralController.hpp.
|
inlineoverridevirtual |
Return ParameterList with current values.
Reimplemented from Tempus::TimeStepControlStrategy< Scalar >.
Definition at line 203 of file Tempus_TimeStepControlStrategyIntegralController.hpp.
|
inlineoverridevirtual |
Reimplemented from Tempus::TimeStepControlStrategy< Scalar >.
Definition at line 224 of file Tempus_TimeStepControlStrategyIntegralController.hpp.
|
inlinevirtual |
Definition at line 248 of file Tempus_TimeStepControlStrategyIntegralController.hpp.
|
inlinevirtual |
Definition at line 249 of file Tempus_TimeStepControlStrategyIntegralController.hpp.
|
inlinevirtual |
Definition at line 250 of file Tempus_TimeStepControlStrategyIntegralController.hpp.
|
inlinevirtual |
Definition at line 251 of file Tempus_TimeStepControlStrategyIntegralController.hpp.
|
inlinevirtual |
Definition at line 252 of file Tempus_TimeStepControlStrategyIntegralController.hpp.
|
inlinevirtual |
Definition at line 253 of file Tempus_TimeStepControlStrategyIntegralController.hpp.
|
inlinevirtual |
Definition at line 254 of file Tempus_TimeStepControlStrategyIntegralController.hpp.
|
inlinevirtual |
Definition at line 255 of file Tempus_TimeStepControlStrategyIntegralController.hpp.
|
inlinevirtual |
Definition at line 257 of file Tempus_TimeStepControlStrategyIntegralController.hpp.
|
inlinevirtual |
Definition at line 258 of file Tempus_TimeStepControlStrategyIntegralController.hpp.
|
inlinevirtual |
Definition at line 259 of file Tempus_TimeStepControlStrategyIntegralController.hpp.
|
inlinevirtual |
Definition at line 260 of file Tempus_TimeStepControlStrategyIntegralController.hpp.
|
inlinevirtual |
Definition at line 261 of file Tempus_TimeStepControlStrategyIntegralController.hpp.
|
inlinevirtual |
Definition at line 262 of file Tempus_TimeStepControlStrategyIntegralController.hpp.
|
inlinevirtual |
Definition at line 263 of file Tempus_TimeStepControlStrategyIntegralController.hpp.
|
inlinevirtual |
Definition at line 264 of file Tempus_TimeStepControlStrategyIntegralController.hpp.
|
private |
Control type ['I', 'PI', 'PID'].
Definition at line 268 of file Tempus_TimeStepControlStrategyIntegralController.hpp.
|
private |
Integral gain.
Definition at line 269 of file Tempus_TimeStepControlStrategyIntegralController.hpp.
|
private |
Proportional gain.
Definition at line 270 of file Tempus_TimeStepControlStrategyIntegralController.hpp.
|
private |
Derivative gain.
Definition at line 271 of file Tempus_TimeStepControlStrategyIntegralController.hpp.
|
private |
Safety Factor.
Definition at line 272 of file Tempus_TimeStepControlStrategyIntegralController.hpp.
|
private |
Safety Factor Following Step Rejection.
Definition at line 273 of file Tempus_TimeStepControlStrategyIntegralController.hpp.
|
private |
Maximum Safety Factor from input.
Definition at line 274 of file Tempus_TimeStepControlStrategyIntegralController.hpp.
|
private |
Maximum Safety Factor.
Definition at line 275 of file Tempus_TimeStepControlStrategyIntegralController.hpp.
|
private |
Minimum Safety Factor.
Definition at line 276 of file Tempus_TimeStepControlStrategyIntegralController.hpp.
|
private |
Definition at line 277 of file Tempus_TimeStepControlStrategyIntegralController.hpp.
|
private |
Definition at line 278 of file Tempus_TimeStepControlStrategyIntegralController.hpp.