ConstrainedOptPack: C++ Tools for Constrained (and Unconstrained) Optimization  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
ConstrainedOptPack_DecompositionSystemOrthogonal.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 #ifndef DECOMPOSITION_SYSTEM_ORTHOGONAL_H
43 #define DECOMPOSITION_SYSTEM_ORTHOGONAL_H
44 
45 #include "ConstrainedOptPack_DecompositionSystemVarReductImp.hpp"
47 
48 namespace ConstrainedOptPack {
49 
75 public:
76 
79 
82  const VectorSpace::space_ptr_t &space_x = Teuchos::null
83  ,const VectorSpace::space_ptr_t &space_c = Teuchos::null
84  ,const basis_sys_ptr_t &basis_sys = Teuchos::null
85  ,const basis_sys_tester_ptr_t &basis_sys_tester = Teuchos::null
86  ,EExplicitImplicit D_imp = MAT_IMP_EXPLICIT
87  ,EExplicitImplicit Uz_imp = MAT_IMP_EXPLICIT
88  );
89 
91 
94 
96  const mat_fcty_ptr_t factory_Y() const;
98  const mat_nonsing_fcty_ptr_t factory_R() const;
100  const mat_fcty_ptr_t factory_Uy() const;
101 
103 
104 protected:
105 
108 
112  mat_nonsing_fcty_ptr_t::element_type::obj_ptr_t uninitialize_matrices(
113  std::ostream *out
114  ,EOutputLevel olevel
115  ,MatrixOp *Y
116  ,MatrixOpNonsing *R
117  ,MatrixOp *Uy
118  ) const;
120  void initialize_matrices(
121  std::ostream *out
122  ,EOutputLevel olevel
123  ,const mat_nonsing_fcty_ptr_t::element_type::obj_ptr_t &C
124  ,const mat_fcty_ptr_t::element_type::obj_ptr_t &D
125  ,MatrixOp *Y
126  ,MatrixOpNonsing *R
127  ,MatrixOp *Uy
128  ,EMatRelations mat_rel
129  ) const;
132  std::ostream& out, const std::string& leading_str ) const;
133 
135 
136 private:
137 
138  // ////////////////////////
139  // Private types
140 
142 
143  // ////////////////////////
144  // Private data members
145 
146  mutable S_ptr_t S_ptr_;
147  // We just hold on to this between calls of uninitialize_matrices() and initialize_matrices()
148 
149  // ////////////////////////
150  // Private member functions
151 
152  // Not defined and not to be called
155 
156 }; // end class DecompositionSystemOrthogonal
157 
158 } // end namespace ConstrainedOptPack
159 
160 #endif // DECOMPOSITION_SYSTEM_ORTHOGONAL_H
void print_update_matrices(std::ostream &out, const std::string &leading_str) const
EOutputLevel
Enumeration for the amount of output to create from update_decomp().
const basis_sys_ptr_t & basis_sys() const
const VectorSpace::space_ptr_t & space_c() const
DecompositionSystemOrthogonal(const VectorSpace::space_ptr_t &space_x=Teuchos::null, const VectorSpace::space_ptr_t &space_c=Teuchos::null, const basis_sys_ptr_t &basis_sys=Teuchos::null, const basis_sys_tester_ptr_t &basis_sys_tester=Teuchos::null, EExplicitImplicit D_imp=MAT_IMP_EXPLICIT, EExplicitImplicit Uz_imp=MAT_IMP_EXPLICIT)
mat_nonsing_fcty_ptr_t::element_type::obj_ptr_t uninitialize_matrices(std::ostream *out, EOutputLevel olevel, MatrixOp *Y, MatrixOpNonsing *R, MatrixOp *Uy) const
EExplicitImplicit D_imp_used() const
Get the type of D matrix to be used or is being used (returns MAT_IMP_EXPLICIT or MAT_IMP_IMPLICIT on...
void initialize_matrices(std::ostream *out, EOutputLevel olevel, const mat_nonsing_fcty_ptr_t::element_type::obj_ptr_t &C, const mat_fcty_ptr_t::element_type::obj_ptr_t &D, MatrixOp *Y, MatrixOpNonsing *R, MatrixOp *Uy, EMatRelations mat_rel) const
const VectorSpace::space_ptr_t & space_x() const
Specialization node implementation subclass of DecompositionSystem for variable reduction decompositi...