DahlquistTestModel_decl.hpp

Go to the documentation of this file.

// @HEADER
// ****************************************************************************
//                Tempus: Copyright (2017) Sandia Corporation
//
// Distributed under BSD 3-clause license (See accompanying file Copyright.txt)
// ****************************************************************************
// @HEADER

#ifndef TEMPUS_TEST_DAHLQUIST_TEST_MODEL_DECL_HPP
#define TEMPUS_TEST_DAHLQUIST_TEST_MODEL_DECL_HPP

#include "Thyra_ModelEvaluator.hpp" // Interface
#include "Thyra_StateFuncModelEvaluatorBase.hpp" // Implementation


namespace Tempus_Test {

template<class Scalar>
class DahlquistTestModel
  : public Thyra::StateFuncModelEvaluatorBase<Scalar>
{
  public:

  // Default Constructor
  DahlquistTestModel();

  // Constructor
  DahlquistTestModel(Scalar lambda, bool includeXDot);

  void constructDahlquistTestModel(Scalar lambda, bool includeXDot);

  ~DahlquistTestModel() = default;

  Thyra::ModelEvaluatorBase::InArgs<Scalar> getExactSolution(double t) const;

  Scalar getLambda() const { return lambda_; }

    Teuchos::RCP<const Thyra::VectorSpaceBase<Scalar> > get_x_space() const;
    Teuchos::RCP<const Thyra::VectorSpaceBase<Scalar> > get_f_space() const;
    Thyra::ModelEvaluatorBase::InArgs<Scalar> getNominalValues() const;
    Teuchos::RCP<Thyra::LinearOpWithSolveBase<Scalar> > create_W() const;
    Teuchos::RCP<Thyra::LinearOpBase<Scalar> > create_W_op() const;
    Teuchos::RCP<const Thyra::LinearOpWithSolveFactoryBase<Scalar> > get_W_factory() const;
    Thyra::ModelEvaluatorBase::InArgs<Scalar> createInArgs() const;

    Teuchos::RCP<const Thyra::VectorSpaceBase<Scalar> > get_p_space(int l) const;
    Teuchos::RCP<const Teuchos::Array<std::string> > get_p_names(int l) const;
    Teuchos::RCP<const Thyra::VectorSpaceBase<Scalar> > get_g_space(int j) const;

private:

  Thyra::ModelEvaluatorBase::OutArgs<Scalar> createOutArgsImpl() const;
  void evalModelImpl(
    const Thyra::ModelEvaluatorBase::InArgs<Scalar> &inArgs_bar,
    const Thyra::ModelEvaluatorBase::OutArgs<Scalar> &outArgs_bar
    ) const;

private:
  int dim_;
  int Np_;
  int np_;
  int Ng_;
  int ng_;
  bool haveIC_;
  bool acceptModelParams_;
  Scalar lambda_;
  bool   includeXDot_;

  mutable bool isInitialized_;
  mutable Thyra::ModelEvaluatorBase::InArgs<Scalar>  inArgs_;
  mutable Thyra::ModelEvaluatorBase::OutArgs<Scalar> outArgs_;
  mutable Thyra::ModelEvaluatorBase::InArgs<Scalar>  nominalValues_;
  Teuchos::RCP<const Thyra::VectorSpaceBase<Scalar> > x_space_;
  Teuchos::RCP<const Thyra::VectorSpaceBase<Scalar> > f_space_;
  Teuchos::RCP<const Thyra::VectorSpaceBase<Scalar> > p_space_;
  Teuchos::RCP<const Thyra::VectorSpaceBase<Scalar> > g_space_;
  Teuchos::RCP<const Thyra::VectorSpaceBase<Scalar> > DxDp_space_;

  Scalar xIC_;    
  Scalar xDotIC_; 
};


} // namespace Tempus_Test
#endif // TEMPUS_TEST_DAHLQUIST_TEST_MODEL_DECL_HPP