MoochoPack : Framework for Large-Scale Optimization Algorithms  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
MoochoPack_IpState.hpp
1 // @HEADER
2 // ***********************************************************************
3 //
4 // Moocho: Multi-functional Object-Oriented arCHitecture for Optimization
5 // Copyright (2003) Sandia Corporation
6 //
7 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
8 // license for use of this work by or on behalf of the U.S. Government.
9 //
10 // Redistribution and use in source and binary forms, with or without
11 // modification, are permitted provided that the following conditions are
12 // met:
13 //
14 // 1. Redistributions of source code must retain the above copyright
15 // notice, this list of conditions and the following disclaimer.
16 //
17 // 2. Redistributions in binary form must reproduce the above copyright
18 // notice, this list of conditions and the following disclaimer in the
19 // documentation and/or other materials provided with the distribution.
20 //
21 // 3. Neither the name of the Corporation nor the names of the
22 // contributors may be used to endorse or promote products derived from
23 // this software without specific prior written permission.
24 //
25 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
26 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
29 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 //
37 // Questions? Contact Roscoe A. Bartlett (rabartl@sandia.gov)
38 //
39 // ***********************************************************************
40 // @HEADER
41 //
42 
43 #if !defined IP_STATE_H
44 #define IP_STATE_H
45 
46 #include "MoochoPack_NLPAlgoState.hpp"
47 
48 namespace MoochoPack {
49 
50 // Iteration Quantity Strings
51 extern const std::string barrier_parameter_name;
52 extern const std::string barrier_obj_name;
53 extern const std::string grad_barrier_obj_name;
54 extern const std::string e_tol_name;
55 extern const std::string comp_err_mu_name;
56 extern const std::string Vu_name;
57 extern const std::string Vl_name;
58 extern const std::string invXu_name;
59 extern const std::string invXl_name;
60 extern const std::string rHB_name;
61 extern const std::string B_name;
62 extern const std::string Sigma_name;
63 extern const std::string w_sigma_name;
64 extern const std::string dvl_name;
65 extern const std::string dvu_name;
66 extern const std::string alpha_vl_name;
67 extern const std::string alpha_vu_name;
68 
69 
70 class IpState
72  {
73 
74  public:
76 
78  STATE_SCALAR_IQ_DECL(barrier_parameter)
79 
80 
81  // barrier term included
82  STATE_SCALAR_IQ_DECL(barrier_obj)
83 
85  // with barrier term included
86  STATE_VECTOR_IQ_DECL(grad_barrier_obj)
87 
90 
92  STATE_SCALAR_IQ_DECL(comp_err_mu)
93 
95  STATE_IQ_DECL(MatrixSymDiagStd, Vu)
96 
98  STATE_IQ_DECL(MatrixSymDiagStd, Vl)
99 
101  STATE_IQ_DECL(MatrixSymDiagStd, invXu)
102 
104  STATE_IQ_DECL(MatrixSymDiagStd, invXl)
105 
107  STATE_IQ_DECL(MatrixSymOp, rHB)
108 
110  STATE_IQ_DECL(MatrixSymOp, B)
111 
113  STATE_IQ_DECL(MatrixSymDiagStd, Sigma)
114 
116  STATE_VECTOR_IQ_DECL(w_sigma)
117 
120 
123 
125  STATE_SCALAR_IQ_DECL(alpha_vl)
126 
128  STATE_SCALAR_IQ_DECL(alpha_vu)
129 
134  IpState(
135  const decomp_sys_ptr_t& decomp_sys = Teuchos::null
136  ,const vec_space_ptr_t& space_x = Teuchos::null
137  ,const vec_space_ptr_t& space_c = Teuchos::null
138  ,const vec_space_ptr_t& space_range = Teuchos::null
139  ,const vec_space_ptr_t& space_null = Teuchos::null
140  );
141 
142  virtual ~IpState();
143 
144  }; // end class IpState
145 
146 } // end namespace MoochoPack
147 
148 
149 
150 #endif // if !defined IP_STATE_H
#define STATE_IQ_DECL(TYPE, NAME)
Add class declarations for an arbitrary iteration quantity.
#define STATE_SCALAR_IQ_DECL(NAME)
Add class declarations for a scalar (i.e. value_type) iteration quantity.
Reduced space SQP state encapsulation interface.
#define STATE_VECTOR_IQ_DECL(NAME)
Add class declarations for a VectorMutable iteration quantity.