AbstractLinAlgPack: C++ Interfaces For Vectors, Matrices And Related Linear Algebra Objects Version of the Day
AbstractLinAlgPack_BasisSystemPermDirectSparse.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 ABSTRACT_LIN_ALG_PACK_BASIS_PERM_DIRECT_SPARSE_SYSTEM_H
00043 #define ABSTRACT_LIN_ALG_PACK_BASIS_PERM_DIRECT_SPARSE_SYSTEM_H
00044 
00045 #include "AbstractLinAlgPack_DirectSparseSolver.hpp"
00046 #include "AbstractLinAlgPack_BasisSystemPerm.hpp"
00047 #include "DenseLinAlgPack_IVector.hpp"
00048 
00049 namespace AbstractLinAlgPack {
00050 
00058 class BasisSystemPermDirectSparse
00059   : public AbstractLinAlgPack::BasisSystemPerm
00060 {
00061 public:
00062 
00065 
00067   typedef Teuchos::RCP<DirectSparseSolver>   direct_solver_ptr_t;
00068 
00070 
00073 
00075   BasisSystemPermDirectSparse(
00076     const direct_solver_ptr_t&   direct_solver = Teuchos::null
00077     );
00078   
00080   void initialize(
00081     const direct_solver_ptr_t&   direct_solver
00082     );
00083 
00085 
00088 
00090   const mat_nonsing_fcty_ptr_t factory_C() const;
00092   const mat_fcty_ptr_t factory_D() const;
00094   const mat_fcty_ptr_t factory_GcUP() const;
00096   Range1D var_dep() const;
00098   Range1D var_indep() const;
00100   Range1D equ_decomp() const;
00102   Range1D equ_undecomp() const;
00104   void update_basis(
00105     const MatrixOp          &Gc
00106     ,MatrixOpNonsing        *C
00107     ,MatrixOp               *D
00108     ,MatrixOp               *GcUP
00109     ,EMatRelations          mat_rel
00110     ,std::ostream           *out
00111     ) const;
00112 
00114 
00117 
00119   const perm_fcty_ptr_t   factory_P_var() const;
00121   const perm_fcty_ptr_t   factory_P_equ() const;
00123   const perm_fcty_ptr_t   factory_P_inequ() const;
00125   void set_basis(
00126     const Permutation          &P_var
00127     ,const Range1D             &var_dep
00128     ,const Permutation         *P_equ
00129     ,const Range1D             *equ_decomp
00130     ,const MatrixOp            &Gc
00131     ,MatrixOpNonsing           *C
00132     ,MatrixOp                  *D
00133     ,MatrixOp                  *GcUP
00134     ,EMatRelations             mat_rel
00135     ,std::ostream              *out
00136     );
00138   void select_basis(
00139     const Vector               *nu
00140     ,MatrixOp                  *Gc
00141     ,Permutation               *P_var
00142     ,Range1D                   *var_dep
00143     ,Permutation               *P_equ
00144     ,Range1D                   *equ_decomp
00145     ,MatrixOpNonsing           *C
00146     ,MatrixOp                  *D
00147     ,MatrixOp                  *GcUP
00148     ,EMatRelations             mat_rel
00149     ,std::ostream              *out
00150     );
00151   
00153 
00154 private:
00155 
00156   // ///////////////////////////////
00157   // Private data members
00158 
00159   direct_solver_ptr_t   direct_solver_;
00160   size_type             n_;
00161   size_type           m_;
00162   size_type             r_;
00163   size_type             Gc_nz_;
00164   Range1D               init_var_rng_;
00165   IVector               init_var_inv_perm_;  // If init_var_rng is full range then this is ignored
00166     Range1D               init_equ_rng_;
00167   IVector               init_equ_inv_perm_;  // If init_equ_rng is full range then this is ignored
00168   Range1D               var_dep_;       // used by factor()
00169   Range1D               var_indep_;     // used by factor()
00170     Range1D               equ_decomp_;    // used by factor()
00171     Range1D               equ_undecomp_;  // used by factor()
00172 
00173   // ///////////////////////////////
00174   // Private member functions
00175 
00177   Teuchos::RCP<DirectSparseSolver::BasisMatrix>
00178   get_basis_matrix( MatrixOpNonsingAggr &C_aggr ) const;
00179 
00181   void set_A_mctse(
00182     size_type                    n
00183     ,size_type                   m
00184     ,const MatrixPermAggr        &Gc_pa
00185     ,MatrixConvertToSparseEncap  *A_mctse
00186     ) const;
00187 
00189   void update_basis_and_auxiliary_matrices(
00190     const MatrixOp& Gc
00191     ,const Teuchos::RCP<DirectSparseSolver::BasisMatrix>& C_bm
00192     ,MatrixOpNonsingAggr *C_aggr
00193     ,MatrixOp* D, MatrixOp* GcUP
00194     ) const;
00195 
00197   void do_some_basis_stuff(
00198     const MatrixOp& Gc
00199     ,const Range1D& var_dep, const Range1D& equ_decomp
00200     ,const Teuchos::RCP<DirectSparseSolver::BasisMatrix>& C_bm
00201     ,MatrixOpNonsingAggr *C_aggr
00202     ,MatrixOp* D, MatrixOp* GcUP
00203     );
00204 
00205 
00206 }; // end class BasisSystemPermDirectSparse
00207 
00208 }  // end namespace AbstractLinAlgPack
00209 
00210 #endif // ABSTRACT_LIN_ALG_PACK_BASIS_PERM_DIRECT_SPARSE_SYSTEM_H
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends