Tempus_StepperHHTAlpha_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_StepperHHTAlpha_decl_hpp
#define Tempus_StepperHHTAlpha_decl_hpp
 
#include "Tempus_config.hpp"
#include "Tempus_StepperImplicit.hpp"
#include "Tempus_WrapperModelEvaluatorSecondOrder.hpp"
#include "Tempus_StepperHHTAlphaAppAction.hpp"
 
namespace Tempus {

template <class Scalar>
class StepperHHTAlpha : virtual public Tempus::StepperImplicit<Scalar> {
 public:
  StepperHHTAlpha();

  StepperHHTAlpha(
      const Teuchos::RCP<const Thyra::ModelEvaluator<Scalar> >& appModel,
      const Teuchos::RCP<Thyra::NonlinearSolverBase<Scalar> >& solver,
      bool useFSAL, std::string ICConsistency, bool ICConsistencyCheck,
      bool zeroInitialGuess, std::string schemeName, Scalar beta, Scalar gamma,
      Scalar alpha_f_, Scalar alpha_m_,
      const Teuchos::RCP<StepperHHTAlphaAppAction<Scalar> >&
          stepperHHTAlphaAppAction);


  virtual void setModel(
      const Teuchos::RCP<const Thyra::ModelEvaluator<Scalar> >& appModel);
 
  virtual void setAppAction(
      Teuchos::RCP<StepperHHTAlphaAppAction<Scalar> > appAction);
 
  virtual Teuchos::RCP<StepperHHTAlphaAppAction<Scalar> > getAppAction() const
  {
    return stepperHHTAlphaAppAction_;
  }

  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
  {
    if (gamma_ == 0.5 + alpha_f_)
      return 2.0;
    else
      return 1.0;
  }
  virtual Scalar getOrderMin() const { return 1.0; }
  virtual Scalar getOrderMax() const { return 2.0; }
 
  virtual bool isExplicit() const { return false; }
  virtual bool isImplicit() const { return true; }
  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 Scalar getW_xDotDot_coeff(const Scalar dt) const
  {
    return Scalar(1.0) / (beta_ * dt * dt);
  }

  virtual Scalar getAlpha(const Scalar dt) const
  {
    return gamma_ / (beta_ * dt);
  }

  virtual Scalar getBeta(const Scalar) const { return Scalar(1.0); }
 
  Teuchos::RCP<const Teuchos::ParameterList> getValidParameters() const;


  virtual void describe(Teuchos::FancyOStream& out,
                        const Teuchos::EVerbosityLevel verbLevel) const;
 
  virtual bool isValidSetup(Teuchos::FancyOStream& out) const;
 
  void predictVelocity(Thyra::VectorBase<Scalar>& vPred,
                       const Thyra::VectorBase<Scalar>& v,
                       const Thyra::VectorBase<Scalar>& a,
                       const Scalar dt) const;
 
  void predictDisplacement(Thyra::VectorBase<Scalar>& dPred,
                           const Thyra::VectorBase<Scalar>& d,
                           const Thyra::VectorBase<Scalar>& v,
                           const Thyra::VectorBase<Scalar>& a,
                           const Scalar dt) const;
 
  void predictVelocity_alpha_f(Thyra::VectorBase<Scalar>& vPred,
                               const Thyra::VectorBase<Scalar>& v) const;
 
  void predictDisplacement_alpha_f(Thyra::VectorBase<Scalar>& dPred,
                                   const Thyra::VectorBase<Scalar>& d) const;
 
  void correctAcceleration(Thyra::VectorBase<Scalar>& a_n_plus1,
                           const Thyra::VectorBase<Scalar>& a_n) const;
 
  void correctVelocity(Thyra::VectorBase<Scalar>& v,
                       const Thyra::VectorBase<Scalar>& vPred,
                       const Thyra::VectorBase<Scalar>& a,
                       const Scalar dt) const;
 
  void correctDisplacement(Thyra::VectorBase<Scalar>& d,
                           const Thyra::VectorBase<Scalar>& dPred,
                           const Thyra::VectorBase<Scalar>& a,
                           const Scalar dt) const;
 
  void setSchemeName(std::string schemeName);
  void setBeta(Scalar beta);
  void setGamma(Scalar gamma);
  void setAlphaF(Scalar alpha_f);
  void setAlphaM(Scalar alpha_m);
  virtual std::string getSchemeName() const { return schemeName_; }
  virtual Scalar getBeta() const { return beta_; }
  virtual Scalar getGamma() const { return gamma_; }
  virtual Scalar getAlphaF() const { return alpha_f_; }
  virtual Scalar getAlphaM() const { return alpha_m_; }

  void validateSchemeParameters() const;
 
 private:
  Teuchos::RCP<StepperHHTAlphaAppAction<Scalar> > stepperHHTAlphaAppAction_;
 
  std::string schemeName_;
  Scalar beta_;
  Scalar gamma_;
  Scalar alpha_f_;
  Scalar alpha_m_;
 
  Teuchos::RCP<Teuchos::FancyOStream> out_;
};

// ------------------------------------------------------------------------
template <class Scalar>
Teuchos::RCP<StepperHHTAlpha<Scalar> > createStepperHHTAlpha(
    const Teuchos::RCP<const Thyra::ModelEvaluator<Scalar> >& model,
    Teuchos::RCP<Teuchos::ParameterList> pl);
 
}  // namespace Tempus
 
#endif  // Tempus_StepperHHTAlpha_decl_hpp