Rythmos - Transient Integration for Differential Equations Version of the Day
|
#include <Rythmos_ForwardEulerStepper_decl.hpp>
Public Member Functions | |
ForwardEulerStepper () | |
bool | supportsCloning () const |
RCP< StepperBase< Scalar > > | cloneStepperAlgorithm () const |
void | setModel (const RCP< const Thyra::ModelEvaluator< Scalar > > &model) |
void | setNonconstModel (const RCP< Thyra::ModelEvaluator< Scalar > > &model) |
RCP< const Thyra::ModelEvaluator< Scalar > > | getModel () const |
RCP< Thyra::ModelEvaluator< Scalar > > | getNonconstModel () |
void | setInitialCondition (const Thyra::ModelEvaluatorBase::InArgs< Scalar > &initialCondition) |
Thyra::ModelEvaluatorBase::InArgs< Scalar > | getInitialCondition () const |
RCP< const Thyra::VectorSpaceBase< Scalar > > | get_x_space () const |
~ForwardEulerStepper () | |
Scalar | takeStep (Scalar dt, StepSizeType flag) |
const StepStatus< Scalar > | getStepStatus () const |
std::string | description () const |
void | describe (Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel) 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 |
Get values from buffer. | |
void | setRange (const TimeRange< Scalar > &range, const InterpolationBufferBase< Scalar > &IB) |
Fill data in from another interpolation buffer. | |
TimeRange< Scalar > | getTimeRange () const |
void | getNodes (Array< Scalar > *time_vec) const |
Get interpolation nodes. | |
void | removeNodes (Array< Scalar > &time_vec) |
Remove interpolation nodes. | |
int | getOrder () const |
Get order of interpolation. | |
void | setParameterList (RCP< Teuchos::ParameterList > const ¶mList) |
Redefined from Teuchos::ParameterListAcceptor. | |
RCP< Teuchos::ParameterList > | getNonconstParameterList () |
RCP< Teuchos::ParameterList > | unsetParameterList () |
RCP< const Teuchos::ParameterList > | getValidParameters () const |
RCP< const MomentoBase< Scalar > > | getMomento () const |
Get momento object for use in restarts. | |
void | setMomento (const Ptr< const MomentoBase< Scalar > > &momentoPtr) |
Set momento object for use in restarts. | |
![]() | |
virtual bool | supportsCloning () const |
Return if this stepper supports cloning or not. | |
virtual RCP< StepperBase< Scalar > > | cloneStepperAlgorithm () const |
Clone the stepper object if supported. | |
virtual bool | isImplicit () const |
Return if this stepper is an implicit stepper. | |
virtual bool | acceptsModel () const |
Return if this stepper accepts a model. | |
virtual void | setModel (const RCP< const Thyra::ModelEvaluator< Scalar > > &model)=0 |
Specify the model problem to integrate. | |
virtual void | setNonconstModel (const RCP< Thyra::ModelEvaluator< Scalar > > &model)=0 |
Accept a nonconst model. | |
virtual bool | modelIsConst () const |
Return of the model is only const or can be returned as a non-const object. | |
virtual RCP< const Thyra::ModelEvaluator< Scalar > > | getModel () const =0 |
Get the model. | |
virtual RCP< Thyra::ModelEvaluator< Scalar > > | getNonconstModel ()=0 |
Get the model nonconst. | |
virtual void | setInitialCondition (const Thyra::ModelEvaluatorBase::InArgs< Scalar > &initialCondition)=0 |
Specify initial condition and re-initialize. | |
virtual Thyra::ModelEvaluatorBase::InArgs< Scalar > | getInitialCondition () const =0 |
Get the currently set initial condtion. | |
virtual Scalar | takeStep (Scalar dt, StepSizeType stepType)=0 |
Take a step. | |
virtual const StepStatus< Scalar > | getStepStatus () const =0 |
Get current stepper status after a step has been taken. | |
virtual void | setStepControlData (const StepperBase &stepper) |
Set step control data from another stepper. | |
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. | |
Additional Inherited Members | |
![]() | |
typedef Teuchos::ScalarTraits< Scalar >::magnitudeType | ScalarMag |
![]() | |
template<class Scalar > | |
bool | isInitialized (const StepperBase< Scalar > &stepper) |
template<class Scalar > | |
bool | isInitialized (const StepperBase< Scalar > &stepper) |
![]() | |
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. | |
Definition at line 327 of file Rythmos_ForwardEulerStepper_decl.hpp.
Rythmos::ForwardEulerStepper< Scalar >::ForwardEulerStepper |
Definition at line 344 of file Rythmos_ForwardEulerStepper_def.hpp.
Rythmos::ForwardEulerStepper< Scalar >::~ForwardEulerStepper |
Definition at line 381 of file Rythmos_ForwardEulerStepper_def.hpp.
|
virtual |
Reimplemented from Rythmos::StepperBase< Scalar >.
Definition at line 639 of file Rythmos_ForwardEulerStepper_def.hpp.
|
virtual |
Reimplemented from Rythmos::StepperBase< Scalar >.
Definition at line 646 of file Rythmos_ForwardEulerStepper_def.hpp.
|
virtual |
Implements Rythmos::StepperBase< Scalar >.
Definition at line 587 of file Rythmos_ForwardEulerStepper_def.hpp.
|
virtual |
Implements Rythmos::StepperBase< Scalar >.
Definition at line 596 of file Rythmos_ForwardEulerStepper_def.hpp.
|
virtual |
Implements Rythmos::StepperBase< Scalar >.
Definition at line 604 of file Rythmos_ForwardEulerStepper_def.hpp.
|
virtual |
Implements Rythmos::StepperBase< Scalar >.
Definition at line 611 of file Rythmos_ForwardEulerStepper_def.hpp.
|
virtual |
Implements Rythmos::StepperBase< Scalar >.
Definition at line 617 of file Rythmos_ForwardEulerStepper_def.hpp.
|
virtual |
Implements Rythmos::StepperBase< Scalar >.
Definition at line 632 of file Rythmos_ForwardEulerStepper_def.hpp.
|
virtual |
Implements Rythmos::InterpolationBufferBase< Scalar >.
Definition at line 386 of file Rythmos_ForwardEulerStepper_def.hpp.
|
virtual |
Implements Rythmos::StepperBase< Scalar >.
Definition at line 393 of file Rythmos_ForwardEulerStepper_def.hpp.
|
virtual |
Implements Rythmos::StepperBase< Scalar >.
Definition at line 419 of file Rythmos_ForwardEulerStepper_def.hpp.
std::string Rythmos::ForwardEulerStepper< Scalar >::description |
Definition at line 446 of file Rythmos_ForwardEulerStepper_def.hpp.
void Rythmos::ForwardEulerStepper< Scalar >::describe | ( | Teuchos::FancyOStream & | out, |
const Teuchos::EVerbosityLevel | verbLevel | ||
) | const |
Definition at line 453 of file Rythmos_ForwardEulerStepper_def.hpp.
|
virtual |
Redefined from InterpolationBufferBase Add points to buffer
Implements Rythmos::InterpolationBufferBase< Scalar >.
Definition at line 476 of file Rythmos_ForwardEulerStepper_def.hpp.
|
virtual |
Get values from buffer.
Implements Rythmos::InterpolationBufferBase< Scalar >.
Definition at line 486 of file Rythmos_ForwardEulerStepper_def.hpp.
void Rythmos::ForwardEulerStepper< Scalar >::setRange | ( | const TimeRange< Scalar > & | range, |
const InterpolationBufferBase< Scalar > & | IB | ||
) |
Fill data in from another interpolation buffer.
|
virtual |
Implements Rythmos::InterpolationBufferBase< Scalar >.
Definition at line 511 of file Rythmos_ForwardEulerStepper_def.hpp.
|
virtual |
Get interpolation nodes.
Implements Rythmos::InterpolationBufferBase< Scalar >.
Definition at line 521 of file Rythmos_ForwardEulerStepper_def.hpp.
|
virtual |
Remove interpolation nodes.
Implements Rythmos::InterpolationBufferBase< Scalar >.
Definition at line 536 of file Rythmos_ForwardEulerStepper_def.hpp.
|
virtual |
Get order of interpolation.
Implements Rythmos::InterpolationBufferBase< Scalar >.
Definition at line 542 of file Rythmos_ForwardEulerStepper_def.hpp.
void Rythmos::ForwardEulerStepper< Scalar >::setParameterList | ( | RCP< Teuchos::ParameterList > const & | paramList | ) |
Redefined from Teuchos::ParameterListAcceptor.
Definition at line 548 of file Rythmos_ForwardEulerStepper_def.hpp.
Teuchos::RCP< Teuchos::ParameterList > Rythmos::ForwardEulerStepper< Scalar >::getNonconstParameterList |
Definition at line 557 of file Rythmos_ForwardEulerStepper_def.hpp.
Teuchos::RCP< Teuchos::ParameterList > Rythmos::ForwardEulerStepper< Scalar >::unsetParameterList |
Definition at line 563 of file Rythmos_ForwardEulerStepper_def.hpp.
RCP< const Teuchos::ParameterList > Rythmos::ForwardEulerStepper< Scalar >::getValidParameters |
Definition at line 573 of file Rythmos_ForwardEulerStepper_def.hpp.
RCP< const MomentoBase< Scalar > > Rythmos::ForwardEulerStepper< Scalar >::getMomento |
Get momento object for use in restarts.
Definition at line 669 of file Rythmos_ForwardEulerStepper_def.hpp.
void Rythmos::ForwardEulerStepper< Scalar >::setMomento | ( | const Ptr< const MomentoBase< Scalar > > & | momentoPtr | ) |
Set momento object for use in restarts.
Definition at line 689 of file Rythmos_ForwardEulerStepper_def.hpp.