AbstractLinAlgPack: C++ Interfaces For Vectors, Matrices And Related Linear Algebra Objects Version of the Day
AbstractLinAlgPack_SuperLUSolver.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 #ifdef SPARSE_SOLVER_PACK_USE_SUPERLU
00043 
00044 #ifndef SSP_SUPERLU_SOLVER_H
00045 #define SSP_SUPERLU_SOLVER_H
00046 
00047 #include "Teuchos_RCP.hpp"
00048 
00049 namespace SuperLUPack {
00050 
00058 class SuperLUSolver {
00059 public:
00060 
00063 
00070   class FactorizationStructure {
00071   public:
00073     virtual ~FactorizationStructure() {}
00074   };
00075 
00079   class FactorizationNonzeros {
00080   public:
00082     virtual ~FactorizationNonzeros() {}
00083   };
00084 
00086 
00088   virtual ~SuperLUSolver() {}
00089 
00092 
00094   static Teuchos::RCP<SuperLUSolver>                         create_solver();
00096   static Teuchos::RCP<SuperLUSolver::FactorizationStructure> create_fact_struct();
00098   static Teuchos::RCP<SuperLUSolver::FactorizationNonzeros>  create_fact_nonzeros();
00099 
00101 
00104 
00136   virtual void analyze_and_factor(
00137     int                         m
00138     ,int                        n
00139     ,int                        nz
00140     ,const double               a_val[]
00141     ,const int                  a_row_i[]
00142     ,const int                  a_col_ptr[]
00143     ,FactorizationStructure     *fact_struct
00144     ,FactorizationNonzeros      *fact_nonzeros
00145     ,int                        perm_r[]
00146     ,int                        perm_c[]
00147     ,int                        *rank
00148     ) = 0;
00149   
00154   virtual void factor(
00155     int                             m
00156     ,int                            n
00157     ,int                            nz
00158     ,const double                   a_val[]
00159     ,const int                      a_row_i[]
00160     ,const int                      a_col_ptr[]
00161     ,const FactorizationStructure   &fact_struct
00162     ,FactorizationNonzeros          *fact_nonzeros
00163     ) = 0;
00164 
00166   
00169 
00174   virtual void solve(
00175     const FactorizationStructure    &fact_struct
00176     ,const FactorizationNonzeros    &fact_nonzeros
00177     ,bool                           transp
00178     ,int                            n
00179     ,int                            nrhs
00180     ,double                         rhs[]
00181     ,int                            ldrhs
00182     ) const = 0;
00183 
00185 
00186 }; // end class SuperLUSolver
00187 
00188 } // end namespace SuperLUPack
00189 
00190 #endif // SSP_SUPERLU_SOLVER_H
00191 
00192 #endif // SPARSE_SOLVER_PACK_USE_SUPERLU
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends