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

Base class for strategy objects that control integration by selecting step sizes for a stepper. More...

#include <Rythmos_SimpleIntegrationControlStrategy_decl.hpp>

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

Public Member Functions

 SimpleIntegrationControlStrategy ()
 Constructors/Initializers.
 
- Public Member Functions inherited from Rythmos::IntegrationControlStrategyBase< Scalar >
virtual bool handlesFailedTimeSteps () const
 Return if this object can handle and repond to failed time steps.
 
virtual bool resetForFailedTimeStep (const StepperBase< Scalar > &, const StepControlInfo< Scalar > &, const int, const StepControlInfo< Scalar > &)
 Inform of a failed time step.
 

Related Symbols

(Note that these are not member symbols.)

template<class Scalar >
RCP< SimpleIntegrationControlStrategy< Scalar > > simpleIntegrationControlStrategy ()
 
template<class Scalar >
RCP< SimpleIntegrationControlStrategy< Scalar > > simpleIntegrationControlStrategy (const RCP< ParameterList > &paramList)
 

Overridden from ParameterListAcceptor

void setParameterList (RCP< ParameterList > const &paramList)
 
RCP< const ParameterList > getValidParameters () const
 
RCP< IntegrationControlStrategyBase< Scalar > > cloneIntegrationControlStrategy () const
 Overridden from IntegrationControlStrategyBase.
 
void resetIntegrationControlStrategy (const TimeRange< Scalar > &integrationTimeDomain)
 
StepControlInfo< Scalar > getNextStepControlInfo (const StepperBase< Scalar > &stepper, const StepControlInfo< Scalar > &stepCtrlInfoLast, const int timeStepIter)
 

Detailed Description

template<class Scalar>
class Rythmos::SimpleIntegrationControlStrategy< Scalar >

Base class for strategy objects that control integration by selecting step sizes for a stepper.

ToDo: Finish Implementation!

Definition at line 49 of file Rythmos_SimpleIntegrationControlStrategy_decl.hpp.

Constructor & Destructor Documentation

◆ SimpleIntegrationControlStrategy()

template<class Scalar >
Rythmos::SimpleIntegrationControlStrategy< Scalar >::SimpleIntegrationControlStrategy ( )

Constructors/Initializers.

Definition at line 117 of file Rythmos_SimpleIntegrationControlStrategy_def.hpp.

Member Function Documentation

◆ setParameterList()

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

◆ getValidParameters()

template<class Scalar >
RCP< const ParameterList > Rythmos::SimpleIntegrationControlStrategy< Scalar >::getValidParameters ( ) const

◆ cloneIntegrationControlStrategy()

template<class Scalar >
RCP< IntegrationControlStrategyBase< Scalar > > Rythmos::SimpleIntegrationControlStrategy< Scalar >::cloneIntegrationControlStrategy ( ) const
virtual

◆ resetIntegrationControlStrategy()

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

◆ getNextStepControlInfo()

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

Friends And Related Symbol Documentation

◆ simpleIntegrationControlStrategy() [1/2]

template<class Scalar >
RCP< SimpleIntegrationControlStrategy< Scalar > > simpleIntegrationControlStrategy ( )
related

◆ simpleIntegrationControlStrategy() [2/2]

template<class Scalar >
RCP< SimpleIntegrationControlStrategy< Scalar > > simpleIntegrationControlStrategy ( const RCP< ParameterList > & paramList)
related

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