ConstrainedOptPack: C++ Tools for Constrained (and Unconstrained) Optimization Version of the Day
ConstrainedOptPack_DecompositionSystemOrthogonal.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 #ifndef DECOMPOSITION_SYSTEM_ORTHOGONAL_H
00043 #define DECOMPOSITION_SYSTEM_ORTHOGONAL_H
00044 
00045 #include "ConstrainedOptPack_DecompositionSystemVarReductImp.hpp"
00046 #include "Teuchos_StandardCompositionMacros.hpp"
00047 
00048 namespace ConstrainedOptPack {
00049 
00074 class DecompositionSystemOrthogonal : public DecompositionSystemVarReductImp {
00075 public:
00076 
00079 
00081   DecompositionSystemOrthogonal(
00082     const VectorSpace::space_ptr_t           &space_x                    = Teuchos::null
00083     ,const VectorSpace::space_ptr_t          &space_c                    = Teuchos::null
00084     ,const basis_sys_ptr_t                   &basis_sys                  = Teuchos::null
00085     ,const basis_sys_tester_ptr_t            &basis_sys_tester           = Teuchos::null
00086     ,EExplicitImplicit                       D_imp                       = MAT_IMP_EXPLICIT
00087     ,EExplicitImplicit                       Uz_imp                      = MAT_IMP_EXPLICIT
00088     );
00089 
00091 
00094 
00096   const mat_fcty_ptr_t factory_Y() const;
00098   const mat_nonsing_fcty_ptr_t factory_R() const;
00100   const mat_fcty_ptr_t factory_Uy() const;
00101 
00103 
00104 protected:
00105 
00108 
00110   void update_D_imp_used(EExplicitImplicit *D_imp_used) const;
00112   mat_nonsing_fcty_ptr_t::element_type::obj_ptr_t uninitialize_matrices(
00113     std::ostream                                       *out
00114     ,EOutputLevel                                      olevel
00115     ,MatrixOp                                          *Y
00116     ,MatrixOpNonsing                                   *R
00117     ,MatrixOp                                          *Uy
00118     ) const;
00120   void initialize_matrices(
00121     std::ostream                                           *out
00122     ,EOutputLevel                                          olevel
00123     ,const mat_nonsing_fcty_ptr_t::element_type::obj_ptr_t &C
00124     ,const mat_fcty_ptr_t::element_type::obj_ptr_t         &D
00125     ,MatrixOp                                              *Y
00126     ,MatrixOpNonsing                                       *R
00127     ,MatrixOp                                              *Uy
00128     ,EMatRelations                                         mat_rel
00129     ) const;
00131   void print_update_matrices(
00132     std::ostream& out, const std::string& leading_str ) const;
00133 
00135 
00136 private:
00137   
00138   // ////////////////////////
00139   // Private types
00140 
00141   typedef Teuchos::RCP<MatrixSymOpNonsing>  S_ptr_t;
00142 
00143   // ////////////////////////
00144   // Private data members
00145 
00146   mutable S_ptr_t        S_ptr_;
00147   // We just hold on to this between calls of uninitialize_matrices() and initialize_matrices()
00148 
00149   // ////////////////////////
00150   // Private member functions
00151 
00152   // Not defined and not to be called
00153   DecompositionSystemOrthogonal(const DecompositionSystemOrthogonal&);
00154   DecompositionSystemOrthogonal& operator=(const DecompositionSystemOrthogonal&);
00155 
00156 };  // end class DecompositionSystemOrthogonal
00157 
00158 } // end namespace ConstrainedOptPack
00159 
00160 #endif  // DECOMPOSITION_SYSTEM_ORTHOGONAL_H
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends