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

#include <Rythmos_DefaultIntegrator_decl.hpp>

Inheritance diagram for Rythmos::DefaultIntegrator< Scalar >:

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)

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]

Implements Rythmos::InterpolationBufferAppenderAcceptingIntegratorBase< Scalar >.

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

template<class Scalar >

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

Implements Rythmos::InterpolationBufferAppenderAcceptingIntegratorBase< Scalar >.

Definition at line 199 of file Rythmos_DefaultIntegrator_def.hpp.

template<class Scalar >

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

Implements Rythmos::InterpolationBufferAppenderAcceptingIntegratorBase< Scalar >.

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

template<class Scalar >

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

Implements Rythmos::IntegrationControlStrategyAcceptingIntegratorBase< Scalar >.

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

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]`

Implements Rythmos::IntegratorBase< Scalar >.

Definition at line 289 of file Rythmos_DefaultIntegrator_def.hpp.

template<class Scalar >

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

Implements Rythmos::IntegratorBase< Scalar >.

Definition at line 318 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 327 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 334 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 341 of file Rythmos_DefaultIntegrator_def.hpp.

template<class Scalar >

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

Implements Rythmos::TrailingInterpolationBufferAcceptingIntegratorBase< Scalar >.

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

template<class Scalar >

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

Implements Rythmos::TrailingInterpolationBufferAcceptingIntegratorBase< Scalar >.

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

template<class Scalar >

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

Implements Rythmos::IntegratorBase< Scalar >.

Definition at line 510 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 524 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 531 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 542 of file Rythmos_DefaultIntegrator_def.hpp.

template<class Scalar >

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

Implements Rythmos::InterpolationBufferBase< Scalar >.

Definition at line 567 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 578 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 585 of file Rythmos_DefaultIntegrator_def.hpp.

template<class Scalar >

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

Implements Rythmos::InterpolationBufferBase< Scalar >.

Definition at line 592 of file Rythmos_DefaultIntegrator_def.hpp.

Friends And Related Function Documentation

template<class Scalar >

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

template<class Scalar >

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

template<class Scalar >

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

template<class Scalar >

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

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:

Public Types

Public Member Functions

Related Functions

Constructors, Initializers, Misc

Overridden from InterpolationBufferAppenderAcceptingIntegratorBase

Overridden from IntegrationControlStrategyAcceptingIntegratorBase

Overridden from ParameterListAcceptor

Overridden from IntegratorBase

Overridden from TrailingInterpolationBufferAcceptingIntegratorBase

Overridden from InterpolationBufferBase

Detailed Description

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

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

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