Thyra_ModelEvaluatorBase_decl.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_BASE_DECL_HPP
#define THYRA_MODEL_EVALUATOR_BASE_DECL_HPP


#include "Thyra_LinearOpWithSolveBase.hpp"
#include "Teuchos_Describable.hpp"
#include "Teuchos_any.hpp"
#include "Teuchos_Assert.hpp"

#ifdef HAVE_THYRA_ME_POLYNOMIAL
#  include "Teuchos_Polynomial.hpp"
#endif

namespace Stokhos {
  class ProductEpetraVector;
  class ProductEpetraMultiVector;
  class ProductEpetraOperator;
}

namespace Thyra {


class ModelEvaluatorBase
  : virtual public Teuchos::Describable,
    virtual public Teuchos::VerboseObject<ModelEvaluatorBase>
{
public:


  enum EInArgsMembers {
    IN_ARG_x_dot_dot 
    ,IN_ARG_x_dot 
    ,IN_ARG_x 
    ,IN_ARG_x_dot_poly 
    ,IN_ARG_x_poly 
    ,IN_ARG_x_dot_mp 
    ,IN_ARG_x_mp 
    ,IN_ARG_t 
    ,IN_ARG_alpha 
    ,IN_ARG_beta 
    ,IN_ARG_W_x_dot_dot_coeff 
    ,IN_ARG_step_size
    ,IN_ARG_stage_number
  };
  static const int NUM_E_IN_ARGS_MEMBERS=13;

  enum EInArgs_p_mp {
    IN_ARG_p_mp 
  };

  template<class Scalar>
  class InArgs : public Teuchos::Describable {
  public:
    typedef typename Teuchos::ScalarTraits<Scalar>::magnitudeType ScalarMag;
    InArgs();
    int Np() const;
    bool supports(EInArgsMembers arg) const;
    void set_x_dot_dot( const RCP<const VectorBase<Scalar> > &x_dot_dot );
    RCP<const VectorBase<Scalar> > get_x_dot_dot() const;
    void set_x_dot( const RCP<const VectorBase<Scalar> > &x_dot );
    RCP<const VectorBase<Scalar> > get_x_dot() const;
    void set_x( const RCP<const VectorBase<Scalar> > &x );
    RCP<const VectorBase<Scalar> > get_x() const;

    template<typename ObjectType>
    bool supports() const;
    template<typename ObjectType>
    void set(const RCP<const ObjectType>& uo);
    template<typename ObjectType>
    RCP<const ObjectType> get() const;
    
#ifdef HAVE_THYRA_ME_POLYNOMIAL

    void set_x_poly( 
      const RCP<const Teuchos::Polynomial< VectorBase<Scalar> > > &x_poly );
    RCP<const Teuchos::Polynomial< VectorBase<Scalar> > > get_x_poly() const;
    void set_x_dot_poly(
      const RCP<const Teuchos::Polynomial< VectorBase<Scalar> > > &x_dot_poly );
    RCP<const Teuchos::Polynomial< VectorBase<Scalar> > > get_x_dot_poly() const;
#endif // HAVE_THYRA_ME_POLYNOMIAL

    void set_p( int l, const RCP<const VectorBase<Scalar> > &p_l );
    RCP<const VectorBase<Scalar> > get_p(int l) const;


    void set_x_dot_mp( const RCP<const Stokhos::ProductEpetraVector > &x_dot_mp );
    RCP<const Stokhos::ProductEpetraVector > get_x_dot_mp() const;

    void set_x_mp( const RCP<const Stokhos::ProductEpetraVector > &x_mp );
    RCP<const Stokhos::ProductEpetraVector > get_x_mp() const;

    void set_p_mp( int l, const RCP<const Stokhos::ProductEpetraVector > &p_mp_l );
    RCP<const Stokhos::ProductEpetraVector > get_p_mp(int l) const;
    bool supports(EInArgs_p_mp arg, int l) const;


    void set_t( ScalarMag t );
    ScalarMag get_t() const;
    void set_alpha( Scalar alpha );
    Scalar get_alpha() const;
    void set_beta( Scalar beta );
    Scalar get_beta() const;
    void set_W_x_dot_dot_coeff( Scalar W_x_dot_dot_coeff );
    Scalar get_W_x_dot_dot_coeff() const;
    void set_step_size( Scalar step_size);
    Scalar get_step_size() const;
    void set_stage_number( Scalar stage_number);
    Scalar get_stage_number() const;
    void setArgs(
      const InArgs<Scalar>& inArgs, bool ignoreUnsupported = false,
      bool cloneObjects = false
      );
    void assertSameSupport( const InArgs<Scalar> &inArgs ) const;
    std::string modelEvalDescription() const;
    std::string description() const;
    void describe(
      Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel
      ) const;
  protected:
    void _setModelEvalDescription( const std::string &modelEvalDescription );
    void _set_Np(int Np);
    void _setSupports( EInArgsMembers arg, bool supports );
    void _setSupports( EInArgs_p_mp arg, int l, bool supports );
    void _setSupports( const InArgs<Scalar>& inputInArgs, const int Np );
    template<typename ObjectType>
    void _setSupports( const bool supports );
    void _setUnsupportsAndRelated( EInArgsMembers arg );
  private:
    // types
    typedef Teuchos::Array<RCP<const VectorBase<Scalar> > > p_t;
    // data
    std::string modelEvalDescription_;
    RCP<const VectorBase<Scalar> > x_dot_dot_;
    RCP<const VectorBase<Scalar> > x_dot_;
    RCP<const VectorBase<Scalar> > x_;
    RCP<const Stokhos::ProductEpetraVector > x_dot_mp_;
    RCP<const Stokhos::ProductEpetraVector > x_mp_;
    Teuchos::Array< RCP< const Stokhos::ProductEpetraVector > > p_mp_;
#ifdef HAVE_THYRA_ME_POLYNOMIAL
    RCP<const Teuchos::Polynomial< VectorBase<Scalar> > > x_dot_poly_;
    RCP<const Teuchos::Polynomial< VectorBase<Scalar> > > x_poly_;
#endif // HAVE_THYRA_ME_POLYNOMIAL
    p_t p_;
    ScalarMag t_;
    Scalar alpha_;
    Scalar beta_;
    Scalar W_x_dot_dot_coeff_;
    Scalar step_size_;
    Scalar stage_number_;
    bool supports_[NUM_E_IN_ARGS_MEMBERS];
    Teuchos::Array<bool> supports_p_mp_; //Np
    // functions
    void assert_supports(EInArgsMembers arg) const;
    void assert_supports(EInArgs_p_mp arg, int l) const;
    void assert_l(int l) const;

    std::map<std::string,Teuchos::any> extended_inargs_;
  };

  enum EEvalType {
    EVAL_TYPE_EXACT = 0, 
    EVAL_TYPE_APPROX_DERIV, 
    EVAL_TYPE_VERY_APPROX_DERIV 
  };

  template<class ObjType>
  class Evaluation : public RCP<ObjType> {
  public:
    Evaluation(Teuchos::ENull)
      : evalType_(EVAL_TYPE_EXACT)  {}
    Evaluation() : evalType_(EVAL_TYPE_EXACT) {}
    Evaluation( const RCP<ObjType> &obj )
      : RCP<ObjType>(obj), evalType_(EVAL_TYPE_EXACT) {}
    Evaluation( const RCP<ObjType> &obj, EEvalType evalType )
      : RCP<ObjType>(obj), evalType_(evalType) {}
    EEvalType getType() const { return evalType_; }
    void reset( const RCP<ObjType> &obj, EEvalType evalType ) 
    { this->operator=(obj); evalType_ = evalType; }
   private:
    EEvalType evalType_;
  };

  enum EDerivativeMultiVectorOrientation {
    DERIV_MV_JACOBIAN_FORM, 
    DERIV_MV_GRADIENT_FORM, 
    DERIV_MV_BY_COL = DERIV_MV_JACOBIAN_FORM, 
    DERIV_TRANS_MV_BY_ROW = DERIV_MV_GRADIENT_FORM 
  };

  enum EDerivativeLinearOp {
    DERIV_LINEAR_OP 
  };

  class DerivativeSupport {
  public:
    DerivativeSupport()
      :supportsLinearOp_(false), supportsMVByCol_(false), supportsTransMVByRow_(false)
      {}
    DerivativeSupport( EDerivativeLinearOp )
      :supportsLinearOp_(true), supportsMVByCol_(false), supportsTransMVByRow_(false)
      {}
    DerivativeSupport( EDerivativeMultiVectorOrientation mvOrientation )
      :supportsLinearOp_(false), supportsMVByCol_(mvOrientation==DERIV_MV_BY_COL)
      ,supportsTransMVByRow_(mvOrientation==DERIV_TRANS_MV_BY_ROW)
      {}
    DerivativeSupport& plus(EDerivativeLinearOp)
      { supportsLinearOp_ = true; return *this; }
    DerivativeSupport& plus(EDerivativeMultiVectorOrientation mvOrientation)
      {
        switch(mvOrientation) {
          case DERIV_MV_BY_COL: supportsMVByCol_ = true; break;
          case DERIV_TRANS_MV_BY_ROW: supportsTransMVByRow_ = true; break;
          default: TEUCHOS_TEST_FOR_EXCEPT(true);
        }
        return *this;
      }
    bool none() const
      { return ( !supportsLinearOp_ && !supportsMVByCol_ && !supportsTransMVByRow_ ); }
    bool supports(EDerivativeLinearOp) const
      { return supportsLinearOp_; }
    bool supports(EDerivativeMultiVectorOrientation mvOrientation) const
      {
        switch(mvOrientation) {
          case DERIV_MV_BY_COL: return supportsMVByCol_;
          case DERIV_TRANS_MV_BY_ROW: return supportsTransMVByRow_;
          default: TEUCHOS_TEST_FOR_EXCEPT(true);
        }
        TEUCHOS_UNREACHABLE_RETURN(false);
      }
    bool isSameSupport(const DerivativeSupport &derivSupport) const
      {
        return (
          supportsLinearOp_ == derivSupport.supportsLinearOp_
          && supportsMVByCol_ == derivSupport.supportsMVByCol_
          && supportsTransMVByRow_ == derivSupport.supportsTransMVByRow_
          );
      } 
    std::string description() const;
  private:
    bool supportsLinearOp_;
    bool supportsMVByCol_;
    bool supportsTransMVByRow_;
  public:
  };
  
  enum EDerivativeLinearity {
    DERIV_LINEARITY_UNKNOWN      
    ,DERIV_LINEARITY_CONST       
    ,DERIV_LINEARITY_NONCONST    
  };

  enum ERankStatus {
    DERIV_RANK_UNKNOWN       
    ,DERIV_RANK_FULL         
    ,DERIV_RANK_DEFICIENT    
  };

  struct DerivativeProperties {
    EDerivativeLinearity     linearity;
    ERankStatus              rank;
    bool                     supportsAdjoint;
    DerivativeProperties()
      :linearity(DERIV_LINEARITY_UNKNOWN),
       rank(DERIV_RANK_UNKNOWN),supportsAdjoint(false)
      {}
    DerivativeProperties(
      EDerivativeLinearity in_linearity, ERankStatus in_rank,
      bool in_supportsAdjoint
      )
      :linearity(in_linearity),rank(in_rank),
       supportsAdjoint(in_supportsAdjoint)
      {}
  };

  template<class Scalar>
  class DerivativeMultiVector {
  public:
    DerivativeMultiVector()
      :orientation_(DERIV_MV_BY_COL)
      {}
    DerivativeMultiVector(
      const RCP<MultiVectorBase<Scalar> > &mv
      ,const EDerivativeMultiVectorOrientation orientation = DERIV_MV_BY_COL
      ) : mv_(mv.assert_not_null()), orientation_(orientation) {}
    void changeOrientation( const EDerivativeMultiVectorOrientation orientation )
      { orientation_ = orientation; };
    const DerivativeMultiVector<Scalar>& assert_not_null() const
      { mv_.assert_not_null(); return *this; }
    RCP<MultiVectorBase<Scalar> > getMultiVector() const
      { return mv_; }
    EDerivativeMultiVectorOrientation getOrientation() const
      { return orientation_; }
    std::string description() const;
    void describe( 
      Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel
      ) const;
  private:
    RCP<MultiVectorBase<Scalar> > mv_;
    EDerivativeMultiVectorOrientation orientation_;
  };

  template<class Scalar>
  class Derivative {
  public:
    Derivative() {}
    Derivative( const RCP<LinearOpBase<Scalar> > &lo )
      : lo_(lo.assert_not_null()) {}
    Derivative(
      const RCP<MultiVectorBase<Scalar> > &mv,
      const EDerivativeMultiVectorOrientation orientation = DERIV_MV_BY_COL
      ) : dmv_(mv,orientation) {}
    Derivative( const DerivativeMultiVector<Scalar> &dmv )
      : dmv_(dmv) {}
    bool isEmpty() const
      { return ( lo_.get()==NULL && dmv_.getMultiVector().get()==NULL ); }
    const Derivative<Scalar>& assert_not_null() const
      { dmv_.assert_not_null(); lo_.assert_not_null(); return *this; }
    RCP<LinearOpBase<Scalar> > getLinearOp() const
      { return lo_; }
    RCP<MultiVectorBase<Scalar> > getMultiVector() const
      { return dmv_.getMultiVector(); }
    EDerivativeMultiVectorOrientation getMultiVectorOrientation() const
      { return dmv_.getOrientation(); }
    DerivativeMultiVector<Scalar> getDerivativeMultiVector() const
      { return dmv_; }
    bool isSupportedBy( const DerivativeSupport &derivSupport ) const
      {
        // If there is not derivative support then we will return false!
        if (derivSupport.none())
          return false;
        if (!is_null(getMultiVector())) {
          return derivSupport.supports(getMultiVectorOrientation());
        }
        else if(!is_null(getLinearOp())) {
          return derivSupport.supports(DERIV_LINEAR_OP);
        }
        // If nothing is set then of course we support that!
        return true;
      }
    std::string description() const;
    void describe( 
      Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel
      ) const;
  private:
    RCP<LinearOpBase<Scalar> > lo_;
    DerivativeMultiVector<Scalar> dmv_;
  };

  class MPDerivativeMultiVector {
  public:
    MPDerivativeMultiVector()
      :orientation_(DERIV_MV_BY_COL)
      {}
    MPDerivativeMultiVector(
      const RCP<Stokhos::ProductEpetraMultiVector > &mv
      ,const EDerivativeMultiVectorOrientation orientation = DERIV_MV_BY_COL
      ,const Teuchos::Array<int> &paramIndexes = Teuchos::Array<int>()
      ) : mv_(mv.assert_not_null()), orientation_(orientation), paramIndexes_(paramIndexes) {}
    void changeOrientation( const EDerivativeMultiVectorOrientation orientation )
      { orientation_ = orientation; };
    const MPDerivativeMultiVector& assert_not_null() const
      { mv_.assert_not_null(); return *this; }
    RCP<Stokhos::ProductEpetraMultiVector > getMultiVector() const
      { return mv_; }
    EDerivativeMultiVectorOrientation getOrientation() const
      { return orientation_; }
    const Teuchos::Array<int>& getParamIndexes() const
      { return paramIndexes_; }
    std::string description() const {return "\n";}
    void describe( 
      Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel
      ) const {}
  private:
    RCP<Stokhos::ProductEpetraMultiVector > mv_;
    EDerivativeMultiVectorOrientation orientation_;
    Teuchos::Array<int> paramIndexes_;
  };

  class MPDerivative {
  public:
    MPDerivative() {}
    MPDerivative( const RCP<Stokhos::ProductEpetraOperator > &lo )
      : lo_(lo.assert_not_null()) {}
    MPDerivative(
      const RCP<Stokhos::ProductEpetraMultiVector > &mv,
      const EDerivativeMultiVectorOrientation orientation = DERIV_MV_BY_COL
      ) : dmv_(mv,orientation) {}
    MPDerivative( const MPDerivativeMultiVector &dmv )
      : dmv_(dmv) {}
    bool isEmpty() const
      { return ( lo_.get()==NULL && dmv_.getMultiVector().get()==NULL ); }
    const MPDerivative& assert_not_null() const
      { dmv_.assert_not_null(); lo_.assert_not_null(); return *this; }
    RCP<Stokhos::ProductEpetraOperator > getLinearOp() const
      { return lo_; }
    RCP<Stokhos::ProductEpetraMultiVector > getMultiVector() const
      { return dmv_.getMultiVector(); }
    EDerivativeMultiVectorOrientation getMultiVectorOrientation() const
      { return dmv_.getOrientation(); }
    MPDerivativeMultiVector getDerivativeMultiVector() const
      { return dmv_; }
    bool isSupportedBy( const DerivativeSupport &derivSupport ) const
      {
        // If there is not derivative support then we will return false!
        if (derivSupport.none())
          return false;
        if (!is_null(getMultiVector())) {
          return derivSupport.supports(getMultiVectorOrientation());
        }
        else if(!is_null(getLinearOp())) {
          return derivSupport.supports(DERIV_LINEAR_OP);
        }
        // If nothing is set then of course we support that!
        return true;
      }
    std::string description() const {return "\n";}
    void describe( 
      Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel
      ) const {}
  private:
    RCP<Stokhos::ProductEpetraOperator > lo_;
    MPDerivativeMultiVector dmv_;
  };

  enum EOutArgsMembers {
    OUT_ARG_f,  
    OUT_ARG_W,  
    OUT_ARG_f_mp,  
    OUT_ARG_W_mp,  
    OUT_ARG_W_op,  
    OUT_ARG_W_prec, 
    OUT_ARG_f_poly  
  };
  static const int NUM_E_OUT_ARGS_MEMBERS=7;

  enum EOutArgsDfDp {
    OUT_ARG_DfDp   
  };

  enum EOutArgsDgDx_dot {
    OUT_ARG_DgDx_dot   
  };

  enum EOutArgsDgDx {
    OUT_ARG_DgDx   
  };

  enum EOutArgsDgDp {
    OUT_ARG_DgDp   
  };
  
  enum EOutArgsDfDp_mp {
    OUT_ARG_DfDp_mp   
  };

  enum EOutArgs_g_mp {
    OUT_ARG_g_mp   
  };

  enum EOutArgsDgDx_dot_mp {
    OUT_ARG_DgDx_dot_mp   
  };

  enum EOutArgsDgDx_mp {
    OUT_ARG_DgDx_mp   
  };

  enum EOutArgsDgDp_mp {
    OUT_ARG_DgDp_mp   
  };
  
  template<class Scalar>
  class OutArgs : public Teuchos::Describable {
  public:
    OutArgs();
    int Np() const;
    int Ng() const;
    bool supports(EOutArgsMembers arg) const;
    const DerivativeSupport& supports(EOutArgsDfDp arg, int l) const;
    const DerivativeSupport& supports(EOutArgsDgDx_dot arg, int j) const;
    const DerivativeSupport& supports(EOutArgsDgDx arg, int j) const;
    const DerivativeSupport& supports(EOutArgsDgDp arg, int j, int l) const;
    void set_f( const Evaluation<VectorBase<Scalar> > &f );
    Evaluation<VectorBase<Scalar> > get_f() const;
    void set_g( int j, const Evaluation<VectorBase<Scalar> > &g_j );
    Evaluation<VectorBase<Scalar> > get_g(int j) const;
    void set_W( const RCP<LinearOpWithSolveBase<Scalar> > &W );
    RCP<LinearOpWithSolveBase<Scalar> > get_W() const;

    template<typename ObjectType>
    bool supports() const;
    template<typename ObjectType>
    void set(const RCP<const ObjectType>& uo);
    template<typename ObjectType>
    RCP<const ObjectType> get() const;

    const DerivativeSupport& supports(EOutArgsDfDp_mp arg, int l) const;
    bool supports(EOutArgs_g_mp arg, int j) const;
    const DerivativeSupport& supports(EOutArgsDgDx_dot_mp arg, int j) const;
    const DerivativeSupport& supports(EOutArgsDgDx_mp arg, int j) const;
    const DerivativeSupport& supports(EOutArgsDgDp_mp arg, int j, int l) const;
    void set_f_mp( const RCP<Stokhos::ProductEpetraVector> &f_mp );
    RCP<Stokhos::ProductEpetraVector> get_f_mp() const;
    void set_g_mp( int j, const RCP<Stokhos::ProductEpetraVector> &g_mp_j );
    RCP<Stokhos::ProductEpetraVector> get_g_mp(int j) const;
    void set_W_mp( const RCP<Stokhos::ProductEpetraOperator> &W_mp );
    RCP<Stokhos::ProductEpetraOperator> get_W_mp() const;

    void set_W_op( const RCP<LinearOpBase<Scalar> > &W_op );
    RCP<LinearOpBase<Scalar> > get_W_op() const;
    void set_W_prec( const RCP<PreconditionerBase<Scalar> > &W_prec );
    RCP<PreconditionerBase<Scalar> > get_W_prec() const;
    DerivativeProperties get_W_properties() const;
    void set_DfDp(int l,  const Derivative<Scalar> &DfDp_l);
    Derivative<Scalar> get_DfDp(int l) const;
    DerivativeProperties get_DfDp_properties(int l) const;
    void set_DgDx_dot(int j, const Derivative<Scalar> &DgDx_dot_j);
    Derivative<Scalar> get_DgDx_dot(int j) const;
    DerivativeProperties get_DgDx_dot_properties(int j) const;
    void set_DgDx(int j, const Derivative<Scalar> &DgDx_j);
    Derivative<Scalar> get_DgDx(int j) const;
    DerivativeProperties get_DgDx_properties(int j) const;
    void set_DgDp( int j, int l, const Derivative<Scalar> &DgDp_j_l );
    Derivative<Scalar> get_DgDp(int j, int l) const;
    DerivativeProperties get_DgDp_properties(int j, int l) const;

    void set_DfDp_mp(int l,  const MPDerivative &DfDp_mp_l);
    MPDerivative get_DfDp_mp(int l) const;
    DerivativeProperties get_DfDp_mp_properties(int l) const;
    void set_DgDx_dot_mp(int j, const MPDerivative &DgDx_dot_mp_j);
    MPDerivative get_DgDx_dot_mp(int j) const;
    DerivativeProperties get_DgDx_dot_mp_properties(int j) const;
    void set_DgDx_mp(int j, const MPDerivative &DgDx_mp_j);
    MPDerivative get_DgDx_mp(int j) const;
    DerivativeProperties get_DgDx_mp_properties(int j) const;
    void set_DgDp_mp( int j, int l, const MPDerivative &DgDp_mp_j_l );
    MPDerivative get_DgDp_mp(int j, int l) const;
    DerivativeProperties get_DgDp_mp_properties(int j, int l) const;

#ifdef HAVE_THYRA_ME_POLYNOMIAL

    void set_f_poly( const RCP<Teuchos::Polynomial< VectorBase<Scalar> > > &f_poly );
    RCP<Teuchos::Polynomial< VectorBase<Scalar> > > get_f_poly() const;
#endif // HAVE_THYRA_ME_POLYNOMIAL

    void setArgs( const OutArgs<Scalar>& outArgs, bool ignoreUnsupported = false );
    void setFailed() const;
    bool isFailed() const;
    bool isEmpty() const;
    void assertSameSupport( const OutArgs<Scalar> &outArgs ) const;
    std::string modelEvalDescription() const;
    std::string description() const;
    void describe(
      Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel
      ) const;
  protected:
    void _setModelEvalDescription( const std::string &modelEvalDescription );
    void _set_Np_Ng(int Np, int Ng);
    void _setSupports( EOutArgsMembers arg, bool supports );
    template<typename ObjectType>
    void _setSupports( const bool supports );
    void _setSupports( EOutArgsDfDp arg, int l, const DerivativeSupport& );
    void _setSupports( EOutArgsDgDx_dot arg, int j, const DerivativeSupport& );
    void _setSupports( EOutArgsDgDx arg, int j, const DerivativeSupport& );
    void _setSupports( EOutArgsDgDp arg, int j, int l, const DerivativeSupport& );

    void _setSupports( EOutArgs_g_mp arg, int j, bool supports );
    void _setSupports( EOutArgsDfDp_mp arg, int l, const DerivativeSupport& );
    void _setSupports( EOutArgsDgDx_dot_mp arg, int j, const DerivativeSupport& );
    void _setSupports( EOutArgsDgDx_mp arg, int j, const DerivativeSupport& );
    void _setSupports( EOutArgsDgDp_mp arg, int j, int l, const DerivativeSupport& );

    void _set_W_properties( const DerivativeProperties &properties );
    void _set_DfDp_properties( int l, const DerivativeProperties &properties );
    void _set_DgDx_dot_properties( int j, const DerivativeProperties &properties );
    void _set_DgDx_properties( int j, const DerivativeProperties &properties );
    void _set_DgDp_properties( int j, int l, const DerivativeProperties &properties );

    void _set_DfDp_mp_properties( int l, const DerivativeProperties &properties );
    void _set_DgDx_dot_mp_properties( int j, const DerivativeProperties &properties );
    void _set_DgDx_mp_properties( int j, const DerivativeProperties &properties );
    void _set_DgDp_mp_properties( int j, int l, const DerivativeProperties &properties );

    void _setSupports( const OutArgs<Scalar>& inputOutArgs );
    void _setUnsupportsAndRelated( EInArgsMembers arg );
    void _setUnsupportsAndRelated( EOutArgsMembers arg );
  private:
    // types
    typedef Teuchos::Array<Evaluation<VectorBase<Scalar> > > g_t;
    typedef Teuchos::Array<Derivative<Scalar> > deriv_t;
    typedef Teuchos::Array<DerivativeProperties> deriv_properties_t;
    typedef Teuchos::Array<DerivativeSupport> supports_t;
    // data
    std::string modelEvalDescription_;
    bool supports_[NUM_E_OUT_ARGS_MEMBERS];
    supports_t supports_DfDp_; // Np
    supports_t supports_DgDx_dot_; // Ng
    supports_t supports_DgDx_; // Ng
    supports_t supports_DgDp_; // Ng x Np
    Evaluation<VectorBase<Scalar> > f_;
    g_t g_; // Ng
    RCP<LinearOpWithSolveBase<Scalar> > W_;
    RCP<LinearOpBase<Scalar> > W_op_;
    RCP<PreconditionerBase<Scalar> > W_prec_;
    DerivativeProperties W_properties_;
    deriv_t DfDp_; // Np
    deriv_properties_t DfDp_properties_; // Np
    deriv_t DgDx_dot_; // Ng
    deriv_t DgDx_; // Ng
    deriv_properties_t DgDx_dot_properties_; // Ng
    deriv_properties_t DgDx_properties_; // Ng
    deriv_t DgDp_; // Ng x Np
    deriv_properties_t DgDp_properties_; // Ng x Np

    Teuchos::Array<bool> supports_g_mp_; //Ng
    supports_t supports_DfDp_mp_; // Np_mp
    supports_t supports_DgDx_dot_mp_; // Ng_mp
    supports_t supports_DgDx_mp_; // Ng_mp
    supports_t supports_DgDp_mp_; // Ng_mp x Np_mp
    Teuchos::Array< RCP< Stokhos::ProductEpetraVector > > g_mp_;
    RCP<Stokhos::ProductEpetraVector> f_mp_;
    RCP<Stokhos::ProductEpetraOperator> W_mp_;
    Teuchos::Array<MPDerivative> DfDp_mp_;
    Teuchos::Array<MPDerivative> DgDx_dot_mp_;
    Teuchos::Array<MPDerivative> DgDx_mp_;
    Teuchos::Array<MPDerivative> DgDp_mp_;
    deriv_properties_t DfDp_mp_properties_;
    deriv_properties_t DgDx_dot_mp_properties_;
    deriv_properties_t DgDx_mp_properties_;
    deriv_properties_t DgDp_mp_properties_;

#ifdef HAVE_THYRA_ME_POLYNOMIAL
   RCP<Teuchos::Polynomial< VectorBase<Scalar> > > f_poly_;
#endif // HAVE_THYRA_ME_POLYNOMIAL
    mutable bool isFailed_;

    std::map<std::string,Teuchos::any> extended_outargs_;

    // functions
    void assert_supports(EOutArgsMembers arg) const;
    void assert_supports(
      EOutArgsDfDp arg, int l,
      const Derivative<Scalar> &deriv = Derivative<Scalar>()
      ) const;
    void assert_supports(
      EOutArgsDgDx_dot arg, int j,
      const Derivative<Scalar> &deriv = Derivative<Scalar>()
      ) const;
    void assert_supports(
      EOutArgsDgDx arg, int j,
      const Derivative<Scalar> &deriv = Derivative<Scalar>()
      ) const;
    void assert_supports(
      EOutArgsDgDp arg, int j, int l,
      const Derivative<Scalar> &deriv = Derivative<Scalar>()
      ) const;

    void assert_supports(EOutArgs_g_mp arg, int j) const;
    void assert_supports(
      EOutArgsDfDp_mp arg, int l,
      const MPDerivative &deriv = MPDerivative()
      ) const;
    void assert_supports(
      EOutArgsDgDx_dot_mp arg, int j,
      const MPDerivative &deriv = MPDerivative()
      ) const;
    void assert_supports(
      EOutArgsDgDx_mp arg, int j,
      const MPDerivative &deriv = MPDerivative()
      ) const;
    void assert_supports(
      EOutArgsDgDp_mp arg, int j, int l,
      const MPDerivative &deriv = MPDerivative()
      ) const;

    void assert_l(int l) const;
    void assert_j(int j) const;
  };


// Added since at least gcc 3.3.4 does not do the right thing here!
#ifdef HAVE_PROTECTED_NESTED_TEMPLATE_CLASS_ACCESS
protected:
#endif


  template<class Scalar>
  class InArgsSetup : public InArgs<Scalar> {
  public:
    InArgsSetup();
    InArgsSetup( const InArgs<Scalar>& );
    void setModelEvalDescription( const std::string &modelEvalDescription );
    void set_Np(int Np);
    void setSupports( EInArgsMembers arg, bool supports = true );
    void setSupports( const InArgs<Scalar>& inputInArgs, const int Np = -1 );
    template<typename ObjectType>
    void setSupports(const bool supports = true);
    void setUnsupportsAndRelated( EInArgsMembers arg );

    void setSupports( EInArgs_p_mp arg, int l, bool supports);
  };

  template<class Scalar>
  class OutArgsSetup : public OutArgs<Scalar> {
  public:
    OutArgsSetup();
    OutArgsSetup( const OutArgs<Scalar>& );
    void setModelEvalDescription( const std::string &modelEvalDescription );
    void set_Np_Ng(int Np, int Ng);
    void setSupports( EOutArgsMembers arg, bool supports = true );
    void setSupports(EOutArgsDfDp arg, int l, const DerivativeSupport& );
    void setSupports(EOutArgsDgDx_dot arg, int j, const DerivativeSupport& );
    void setSupports(EOutArgsDgDx arg, int j, const DerivativeSupport& );
    void setSupports(EOutArgsDgDp arg, int j, int l, const DerivativeSupport& );
    template<typename ObjectType>
    void setSupports(const bool supports = true);

    void setSupports( EOutArgs_g_mp arg, int j, bool supports);
    void setSupports(EOutArgsDfDp_mp arg, int l, const DerivativeSupport& );
    void setSupports(EOutArgsDgDx_dot_mp arg, int j, const DerivativeSupport& );
    void setSupports(EOutArgsDgDx_mp arg, int j, const DerivativeSupport& );
    void setSupports(EOutArgsDgDp_mp arg, int j, int l, const DerivativeSupport& );

    void set_W_properties( const DerivativeProperties &properties );
    void set_DfDp_properties( int l, const DerivativeProperties &properties );
    void set_DgDx_dot_properties( int j, const DerivativeProperties &properties );
    void set_DgDx_properties( int j, const DerivativeProperties &properties );
    void set_DgDp_properties( int j, int l, const DerivativeProperties &properties );

    void set_DfDp_mp_properties( int l, const DerivativeProperties &properties );
    void set_DgDx_dot_mp_properties( int j, const DerivativeProperties &properties );
    void set_DgDx_mp_properties( int j, const DerivativeProperties &properties );
    void set_DgDp_mp_properties( int j, int l, const DerivativeProperties &properties );

    void setSupports( const OutArgs<Scalar>& inputOutArgs );
    void setUnsupportsAndRelated( EInArgsMembers arg );
    void setUnsupportsAndRelated( EOutArgsMembers arg );
   };


 
  ModelEvaluatorBase();


private:
  // Not defined and not to be called
  ModelEvaluatorBase(const ModelEvaluatorBase&);
  ModelEvaluatorBase& operator=(const ModelEvaluatorBase&);

}; // ModelEvaluatorBase


std::string toString(ModelEvaluatorBase::EInArgsMembers);


std::string toString(ModelEvaluatorBase::EOutArgsMembers);


std::string toString(
  ModelEvaluatorBase::EDerivativeMultiVectorOrientation orientation
  );


ModelEvaluatorBase::EDerivativeMultiVectorOrientation
getOtherDerivativeMultiVectorOrientation(
  ModelEvaluatorBase::EDerivativeMultiVectorOrientation orientation
  );


} // namespace Thyra


// //////////////////////////////////
// Inline Defintions

// Extended InArgs
template<class Scalar>
template<typename ObjectType>
bool Thyra::ModelEvaluatorBase::InArgs<Scalar>::supports() const
{
  std::map<std::string,Teuchos::any>::const_iterator search =
    extended_inargs_.find(typeid(ObjectType).name());

  if (search == extended_inargs_.end())
    return false;

  return true;
} 

template<class Scalar>
template<typename ObjectType>
void Thyra::ModelEvaluatorBase::InArgs<Scalar>::set(const Teuchos::RCP<const ObjectType>& eo)
{
  std::map<std::string,Teuchos::any>::iterator search = extended_inargs_.find(typeid(ObjectType).name());
  TEUCHOS_TEST_FOR_EXCEPTION(search == extended_inargs_.end(),
                             std::runtime_error,
                             "ERROR: InArgs::set<ObjectType>() was called with unsupported extended data type \""
                             << typeid(ObjectType).name() << "\"!");

  search->second = Teuchos::any(eo);
}

template<class Scalar>
template<typename ObjectType>
Teuchos::RCP<const ObjectType>
Thyra::ModelEvaluatorBase::InArgs<Scalar>::get() const
{
  std::map<std::string,Teuchos::any>::const_iterator search = extended_inargs_.find(typeid(ObjectType).name());
  TEUCHOS_TEST_FOR_EXCEPTION(search == extended_inargs_.end(),
                             std::runtime_error,
                             "ERROR: InArgs::get<ObjectType>() was called with unsupported extended data type \""
                             << typeid(ObjectType).name() << "\"!");

  return Teuchos::any_cast<Teuchos::RCP<const ObjectType> >(search->second);
}

template<class Scalar>
template<class ObjectType>
void Thyra::ModelEvaluatorBase::InArgsSetup<Scalar>::
setSupports(const bool in_supports)
{
  this->template _setSupports<ObjectType>(in_supports);
}

template<class Scalar>
template<class ObjectType>
void Thyra::ModelEvaluatorBase::InArgs<Scalar>::
_setSupports(const bool in_supports)
{
  if (in_supports)
    // When supports() is called, the map is searched to check for
    // supporting a type. If we support the type, we will insert an
    // empty placholder for now so that the search is successful for
    // support checks.
    this->extended_inargs_[typeid(ObjectType).name()] = Teuchos::any();
  else {
    // if false, remove the entry
    std::map<std::string,Teuchos::any>::iterator search =
      this->extended_inargs_.find(typeid(ObjectType).name());

    if (search != this->extended_inargs_.end())
      this->extended_inargs_.erase(typeid(ObjectType).name());
  }
}

// Extended OutArgs
template<class Scalar>
template<typename ObjectType>
bool Thyra::ModelEvaluatorBase::OutArgs<Scalar>::supports() const
{
  std::map<std::string,Teuchos::any>::const_iterator search =
    extended_outargs_.find(typeid(ObjectType).name());

  if (search == extended_outargs_.end())
    return false;

  return true;
} 

template<class Scalar>
template<typename ObjectType>
void Thyra::ModelEvaluatorBase::OutArgs<Scalar>::set(const Teuchos::RCP<const ObjectType>& eo)
{
  std::map<std::string,Teuchos::any>::iterator search = extended_outargs_.find(typeid(ObjectType).name());
  TEUCHOS_TEST_FOR_EXCEPTION(search == extended_outargs_.end(),
                             std::runtime_error,
                             "ERROR: OutArgs::set<ObjectType>() was called with unsupported extended data type \""
                             << typeid(ObjectType).name() << "\"!");

  search->second = Teuchos::any(eo);
}

template<class Scalar>
template<typename ObjectType>
Teuchos::RCP<const ObjectType>
Thyra::ModelEvaluatorBase::OutArgs<Scalar>::get() const
{
  std::map<std::string,Teuchos::any>::const_iterator search = extended_outargs_.find(typeid(ObjectType).name());
  TEUCHOS_TEST_FOR_EXCEPTION(search == extended_outargs_.end(),
                             std::runtime_error,
                             "ERROR: OutArgs::get<ObjectType>() was called with unsupported extended data type \""
                             << typeid(ObjectType).name() << "\"!");

  return Teuchos::any_cast<Teuchos::RCP<const ObjectType> >(search->second);
}

template<class Scalar>
template<class ObjectType>
void Thyra::ModelEvaluatorBase::OutArgsSetup<Scalar>::
setSupports(const bool in_supports)
{
  this->template _setSupports<ObjectType>(in_supports);
}

template<class Scalar>
template<class ObjectType>
void Thyra::ModelEvaluatorBase::OutArgs<Scalar>::
_setSupports(const bool in_supports)
{
  if (in_supports)
    // When supports() is called, the map is searched to check for
    // supporting a type. If we support the type, we will insert an
    // empty placholder for now so that the search is successful for
    // support checks.
    this->extended_outargs_[typeid(ObjectType).name()] = Teuchos::any();
  else {
    // if false, remove the entry
    std::map<std::string,Teuchos::any>::iterator search =
      this->extended_outargs_.find(typeid(ObjectType).name());

    if (search != this->extended_outargs_.end())
      this->extended_outargs_.erase(typeid(ObjectType).name());
  }
}

//
// Thyra_MEB_helper_functions_grp
//


inline
std::string Thyra::toString(ModelEvaluatorBase::EInArgsMembers arg)
{
  switch(arg) {
    case ModelEvaluatorBase::IN_ARG_x_dot_dot:
      return "IN_ARG_x_dot_dot";
    case ModelEvaluatorBase::IN_ARG_x_dot:
      return "IN_ARG_x_dot";
    case ModelEvaluatorBase::IN_ARG_x:
      return "IN_ARG_x";
    case ModelEvaluatorBase::IN_ARG_x_dot_poly:
      return "IN_ARG_x_dot_poly";
    case ModelEvaluatorBase::IN_ARG_x_poly:
      return "IN_ARG_x_poly";
    case ModelEvaluatorBase::IN_ARG_x_dot_mp:
      return "IN_ARG_x_dot_mp";
    case ModelEvaluatorBase::IN_ARG_x_mp:
      return "IN_ARG_x_mp";
    case ModelEvaluatorBase::IN_ARG_t:
      return "IN_ARG_t";
    case ModelEvaluatorBase::IN_ARG_alpha:
      return "IN_ARG_alpha";
    case ModelEvaluatorBase::IN_ARG_beta:
      return "IN_ARG_beta";
    case ModelEvaluatorBase::IN_ARG_W_x_dot_dot_coeff:
      return "IN_ARG_W_x_dot_dot_coeff";
    case ModelEvaluatorBase::IN_ARG_step_size:
      return "IN_ARG_step_size";
    case ModelEvaluatorBase::IN_ARG_stage_number:
      return "IN_ARG_stage_number";
#ifdef TEUCHOS_DEBUG
    default:
      TEUCHOS_TEST_FOR_EXCEPT(true);
#endif
  }
  return ""; // Will never be executed!
}


inline
std::string Thyra::toString(ModelEvaluatorBase::EOutArgsMembers arg)
{
  switch(arg) {
    case ModelEvaluatorBase::OUT_ARG_f:
      return "OUT_ARG_f";
    case ModelEvaluatorBase::OUT_ARG_W:
      return "OUT_ARG_W";
    case ModelEvaluatorBase::OUT_ARG_f_mp:
      return "OUT_ARG_f_mp";
    case ModelEvaluatorBase::OUT_ARG_W_mp:
      return "OUT_ARG_W_mp";
    case ModelEvaluatorBase::OUT_ARG_W_op:
      return "OUT_ARG_W_op";
    case ModelEvaluatorBase::OUT_ARG_W_prec:
      return "OUT_ARG_W_prec";
    case ModelEvaluatorBase::OUT_ARG_f_poly:
      return "OUT_ARG_f_poly";
#ifdef TEUCHOS_DEBUG
    default:
      TEUCHOS_TEST_FOR_EXCEPT(true);
#endif
  }
  return ""; // Will never be executed!
}


inline
std::string Thyra::toString(
  ModelEvaluatorBase::EDerivativeMultiVectorOrientation orientation
  )
{
  switch(orientation) {
    case ModelEvaluatorBase::DERIV_MV_BY_COL:
      return "DERIV_MV_BY_COL";
    case ModelEvaluatorBase::DERIV_TRANS_MV_BY_ROW:
      return "DERIV_TRANS_MV_BY_ROW";
#ifdef TEUCHOS_DEBUG
    default:
      TEUCHOS_TEST_FOR_EXCEPT(true);
#endif
  }
  return ""; // Should never execute this!
}


inline
Thyra::ModelEvaluatorBase::EDerivativeMultiVectorOrientation
Thyra::getOtherDerivativeMultiVectorOrientation(
  ModelEvaluatorBase::EDerivativeMultiVectorOrientation orientation
  )
{
  switch(orientation) {
    case ModelEvaluatorBase::DERIV_MV_BY_COL:
      return ModelEvaluatorBase::DERIV_TRANS_MV_BY_ROW;
    case ModelEvaluatorBase::DERIV_TRANS_MV_BY_ROW:
      return ModelEvaluatorBase::DERIV_MV_BY_COL;
#ifdef TEUCHOS_DEBUG
    default:
      TEUCHOS_TEST_FOR_EXCEPT(true);
#endif
  }
  return ModelEvaluatorBase::DERIV_MV_BY_COL; // Should never execute this!
}


#endif // THYRA_MODEL_EVALUATOR_BASE_DECL_HPP