Rythmos::DefaultIntegrator< Scalar > Class Template Reference

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

#include <Rythmos_DefaultIntegrator.hpp>

Inheritance diagram for Rythmos::DefaultIntegrator< Scalar >:

Public Types
typedef 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)

Constructors, Initializers, Misc

	DefaultIntegrator ()

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

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

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

RCP< const InterpolationBufferAppenderBase < Scalar > >	getInterpolationBufferAppender ()

RCP < InterpolationBufferAppenderBase < Scalar > >	unSetInterpolationBufferAppender ()

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)

RCP< StepperBase< Scalar > >	unSetStepper ()

RCP< const StepperBase< Scalar > >	getStepper () const

bool	acceptsTrailingInterpolationBuffer () const

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

RCP< InterpolationBufferBase < Scalar > >	getTrailingInterpolationBuffer ()

RCP< const InterpolationBufferBase < Scalar > >	getTrailingInterpolationBuffer () const

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

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 53 of file Rythmos_DefaultIntegrator.hpp.

Member Typedef Documentation

template<class Scalar >

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

Reimplemented from Rythmos::IntegratorBase< Scalar >.

Definition at line 60 of file Rythmos_DefaultIntegrator.hpp.

Constructor & Destructor Documentation

template<class Scalar >

Rythmos::DefaultIntegrator< Scalar >::DefaultIntegrator ( ) [inline]

Definition at line 313 of file Rythmos_DefaultIntegrator.hpp.

Member Function Documentation

template<class Scalar >

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

Definition at line 321 of file Rythmos_DefaultIntegrator.hpp.

template<class Scalar >

void Rythmos::DefaultIntegrator< Scalar >::setIntegrationObserver ( const RCP< IntegrationObserverBase< Scalar > > & integrationObserver ) [inline]

Definition at line 333 of file Rythmos_DefaultIntegrator.hpp.

template<class Scalar >

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

Definition at line 345 of file Rythmos_DefaultIntegrator.hpp.

template<class Scalar >

RCP< const InterpolationBufferAppenderBase< Scalar > > Rythmos::DefaultIntegrator< Scalar >::getInterpolationBufferAppender ( ) [inline]

Definition at line 355 of file Rythmos_DefaultIntegrator.hpp.

template<class Scalar >

RCP< InterpolationBufferAppenderBase< Scalar > > Rythmos::DefaultIntegrator< Scalar >::unSetInterpolationBufferAppender ( ) [inline]

Definition at line 363 of file Rythmos_DefaultIntegrator.hpp.

template<class Scalar >

void Rythmos::DefaultIntegrator< Scalar >::setParameterList ( RCP< ParameterList > const & paramList ) [inline, virtual]

Implements Teuchos::ParameterListAcceptor.

Definition at line 375 of file Rythmos_DefaultIntegrator.hpp.

template<class Scalar >

RCP< const ParameterList > Rythmos::DefaultIntegrator< Scalar >::getValidParameters ( ) const [inline, virtual]

Reimplemented from Teuchos::ParameterListAcceptor.

Definition at line 390 of file Rythmos_DefaultIntegrator.hpp.

template<class Scalar >

RCP< IntegratorBase< Scalar > > Rythmos::DefaultIntegrator< Scalar >::cloneIntegrator ( ) const [inline, virtual]

Reimplemented from Rythmos::IntegratorBase< Scalar >.

Definition at line 410 of file Rythmos_DefaultIntegrator.hpp.

template<class Scalar >

void Rythmos::DefaultIntegrator< Scalar >::setStepper	(	const RCP< StepperBase< Scalar > > &	stepper,
		const Scalar &	finalTime,
		const bool	landOnFinalTime
	)			`[inline, virtual]`

Implements Rythmos::IntegratorBase< Scalar >.

Definition at line 439 of file Rythmos_DefaultIntegrator.hpp.

template<class Scalar >

RCP< StepperBase< Scalar > > Rythmos::DefaultIntegrator< Scalar >::unSetStepper ( ) [inline, virtual]

Implements Rythmos::IntegratorBase< Scalar >.

Definition at line 467 of file Rythmos_DefaultIntegrator.hpp.

template<class Scalar >

RCP< const StepperBase< Scalar > > Rythmos::DefaultIntegrator< Scalar >::getStepper ( ) const [inline, virtual]

Implements Rythmos::IntegratorBase< Scalar >.

Definition at line 476 of file Rythmos_DefaultIntegrator.hpp.

template<class Scalar >

bool Rythmos::DefaultIntegrator< Scalar >::acceptsTrailingInterpolationBuffer ( ) const [inline, virtual]

Reimplemented from Rythmos::IntegratorBase< Scalar >.

Definition at line 483 of file Rythmos_DefaultIntegrator.hpp.

template<class Scalar >

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

Reimplemented from Rythmos::IntegratorBase< Scalar >.

Definition at line 490 of file Rythmos_DefaultIntegrator.hpp.

template<class Scalar >

RCP< InterpolationBufferBase< Scalar > > Rythmos::DefaultIntegrator< Scalar >::getTrailingInterpolationBuffer ( ) [inline, virtual]

Reimplemented from Rythmos::IntegratorBase< Scalar >.

Definition at line 500 of file Rythmos_DefaultIntegrator.hpp.

template<class Scalar >

RCP< const InterpolationBufferBase< Scalar > > Rythmos::DefaultIntegrator< Scalar >::getTrailingInterpolationBuffer ( ) const [inline, virtual]

Reimplemented from Rythmos::IntegratorBase< Scalar >.

Definition at line 508 of file Rythmos_DefaultIntegrator.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
	)			`[inline]`

Definition at line 515 of file Rythmos_DefaultIntegrator.hpp.

template<class Scalar >

TimeRange< Scalar > Rythmos::DefaultIntegrator< Scalar >::getFwdTimeRange ( ) const [inline, virtual]

Implements Rythmos::IntegratorBase< Scalar >.

Definition at line 624 of file Rythmos_DefaultIntegrator.hpp.

template<class Scalar >

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

Implements Rythmos::InterpolationBufferBase< Scalar >.

Definition at line 638 of file Rythmos_DefaultIntegrator.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
	)			`[inline, virtual]`

Implements Rythmos::InterpolationBufferBase< Scalar >.

Definition at line 645 of file Rythmos_DefaultIntegrator.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 `[inline]`

Definition at line 656 of file Rythmos_DefaultIntegrator.hpp.

template<class Scalar >

TimeRange< Scalar > Rythmos::DefaultIntegrator< Scalar >::getTimeRange ( ) const [inline, virtual]

Implements Rythmos::InterpolationBufferBase< Scalar >.

Definition at line 669 of file Rythmos_DefaultIntegrator.hpp.

template<class Scalar >

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

Implements Rythmos::InterpolationBufferBase< Scalar >.

Definition at line 676 of file Rythmos_DefaultIntegrator.hpp.

template<class Scalar >

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

Implements Rythmos::InterpolationBufferBase< Scalar >.

Definition at line 683 of file Rythmos_DefaultIntegrator.hpp.

template<class Scalar >

int Rythmos::DefaultIntegrator< Scalar >::getOrder ( ) const [inline, virtual]

Implements Rythmos::InterpolationBufferBase< Scalar >.

Definition at line 690 of file Rythmos_DefaultIntegrator.hpp.

Friends And Related Function Documentation

template<class Scalar >

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

Definition at line 226 of file Rythmos_DefaultIntegrator.hpp.

template<class Scalar >

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

Definition at line 240 of file Rythmos_DefaultIntegrator.hpp.

template<class Scalar >

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