AbstractLinAlgPack: C++ Interfaces For Vectors, Matrices And Related Linear Algebra Objects  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
AbstractLinAlgPack_SuperLUSolver.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 #ifdef SPARSE_SOLVER_PACK_USE_SUPERLU
43 
44 #ifndef SSP_SUPERLU_SOLVER_H
45 #define SSP_SUPERLU_SOLVER_H
46 
47 #include "Teuchos_RCP.hpp"
48 
49 namespace SuperLUPack {
50 
58 class SuperLUSolver {
59 public:
60 
63 
70  class FactorizationStructure {
71  public:
73  virtual ~FactorizationStructure() {}
74  };
75 
79  class FactorizationNonzeros {
80  public:
82  virtual ~FactorizationNonzeros() {}
83  };
84 
86 
88  virtual ~SuperLUSolver() {}
89 
92 
94  static Teuchos::RCP<SuperLUSolver> create_solver();
96  static Teuchos::RCP<SuperLUSolver::FactorizationStructure> create_fact_struct();
98  static Teuchos::RCP<SuperLUSolver::FactorizationNonzeros> create_fact_nonzeros();
99 
101 
104 
136  virtual void analyze_and_factor(
137  int m
138  ,int n
139  ,int nz
140  ,const double a_val[]
141  ,const int a_row_i[]
142  ,const int a_col_ptr[]
143  ,FactorizationStructure *fact_struct
144  ,FactorizationNonzeros *fact_nonzeros
145  ,int perm_r[]
146  ,int perm_c[]
147  ,int *rank
148  ) = 0;
149 
154  virtual void factor(
155  int m
156  ,int n
157  ,int nz
158  ,const double a_val[]
159  ,const int a_row_i[]
160  ,const int a_col_ptr[]
161  ,const FactorizationStructure &fact_struct
162  ,FactorizationNonzeros *fact_nonzeros
163  ) = 0;
164 
166 
169 
174  virtual void solve(
175  const FactorizationStructure &fact_struct
176  ,const FactorizationNonzeros &fact_nonzeros
177  ,bool transp
178  ,int n
179  ,int nrhs
180  ,double rhs[]
181  ,int ldrhs
182  ) const = 0;
183 
185 
186 }; // end class SuperLUSolver
187 
188 } // end namespace SuperLUPack
189 
190 #endif // SSP_SUPERLU_SOLVER_H
191 
192 #endif // SPARSE_SOLVER_PACK_USE_SUPERLU