Thyra_ModelEvaluator.hpp

Go to the documentation of this file.

// @HEADER
// ***********************************************************************
// 
//    Thyra: Interfaces and Support for Abstract Numerical Algorithms
//                 Copyright (2004) Sandia Corporation
// 
// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
// license for use of this work by or on behalf of the U.S. Government.
// 
// This library is free software; you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as
// published by the Free Software Foundation; either version 2.1 of the
// License, or (at your option) any later version.
//  
// This library is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//  
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
// USA
// Questions? Contact Michael A. Heroux (maherou@sandia.gov) 
// 
// ***********************************************************************
// @HEADER


#ifndef THYRA_MODEL_EVALUATOR_HPP
#define THYRA_MODEL_EVALUATOR_HPP


#include "Thyra_ModelEvaluatorBase.hpp"
#include "Thyra_LinearOpWithSolveFactoryBase.hpp"


namespace Thyra {


template<class Scalar>
class ModelEvaluator : public ModelEvaluatorBase {
public:

  typedef typename Teuchos::ScalarTraits<Scalar>::magnitudeType ScalarMag;


  virtual int Np() const = 0;

  virtual int Ng() const = 0;



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

  virtual RCP<const VectorSpaceBase<Scalar> > get_f_space() const = 0;

  virtual RCP<const VectorSpaceBase<Scalar> > get_p_space(int l) const = 0;

  virtual RCP<const Teuchos::Array<std::string> > get_p_names(int l) const = 0;

  virtual RCP<const VectorSpaceBase<Scalar> > get_g_space(int j) const = 0;


  
  virtual ModelEvaluatorBase::InArgs<Scalar> getNominalValues() const = 0;
  
  virtual ModelEvaluatorBase::InArgs<Scalar> getLowerBounds() const = 0;
  
  virtual ModelEvaluatorBase::InArgs<Scalar> getUpperBounds() const = 0;



  virtual RCP<LinearOpWithSolveBase<Scalar> > create_W() const = 0;

  virtual RCP<LinearOpBase<Scalar> > create_W_op() const = 0;

  virtual RCP<LinearOpBase<Scalar> > create_DfDp_op(int l) const = 0;

  virtual RCP<LinearOpBase<Scalar> > create_DgDx_dot_op(int j) const = 0;

  virtual RCP<LinearOpBase<Scalar> > create_DgDx_op(int j) const = 0;

  virtual RCP<LinearOpBase<Scalar> > create_DgDp_op( int j, int l ) const = 0;
  


  virtual RCP<const LinearOpWithSolveFactoryBase<Scalar> > get_W_factory() const = 0;



  virtual ModelEvaluatorBase::InArgs<Scalar> createInArgs() const = 0;

  virtual ModelEvaluatorBase::OutArgs<Scalar> createOutArgs() const = 0;

  virtual void evalModel(
    const ModelEvaluatorBase::InArgs<Scalar> &inArgs,
    const ModelEvaluatorBase::OutArgs<Scalar> &outArgs
    ) const = 0;



  virtual void reportFinalPoint(
    const ModelEvaluatorBase::InArgs<Scalar> &finalPoint,
    const bool wasSolved
    ) = 0;


private:
  
  // Not defined and not to be called
  ModelEvaluator<Scalar>&
  operator=(const ModelEvaluator<Scalar>&);

};

} // namespace Thyra


#endif // THYRA_MODEL_EVALUATOR_HPP