Thyra_ModelEvaluator.hpp

// @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.
// 
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// 3. Neither the name of the Corporation nor the names of the
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Questions? Contact Roscoe A. Bartlett (bartlettra@ornl.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_f_multiplier_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 RCP<const VectorSpaceBase<Scalar> > get_g_multiplier_space(int j) const = 0;

  virtual Teuchos::ArrayView<const std::string> get_g_names(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<PreconditionerBase<Scalar> > create_W_prec() 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<LinearOpBase<Scalar> > create_hess_f_xx() const = 0;

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

  virtual RCP<LinearOpBase<Scalar> > create_hess_f_pp( int l1, int l2 ) const = 0;

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

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

  virtual RCP<LinearOpBase<Scalar> > create_hess_g_pp( int j, int l1, int l2 ) 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