Tempus_WrapperModelEvaluatorPairIMEX_Basic_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_ModelEvaluatorPairIMEX_Basic_decl_hpp
#define Tempus_ModelEvaluatorPairIMEX_Basic_decl_hpp

#include "Tempus_config.hpp"
#include "Tempus_WrapperModelEvaluatorPairIMEX.hpp"
#include "Thyra_StateFuncModelEvaluatorBase.hpp"

namespace Tempus {

template <typename Scalar>
class WrapperModelEvaluatorPairIMEX_Basic
  : public Tempus::WrapperModelEvaluatorPairIMEX<Scalar> {
 public:
  WrapperModelEvaluatorPairIMEX_Basic(
      const Teuchos::RCP<const Thyra::ModelEvaluator<Scalar> >& explicitModel,
      const Teuchos::RCP<const Thyra::ModelEvaluator<Scalar> >& implicitModel)
    : timeDer_(Teuchos::null)
  {
    setExplicitModel(explicitModel);
    setImplicitModel(implicitModel);
    initialize();
  }

  virtual ~WrapperModelEvaluatorPairIMEX_Basic() {}

  virtual void initialize();


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

  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 */)
  {
    x_       = x;
    xDot_    = xDot;
    time_    = time;
    p_       = p;
    y_       = y;
    index_   = index;
    timeDer_ = p->timeDer_;
  }



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

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

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

  virtual void setExplicitModel(
      const Teuchos::RCP<const Thyra::ModelEvaluator<Scalar> >& model)
  {
    explicitModel_ = model;
  }
  virtual void setImplicitModel(
      const Teuchos::RCP<const Thyra::ModelEvaluator<Scalar> >& model)
  {
    implicitModel_ = model;
  }
  virtual Teuchos::RCP<const Thyra::ModelEvaluator<Scalar> > getExplicitModel()
      const
  {
    return explicitModel_;
  }
  virtual Teuchos::RCP<const Thyra::ModelEvaluator<Scalar> > getImplicitModel()
      const
  {
    return implicitModel_;
  }


  virtual Teuchos::RCP<Thyra::LinearOpBase<Scalar> > create_W_op() const
  {
    return implicitModel_->create_W_op();
  }

  Teuchos::RCP<const Thyra::LinearOpWithSolveFactoryBase<Scalar> >
  get_W_factory() const
  {
    return implicitModel_->get_W_factory();
  }

  virtual Teuchos::RCP<const Thyra::VectorSpaceBase<Scalar> > get_f_space()
      const
  {
    return explicitModel_->get_f_space();
  }

  virtual Thyra::ModelEvaluatorBase::InArgs<Scalar> getNominalValues() const;
  virtual Thyra::ModelEvaluatorBase::InArgs<Scalar> createInArgs() const;
  virtual Thyra::ModelEvaluatorBase::OutArgs<Scalar> createOutArgsImpl() const;

  virtual void evalModelImpl(
      const Thyra::ModelEvaluatorBase::InArgs<Scalar>& in,
      const Thyra::ModelEvaluatorBase::OutArgs<Scalar>& out) const;

 protected:
  WrapperModelEvaluatorPairIMEX_Basic() {}

  void setup(
      const Teuchos::RCP<const Thyra::ModelEvaluator<Scalar> >& explicitModel,
      const Teuchos::RCP<const Thyra::ModelEvaluator<Scalar> >& implicitModel)
  {
    setExplicitModel(explicitModel);
    setImplicitModel(implicitModel);
    initialize();
  }

 protected:
  Teuchos::RCP<const Thyra::ModelEvaluator<Scalar> > explicitModel_;
  Teuchos::RCP<const Thyra::ModelEvaluator<Scalar> > implicitModel_;

  Teuchos::RCP<Thyra::VectorBase<Scalar> > x_;
  Teuchos::RCP<Thyra::VectorBase<Scalar> > xDot_;
  Scalar time_;
  Teuchos::RCP<ImplicitODEParameters<Scalar> > p_;
  Teuchos::RCP<Thyra::VectorBase<Scalar> > y_;
  int index_;
  Teuchos::RCP<TimeDerivative<Scalar> > timeDer_;
};

}  // namespace Tempus

#endif  // Tempus_ModelEvaluatorPairIMEX_Basic_decl_hpp