Tempus_WrapperModelEvaluator.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_WrapperModelEvaluator_hpp
#define Tempus_WrapperModelEvaluator_hpp

#include "Tempus_config.hpp"
#include "Tempus_TimeDerivative.hpp"
#include "Thyra_StateFuncModelEvaluatorBase.hpp"

namespace Tempus {

enum EVALUATION_TYPE {
  EVALUATE_RESIDUAL,      
  SOLVE_FOR_X,            
  SOLVE_FOR_XDOT_CONST_X  
};

template <class Scalar>
class ImplicitODEParameters {
 public:
  ImplicitODEParameters()
    : timeDer_(Teuchos::null),
      timeStepSize_(Scalar(0.0)),
      alpha_(Scalar(0.0)),
      beta_(Scalar(0.0)),
      evaluationType_(SOLVE_FOR_X),
      stageNumber_(0)
  {
  }
  ImplicitODEParameters(Teuchos::RCP<TimeDerivative<Scalar> > timeDer,
                        Scalar timeStepSize, Scalar alpha, Scalar beta,
                        EVALUATION_TYPE evaluationType = SOLVE_FOR_X,
                        int stageNumber                = 0)
    : timeDer_(timeDer),
      timeStepSize_(timeStepSize),
      alpha_(alpha),
      beta_(beta),
      evaluationType_(evaluationType),
      stageNumber_(stageNumber)
  {
  }

  Teuchos::RCP<TimeDerivative<Scalar> > timeDer_;
  Scalar timeStepSize_;
  Scalar alpha_;
  Scalar beta_;
  EVALUATION_TYPE evaluationType_;
  int stageNumber_;
};

template <typename Scalar>
class WrapperModelEvaluator
  : public Thyra::StateFuncModelEvaluatorBase<Scalar> {
 public:

  virtual Teuchos::RCP<const Thyra::VectorSpaceBase<Scalar> > get_x_space()
      const = 0;

  virtual Teuchos::RCP<const Thyra::VectorSpaceBase<Scalar> > get_g_space(
      int i) const = 0;

  virtual Teuchos::RCP<const Thyra::VectorSpaceBase<Scalar> > get_p_space(
      int i) const = 0;

  virtual void setAppModel(
      const Teuchos::RCP<const Thyra::ModelEvaluator<Scalar> >& me) = 0;

  virtual Teuchos::RCP<const Thyra::ModelEvaluator<Scalar> > getAppModel()
      const = 0;

  virtual void setForSolve(
      const Teuchos::RCP<Thyra::VectorBase<Scalar> >& x,
      const Teuchos::RCP<Thyra::VectorBase<Scalar> >& xDot, const Scalar time,
      const Teuchos::RCP<ImplicitODEParameters<Scalar> >& p,
      const Teuchos::RCP<Thyra::VectorBase<Scalar> >& y = Teuchos::null,
      const int index                                   = -1 /* index and y are for IMEX_RK_Partition */) = 0;
};

}  // namespace Tempus

#endif  // Tempus_WrapperModelEvaluator_hpp