Tempus  Version of the Day
Time Integration
Public Member Functions | Private Member Functions | List of all members
Tempus::StepperFactory< Scalar > Class Template Reference

Stepper factory. More...

#include <Tempus_StepperBackwardEuler_impl.hpp>

Public Member Functions

 StepperFactory ()
 Constructor. More...
 
virtual ~StepperFactory ()
 Destructor. More...
 
Teuchos::RCP< Stepper< Scalar > > createStepper (const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &model, std::string stepperType="Forward Euler")
 Create default stepper from stepper type (e.g., "Forward Euler"). More...
 
Teuchos::RCP< Stepper< Scalar > > createStepper (const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &model, Teuchos::RCP< Teuchos::ParameterList > stepperPL)
 Create stepper from ParameterList with its details. More...
 
Teuchos::RCP< Stepper< Scalar > > createStepper (std::vector< Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > > models, Teuchos::RCP< Teuchos::ParameterList > stepperPL)
 Create stepper from ParameterList with its details. More...
 

Private Member Functions

Teuchos::RCP< Stepper< Scalar > > createStepper (const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &model, std::string stepperType, Teuchos::RCP< Teuchos::ParameterList > stepperPL)
 Very simple factory method. More...
 
Teuchos::RCP< Stepper< Scalar > > createStepper (std::vector< Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > > models, std::string stepperType, Teuchos::RCP< Teuchos::ParameterList > stepperPL)
 

Detailed Description

template<class Scalar>
class Tempus::StepperFactory< Scalar >

Stepper factory.

Adding Steppers

Definition at line 22 of file Tempus_StepperBackwardEuler_impl.hpp.

Constructor & Destructor Documentation

◆ StepperFactory()

template<class Scalar >
Tempus::StepperFactory< Scalar >::StepperFactory ( )
inline

Constructor.

Definition at line 42 of file Tempus_StepperFactory.hpp.

◆ ~StepperFactory()

template<class Scalar >
virtual Tempus::StepperFactory< Scalar >::~StepperFactory ( )
inlinevirtual

Destructor.

Definition at line 45 of file Tempus_StepperFactory.hpp.

Member Function Documentation

◆ createStepper() [1/5]

template<class Scalar >
Teuchos::RCP<Stepper<Scalar> > Tempus::StepperFactory< Scalar >::createStepper ( const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &  model,
std::string  stepperType,
Teuchos::RCP< Teuchos::ParameterList >  stepperPL 
)
inlineprivate

Very simple factory method.

Definition at line 78 of file Tempus_StepperFactory.hpp.

◆ createStepper() [2/5]

template<class Scalar >
Teuchos::RCP<Stepper<Scalar> > Tempus::StepperFactory< Scalar >::createStepper ( const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &  model,
std::string  stepperType = "Forward Euler" 
)
inline

Create default stepper from stepper type (e.g., "Forward Euler").

Definition at line 48 of file Tempus_StepperFactory.hpp.

◆ createStepper() [3/5]

template<class Scalar >
Teuchos::RCP<Stepper<Scalar> > Tempus::StepperFactory< Scalar >::createStepper ( const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &  model,
Teuchos::RCP< Teuchos::ParameterList >  stepperPL 
)
inline

Create stepper from ParameterList with its details.

Definition at line 57 of file Tempus_StepperFactory.hpp.

◆ createStepper() [4/5]

template<class Scalar >
Teuchos::RCP<Stepper<Scalar> > Tempus::StepperFactory< Scalar >::createStepper ( std::vector< Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > >  models,
std::string  stepperType,
Teuchos::RCP< Teuchos::ParameterList >  stepperPL 
)
inlineprivate

Definition at line 231 of file Tempus_StepperFactory.hpp.

◆ createStepper() [5/5]

template<class Scalar >
Teuchos::RCP<Stepper<Scalar> > Tempus::StepperFactory< Scalar >::createStepper ( std::vector< Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > >  models,
Teuchos::RCP< Teuchos::ParameterList >  stepperPL 
)
inline

Create stepper from ParameterList with its details.

Definition at line 68 of file Tempus_StepperFactory.hpp.

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