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.

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
 

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.)

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

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 133 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 167 of file Rythmos_DefaultIntegrator_def.hpp.

template<class Scalar>
void Rythmos::DefaultIntegrator< Scalar >::setInterpolationBufferAppender ( const RCP< InterpolationBufferAppenderBase< Scalar > > &  interpBufferAppender  )  [virtual]

Implements Rythmos::InterpolationBufferAppenderAcceptingIntegratorBase< Scalar >.

Definition at line 179 of file Rythmos_DefaultIntegrator_def.hpp.

template<class Scalar>
RCP< const InterpolationBufferAppenderBase< Scalar > > Rythmos::DefaultIntegrator< Scalar >::getInterpolationBufferAppender (  )  [virtual]

Implements Rythmos::InterpolationBufferAppenderAcceptingIntegratorBase< Scalar >.

Definition at line 189 of file Rythmos_DefaultIntegrator_def.hpp.

template<class Scalar>
RCP< InterpolationBufferAppenderBase< Scalar > > Rythmos::DefaultIntegrator< Scalar >::getNonconstInterpolationBufferAppender (  )  [virtual]

Implements Rythmos::InterpolationBufferAppenderAcceptingIntegratorBase< Scalar >.

Definition at line 196 of file Rythmos_DefaultIntegrator_def.hpp.

template<class Scalar>
RCP< InterpolationBufferAppenderBase< Scalar > > Rythmos::DefaultIntegrator< Scalar >::unSetInterpolationBufferAppender (  )  [virtual]

Implements Rythmos::InterpolationBufferAppenderAcceptingIntegratorBase< Scalar >.

Definition at line 203 of file Rythmos_DefaultIntegrator_def.hpp.

template<class Scalar>
void Rythmos::DefaultIntegrator< Scalar >::setIntegrationControlStrategy ( const RCP< IntegrationControlStrategyBase< Scalar > > &  integrationControlStrategy  )  [virtual]

Implements Rythmos::IntegrationControlStrategyAcceptingIntegratorBase< Scalar >.

Definition at line 141 of file Rythmos_DefaultIntegrator_def.hpp.

template<class Scalar>
RCP< IntegrationControlStrategyBase< Scalar > > Rythmos::DefaultIntegrator< Scalar >::getNonconstIntegrationControlStrategy (  )  [virtual]

Implements Rythmos::IntegrationControlStrategyAcceptingIntegratorBase< Scalar >.

Definition at line 153 of file Rythmos_DefaultIntegrator_def.hpp.

template<class Scalar>
RCP< const IntegrationControlStrategyBase< Scalar > > Rythmos::DefaultIntegrator< Scalar >::getIntegrationControlStrategy (  )  const [virtual]

Implements Rythmos::IntegrationControlStrategyAcceptingIntegratorBase< Scalar >.

Definition at line 160 of file Rythmos_DefaultIntegrator_def.hpp.

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

Definition at line 215 of file Rythmos_DefaultIntegrator_def.hpp.

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

Definition at line 230 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 250 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]

Implements Rythmos::IntegratorBase< Scalar >.

Definition at line 287 of file Rythmos_DefaultIntegrator_def.hpp.

template<class Scalar>
RCP< StepperBase< Scalar > > Rythmos::DefaultIntegrator< Scalar >::unSetStepper (  )  [virtual]

Implements Rythmos::IntegratorBase< Scalar >.

Definition at line 315 of file Rythmos_DefaultIntegrator_def.hpp.

template<class Scalar>
RCP< const StepperBase< Scalar > > Rythmos::DefaultIntegrator< Scalar >::getStepper (  )  const [virtual]

Implements Rythmos::IntegratorBase< Scalar >.

Definition at line 324 of file Rythmos_DefaultIntegrator_def.hpp.

template<class Scalar>
RCP< StepperBase< Scalar > > Rythmos::DefaultIntegrator< Scalar >::getNonconstStepper (  )  const [virtual]

Implements Rythmos::IntegratorBase< Scalar >.

Definition at line 331 of file Rythmos_DefaultIntegrator_def.hpp.

template<class Scalar>
void Rythmos::DefaultIntegrator< Scalar >::setTrailingInterpolationBuffer ( const RCP< InterpolationBufferBase< Scalar > > &  trailingInterpBuffer  )  [virtual]

Implements Rythmos::TrailingInterpolationBufferAcceptingIntegratorBase< Scalar >.

Definition at line 338 of file Rythmos_DefaultIntegrator_def.hpp.

template<class Scalar>
RCP< InterpolationBufferBase< Scalar > > Rythmos::DefaultIntegrator< Scalar >::getNonconstTrailingInterpolationBuffer (  )  [virtual]

Implements Rythmos::TrailingInterpolationBufferAcceptingIntegratorBase< Scalar >.

Definition at line 348 of file Rythmos_DefaultIntegrator_def.hpp.

template<class Scalar>
RCP< const InterpolationBufferBase< Scalar > > Rythmos::DefaultIntegrator< Scalar >::getTrailingInterpolationBuffer (  )  const [virtual]

Implements Rythmos::TrailingInterpolationBufferAcceptingIntegratorBase< Scalar >.

Definition at line 356 of file Rythmos_DefaultIntegrator_def.hpp.

template<class Scalar>
RCP< InterpolationBufferBase< Scalar > > Rythmos::DefaultIntegrator< Scalar >::unSetTrailingInterpolationBuffer (  )  [virtual]

Implements Rythmos::TrailingInterpolationBufferAcceptingIntegratorBase< Scalar >.

Definition at line 363 of file Rythmos_DefaultIntegrator_def.hpp.

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 372 of file Rythmos_DefaultIntegrator_def.hpp.

template<class Scalar>
TimeRange< Scalar > Rythmos::DefaultIntegrator< Scalar >::getFwdTimeRange (  )  const [virtual]

Implements Rythmos::IntegratorBase< Scalar >.

Definition at line 491 of file Rythmos_DefaultIntegrator_def.hpp.

template<class Scalar>
RCP< const Thyra::VectorSpaceBase< Scalar > > Rythmos::DefaultIntegrator< Scalar >::get_x_space (  )  const [virtual]

Implements Rythmos::InterpolationBufferBase< Scalar >.

Definition at line 505 of file Rythmos_DefaultIntegrator_def.hpp.

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]

Implements Rythmos::InterpolationBufferBase< Scalar >.

Definition at line 512 of file Rythmos_DefaultIntegrator_def.hpp.

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 523 of file Rythmos_DefaultIntegrator_def.hpp.

template<class Scalar>
TimeRange< Scalar > Rythmos::DefaultIntegrator< Scalar >::getTimeRange (  )  const [virtual]

Implements Rythmos::InterpolationBufferBase< Scalar >.

Definition at line 548 of file Rythmos_DefaultIntegrator_def.hpp.

template<class Scalar>
void Rythmos::DefaultIntegrator< Scalar >::getNodes ( Array< Scalar > *  time_vec  )  const [virtual]

Implements Rythmos::InterpolationBufferBase< Scalar >.

Definition at line 559 of file Rythmos_DefaultIntegrator_def.hpp.

template<class Scalar>
void Rythmos::DefaultIntegrator< Scalar >::removeNodes ( Array< Scalar > &  time_vec  )  [virtual]

Implements Rythmos::InterpolationBufferBase< Scalar >.

Definition at line 566 of file Rythmos_DefaultIntegrator_def.hpp.

template<class Scalar>
int Rythmos::DefaultIntegrator< Scalar >::getOrder (  )  const [virtual]

Implements Rythmos::InterpolationBufferBase< Scalar >.

Definition at line 573 of file Rythmos_DefaultIntegrator_def.hpp.


Friends And Related Function Documentation

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

Definition at line 51 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 65 of file Rythmos_DefaultIntegrator_def.hpp.

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

Definition at line 84 of file Rythmos_DefaultIntegrator_def.hpp.

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

Definition at line 101 of file Rythmos_DefaultIntegrator_def.hpp.


The documentation for this class was generated from the following files:
Generated on Tue Jul 13 09:23:54 2010 for Rythmos - Transient Integration for Differential Equations by  doxygen 1.4.7