Rythmos - Transient Integration for Differential Equations Version of the Day
Loading...
Searching...
No Matches
Public Member Functions | Related Functions | List of all members
Rythmos::RampingIntegrationControlStrategy< Scalar > Class Template Reference

Controls inital ramping at a fixed or incrementing time step size. More...

#include <Rythmos_RampingIntegrationControlStrategy_decl.hpp>

Inheritance diagram for Rythmos::RampingIntegrationControlStrategy< Scalar >:
Inheritance graph
[legend]

Public Member Functions

 RampingIntegrationControlStrategy ()
 Constructors/Initializers.
 
virtual bool handlesFailedTimeSteps () const
 Return if this object can handle and repond to failed time steps.
 
virtual RCP< IntegrationControlStrategyBase< Scalar > > cloneIntegrationControlStrategy () const =0
 Clone this integration control object if supported .
 
virtual void resetIntegrationControlStrategy (const TimeRange< Scalar > &integrationTimeDomain)=0
 Reset the control algorithm to the beginning to start a new integration.
 
virtual StepControlInfo< Scalar > getNextStepControlInfo (const StepperBase< Scalar > &stepper, const StepControlInfo< Scalar > &stepCtrlInfoLast, const int timeStepIter)=0
 Select the next time step control info.
 
virtual bool resetForFailedTimeStep (const StepperBase< Scalar > &, const StepControlInfo< Scalar > &, const int, const StepControlInfo< Scalar > &)
 Inform of a failed time step.
 

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 > &paramList)
 

Overridden from ParameterListAcceptor

void setParameterList (RCP< ParameterList > const &paramList)
 
RCP< const ParameterList > getValidParameters () const
 
bool handlesFailedTimeSteps () const
 Overridden from IntegrationControlStrategyBase.
 
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

template<class Scalar>
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()

template<class Scalar >
Rythmos::RampingIntegrationControlStrategy< Scalar >::RampingIntegrationControlStrategy

Constructors/Initializers.

Definition at line 164 of file Rythmos_RampingIntegrationControlStrategy_def.hpp.

Member Function Documentation

◆ setParameterList()

template<class Scalar >
void Rythmos::RampingIntegrationControlStrategy< Scalar >::setParameterList ( RCP< ParameterList > const &  paramList)

◆ getValidParameters()

template<class Scalar >
RCP< const ParameterList > Rythmos::RampingIntegrationControlStrategy< Scalar >::getValidParameters

◆ handlesFailedTimeSteps()

template<class Scalar >
bool Rythmos::RampingIntegrationControlStrategy< Scalar >::handlesFailedTimeSteps
virtual

◆ cloneIntegrationControlStrategy()

template<class Scalar >
RCP< IntegrationControlStrategyBase< Scalar > > Rythmos::RampingIntegrationControlStrategy< Scalar >::cloneIntegrationControlStrategy
virtual

◆ resetIntegrationControlStrategy()

template<class Scalar >
void Rythmos::RampingIntegrationControlStrategy< Scalar >::resetIntegrationControlStrategy ( const TimeRange< Scalar > &  integrationTimeDomain)
virtual

◆ getNextStepControlInfo()

template<class Scalar >
StepControlInfo< Scalar > Rythmos::RampingIntegrationControlStrategy< Scalar >::getNextStepControlInfo ( const StepperBase< Scalar > &  stepper,
const StepControlInfo< Scalar > &  stepCtrlInfoLast,
const int  timeStepIter 
)
virtual

◆ resetForFailedTimeStep()

template<class Scalar >
bool Rythmos::RampingIntegrationControlStrategy< Scalar >::resetForFailedTimeStep ( const StepperBase< Scalar > &  stepper,
const StepControlInfo< Scalar > &  stepCtrlInfoLast,
const int  timeStepIter,
const StepControlInfo< Scalar > &  stepCtrlInfo 
)
virtual

Friends And Related Function Documentation

◆ rampingIntegrationControlStrategy() [1/2]

template<class Scalar >
RCP< RampingIntegrationControlStrategy< Scalar > > rampingIntegrationControlStrategy ( )
related

◆ rampingIntegrationControlStrategy() [2/2]

template<class Scalar >
RCP< RampingIntegrationControlStrategy< Scalar > > rampingIntegrationControlStrategy ( const RCP< ParameterList > &  paramList)
related

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