Tempus_StepperFactory_decl.hpp

Go to the documentation of this file.

//@HEADER
// *****************************************************************************
//          Tempus: Time Integration and Sensitivity Analysis Package
//
// Copyright 2017 NTESS and the Tempus contributors.
// SPDX-License-Identifier: BSD-3-Clause
// *****************************************************************************
//@HEADER

#ifndef Tempus_StepperFactory_decl_hpp
#define Tempus_StepperFactory_decl_hpp

#include "Teuchos_ParameterList.hpp"

#include "Tempus_config.hpp"
#include "Tempus_Stepper.hpp"

namespace Tempus {

template <class Scalar>
class StepperFactory {
 public:
  StepperFactory() {}

  virtual ~StepperFactory() {}


  Teuchos::RCP<Stepper<Scalar> > createStepper(
      std::string stepperType = "Forward Euler",
      const Teuchos::RCP<const Thyra::ModelEvaluator<Scalar> >& model =
          Teuchos::null);

  Teuchos::RCP<Stepper<Scalar> > createStepper(
      Teuchos::RCP<Teuchos::ParameterList> stepperPL,
      const Teuchos::RCP<const Thyra::ModelEvaluator<Scalar> >& model =
          Teuchos::null);

  Teuchos::RCP<Stepper<Scalar> > createStepper(
      Teuchos::RCP<Teuchos::ParameterList> stepperPL,
      std::vector<Teuchos::RCP<const Thyra::ModelEvaluator<Scalar> > > models);

 private:
  Teuchos::RCP<Stepper<Scalar> > createStepper(
      std::string stepperType, Teuchos::RCP<Teuchos::ParameterList> stepperPL,
      const Teuchos::RCP<const Thyra::ModelEvaluator<Scalar> >& model);
};

}  // namespace Tempus
#endif  // Tempus_StepperFactory_decl_hpp