Controls inital ramping at a fixed or incrementing time step size. More...
#include <Rythmos_RampingIntegrationControlStrategy_decl.hpp>
Public Member Functions | |
| RampingIntegrationControlStrategy () | |
| Constructors/Initializers. More... | |
| virtual bool | handlesFailedTimeSteps () const |
| Return if this object can handle and repond to failed time steps. More... | |
| virtual RCP< IntegrationControlStrategyBase< Scalar > > | cloneIntegrationControlStrategy () const =0 |
| Clone this integration control object if supported . More... | |
| virtual void | resetIntegrationControlStrategy (const TimeRange< Scalar > &integrationTimeDomain)=0 |
| Reset the control algorithm to the beginning to start a new integration. More... | |
| virtual StepControlInfo< Scalar > | getNextStepControlInfo (const StepperBase< Scalar > &stepper, const StepControlInfo< Scalar > &stepCtrlInfoLast, const int timeStepIter)=0 |
| Select the next time step control info. More... | |
| virtual bool | resetForFailedTimeStep (const StepperBase< Scalar > &, const StepControlInfo< Scalar > &, const int, const StepControlInfo< Scalar > &) |
| Inform of a failed time step. More... | |
Related Functions | |
(Note that these are not member functions.) | |
| template<class Scalar > | |
| RCP< RampingIntegrationControlStrategy< Scalar > > | rampingIntegrationControlStrategy () |
| template<class Scalar > | |
| RCP< RampingIntegrationControlStrategy< Scalar > > | rampingIntegrationControlStrategy (const RCP< ParameterList > ¶mList) |
Overridden from ParameterListAcceptor | |
| void | setParameterList (RCP< ParameterList > const ¶mList) |
| RCP< const ParameterList > | getValidParameters () const |
| bool | handlesFailedTimeSteps () const |
| Overridden from IntegrationControlStrategyBase. More... | |
| RCP< IntegrationControlStrategyBase< Scalar > > | cloneIntegrationControlStrategy () const |
| void | resetIntegrationControlStrategy (const TimeRange< Scalar > &integrationTimeDomain) |
| StepControlInfo< Scalar > | getNextStepControlInfo (const StepperBase< Scalar > &stepper, const StepControlInfo< Scalar > &stepCtrlInfoLast, const int timeStepIter) |
| bool | resetForFailedTimeStep (const StepperBase< Scalar > &stepper, const StepControlInfo< Scalar > &stepCtrlInfoLast, const int timeStepIter, const StepControlInfo< Scalar > &stepCtrlInfo) |
Detailed Description
class Rythmos::RampingIntegrationControlStrategy< Scalar >
Controls inital ramping at a fixed or incrementing time step size.
This integration control strategy starts a run by taking a fixed step size for a number of time steps (can optionally ramp the size). It then turns over control to a variable time stepper.
Definition at line 48 of file Rythmos_RampingIntegrationControlStrategy_decl.hpp.
Constructor & Destructor Documentation
◆ RampingIntegrationControlStrategy()
| Rythmos::RampingIntegrationControlStrategy< Scalar >::RampingIntegrationControlStrategy |
Constructors/Initializers.
Definition at line 164 of file Rythmos_RampingIntegrationControlStrategy_def.hpp.
Member Function Documentation
◆ setParameterList()
| void Rythmos::RampingIntegrationControlStrategy< Scalar >::setParameterList | ( | RCP< ParameterList > const & | paramList | ) |
Definition at line 182 of file Rythmos_RampingIntegrationControlStrategy_def.hpp.
◆ getValidParameters()
| RCP< const ParameterList > Rythmos::RampingIntegrationControlStrategy< Scalar >::getValidParameters |
Definition at line 214 of file Rythmos_RampingIntegrationControlStrategy_def.hpp.
◆ handlesFailedTimeSteps()
|
virtual |
Overridden from IntegrationControlStrategyBase.
Reimplemented from Rythmos::IntegrationControlStrategyBase< Scalar >.
Definition at line 256 of file Rythmos_RampingIntegrationControlStrategy_def.hpp.
◆ cloneIntegrationControlStrategy()
|
virtual |
Implements Rythmos::IntegrationControlStrategyBase< Scalar >.
Definition at line 264 of file Rythmos_RampingIntegrationControlStrategy_def.hpp.
◆ resetIntegrationControlStrategy()
|
virtual |
Implements Rythmos::IntegrationControlStrategyBase< Scalar >.
Definition at line 287 of file Rythmos_RampingIntegrationControlStrategy_def.hpp.
◆ getNextStepControlInfo()
|
virtual |
Implements Rythmos::IntegrationControlStrategyBase< Scalar >.
Definition at line 306 of file Rythmos_RampingIntegrationControlStrategy_def.hpp.
◆ resetForFailedTimeStep()
|
virtual |
Reimplemented from Rythmos::IntegrationControlStrategyBase< Scalar >.
Definition at line 345 of file Rythmos_RampingIntegrationControlStrategy_def.hpp.
Friends And Related Function Documentation
◆ rampingIntegrationControlStrategy() [1/2]
|
related |
Definition at line 42 of file Rythmos_RampingIntegrationControlStrategy_def.hpp.
◆ rampingIntegrationControlStrategy() [2/2]
|
related |
Definition at line 53 of file Rythmos_RampingIntegrationControlStrategy_def.hpp.
The documentation for this class was generated from the following files:
