MOOCHO (Single Doxygen Collection) Version of the Day
NLPInterfacePack_NLPFirstOrderThyraModelEvaluator.hpp
Go to the documentation of this file.
00001 // @HEADER
00002 // ***********************************************************************
00003 // 
00004 // Moocho: Multi-functional Object-Oriented arCHitecture for Optimization
00005 //                  Copyright (2003) Sandia Corporation
00006 // 
00007 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
00008 // license for use of this work by or on behalf of the U.S. Government.
00009 // 
00010 // Redistribution and use in source and binary forms, with or without
00011 // modification, are permitted provided that the following conditions are
00012 // met:
00013 //
00014 // 1. Redistributions of source code must retain the above copyright
00015 // notice, this list of conditions and the following disclaimer.
00016 //
00017 // 2. Redistributions in binary form must reproduce the above copyright
00018 // notice, this list of conditions and the following disclaimer in the
00019 // documentation and/or other materials provided with the distribution.
00020 //
00021 // 3. Neither the name of the Corporation nor the names of the
00022 // contributors may be used to endorse or promote products derived from
00023 // this software without specific prior written permission.
00024 //
00025 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
00026 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00027 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00028 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
00029 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00030 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00031 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00032 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00033 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00034 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00035 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00036 //
00037 // Questions? Contact Roscoe A. Bartlett (rabartl@sandia.gov) 
00038 // 
00039 // ***********************************************************************
00040 // @HEADER
00041 
00042 #ifndef NLPIP_NLP_FIRST_ORDER_THYRA_MODEL_EVALUATOR_HPP
00043 #define NLPIP_NLP_FIRST_ORDER_THYRA_MODEL_EVALUATOR_HPP
00044 
00045 #include <vector>
00046 
00047 #include "NLPInterfacePack_NLPThyraModelEvaluatorBase.hpp"
00048 
00049 namespace NLPInterfacePack {
00050 
00056 class NLPFirstOrderThyraModelEvaluator
00057   : virtual public NLPFirstOrder
00058   , virtual public NLPThyraModelEvaluatorBase
00059 {
00060 public:
00061 
00063   NLPFirstOrderThyraModelEvaluator();
00064 
00066   NLPFirstOrderThyraModelEvaluator(
00067     const Teuchos::RCP<Thyra::ModelEvaluator<value_type> >  &model
00068     ,const int                                                      p_idx
00069     ,const int                                                      g_idx
00070     );
00071 
00079   void initialize(
00080     const Teuchos::RCP<Thyra::ModelEvaluator<value_type> >  &model
00081     ,const int                                                      p_idx
00082     ,const int                                                      g_idx
00083     );
00084 
00087 
00089   void initialize(bool test_setup);
00091   void unset_quantities();
00092 
00094 
00097 
00099   void set_Gc(MatrixOp* Gc);
00101   const NLPFirstOrder::mat_fcty_ptr_t factory_Gc() const;
00103   const basis_sys_ptr_t basis_sys() const;
00104 
00106 
00107 protected:
00108 
00111 
00113   void imp_calc_Gc(
00114     const Vector& x, bool newx
00115     ,const FirstOrderInfo& first_order_info) const;
00116 
00118 
00119 private:
00120 
00121   // /////////////////////////////////////////
00122   // Private member functions
00123 
00125   void evalModel( 
00126     const Vector            &x
00127     ,bool                   newx
00128     ,const ZeroOrderInfo    *zero_order_info  // != NULL if only zero-order info
00129     ,const ObjGradInfo      *obj_grad_info    // != NULL if obj-grad and below info
00130     ,const FirstOrderInfo   *first_order_info // != NULL if first-order and below info
00131     ) const;
00132 
00133 };  // end class NLPFirstOrderThyraModelEvaluator
00134 
00135 } // end namespace NLPInterfacePack
00136 
00137 #endif  // NLPIP_NLP_FIRST_ORDER_THYRA_MODEL_EVALUATOR_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines