Rythmos::ImplicitBDFStepper< Scalar > Class Template Reference

More...

#include <Rythmos_ImplicitBDFStepper_decl.hpp>

Inheritance diagram for Rythmos::ImplicitBDFStepper< Scalar >:

Inheritance graph
[legend]
List of all members.
 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)
 

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 Returns true.
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
 

Overridden from Teuchos::Describable

std::string description () const
 
void describe (Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel) const
 

Public Types

typedef Teuchos::ScalarTraits<
Scalar >::magnitudeType 
ScalarMag
 

Detailed Description

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

Definition at line 52 of file Rythmos_ImplicitBDFStepper_decl.hpp.


Member Typedef Documentation

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

Reimplemented from Rythmos::InterpolationBufferBase< Scalar >.

Definition at line 59 of file Rythmos_ImplicitBDFStepper_decl.hpp.


Constructor & Destructor Documentation

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

Constructors, intializers, Misc. .

Definition at line 63 of file Rythmos_ImplicitBDFStepper_def.hpp.

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

Definition at line 89 of file Rythmos_ImplicitBDFStepper_def.hpp.

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 72 of file Rythmos_ImplicitBDFStepper_def.hpp.


Member Function Documentation

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

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

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

Definition at line 104 of file Rythmos_ImplicitBDFStepper_def.hpp.

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

Definition at line 1137 of file Rythmos_ImplicitBDFStepper_def.hpp.

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

Definition at line 114 of file Rythmos_ImplicitBDFStepper_def.hpp.

template<class Scalar>
RCP< StepControlStrategyBase< Scalar > > Rythmos::ImplicitBDFStepper< Scalar >::getNonconstStepControlStrategy (  )  [virtual]

Implements Rythmos::StepControlStrategyAcceptingStepperBase< Scalar >.

Definition at line 121 of file Rythmos_ImplicitBDFStepper_def.hpp.

template<class Scalar>
RCP< const StepControlStrategyBase< Scalar > > Rythmos::ImplicitBDFStepper< Scalar >::getStepControlStrategy (  )  const [virtual]

Implements Rythmos::StepControlStrategyAcceptingStepperBase< Scalar >.

Definition at line 127 of file Rythmos_ImplicitBDFStepper_def.hpp.

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

Definition at line 137 of file Rythmos_ImplicitBDFStepper_def.hpp.

template<class Scalar>
RCP< Thyra::NonlinearSolverBase< Scalar > > Rythmos::ImplicitBDFStepper< Scalar >::getNonconstSolver (  )  [virtual]

Implements Rythmos::SolverAcceptingStepperBase< Scalar >.

Definition at line 146 of file Rythmos_ImplicitBDFStepper_def.hpp.

template<class Scalar>
RCP< const Thyra::NonlinearSolverBase< Scalar > > Rythmos::ImplicitBDFStepper< Scalar >::getSolver (  )  const [virtual]

Implements Rythmos::SolverAcceptingStepperBase< Scalar >.

Definition at line 154 of file Rythmos_ImplicitBDFStepper_def.hpp.

template<class Scalar>
bool Rythmos::ImplicitBDFStepper< Scalar >::isImplicit (  )  const [virtual]

Overridden from StepperBase Returns true.

Reimplemented from Rythmos::StepperBase< Scalar >.

Definition at line 164 of file Rythmos_ImplicitBDFStepper_def.hpp.

template<class Scalar>
bool Rythmos::ImplicitBDFStepper< Scalar >::supportsCloning (  )  const [virtual]

Returns true.

Reimplemented from Rythmos::StepperBase< Scalar >.

Definition at line 170 of file Rythmos_ImplicitBDFStepper_def.hpp.

template<class Scalar>
RCP< StepperBase< Scalar > > Rythmos::ImplicitBDFStepper< Scalar >::cloneStepperAlgorithm (  )  const [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 178 of file Rythmos_ImplicitBDFStepper_def.hpp.

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

Implements Rythmos::StepperBase< Scalar >.

Definition at line 213 of file Rythmos_ImplicitBDFStepper_def.hpp.

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

Implements Rythmos::StepperBase< Scalar >.

Definition at line 224 of file Rythmos_ImplicitBDFStepper_def.hpp.

template<class Scalar>
RCP< const Thyra::ModelEvaluator< Scalar > > Rythmos::ImplicitBDFStepper< Scalar >::getModel (  )  const [virtual]

Implements Rythmos::StepperBase< Scalar >.

Definition at line 234 of file Rythmos_ImplicitBDFStepper_def.hpp.

template<class Scalar>
RCP< Thyra::ModelEvaluator< Scalar > > Rythmos::ImplicitBDFStepper< Scalar >::getNonconstModel (  )  [virtual]

Implements Rythmos::StepperBase< Scalar >.

Definition at line 242 of file Rythmos_ImplicitBDFStepper_def.hpp.

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

Implements Rythmos::StepperBase< Scalar >.

Definition at line 249 of file Rythmos_ImplicitBDFStepper_def.hpp.

template<class Scalar>
Thyra::ModelEvaluatorBase::InArgs< Scalar > Rythmos::ImplicitBDFStepper< Scalar >::getInitialCondition (  )  const [virtual]

Implements Rythmos::StepperBase< Scalar >.

Definition at line 280 of file Rythmos_ImplicitBDFStepper_def.hpp.

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

Implements Rythmos::StepperBase< Scalar >.

Definition at line 287 of file Rythmos_ImplicitBDFStepper_def.hpp.

template<class Scalar>
const StepStatus< Scalar > Rythmos::ImplicitBDFStepper< Scalar >::getStepStatus (  )  const [virtual]

Implements Rythmos::StepperBase< Scalar >.

Definition at line 459 of file Rythmos_ImplicitBDFStepper_def.hpp.

template<class Scalar>
RCP< const Thyra::VectorSpaceBase< Scalar > > Rythmos::ImplicitBDFStepper< Scalar >::get_x_space (  )  const [virtual]

Implements Rythmos::InterpolationBufferBase< Scalar >.

Definition at line 500 of file Rythmos_ImplicitBDFStepper_def.hpp.

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]

Implements Rythmos::InterpolationBufferBase< Scalar >.

Definition at line 508 of file Rythmos_ImplicitBDFStepper_def.hpp.

template<class Scalar>
TimeRange< Scalar > Rythmos::ImplicitBDFStepper< Scalar >::getTimeRange (  )  const [virtual]

Implements Rythmos::InterpolationBufferBase< Scalar >.

Definition at line 520 of file Rythmos_ImplicitBDFStepper_def.hpp.

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]

Implements Rythmos::InterpolationBufferBase< Scalar >.

Definition at line 531 of file Rythmos_ImplicitBDFStepper_def.hpp.

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

Implements Rythmos::InterpolationBufferBase< Scalar >.

Definition at line 609 of file Rythmos_ImplicitBDFStepper_def.hpp.

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

Implements Rythmos::InterpolationBufferBase< Scalar >.

Definition at line 624 of file Rythmos_ImplicitBDFStepper_def.hpp.

template<class Scalar>
int Rythmos::ImplicitBDFStepper< Scalar >::getOrder (  )  const [virtual]

Implements Rythmos::InterpolationBufferBase< Scalar >.

Definition at line 632 of file Rythmos_ImplicitBDFStepper_def.hpp.

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

Definition at line 645 of file Rythmos_ImplicitBDFStepper_def.hpp.

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

Definition at line 657 of file Rythmos_ImplicitBDFStepper_def.hpp.

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

Definition at line 665 of file Rythmos_ImplicitBDFStepper_def.hpp.

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

Definition at line 675 of file Rythmos_ImplicitBDFStepper_def.hpp.

template<class Scalar>
std::string Rythmos::ImplicitBDFStepper< Scalar >::description (  )  const

Definition at line 710 of file Rythmos_ImplicitBDFStepper_def.hpp.

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

Definition at line 725 of file Rythmos_ImplicitBDFStepper_def.hpp.


The documentation for this class was generated from the following files:
Generated on Tue Jul 13 09:23:54 2010 for Rythmos - Transient Integration for Differential Equations by  doxygen 1.4.7