Rythmos - Transient Integration for Differential Equations Version of the Day
Related Functions
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]

List of all members.

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)
 
 RampingIntegrationControlStrategy ()
 Constructors/Initializers.

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

Constructors/Initializers.

Definition at line 118 of file Rythmos_RampingIntegrationControlStrategy_def.hpp.


Member Function Documentation

template<class Scalar >
void Rythmos::RampingIntegrationControlStrategy< Scalar >::setParameterList ( RCP< ParameterList > const &  paramList)
template<class Scalar >
RCP< const ParameterList > Rythmos::RampingIntegrationControlStrategy< Scalar >::getValidParameters ( ) const
template<class Scalar >
bool Rythmos::RampingIntegrationControlStrategy< Scalar >::handlesFailedTimeSteps ( ) const [virtual]
template<class Scalar >
RCP< IntegrationControlStrategyBase< Scalar > > Rythmos::RampingIntegrationControlStrategy< Scalar >::cloneIntegrationControlStrategy ( ) const [virtual]
template<class Scalar >
void Rythmos::RampingIntegrationControlStrategy< Scalar >::resetIntegrationControlStrategy ( const TimeRange< Scalar > &  integrationTimeDomain) [virtual]
template<class Scalar >
StepControlInfo< Scalar > Rythmos::RampingIntegrationControlStrategy< Scalar >::getNextStepControlInfo ( const StepperBase< Scalar > &  stepper,
const StepControlInfo< Scalar > &  stepCtrlInfoLast,
const int  timeStepIter 
) [virtual]
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

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

The documentation for this class was generated from the following files:
 All Classes Functions Variables Typedefs Friends