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 >:

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

template<class Scalar >

Rythmos::RampingIntegrationControlStrategy< Scalar >::RampingIntegrationControlStrategy

(

)

Constructors/Initializers.

Definition at line 164 of file Rythmos_RampingIntegrationControlStrategy_def.hpp.

---

Member Function Documentation

template<class Scalar >

void Rythmos::RampingIntegrationControlStrategy< Scalar >::setParameterList

(

RCP< ParameterList > const &

paramList

)

Definition at line 182 of file Rythmos_RampingIntegrationControlStrategy_def.hpp.

template<class Scalar >

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

(

)

const

Definition at line 214 of file Rythmos_RampingIntegrationControlStrategy_def.hpp.

template<class Scalar >

bool Rythmos::RampingIntegrationControlStrategy< Scalar >::handlesFailedTimeSteps

(

)

const [virtual]

Overridden from IntegrationControlStrategyBase.

Reimplemented from Rythmos::IntegrationControlStrategyBase< Scalar >.

Definition at line 256 of file Rythmos_RampingIntegrationControlStrategy_def.hpp.

template<class Scalar >

RCP< IntegrationControlStrategyBase< Scalar > > Rythmos::RampingIntegrationControlStrategy< Scalar >::cloneIntegrationControlStrategy

(

)

const [virtual]

Implements Rythmos::IntegrationControlStrategyBase< Scalar >.

Definition at line 264 of file Rythmos_RampingIntegrationControlStrategy_def.hpp.

template<class Scalar >

void Rythmos::RampingIntegrationControlStrategy< Scalar >::resetIntegrationControlStrategy

(

const TimeRange< Scalar > &

integrationTimeDomain

)

[virtual]

Implements Rythmos::IntegrationControlStrategyBase< Scalar >.

Definition at line 287 of file Rythmos_RampingIntegrationControlStrategy_def.hpp.

template<class Scalar >

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

Implements Rythmos::IntegrationControlStrategyBase< Scalar >.

Definition at line 306 of file Rythmos_RampingIntegrationControlStrategy_def.hpp.

template<class Scalar >

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

Reimplemented from Rythmos::IntegrationControlStrategyBase< Scalar >.

Definition at line 346 of file Rythmos_RampingIntegrationControlStrategy_def.hpp.

---

Friends And Related Function Documentation

template<class Scalar >

RCP< RampingIntegrationControlStrategy< Scalar > > rampingIntegrationControlStrategy

(

)

[related]

Definition at line 42 of file Rythmos_RampingIntegrationControlStrategy_def.hpp.

template<class Scalar >

RCP< RampingIntegrationControlStrategy< Scalar > > rampingIntegrationControlStrategy

(

const RCP< ParameterList > &

paramList

)

[related]

Definition at line 53 of file Rythmos_RampingIntegrationControlStrategy_def.hpp.

---

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

• Rythmos_RampingIntegrationControlStrategy_decl.hpp
• Rythmos_RampingIntegrationControlStrategy_def.hpp