xc
SuperLU.h
1 // -*-c++-*-
2 //----------------------------------------------------------------------------
3 // XC program; finite element analysis code
4 // for structural analysis and design.
5 //
6 // Copyright (C) Luis Claudio Pérez Tato
7 //
8 // This program derives from OpenSees <http://opensees.berkeley.edu>
9 // developed by the «Pacific earthquake engineering research center».
10 //
11 // Except for the restrictions that may arise from the copyright
12 // of the original program (see copyright_opensees.txt)
13 // XC is free software: you can redistribute it and/or modify
14 // it under the terms of the GNU General Public License as published by
15 // the Free Software Foundation, either version 3 of the License, or
16 // (at your option) any later version.
17 //
18 // This software is distributed in the hope that it will be useful, but
19 // WITHOUT ANY WARRANTY; without even the implied warranty of
20 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 // GNU General Public License for more details.
22 //
23 //
24 // You should have received a copy of the GNU General Public License
25 // along with this program.
26 // If not, see <http://www.gnu.org/licenses/>.
27 //----------------------------------------------------------------------------
28 /* ****************************************************************** **
29 ** OpenSees - Open System for Earthquake Engineering Simulation **
30 ** Pacific Earthquake Engineering Research Center **
31 ** **
32 ** **
33 ** (C) Copyright 1999, The Regents of the University of California **
34 ** All Rights Reserved. **
35 ** **
36 ** Commercial use of this program without express permission of the **
37 ** University of California, Berkeley, is strictly prohibited. See **
38 ** file 'COPYRIGHT' in main directory for information on usage and **
39 ** redistribution, and for a DISCLAIMER OF ALL WARRANTIES. **
40 ** **
41 ** Developed by: **
42 ** Frank McKenna (fmckenna@ce.berkeley.edu) **
43 ** Gregory L. Fenves (fenves@ce.berkeley.edu) **
44 ** Filip C. Filippou (filippou@ce.berkeley.edu) **
45 ** **
46 ** ****************************************************************** */
47 
48 // $Revision: 1.3 $
49 // $Date: 2005/03/17 20:47:09 $
50 // $Source: /usr/local/cvs/OpenSees/SRC/system_of_eqn/linearSOE/sparseGEN/SuperLU.h,v $
51 
52 
53 #ifndef SuperLU_h
54 #define SuperLU_h
55 
56 // File: ~/system_of_eqn/linearSOE/sparseGEN/SuperLU.h
57 //
58 // Written: fmk
59 // Created: 11/96
60 //
61 // Description: This file contains the class definition for SuperLU.
62 // A SuperLU object can be constructed to solve a SparseGenColLinSOE
63 // object. It obtains the solution by making calls on the
64 // the SuperLU library developed at UC Berkeley by Prof. James Demmel,
65 // Xiaoye S. Li and John R. Gilbert.
66 // The SuperLU library contains a set of subroutines to solve a sparse
67 // linear system $AX=B$. It uses Gaussian elimination with partial
68 // pivoting (GEPP). The columns of A may be preordered before
69 // factorization; the preordering for sparsity is completely separate
70 // from the factorization and a number of ordering schemes are provided.
71 //
72 // What: "@(#) SuperLU.h, revA"
73 
74 #include <solution/system_of_eqn/linearSOE/sparseGEN/SparseGenColLinSolver.h>
75 //#include "superlu/slu_cdefs.h"
76 #include "superlu/slu_ddefs.h"
77 #include "superlu/supermatrix.h"
78 
79 namespace XC {
80 
82 //
95  {
96  private:
97  SuperMatrix A,B,AC;
98  SuperMatrix L,U;
99  ID perm_r;
100  ID perm_c;
101  ID etree;
102  int relax, permSpec, panelSize;
103  double drop_tol;
104  char symmetric;
105  superlu_options_t options;
106  void free_matricesLU(void);
107  void free_matricesABAC(void);
108  void free_matrices(void);
109  void free_mem(void);
110  void inic_permutation_vectors(const size_t &n);
111  void alloc_matrices(const size_t &n);
112  void alloc(const size_t &n);
113  int factorize(void);
114 
115  friend class LinearSOE;
116  friend class FEM_ObjectBroker;
117  SuperLU(int permSpec = 0, double drop_tol = 0.0, int panelSize = 6, int relax = 6,char symmetric = 'N');
118  SuperLU(const SuperLU &);
119  SuperLU &operator=(const SuperLU &);
120  virtual LinearSOESolver *getCopy(void) const;
121  public:
122  ~SuperLU(void);
123 
124  int solve(void);
125  int setSize(void);
126 
127  int sendSelf(Communicator &);
128  int recvSelf(const Communicator &);
129 
130  void Print(std::ostream &os) const;
131  };
132 } // end of XC namespace
133 
134 #endif
135 
~SuperLU(void)
Destructor.
Definition: SuperLU.cpp:230
Communication parameters between processes.
Definition: Communicator.h:66
Linear system of equations.
Definition: LinearSOE.h:92
SuperLU based sparse general matrix linear SOE solver.
Definition: SuperLU.h:94
FEM_ObjectBroker is is an object broker class for the finite element method.
Definition: FEM_ObjectBroker.h:148
Vector of integers.
Definition: ID.h:94
Base class for sparse general matrix linear SOE solver.
Definition: SparseGenColLinSolver.h:77
int solve(void)
Solve the system.
Definition: SuperLU.cpp:280
Open source finite element program for structural analysis.
Definition: ContinuaReprComponent.h:35
Base class of the solvers for linear system of equations.
Definition: LinearSOESolver.h:87
int sendSelf(Communicator &)
Send the object.
Definition: SuperLU.cpp:385
int setSize(void)
Set the system size.
Definition: SuperLU.cpp:354
int recvSelf(const Communicator &)
Receive the object.
Definition: SuperLU.cpp:391