Tempus_StepperLeapfrog_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_StepperLeapfrog_decl_hpp
#define Tempus_StepperLeapfrog_decl_hpp

#include "Tempus_config.hpp"
#include "Tempus_StepperExplicit.hpp"
#include "Tempus_StepperLeapfrogAppAction.hpp"
#include "Tempus_StepperLeapfrogAppActionComposite.hpp"

namespace Tempus {

template <class Scalar>
class StepperLeapfrog : virtual public Tempus::StepperExplicit<Scalar> {
 public:
  StepperLeapfrog();

  StepperLeapfrog(
      const Teuchos::RCP<const Thyra::ModelEvaluator<Scalar> >& appModel,
      bool useFSAL, std::string ICConsistency, bool ICConsistencyCheck,
      const Teuchos::RCP<StepperLeapfrogAppAction<Scalar> >&
          stepperLFAppAction);


  virtual void setAppAction(
      Teuchos::RCP<StepperLeapfrogAppAction<Scalar> > appAction);

  virtual Teuchos::RCP<StepperLeapfrogAppAction<Scalar> > getAppAction() const
  {
    return stepperLFAppAction_;
  }

  virtual void setInitialConditions(
      const Teuchos::RCP<SolutionHistory<Scalar> >& solutionHistory);

  virtual void takeStep(
      const Teuchos::RCP<SolutionHistory<Scalar> >& solutionHistory);

  virtual Teuchos::RCP<Tempus::StepperState<Scalar> > getDefaultStepperState();
  virtual Scalar getOrder() const { return 2.0; }
  virtual Scalar getOrderMin() const { return 2.0; }
  virtual Scalar getOrderMax() const { return 2.0; }
  virtual Scalar getInitTimeStep(
      const Teuchos::RCP<SolutionHistory<Scalar> >& /* solutionHistory */) const
  {
    return Scalar(1.0e+99);
  }

  virtual bool isExplicit() const { return true; }
  virtual bool isImplicit() const { return false; }
  virtual bool isExplicitImplicit() const
  {
    return isExplicit() && isImplicit();
  }
  virtual bool isOneStepMethod() const { return true; }
  virtual bool isMultiStepMethod() const { return !isOneStepMethod(); }
  virtual OrderODE getOrderODE() const { return SECOND_ORDER_ODE; }


  virtual void describe(Teuchos::FancyOStream& out,
                        const Teuchos::EVerbosityLevel verbLevel) const;

  virtual bool isValidSetup(Teuchos::FancyOStream& out) const;

 protected:
  Teuchos::RCP<StepperLeapfrogAppAction<Scalar> > stepperLFAppAction_;
};

// ------------------------------------------------------------------------
template <class Scalar>
Teuchos::RCP<StepperLeapfrog<Scalar> > createStepperLeapfrog(
    const Teuchos::RCP<const Thyra::ModelEvaluator<Scalar> >& model,
    Teuchos::RCP<Teuchos::ParameterList> pl);

}  // namespace Tempus

#endif  // Tempus_StepperLeapfrog_decl_hpp