MoochoPack : Framework for Large-Scale Optimization Algorithms Version of the Day
MoochoPack_IpState.hpp
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 
00043 #if !defined IP_STATE_H
00044 #define IP_STATE_H
00045 
00046 #include "MoochoPack_NLPAlgoState.hpp"
00047 
00048 namespace MoochoPack {
00049 
00050 // Iteration Quantity Strings
00051 extern const std::string barrier_parameter_name;
00052 extern const std::string barrier_obj_name;
00053 extern const std::string grad_barrier_obj_name;
00054 extern const std::string e_tol_name;
00055 extern const std::string comp_err_mu_name;
00056 extern const std::string Vu_name;
00057 extern const std::string Vl_name;
00058 extern const std::string invXu_name;
00059 extern const std::string invXl_name;
00060 extern const std::string rHB_name;
00061 extern const std::string B_name;
00062 extern const std::string Sigma_name;
00063 extern const std::string w_sigma_name;
00064 extern const std::string dvl_name;
00065 extern const std::string dvu_name;
00066 extern const std::string alpha_vl_name;
00067 extern const std::string alpha_vu_name;
00068 
00069 
00070 class IpState 
00071   : public MoochoPack::NLPAlgoState
00072   {
00073 
00074   public:
00076 
00078     STATE_SCALAR_IQ_DECL(barrier_parameter)
00079 
00080     
00081     //   barrier term included
00082     STATE_SCALAR_IQ_DECL(barrier_obj)
00083 
00085     //   with barrier term included
00086     STATE_VECTOR_IQ_DECL(grad_barrier_obj)
00087 
00089     STATE_SCALAR_IQ_DECL(e_tol)
00090 
00092     STATE_SCALAR_IQ_DECL(comp_err_mu)
00093 
00095     STATE_IQ_DECL(MatrixSymDiagStd, Vu)
00096 
00098     STATE_IQ_DECL(MatrixSymDiagStd, Vl)
00099 
00101     STATE_IQ_DECL(MatrixSymDiagStd, invXu)
00102 
00104     STATE_IQ_DECL(MatrixSymDiagStd, invXl)
00105 
00107     STATE_IQ_DECL(MatrixSymOp, rHB)
00108 
00110     STATE_IQ_DECL(MatrixSymOp, B)
00111 
00113     STATE_IQ_DECL(MatrixSymDiagStd, Sigma)
00114 
00116     STATE_VECTOR_IQ_DECL(w_sigma) 
00117 
00119     STATE_VECTOR_IQ_DECL(dvl)
00120 
00122     STATE_VECTOR_IQ_DECL(dvu)
00123 
00125     STATE_SCALAR_IQ_DECL(alpha_vl)
00126 
00128     STATE_SCALAR_IQ_DECL(alpha_vu)
00129 
00134     IpState(
00135       const decomp_sys_ptr_t& decomp_sys   = Teuchos::null
00136       ,const vec_space_ptr_t& space_x      = Teuchos::null
00137       ,const vec_space_ptr_t& space_c      = Teuchos::null
00138       ,const vec_space_ptr_t& space_range  = Teuchos::null
00139       ,const vec_space_ptr_t& space_null   = Teuchos::null
00140       );
00141 
00142     virtual ~IpState();
00143 
00144   }; // end class IpState
00145 
00146 } // end namespace MoochoPack
00147 
00148 
00149 
00150 #endif // if !defined IP_STATE_H
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends