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 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 Symbols
(Note that these are not member symbols.)
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)
Related Symbols inherited from Rythmos::IntegratorBase< Scalar >
template<class Scalar>
RCP< const Thyra::VectorBase< Scalar > >	get_fwd_x (IntegratorBase< Scalar > &integrator, const Scalar t)
	Nonmember helper function to get x at a (forward) time t.
template<class Scalar>
void	get_fwd_x_and_x_dot (IntegratorBase< Scalar > &integrator, const Scalar t, const Ptr< RCP< const Thyra::VectorBase< Scalar > > > &x, const Ptr< RCP< const Thyra::VectorBase< Scalar > > > &x_dot)
	Nonmember helper function to get x and/or x_dot at s (forward) time t.
Related Symbols inherited from Rythmos::InterpolationBufferBase< Scalar >
template<class Scalar>
RCP< const Thyra::VectorBase< Scalar > >	get_x (const InterpolationBufferBase< Scalar > &interpBuffer, const Scalar &t)
	Get a single point x(t) from an interpolation buffer.
template<class Scalar>
RCP< const Thyra::VectorBase< Scalar > >	get_xdot (const InterpolationBufferBase< Scalar > &interpBuffer, const Scalar &t)
	Get a single point xdot(t) from an interpolation buffer.
template<class Scalar>
void	get_x_and_x_dot (const InterpolationBufferBase< Scalar > &interpBuffer, const Scalar t, const Ptr< RCP< const Thyra::VectorBase< Scalar > > > &x, const Ptr< RCP< const Thyra::VectorBase< Scalar > > > &x_dot)
	Nonmember helper function to get x and x_dot at t.
template<class Scalar>
void	assertTimePointsAreSorted (const Array< Scalar > &time_vec)
	Assert that a time point vector is sorted.
template<class Scalar>
void	assertNoTimePointsBeforeCurrentTimeRange (const InterpolationBufferBase< Scalar > &interpBuffer, const Array< Scalar > &time_vec, const int &startingTimePointIndex=0)
	Assert that none of the time points fall before the current time range for an interpolation buffer object.
template<class Scalar>
void	assertNoTimePointsInsideCurrentTimeRange (const InterpolationBufferBase< Scalar > &interpBuffer, const Array< Scalar > &time_vec)
	Assert that none of the time points fall inside the current time range for an interpolation buffer object.
template<class TimeType>
void	selectPointsInTimeRange (const Array< TimeType > &points_in, const TimeRange< TimeType > &range, const Ptr< Array< TimeType > > &points_out)
	Select points from an Array that sit in a TimeRange.
template<class TimeType>
void	removePointsInTimeRange (Array< TimeType > *points_in, const TimeRange< TimeType > &range)
	Remove points from an Array that sit in a TimeRange.
template<class Scalar>
bool	getCurrentPoints (const InterpolationBufferBase< Scalar > &interpBuffer, const Array< Scalar > &time_vec, Array< RCP< const Thyra::VectorBase< Scalar > > > x_vec, Array< RCP< const Thyra::VectorBase< Scalar > > > xdot_vec, int *nextTimePointIndex)
	Get time points in the current range of an interpolation buffer object.

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
Public Member Functions inherited from Rythmos::IntegratorBase< Scalar >
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.
Public Member Functions inherited from Rythmos::InterpolationBufferBase< Scalar >
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.

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

Implements Rythmos::InterpolationBufferAppenderAcceptingIntegratorBase< Scalar >.

Definition at line 182 of file Rythmos_DefaultIntegrator_def.hpp.

◆ getInterpolationBufferAppender()

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.

◆ getNonconstInterpolationBufferAppender()

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.

◆ unSetInterpolationBufferAppender()

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.

◆ setIntegrationControlStrategy()

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.

◆ getNonconstIntegrationControlStrategy()

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.

◆ getIntegrationControlStrategy()

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.

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

Definition at line 233 of file Rythmos_DefaultIntegrator_def.hpp.

◆ cloneIntegrator()

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.

◆ setStepper()

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.

◆ unSetStepper()

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.

◆ getStepper()

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.

◆ getNonconstStepper()

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.

◆ setTrailingInterpolationBuffer()

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.

◆ getNonconstTrailingInterpolationBuffer()

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.

◆ getTrailingInterpolationBuffer()

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.

◆ unSetTrailingInterpolationBuffer()

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.

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

virtual

Implements Rythmos::IntegratorBase< Scalar >.

Definition at line 510 of file Rythmos_DefaultIntegrator_def.hpp.

◆ get_x_space()

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.

◆ 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

Implements Rythmos::InterpolationBufferBase< Scalar >.

Definition at line 531 of file Rythmos_DefaultIntegrator_def.hpp.

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

virtual

Implements Rythmos::InterpolationBufferBase< Scalar >.

Definition at line 567 of file Rythmos_DefaultIntegrator_def.hpp.

◆ getNodes()

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.

◆ removeNodes()

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.

◆ getOrder()

template<class Scalar>

int Rythmos::DefaultIntegrator< Scalar >::getOrder ( ) const

virtual

Implements Rythmos::InterpolationBufferBase< Scalar >.

Definition at line 592 of file Rythmos_DefaultIntegrator_def.hpp.

◆ defaultIntegrator() [1/4]

template<class Scalar>

RCP< DefaultIntegrator< Scalar > > defaultIntegrator ( )

◆ defaultIntegrator() [2/4]

template<class Scalar>

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

◆ controlledDefaultIntegrator() [1/2]

template<class Scalar>

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

◆ observedDefaultIntegrator() [1/2]

template<class Scalar>

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

◆ defaultIntegrator() [3/4]

template<class Scalar>

RCP< DefaultIntegrator< Scalar > > defaultIntegrator ( )

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 )

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 )

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 )

Definition at line 102 of file Rythmos_DefaultIntegrator_def.hpp.

The documentation for this class was generated from the following files:

Public Types

Related Symbols

Overridden from InterpolationBufferBase

Constructors, Initializers, Misc

Overridden from InterpolationBufferAppenderAcceptingIntegratorBase

Overridden from IntegrationControlStrategyAcceptingIntegratorBase

Overridden from ParameterListAcceptor

Overridden from IntegratorBase

Overridden from TrailingInterpolationBufferAcceptingIntegratorBase

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ ScalarMag

Constructor & Destructor Documentation

◆ DefaultIntegrator()

Member Function Documentation

◆ setIntegrationObserver()

◆ setInterpolationBufferAppender()

◆ getInterpolationBufferAppender()

◆ getNonconstInterpolationBufferAppender()

◆ unSetInterpolationBufferAppender()

◆ setIntegrationControlStrategy()

◆ getNonconstIntegrationControlStrategy()

◆ getIntegrationControlStrategy()

◆ setParameterList()

◆ getValidParameters()

◆ cloneIntegrator()

◆ setStepper()

◆ unSetStepper()

◆ getStepper()

◆ getNonconstStepper()

◆ setTrailingInterpolationBuffer()

◆ getNonconstTrailingInterpolationBuffer()

◆ getTrailingInterpolationBuffer()

◆ unSetTrailingInterpolationBuffer()

◆ getFwdPoints()

◆ getFwdTimeRange()

◆ get_x_space()

◆ addPoints()

◆ getPoints()

◆ getTimeRange()

◆ getNodes()

◆ removeNodes()

◆ getOrder()

Friends And Related Symbol Documentation

◆ defaultIntegrator() [1/4]

◆ defaultIntegrator() [2/4]

◆ controlledDefaultIntegrator() [1/2]

◆ observedDefaultIntegrator() [1/2]

◆ defaultIntegrator() [3/4]

◆ defaultIntegrator() [4/4]

◆ controlledDefaultIntegrator() [2/2]

◆ observedDefaultIntegrator() [2/2]