Mix-in interface for stepper objects that accept a step control strategy object to be used for evaluating steps and picking step-sizes & orders. More...
#include <Rythmos_StepControlStrategyAcceptingStepperBase.hpp>
Inheritance diagram for Rythmos::StepControlStrategyAcceptingStepperBase< Scalar >:
Public Member Functions | |
| virtual void | setStepControlStrategy (const Teuchos::RCP< StepControlStrategyBase< Scalar > > &stepControlStrategy)=0 |
| virtual Teuchos::RCP< StepControlStrategyBase< Scalar > > | getNonconstStepControlStrategy ()=0 |
| virtual Teuchos::RCP< const StepControlStrategyBase< Scalar > > | getStepControlStrategy () const =0 |
 Public Member Functions inherited from Rythmos::StepperBase< Scalar > | |
| virtual bool | supportsCloning () const |
| Return if this stepper supports cloning or not. More... | |
| virtual RCP< StepperBase< Scalar > > | cloneStepperAlgorithm () const |
| Clone the stepper object if supported. More... | |
| virtual bool | isImplicit () const |
| Return if this stepper is an implicit stepper. More... | |
| virtual bool | acceptsModel () const |
| Return if this stepper accepts a model. More... | |
| virtual void | setModel (const RCP< const Thyra::ModelEvaluator< Scalar > > &model)=0 |
| Specify the model problem to integrate. More... | |
| virtual void | setNonconstModel (const RCP< Thyra::ModelEvaluator< Scalar > > &model)=0 |
| Accept a nonconst model. More... | |
| virtual bool | modelIsConst () const |
| Return of the model is only const or can be returned as a non-const object. More... | |
| virtual RCP< const Thyra::ModelEvaluator< Scalar > > | getModel () const =0 |
| Get the model. More... | |
| virtual RCP< Thyra::ModelEvaluator< Scalar > > | getNonconstModel ()=0 |
| Get the model nonconst. More... | |
| virtual void | setInitialCondition (const Thyra::ModelEvaluatorBase::InArgs< Scalar > &initialCondition)=0 |
| Specify initial condition and re-initialize. More... | |
| virtual Thyra::ModelEvaluatorBase::InArgs< Scalar > | getInitialCondition () const =0 |
| Get the currently set initial condtion. More... | |
| virtual Scalar | takeStep (Scalar dt, StepSizeType stepType)=0 |
| Take a step. More... | |
| virtual const StepStatus< Scalar > | getStepStatus () const =0 |
| Get current stepper status after a step has been taken. More... | |
| virtual void | setStepControlData (const StepperBase &stepper) |
| Set step control data from another stepper. More... | |
Additional Inherited Members | |
| Related Functions inherited from Rythmos::StepperBase< Scalar > | |
| template<class Scalar > | |
| bool | isInitialized (const StepperBase< Scalar > &stepper) |
| template<class Scalar > | |
| bool | isInitialized (const StepperBase< Scalar > &stepper) |
Detailed Description
template<class Scalar>
class Rythmos::StepControlStrategyAcceptingStepperBase< Scalar >
Mix-in interface for stepper objects that accept a step control strategy object to be used for evaluating steps and picking step-sizes & orders.
ToDo: Finish documentation!
Definition at line 48 of file Rythmos_StepControlStrategyAcceptingStepperBase.hpp.
Member Function Documentation
◆ setStepControlStrategy()
template<class Scalar >
|
pure virtual |
◆ getNonconstStepControlStrategy()
template<class Scalar >
|
pure virtual |
◆ getStepControlStrategy()
template<class Scalar >
|
pure virtual |
The documentation for this class was generated from the following file:
