NLPInterfacePack_NLPThyraModelEvaluatorBase.hpp

// @HEADER
// ***********************************************************************
// 
// Moocho: Multi-functional Object-Oriented arCHitecture for Optimization
//                  Copyright (2003) 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 (rabartl@sandia.gov) 
// 
// ***********************************************************************
// @HEADER

#ifndef NLPIP_NLP_THYRA_MODEL_EVALUATOR_BASE_HPP
#define NLPIP_NLP_THYRA_MODEL_EVALUATOR_BASE_HPP

#include <vector>

#include "NLPInterfacePack_NLPFirstOrder.hpp"
#include "AbstractLinAlgPack_VectorSpace.hpp"
#include "Thyra_ModelEvaluator.hpp"
#include "Teuchos_Assert.hpp"
#include "Teuchos_StandardMemberCompositionMacros.hpp"

namespace AbstractLinAlgPack { class VectorSpaceThyra; }

namespace NLPInterfacePack {

class NLPThyraModelEvaluatorBase : virtual public NLPObjGrad {
public:

  STANDARD_MEMBER_COMPOSITION_MEMBERS( bool, showModelEvaluatorTrace );


  void initialize(bool test_setup);
  bool is_initialized() const;
  vec_space_ptr_t space_x() const;
  vec_space_ptr_t space_c() const;
    size_type num_bounded_x() const;
  void force_xinit_in_bounds(bool force_xinit_in_bounds);
  bool force_xinit_in_bounds() const;
  const Vector& xinit() const;
  const Vector& xl() const;
  const Vector& xu() const;
  value_type max_var_bounds_viol() const;
  void set_f(value_type* f);
  void set_c(VectorMutable* c);
  void unset_quantities();
  void scale_f( value_type scale_f );
  value_type scale_f() const;
  void report_final_solution(
    const Vector&    x
    ,const Vector*   lambda
    ,const Vector*   nu
    ,bool            optimal
    );



  void set_Gf(VectorMutable* Gf);


protected:


  void imp_calc_f(
    const Vector& x, bool newx
    ,const ZeroOrderInfo& zero_order_info) const;
  void imp_calc_c(
    const Vector& x, bool newx
    ,const ZeroOrderInfo& zero_order_info) const;



  void imp_calc_Gf(
    const Vector& x, bool newx
    ,const ObjGradInfo& obj_grad_info) const;


protected:


  NLPThyraModelEvaluatorBase();

  void initializeBase(
    const Teuchos::RCP<Thyra::ModelEvaluator<value_type> >  &model
    ,const int                                                      p_idx
    ,const int                                                      g_idx
    );

  void updateInitialGuessAndBounds() const;

  void assert_is_initialized() const;
  void copy_from_model_x( const Thyra::VectorBase<value_type>* model_x, VectorMutable* x_D ) const;
  void copy_from_model_p( const Thyra::VectorBase<value_type> *model_p, VectorMutable* x_I ) const;
  void set_x(
    const Vector                                      &x
    ,Thyra::ModelEvaluatorBase::InArgs<value_type>    *model_inArgs_inout
    ) const;
  void preprocessBaseInOutArgs(
    const Vector                                      &x
    ,bool                                             newx
    ,const ZeroOrderInfo                              *zero_order_info
    ,const ObjGradInfo                                *obj_grad_info
    ,const NLPFirstOrder::FirstOrderInfo              *first_order_info
    ,Thyra::ModelEvaluatorBase::InArgs<value_type>    *model_inArgs_inout
    ,Thyra::ModelEvaluatorBase::OutArgs<value_type>   *model_outArgs_inout
    ,MatrixOp*                                        *Gc_out
    ,VectorMutable*                                   *Gf_out
    ,value_type*                                      *f_out
    ,VectorMutable*                                   *c_out
    ) const;
  void postprocessBaseOutArgs(
    Thyra::ModelEvaluatorBase::OutArgs<value_type>        *model_outArgs_inout
    ,VectorMutable                                        *Gf
    ,value_type                                           *f
    ,VectorMutable                                        *c
    ) const;
    

//private: // ToDo: Make these private and refactor the other classes ...

  // /////////////////////////////////////////
  // Private types

  typedef Teuchos::RCP<const AbstractLinAlgPack::VectorSpaceThyra> VectorSpaceThyra_ptr_t;

  // /////////////////////////////////////////
  // Private data members

  bool                                initialized_;  // flag for if initialized has been called.
  value_type                          obj_scale_;    // default = 1.0;
  bool                                has_bounds_;   // True if has bounds
  bool                                force_xinit_in_bounds_; // default = true.
  index_type                          num_bounded_x_;
  Teuchos::RCP<Thyra::ModelEvaluator<value_type> >
                                      model_;
  int                                 p_idx_;
  int                                 g_idx_;
  bool                                DfDp_supports_op_;
  bool                                DfDp_supports_mv_;
  VectorSpace::space_ptr_t            space_x_;      // Space for the variables
  VectorSpaceThyra_ptr_t              space_c_;      // Space for the constraints
  NLPFirstOrder::mat_fcty_ptr_t       factory_Gc_;   // Factory for Gc
  NLPFirstOrder::basis_sys_ptr_t      basis_sys_;    // The basis system
  mutable bool                        x_guess_bounds_updated_;
  VectorSpace::vec_mut_ptr_t          xinit_;        // Initial guess.
  VectorSpace::vec_mut_ptr_t          xl_;           // lower bounds.
  VectorSpace::vec_mut_ptr_t          xu_;           // upper bounds.

  Teuchos::RCP<Thyra::VectorBase<value_type> >                     model_g_;

  mutable bool model_g_updated_;
  mutable bool model_Dg_updated_;

  mutable bool f_updated_;
  mutable bool c_updated_;
  mutable bool Gf_updated_;
  mutable bool Gc_updated_;

  // /////////////////////////////////////////
  // Private member functions

  void evalModel( 
    const Vector            &x
    ,bool                   newx
    ,const ZeroOrderInfo    *zero_order_info  // != NULL if only zero-order info
    ,const ObjGradInfo      *obj_grad_info    // != NULL if obj-grad and below info
    ) const;

};  // end class NLPThyraModelEvaluatorBase

} // end namespace NLPInterfacePack

#endif  // NLPIP_NLP_THYRA_MODEL_EVALUATOR_BASE_HPP