Rythmos - Transient Integration for Differential Equations Version of the Day
Loading...
Searching...
No Matches
Public Types | Related Functions | List of all members
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]

Public Types

typedef ScalarTraits< Scalar >::magnitudeType ScalarMag
 
- Public Types inherited from Rythmos::IntegratorBase< Scalar >
typedef Teuchos::ScalarTraits< Scalar >::magnitudeType ScalarMag
 
- Public Types inherited from Rythmos::InterpolationBufferBase< Scalar >
typedef Teuchos::ScalarTraits< Scalar >::magnitudeType ScalarMag
 

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

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
 

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

Additional Inherited Members

virtual void setIntegrationControlStrategy (const RCP< IntegrationControlStrategyBase< Scalar > > &integrationControlStrategy)=0
 
virtual RCP< IntegrationControlStrategyBase< Scalar > > getNonconstIntegrationControlStrategy ()=0
 
virtual RCP< const IntegrationControlStrategyBase< Scalar > > getIntegrationControlStrategy () const =0
 
- Public Member Functions inherited from Rythmos::IntegratorBase< Scalar >
virtual RCP< IntegratorBase< Scalar > > cloneIntegrator () const
 
virtual void setStepper (const RCP< StepperBase< Scalar > > &stepper, const Scalar &finalTime, const bool landOnFinalTime=true)=0
 Specify the stepper to use for integration which effectively reinitializes the intergrator.
 
virtual Teuchos::RCP< const StepperBase< Scalar > > getStepper () const =0
 Get the current stepper that is set.
 
virtual Teuchos::RCP< StepperBase< Scalar > > getNonconstStepper () const =0
 Get the current stepper that is set.
 
virtual RCP< StepperBase< Scalar > > unSetStepper ()=0
 Remove the stepper and set *this to an unitilaized state.
 
virtual 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)=0
 Get values at time points both inside and outside (forward) of current TimeRange.
 
virtual TimeRange< Scalar > getFwdTimeRange () const =0
 Return the valid range of points that the integrator can integrate over.
 
- Public Member Functions inherited from Rythmos::InterpolationBufferBase< Scalar >
virtual RCP< const Thyra::VectorSpaceBase< Scalar > > get_x_space () const =0
 Return the space for x and x_dot.
 
virtual 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)=0
 Add points to the buffer.
 
virtual TimeRange< Scalar > getTimeRange () const =0
 Return the range of time values where interpolation calls can be performed.
 
virtual 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 =0
 Get values from the buffer at different time points.
 
virtual void getNodes (Array< Scalar > *time_vec) const =0
 Get interpolation nodes.
 
virtual void removeNodes (Array< Scalar > &time_vec)=0
 Remove nodes from the interpolation buffer.
 
virtual int getOrder () const =0
 Get order of interpolation.
 
virtual void setInterpolationBufferAppender (const RCP< InterpolationBufferAppenderBase< Scalar > > &interpBufferAppender)=0
 
virtual RCP< const InterpolationBufferAppenderBase< Scalar > > getInterpolationBufferAppender ()=0
 
virtual RCP< InterpolationBufferAppenderBase< Scalar > > getNonconstInterpolationBufferAppender ()=0
 
virtual RCP< InterpolationBufferAppenderBase< Scalar > > unSetInterpolationBufferAppender ()=0
 
virtual void setTrailingInterpolationBuffer (const RCP< InterpolationBufferBase< Scalar > > &trailingInterpBuffer)=0
 
virtual RCP< InterpolationBufferBase< Scalar > > getNonconstTrailingInterpolationBuffer ()=0
 
virtual RCP< const InterpolationBufferBase< Scalar > > getTrailingInterpolationBuffer () const =0
 
virtual RCP< InterpolationBufferBase< Scalar > > unSetTrailingInterpolationBuffer ()=0
 

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

◆ ScalarMag

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

Definition at line 59 of file Rythmos_DefaultIntegrator_decl.hpp.

Constructor & Destructor Documentation

◆ DefaultIntegrator()

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

Definition at line 136 of file Rythmos_DefaultIntegrator_def.hpp.

Member Function Documentation

◆ setIntegrationObserver()

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

Definition at line 170 of file Rythmos_DefaultIntegrator_def.hpp.

◆ setInterpolationBufferAppender()

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

◆ getInterpolationBufferAppender()

template<class Scalar >
RCP< const InterpolationBufferAppenderBase< Scalar > > Rythmos::DefaultIntegrator< Scalar >::getInterpolationBufferAppender
virtual

◆ getNonconstInterpolationBufferAppender()

template<class Scalar >
RCP< InterpolationBufferAppenderBase< Scalar > > Rythmos::DefaultIntegrator< Scalar >::getNonconstInterpolationBufferAppender
virtual

◆ unSetInterpolationBufferAppender()

template<class Scalar >
RCP< InterpolationBufferAppenderBase< Scalar > > Rythmos::DefaultIntegrator< Scalar >::unSetInterpolationBufferAppender
virtual

◆ setIntegrationControlStrategy()

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

◆ getNonconstIntegrationControlStrategy()

template<class Scalar >
RCP< IntegrationControlStrategyBase< Scalar > > Rythmos::DefaultIntegrator< Scalar >::getNonconstIntegrationControlStrategy
virtual

◆ getIntegrationControlStrategy()

template<class Scalar >
RCP< const IntegrationControlStrategyBase< Scalar > > Rythmos::DefaultIntegrator< Scalar >::getIntegrationControlStrategy
virtual

◆ setParameterList()

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

Definition at line 218 of file Rythmos_DefaultIntegrator_def.hpp.

◆ getValidParameters()

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

Definition at line 233 of file Rythmos_DefaultIntegrator_def.hpp.

◆ cloneIntegrator()

template<class Scalar >
RCP< IntegratorBase< Scalar > > Rythmos::DefaultIntegrator< Scalar >::cloneIntegrator
virtual

Reimplemented from Rythmos::IntegratorBase< Scalar >.

Definition at line 252 of file Rythmos_DefaultIntegrator_def.hpp.

◆ setStepper()

template<class Scalar >
void Rythmos::DefaultIntegrator< Scalar >::setStepper ( const RCP< StepperBase< Scalar > > &  stepper,
const Scalar &  finalTime,
const bool  landOnFinalTime = true 
)
virtual

◆ unSetStepper()

template<class Scalar >
RCP< StepperBase< Scalar > > Rythmos::DefaultIntegrator< Scalar >::unSetStepper
virtual

◆ getStepper()

template<class Scalar >
RCP< const StepperBase< Scalar > > Rythmos::DefaultIntegrator< Scalar >::getStepper
virtual

◆ getNonconstStepper()

template<class Scalar >
RCP< StepperBase< Scalar > > Rythmos::DefaultIntegrator< Scalar >::getNonconstStepper
virtual

◆ setTrailingInterpolationBuffer()

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

◆ getNonconstTrailingInterpolationBuffer()

template<class Scalar >
RCP< InterpolationBufferBase< Scalar > > Rythmos::DefaultIntegrator< Scalar >::getNonconstTrailingInterpolationBuffer
virtual

◆ getTrailingInterpolationBuffer()

template<class Scalar >
RCP< const InterpolationBufferBase< Scalar > > Rythmos::DefaultIntegrator< Scalar >::getTrailingInterpolationBuffer
virtual

◆ unSetTrailingInterpolationBuffer()

template<class Scalar >
RCP< InterpolationBufferBase< Scalar > > Rythmos::DefaultIntegrator< Scalar >::unSetTrailingInterpolationBuffer
virtual

◆ getFwdPoints()

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.

◆ getFwdTimeRange()

template<class Scalar >
TimeRange< Scalar > Rythmos::DefaultIntegrator< Scalar >::getFwdTimeRange
virtual

◆ get_x_space()

template<class Scalar >
RCP< const Thyra::VectorSpaceBase< Scalar > > Rythmos::DefaultIntegrator< Scalar >::get_x_space
virtual

◆ addPoints()

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

◆ getPoints()

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.

◆ getTimeRange()

template<class Scalar >
TimeRange< Scalar > Rythmos::DefaultIntegrator< Scalar >::getTimeRange
virtual

◆ getNodes()

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

◆ removeNodes()

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

◆ getOrder()

template<class Scalar >
int Rythmos::DefaultIntegrator< Scalar >::getOrder
virtual

Friends And Related Function Documentation

◆ defaultIntegrator() [1/4]

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

◆ defaultIntegrator() [2/4]

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

◆ controlledDefaultIntegrator() [1/2]

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

◆ observedDefaultIntegrator() [1/2]

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

◆ defaultIntegrator() [3/4]

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

Definition at line 52 of file Rythmos_DefaultIntegrator_def.hpp.

◆ defaultIntegrator() [4/4]

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.

◆ controlledDefaultIntegrator() [2/2]

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

Definition at line 85 of file Rythmos_DefaultIntegrator_def.hpp.

◆ observedDefaultIntegrator() [2/2]

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: