Rythmos - Transient Integration for Differential Equations Version of the Day
Public Types | Public Member Functions | Related Functions
Rythmos::DefaultIntegrator< Scalar > Class Template Reference

A concrete subclass for IntegratorBase that allows a good deal of customization. More...

#include <Rythmos_DefaultIntegrator_decl.hpp>

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

List of all members.

Public Types

typedef ScalarTraits< Scalar >
::magnitudeType 
ScalarMag
 

Public Member Functions

void getFwdPoints (const Array< Scalar > &time_vec, Array< RCP< const Thyra::VectorBase< Scalar > > > *x_vec, Array< RCP< const Thyra::VectorBase< Scalar > > > *xdot_vec, Array< ScalarMag > *accuracy_vec)
 
TimeRange< Scalar > getFwdTimeRange () const
 

Related Functions

(Note that these are not member functions.)

template<class Scalar >
RCP< DefaultIntegrator< Scalar > > defaultIntegrator ()
 
template<class Scalar >
RCP< DefaultIntegrator< Scalar > > defaultIntegrator (const RCP< IntegrationControlStrategyBase< Scalar > > &integrationControlStrategy, const RCP< IntegrationObserverBase< Scalar > > &integrationObserver)
 
template<class Scalar >
RCP< DefaultIntegrator< Scalar > > controlledDefaultIntegrator (const RCP< IntegrationControlStrategyBase< Scalar > > &integrationControlStrategy)
 
template<class Scalar >
RCP< DefaultIntegrator< Scalar > > observedDefaultIntegrator (const RCP< IntegrationObserverBase< Scalar > > &integrationObserver)
 

Constructors, Initializers, Misc

 DefaultIntegrator ()
 
void setIntegrationObserver (const RCP< IntegrationObserverBase< Scalar > > &integrationObserver)
 

Overridden from InterpolationBufferAppenderAcceptingIntegratorBase

void setInterpolationBufferAppender (const RCP< InterpolationBufferAppenderBase< Scalar > > &interpBufferAppender)
 
RCP< const
InterpolationBufferAppenderBase
< Scalar > > 
getInterpolationBufferAppender ()
 
RCP
< InterpolationBufferAppenderBase
< Scalar > > 
getNonconstInterpolationBufferAppender ()
 
RCP
< InterpolationBufferAppenderBase
< Scalar > > 
unSetInterpolationBufferAppender ()
 

Overridden from IntegrationControlStrategyAcceptingIntegratorBase

void setIntegrationControlStrategy (const RCP< IntegrationControlStrategyBase< Scalar > > &integrationControlStrategy)
 
RCP
< IntegrationControlStrategyBase
< Scalar > > 
getNonconstIntegrationControlStrategy ()
 
RCP< const
IntegrationControlStrategyBase
< Scalar > > 
getIntegrationControlStrategy () const
 

Overridden from ParameterListAcceptor

void setParameterList (RCP< ParameterList > const &paramList)
 
RCP< const ParameterList > getValidParameters () const
 

Overridden from IntegratorBase

RCP< IntegratorBase< Scalar > > cloneIntegrator () const
 
void setStepper (const RCP< StepperBase< Scalar > > &stepper, const Scalar &finalTime, const bool landOnFinalTime=true)
 
RCP< StepperBase< Scalar > > unSetStepper ()
 
RCP< const StepperBase< Scalar > > getStepper () const
 
RCP< StepperBase< Scalar > > getNonconstStepper () const
 

Overridden from TrailingInterpolationBufferAcceptingIntegratorBase

void setTrailingInterpolationBuffer (const RCP< InterpolationBufferBase< Scalar > > &trailingInterpBuffer)
 
RCP< InterpolationBufferBase
< Scalar > > 
getNonconstTrailingInterpolationBuffer ()
 
RCP< const
InterpolationBufferBase
< Scalar > > 
getTrailingInterpolationBuffer () const
 
RCP< InterpolationBufferBase
< Scalar > > 
unSetTrailingInterpolationBuffer ()
 

Overridden from InterpolationBufferBase

RCP< const
Thyra::VectorSpaceBase< Scalar > > 
get_x_space () const
 
void addPoints (const Array< Scalar > &time_vec, const Array< RCP< const Thyra::VectorBase< Scalar > > > &x_vec, const Array< RCP< const Thyra::VectorBase< Scalar > > > &xdot_vec)
 
void getPoints (const Array< Scalar > &time_vec, Array< RCP< const Thyra::VectorBase< Scalar > > > *x_vec, Array< RCP< const Thyra::VectorBase< Scalar > > > *xdot_vec, Array< ScalarMag > *accuracy_vec) const
 
TimeRange< Scalar > getTimeRange () const
 
void getNodes (Array< Scalar > *time_vec) const
 
void removeNodes (Array< Scalar > &time_vec)
 
int getOrder () const
 

Detailed Description

template<class Scalar>
class Rythmos::DefaultIntegrator< Scalar >

A concrete subclass for IntegratorBase that allows a good deal of customization.

Definition at line 50 of file Rythmos_DefaultIntegrator_decl.hpp.


Member Typedef Documentation

template<class Scalar >
typedef ScalarTraits<Scalar>::magnitudeType Rythmos::DefaultIntegrator< Scalar >::ScalarMag

Reimplemented from Rythmos::IntegratorBase< Scalar >.

Definition at line 59 of file Rythmos_DefaultIntegrator_decl.hpp.


Constructor & Destructor Documentation

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

Definition at line 136 of file Rythmos_DefaultIntegrator_def.hpp.


Member Function Documentation

template<class Scalar >
void Rythmos::DefaultIntegrator< Scalar >::setIntegrationObserver ( const RCP< IntegrationObserverBase< Scalar > > &  integrationObserver)

Definition at line 170 of file Rythmos_DefaultIntegrator_def.hpp.

template<class Scalar >
void Rythmos::DefaultIntegrator< Scalar >::setInterpolationBufferAppender ( const RCP< InterpolationBufferAppenderBase< Scalar > > &  interpBufferAppender) [virtual]
template<class Scalar >
RCP< const InterpolationBufferAppenderBase< Scalar > > Rythmos::DefaultIntegrator< Scalar >::getInterpolationBufferAppender ( ) [virtual]
template<class Scalar >
RCP< InterpolationBufferAppenderBase< Scalar > > Rythmos::DefaultIntegrator< Scalar >::getNonconstInterpolationBufferAppender ( ) [virtual]
template<class Scalar >
RCP< InterpolationBufferAppenderBase< Scalar > > Rythmos::DefaultIntegrator< Scalar >::unSetInterpolationBufferAppender ( ) [virtual]
template<class Scalar >
void Rythmos::DefaultIntegrator< Scalar >::setIntegrationControlStrategy ( const RCP< IntegrationControlStrategyBase< Scalar > > &  integrationControlStrategy) [virtual]
template<class Scalar >
RCP< IntegrationControlStrategyBase< Scalar > > Rythmos::DefaultIntegrator< Scalar >::getNonconstIntegrationControlStrategy ( ) [virtual]
template<class Scalar >
RCP< const IntegrationControlStrategyBase< Scalar > > Rythmos::DefaultIntegrator< Scalar >::getIntegrationControlStrategy ( ) const [virtual]
template<class Scalar >
void Rythmos::DefaultIntegrator< Scalar >::setParameterList ( RCP< ParameterList > const &  paramList)

Definition at line 218 of file Rythmos_DefaultIntegrator_def.hpp.

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

Definition at line 233 of file Rythmos_DefaultIntegrator_def.hpp.

template<class Scalar >
RCP< IntegratorBase< Scalar > > Rythmos::DefaultIntegrator< Scalar >::cloneIntegrator ( ) const [virtual]

Reimplemented from Rythmos::IntegratorBase< Scalar >.

Definition at line 252 of file Rythmos_DefaultIntegrator_def.hpp.

template<class Scalar >
void Rythmos::DefaultIntegrator< Scalar >::setStepper ( const RCP< StepperBase< Scalar > > &  stepper,
const Scalar &  finalTime,
const bool  landOnFinalTime = true 
) [virtual]
template<class Scalar >
RCP< StepperBase< Scalar > > Rythmos::DefaultIntegrator< Scalar >::unSetStepper ( ) [virtual]
template<class Scalar >
RCP< const StepperBase< Scalar > > Rythmos::DefaultIntegrator< Scalar >::getStepper ( ) const [virtual]
template<class Scalar >
RCP< StepperBase< Scalar > > Rythmos::DefaultIntegrator< Scalar >::getNonconstStepper ( ) const [virtual]
template<class Scalar >
void Rythmos::DefaultIntegrator< Scalar >::setTrailingInterpolationBuffer ( const RCP< InterpolationBufferBase< Scalar > > &  trailingInterpBuffer) [virtual]
template<class Scalar >
RCP< InterpolationBufferBase< Scalar > > Rythmos::DefaultIntegrator< Scalar >::getNonconstTrailingInterpolationBuffer ( ) [virtual]
template<class Scalar >
RCP< const InterpolationBufferBase< Scalar > > Rythmos::DefaultIntegrator< Scalar >::getTrailingInterpolationBuffer ( ) const [virtual]
template<class Scalar >
RCP< InterpolationBufferBase< Scalar > > Rythmos::DefaultIntegrator< Scalar >::unSetTrailingInterpolationBuffer ( ) [virtual]
template<class Scalar >
void Rythmos::DefaultIntegrator< Scalar >::getFwdPoints ( const Array< Scalar > &  time_vec,
Array< RCP< const Thyra::VectorBase< Scalar > > > *  x_vec,
Array< RCP< const Thyra::VectorBase< Scalar > > > *  xdot_vec,
Array< ScalarMag > *  accuracy_vec 
)

Definition at line 375 of file Rythmos_DefaultIntegrator_def.hpp.

template<class Scalar >
TimeRange< Scalar > Rythmos::DefaultIntegrator< Scalar >::getFwdTimeRange ( ) const [virtual]
template<class Scalar >
RCP< const Thyra::VectorSpaceBase< Scalar > > Rythmos::DefaultIntegrator< Scalar >::get_x_space ( ) const [virtual]
template<class Scalar >
void Rythmos::DefaultIntegrator< Scalar >::addPoints ( const Array< Scalar > &  time_vec,
const Array< RCP< const Thyra::VectorBase< Scalar > > > &  x_vec,
const Array< RCP< const Thyra::VectorBase< Scalar > > > &  xdot_vec 
) [virtual]
template<class Scalar >
void Rythmos::DefaultIntegrator< Scalar >::getPoints ( const Array< Scalar > &  time_vec,
Array< RCP< const Thyra::VectorBase< Scalar > > > *  x_vec,
Array< RCP< const Thyra::VectorBase< Scalar > > > *  xdot_vec,
Array< ScalarMag > *  accuracy_vec 
) const

Definition at line 542 of file Rythmos_DefaultIntegrator_def.hpp.

template<class Scalar >
TimeRange< Scalar > Rythmos::DefaultIntegrator< Scalar >::getTimeRange ( ) const [virtual]
template<class Scalar >
void Rythmos::DefaultIntegrator< Scalar >::getNodes ( Array< Scalar > *  time_vec) const [virtual]
template<class Scalar >
void Rythmos::DefaultIntegrator< Scalar >::removeNodes ( Array< Scalar > &  time_vec) [virtual]
template<class Scalar >
int Rythmos::DefaultIntegrator< Scalar >::getOrder ( ) const [virtual]

Friends And Related Function Documentation

template<class Scalar >
RCP< DefaultIntegrator< Scalar > > defaultIntegrator ( ) [related]

Definition at line 52 of file Rythmos_DefaultIntegrator_def.hpp.

template<class Scalar >
RCP< DefaultIntegrator< Scalar > > defaultIntegrator ( const RCP< IntegrationControlStrategyBase< Scalar > > &  integrationControlStrategy,
const RCP< IntegrationObserverBase< Scalar > > &  integrationObserver 
) [related]

Definition at line 66 of file Rythmos_DefaultIntegrator_def.hpp.

template<class Scalar >
RCP< DefaultIntegrator< Scalar > > controlledDefaultIntegrator ( const RCP< IntegrationControlStrategyBase< Scalar > > &  integrationControlStrategy) [related]

Definition at line 85 of file Rythmos_DefaultIntegrator_def.hpp.

template<class Scalar >
RCP< DefaultIntegrator< Scalar > > observedDefaultIntegrator ( const RCP< IntegrationObserverBase< Scalar > > &  integrationObserver) [related]

Definition at line 102 of file Rythmos_DefaultIntegrator_def.hpp.


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