Rythmos - Transient Integration for Differential Equations Version of the Day
Loading...
Searching...
No Matches
Public Types | Public Member Functions | List of all members
Rythmos::ImplicitBDFStepper< Scalar > Class Template Reference

More...

#include <Rythmos_ImplicitBDFStepper_decl.hpp>

Inheritance diagram for Rythmos::ImplicitBDFStepper< Scalar >:
Inheritance graph
[legend]

Public Types

typedef Teuchos::ScalarTraits< Scalar >::magnitudeType ScalarMag
 
- Public Types inherited from Rythmos::InterpolationBufferBase< Scalar >
typedef Teuchos::ScalarTraits< Scalar >::magnitudeType ScalarMag
 

Public Member Functions

 ImplicitBDFStepper ()
 Constructors, intializers, Misc.
 
 ImplicitBDFStepper (const RCP< Thyra::ModelEvaluator< Scalar > > &model, const RCP< Thyra::NonlinearSolverBase< Scalar > > &solver)
 
 ImplicitBDFStepper (const RCP< Thyra::ModelEvaluator< Scalar > > &model, const RCP< Thyra::NonlinearSolverBase< Scalar > > &solver, const RCP< Teuchos::ParameterList > &parameterList)
 
RCP< const Thyra::VectorBase< Scalar > > get_solution () const
 
RCP< const Thyra::VectorBase< Scalar > > get_residual () const
 
const Thyra::VectorBase< Scalar > & getxHistory (int index) const
 
void setStepControlData (const StepperBase< Scalar > &stepper)
 
- Public Member Functions inherited from Rythmos::SolverAcceptingStepperBase< Scalar >
virtual void setSolver (const Teuchos::RCP< Thyra::NonlinearSolverBase< Scalar > > &solver)=0
 
virtual Teuchos::RCP< Thyra::NonlinearSolverBase< Scalar > > getNonconstSolver ()=0
 
virtual Teuchos::RCP< const Thyra::NonlinearSolverBase< Scalar > > getSolver () const =0
 
- Public Member Functions inherited from Rythmos::StepperBase< Scalar >
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.
 
- Public Member Functions inherited from Rythmos::StepControlStrategyAcceptingStepperBase< Scalar >
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
 

Overridden from Teuchos::Describable

std::string description () const
 
void describe (Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel) const
 
const Thyra::SolveStatus< Scalar > & getNonlinearSolveStatus () const
 Returns the Thyra::SolveStatus object from the last nonlinear solve.
 

Overridden from StepControlStrategyAcceptingStepperBase

void setStepControlStrategy (const RCP< StepControlStrategyBase< Scalar > > &stepControlStrategy)
 
RCP< StepControlStrategyBase< Scalar > > getNonconstStepControlStrategy ()
 
RCP< const StepControlStrategyBase< Scalar > > getStepControlStrategy () const
 

Overridden from SolverAcceptingStepperBase

void setSolver (const RCP< Thyra::NonlinearSolverBase< Scalar > > &solver)
 
RCP< Thyra::NonlinearSolverBase< Scalar > > getNonconstSolver ()
 
RCP< const Thyra::NonlinearSolverBase< Scalar > > getSolver () const
 
bool isImplicit () const
 Overridden from StepperBase.
 
bool supportsCloning () const
 Returns true.
 
RCP< StepperBase< Scalar > > cloneStepperAlgorithm () const
 Creates copies of all internal data (including the parameter list) except the model which is assumed to stateless.
 
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
 
Scalar takeStep (Scalar dt, StepSizeType flag)
 
const StepStatus< Scalar > getStepStatus () 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)
 
TimeRange< Scalar > getTimeRange () const
 
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
 
void getNodes (Array< Scalar > *time_vec) const
 
void removeNodes (Array< Scalar > &time_vec)
 
int getOrder () const
 

Overridden from Teuchos::ParameterListAcceptor

void setParameterList (RCP< Teuchos::ParameterList > const &paramList)
 
RCP< Teuchos::ParameterList > getNonconstParameterList ()
 
RCP< Teuchos::ParameterList > unsetParameterList ()
 
RCP< const Teuchos::ParameterList > getValidParameters () const
 

Additional Inherited Members

Detailed Description

template<class Scalar>
class Rythmos::ImplicitBDFStepper< Scalar >

Definition at line 52 of file Rythmos_ImplicitBDFStepper_decl.hpp.

Member Typedef Documentation

◆ ScalarMag

template<class Scalar >
typedef Teuchos::ScalarTraits<Scalar>::magnitudeType Rythmos::ImplicitBDFStepper< Scalar >::ScalarMag

Definition at line 59 of file Rythmos_ImplicitBDFStepper_decl.hpp.

Constructor & Destructor Documentation

◆ ImplicitBDFStepper() [1/3]

template<class Scalar >
Rythmos::ImplicitBDFStepper< Scalar >::ImplicitBDFStepper

Constructors, intializers, Misc.

Definition at line 78 of file Rythmos_ImplicitBDFStepper_def.hpp.

◆ ImplicitBDFStepper() [2/3]

template<class Scalar >
Rythmos::ImplicitBDFStepper< Scalar >::ImplicitBDFStepper ( const RCP< Thyra::ModelEvaluator< Scalar > > &  model,
const RCP< Thyra::NonlinearSolverBase< Scalar > > &  solver 
)

Definition at line 104 of file Rythmos_ImplicitBDFStepper_def.hpp.

◆ ImplicitBDFStepper() [3/3]

template<class Scalar >
Rythmos::ImplicitBDFStepper< Scalar >::ImplicitBDFStepper ( const RCP< Thyra::ModelEvaluator< Scalar > > &  model,
const RCP< Thyra::NonlinearSolverBase< Scalar > > &  solver,
const RCP< Teuchos::ParameterList > &  parameterList 
)

Definition at line 87 of file Rythmos_ImplicitBDFStepper_def.hpp.

Member Function Documentation

◆ get_solution()

template<class Scalar >
RCP< const Thyra::VectorBase< Scalar > > Rythmos::ImplicitBDFStepper< Scalar >::get_solution ( ) const

◆ get_residual()

template<class Scalar >
RCP< const Thyra::VectorBase< Scalar > > Rythmos::ImplicitBDFStepper< Scalar >::get_residual ( ) const

◆ getxHistory()

template<class Scalar >
const Thyra::VectorBase< Scalar > & Rythmos::ImplicitBDFStepper< Scalar >::getxHistory ( int  index) const

Definition at line 119 of file Rythmos_ImplicitBDFStepper_def.hpp.

◆ setStepControlData()

template<class Scalar >
void Rythmos::ImplicitBDFStepper< Scalar >::setStepControlData ( const StepperBase< Scalar > &  stepper)
virtual

Reimplemented from Rythmos::StepperBase< Scalar >.

Definition at line 1163 of file Rythmos_ImplicitBDFStepper_def.hpp.

◆ setStepControlStrategy()

template<class Scalar >
void Rythmos::ImplicitBDFStepper< Scalar >::setStepControlStrategy ( const RCP< StepControlStrategyBase< Scalar > > &  stepControlStrategy)

Definition at line 129 of file Rythmos_ImplicitBDFStepper_def.hpp.

◆ getNonconstStepControlStrategy()

template<class Scalar >
RCP< StepControlStrategyBase< Scalar > > Rythmos::ImplicitBDFStepper< Scalar >::getNonconstStepControlStrategy
virtual

◆ getStepControlStrategy()

template<class Scalar >
RCP< const StepControlStrategyBase< Scalar > > Rythmos::ImplicitBDFStepper< Scalar >::getStepControlStrategy
virtual

◆ setSolver()

template<class Scalar >
void Rythmos::ImplicitBDFStepper< Scalar >::setSolver ( const RCP< Thyra::NonlinearSolverBase< Scalar > > &  solver)

Definition at line 152 of file Rythmos_ImplicitBDFStepper_def.hpp.

◆ getNonconstSolver()

template<class Scalar >
RCP< Thyra::NonlinearSolverBase< Scalar > > Rythmos::ImplicitBDFStepper< Scalar >::getNonconstSolver
virtual

◆ getSolver()

template<class Scalar >
RCP< const Thyra::NonlinearSolverBase< Scalar > > Rythmos::ImplicitBDFStepper< Scalar >::getSolver
virtual

◆ isImplicit()

template<class Scalar >
bool Rythmos::ImplicitBDFStepper< Scalar >::isImplicit
virtual

Overridden from StepperBase.

Returns true.

Reimplemented from Rythmos::StepperBase< Scalar >.

Definition at line 179 of file Rythmos_ImplicitBDFStepper_def.hpp.

◆ supportsCloning()

template<class Scalar >
bool Rythmos::ImplicitBDFStepper< Scalar >::supportsCloning
virtual

Returns true.

Reimplemented from Rythmos::StepperBase< Scalar >.

Definition at line 185 of file Rythmos_ImplicitBDFStepper_def.hpp.

◆ cloneStepperAlgorithm()

template<class Scalar >
RCP< StepperBase< Scalar > > Rythmos::ImplicitBDFStepper< Scalar >::cloneStepperAlgorithm
virtual

Creates copies of all internal data (including the parameter list) except the model which is assumed to stateless.

If a shallow copy of the model is not appropirate for some reason, then the client can simply reset the model using returnVal->setModel().

Reimplemented from Rythmos::StepperBase< Scalar >.

Definition at line 193 of file Rythmos_ImplicitBDFStepper_def.hpp.

◆ setModel()

template<class Scalar >
void Rythmos::ImplicitBDFStepper< Scalar >::setModel ( const RCP< const Thyra::ModelEvaluator< Scalar > > &  model)
virtual

◆ setNonconstModel()

template<class Scalar >
void Rythmos::ImplicitBDFStepper< Scalar >::setNonconstModel ( const RCP< Thyra::ModelEvaluator< Scalar > > &  model)
virtual

◆ getModel()

template<class Scalar >
RCP< const Thyra::ModelEvaluator< Scalar > > Rythmos::ImplicitBDFStepper< Scalar >::getModel
virtual

◆ getNonconstModel()

template<class Scalar >
RCP< Thyra::ModelEvaluator< Scalar > > Rythmos::ImplicitBDFStepper< Scalar >::getNonconstModel
virtual

◆ setInitialCondition()

template<class Scalar >
void Rythmos::ImplicitBDFStepper< Scalar >::setInitialCondition ( const Thyra::ModelEvaluatorBase::InArgs< Scalar > &  initialCondition)
virtual

◆ getInitialCondition()

template<class Scalar >
Thyra::ModelEvaluatorBase::InArgs< Scalar > Rythmos::ImplicitBDFStepper< Scalar >::getInitialCondition
virtual

◆ takeStep()

template<class Scalar >
Scalar Rythmos::ImplicitBDFStepper< Scalar >::takeStep ( Scalar  dt,
StepSizeType  flag 
)
virtual

◆ getStepStatus()

template<class Scalar >
const StepStatus< Scalar > Rythmos::ImplicitBDFStepper< Scalar >::getStepStatus
virtual

◆ get_x_space()

template<class Scalar >
RCP< const Thyra::VectorSpaceBase< Scalar > > Rythmos::ImplicitBDFStepper< Scalar >::get_x_space
virtual

◆ addPoints()

template<class Scalar >
void Rythmos::ImplicitBDFStepper< 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

◆ getTimeRange()

template<class Scalar >
TimeRange< Scalar > Rythmos::ImplicitBDFStepper< Scalar >::getTimeRange
virtual

◆ getPoints()

template<class Scalar >
void Rythmos::ImplicitBDFStepper< 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
virtual

◆ getNodes()

template<class Scalar >
void Rythmos::ImplicitBDFStepper< Scalar >::getNodes ( Array< Scalar > *  time_vec) const
virtual

◆ removeNodes()

template<class Scalar >
void Rythmos::ImplicitBDFStepper< Scalar >::removeNodes ( Array< Scalar > &  time_vec)
virtual

◆ getOrder()

template<class Scalar >
int Rythmos::ImplicitBDFStepper< Scalar >::getOrder
virtual

◆ setParameterList()

template<class Scalar >
void Rythmos::ImplicitBDFStepper< Scalar >::setParameterList ( RCP< Teuchos::ParameterList > const &  paramList)

Definition at line 667 of file Rythmos_ImplicitBDFStepper_def.hpp.

◆ getNonconstParameterList()

template<class Scalar >
RCP< Teuchos::ParameterList > Rythmos::ImplicitBDFStepper< Scalar >::getNonconstParameterList

Definition at line 679 of file Rythmos_ImplicitBDFStepper_def.hpp.

◆ unsetParameterList()

template<class Scalar >
RCP< Teuchos::ParameterList > Rythmos::ImplicitBDFStepper< Scalar >::unsetParameterList

Definition at line 687 of file Rythmos_ImplicitBDFStepper_def.hpp.

◆ getValidParameters()

template<class Scalar >
RCP< const Teuchos::ParameterList > Rythmos::ImplicitBDFStepper< Scalar >::getValidParameters

Definition at line 697 of file Rythmos_ImplicitBDFStepper_def.hpp.

◆ description()

template<class Scalar >
std::string Rythmos::ImplicitBDFStepper< Scalar >::description

Definition at line 725 of file Rythmos_ImplicitBDFStepper_def.hpp.

◆ describe()

template<class Scalar >
void Rythmos::ImplicitBDFStepper< Scalar >::describe ( Teuchos::FancyOStream &  out,
const Teuchos::EVerbosityLevel  verbLevel 
) const

Definition at line 740 of file Rythmos_ImplicitBDFStepper_def.hpp.

◆ getNonlinearSolveStatus()

template<class Scalar >
const Thyra::SolveStatus< Scalar > & Rythmos::ImplicitBDFStepper< Scalar >::getNonlinearSolveStatus

Returns the Thyra::SolveStatus object from the last nonlinear solve.

Definition at line 1173 of file Rythmos_ImplicitBDFStepper_def.hpp.


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