Amesos Package Browser (Single Doxygen Collection)  Development
Amesos_Pardiso.h
Go to the documentation of this file.
1 // @HEADER
2 // ***********************************************************************
3 //
4 // Amesos: Direct Sparse Solver Package
5 // Copyright (2004) 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 // This library is free software; you can redistribute it and/or modify
11 // it under the terms of the GNU Lesser General Public License as
12 // published by the Free Software Foundation; either version 2.1 of the
13 // License, or (at your option) any later version.
14 //
15 // This library is distributed in the hope that it will be useful, but
16 // WITHOUT ANY WARRANTY; without even the implied warranty of
17 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 // Lesser General Public License for more details.
19 //
20 // You should have received a copy of the GNU Lesser General Public
21 // License along with this library; if not, write to the Free Software
22 // Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301
23 // USA
24 // Questions? Contact Michael A. Heroux (maherou@sandia.gov)
25 //
26 // ***********************************************************************
27 // @HEADER
28 
29 #ifndef AMESOS_PARDISO_H
30 #define AMESOS_PARDISO_H
31 
32 #include "Amesos_ConfigDefs.h"
33 #include "Amesos_BaseSolver.h"
34 #include "Amesos_NoCopiable.h"
35 #include "Amesos_Utils.h"
36 #include "Amesos_Time.h"
37 #include "Amesos_Status.h"
38 #include "Amesos_Control.h"
39 #include "Epetra_LinearProblem.h"
40 #include "Epetra_Time.h"
41 #include "Epetra_Map.h"
42 #include "Epetra_Import.h"
43 #include "Epetra_Comm.h"
44 #include "Epetra_RowMatrix.h"
45 #include "Epetra_CrsMatrix.h"
47 #include "Teuchos_RCP.hpp"
48 
50 
58  private Amesos_Time,
59  private Amesos_NoCopiable,
60  private Amesos_Utils,
61  private Amesos_Control,
62  private Amesos_Status {
63 
64 public:
65 
67  Amesos_Pardiso(const Epetra_LinearProblem& LinearProblem );
69 
73 
75 
77  int SymbolicFactorization() ;
78 
80  int NumericFactorization() ;
81 
83  int Solve();
85 
87 
89  const Epetra_LinearProblem* GetProblem() const { return(Problem_); }
90 
92 
95  bool MatrixShapeOK() const;
96 
98 
103 
105  bool UseTranspose() const { return(UseTranspose_); }
106 
108  const Epetra_Comm& Comm() const { return(GetProblem()->GetOperator()->Comm()); }
109 
112 
115 
118 
120  int NumSolve() const { return( Amesos_Status::NumSolve_ ); }
121 
123  void PrintTiming() const;
124 
126  void PrintStatus() const;
127 
129  void GetTiming( Teuchos::ParameterList &TimingParameterList ) const { Amesos_Time::GetTiming(TimingParameterList); }
130 
132 
133 private:
134 
135  int CheckError(const int error) const;
136 
137  inline const Epetra_Map& Map() const
138  {
139  return(Matrix_->RowMatrixRowMap());
140  }
141 
142  inline const Epetra_RowMatrix& Matrix() const
143  {
144  return(*Matrix_);
145  }
146 
148  {
149  return(*(SerialMap_.get()));
150  }
151 
153  {
154  return(*(SerialMatrix_.get()));
155  }
156 
158  {
159  return(*(SerialCrsMatrix_.get()));
160  }
161 
163  {
164  return(*(Importer_.get()));
165  }
166 
167  int ConvertToSerial();
168  int ConvertToPardiso();
171 
176 
177  const Epetra_Map* Map_;
179 
184 
188 
189  // Data for PARDISO
190  std::vector<double> aa_;
191  std::vector<int> ia_;
192  std::vector<int> ja_;
193 
195  int mtype_;
196  void* pt_[64];
197 
198  int iparm_[64];
199  double dparm_[64];
200  int maxfct_; // Maximal number of factors with idential nonzero pattern (always 1)
201  int mnum_;
202  int msglvl_;
203  int nrhs_; // Number of RHS
204 
206 
207 }; // class Amesos_Pardiso
208 #endif
Amesos_Pardiso::ia_
std::vector< int > ia_
Definition: Amesos_Pardiso.h:191
Amesos_Pardiso::SerialMatrix
Epetra_RowMatrix & SerialMatrix()
Definition: Amesos_Pardiso.h:152
Amesos_Pardiso::SolveTime_
int SolveTime_
Definition: Amesos_Pardiso.h:187
Teuchos_ParameterList.hpp
Amesos_Pardiso::SetParameters
int SetParameters(Teuchos::ParameterList &ParameterList)
Set parameters from the input parameters list, returns 0 if successful.
Definition: Amesos_Pardiso.cpp:223
Teuchos_RCP.hpp
Amesos_Pardiso::MatrixShapeOK
bool MatrixShapeOK() const
Returns true if PARDISO can handle this matrix shape.
Definition: Amesos_Pardiso.cpp:360
Amesos_Pardiso::NumFactTime_
int NumFactTime_
Definition: Amesos_Pardiso.h:187
Amesos_Pardiso::dparm_
double dparm_[64]
Definition: Amesos_Pardiso.h:199
Amesos_Pardiso::SerialMap
Epetra_Map & SerialMap()
Definition: Amesos_Pardiso.h:147
Amesos_Pardiso::ConvertToSerial
int ConvertToSerial()
Definition: Amesos_Pardiso.cpp:138
Amesos_Status::NumSolve_
int NumSolve_
Number of solves.
Definition: Amesos_Status.h:71
Amesos_Pardiso::NumericFactorization
int NumericFactorization()
Performs NumericFactorization on the matrix A.
Definition: Amesos_Pardiso.cpp:415
Amesos_Pardiso::PrintTiming
void PrintTiming() const
Prints timing information.
Definition: Amesos_Pardiso.cpp:579
Amesos_NoCopiable.h
Amesos_NoCopiable
Amesos_NoCopiable: Simple class to prevent the usage of copy constructor and operator =.
Definition: Amesos_NoCopiable.h:44
Amesos_Pardiso::Comm
const Epetra_Comm & Comm() const
Returns a pointer to the Epetra_Comm communicator associated with this matrix.
Definition: Amesos_Pardiso.h:108
Amesos_Pardiso::Problem_
const Epetra_LinearProblem * Problem_
Pointer to the linear system problem.
Definition: Amesos_Pardiso.h:183
Amesos_BaseSolver
Amesos_BaseSolver: A pure virtual class for direct solution of real-valued double-precision operators...
Definition: Amesos_BaseSolver.h:223
Epetra_RowMatrix.h
Amesos_Status::NumSymbolicFact_
int NumSymbolicFact_
Number of symbolic factorization phases.
Definition: Amesos_Status.h:67
Amesos_Pardiso::Importer_
Teuchos::RCP< Epetra_Import > Importer_
Definition: Amesos_Pardiso.h:175
Epetra_CrsMatrix.h
Amesos_Pardiso::param_
Teuchos::ParameterList param_
Definition: Amesos_Pardiso.h:205
Amesos_Pardiso::SerialMatrix_
Teuchos::RCP< Epetra_RowMatrix > SerialMatrix_
Definition: Amesos_Pardiso.h:174
Amesos_Time.h
Epetra_Comm
Amesos_Pardiso::UseTranspose
bool UseTranspose() const
Returns the current UseTranspose setting.
Definition: Amesos_Pardiso.h:105
Amesos_Pardiso::iparm_
int iparm_[64]
Definition: Amesos_Pardiso.h:198
Epetra_RowMatrix::RowMatrixRowMap
virtual const Epetra_Map & RowMatrixRowMap() const=0
Epetra_LinearProblem.h
Teuchos::RCP< Epetra_Map >
Epetra_CrsMatrix
Amesos_Pardiso::maxfct_
int maxfct_
Definition: Amesos_Pardiso.h:200
Amesos_Pardiso::CheckError
int CheckError(const int error) const
Definition: Amesos_Pardiso.cpp:628
Amesos_Status::NumNumericFact_
int NumNumericFact_
Number of numeric factorization phases.
Definition: Amesos_Status.h:69
Amesos_Pardiso::nrhs_
int nrhs_
Output level.
Definition: Amesos_Pardiso.h:203
Amesos_Utils
Amesos_Utils: Collections of basic utilities.
Definition: Amesos_Utils.h:19
Epetra_RowMatrix
Amesos_BaseSolver.h
Amesos_Pardiso::pt_
void * pt_[64]
Definition: Amesos_Pardiso.h:196
Amesos_Pardiso::Importer
Epetra_Import & Importer()
Definition: Amesos_Pardiso.h:162
Amesos_Pardiso::SetUseTranspose
int SetUseTranspose(bool UseTranspose)
SetUseTranpose()
Definition: Amesos_Pardiso.h:102
Amesos_Pardiso::SerialCrsMatrix_
Teuchos::RCP< Epetra_CrsMatrix > SerialCrsMatrix_
Definition: Amesos_Pardiso.h:173
Epetra_LinearProblem
Amesos_Pardiso::UseTranspose_
bool UseTranspose_
If true, the transpose of A is used.
Definition: Amesos_Pardiso.h:181
Amesos_Pardiso::Matrix_
const Epetra_RowMatrix * Matrix_
Definition: Amesos_Pardiso.h:178
Amesos_Pardiso::PerformSymbolicFactorization
int PerformSymbolicFactorization()
Definition: Amesos_Pardiso.cpp:256
Amesos_Pardiso::PerformNumericFactorization
int PerformNumericFactorization()
Definition: Amesos_Pardiso.cpp:321
Amesos_Pardiso::GetProblem
const Epetra_LinearProblem * GetProblem() const
Get a pointer to the Problem.
Definition: Amesos_Pardiso.h:89
Epetra_Import.h
Amesos_Pardiso::Amesos_Pardiso
Amesos_Pardiso(const Epetra_LinearProblem &LinearProblem)
Constructor.
Definition: Amesos_Pardiso.cpp:61
Amesos_Control
Amesos_Control: Container for some control variables.
Definition: Amesos_Control.h:16
Amesos_Pardiso::MtxRedistTime_
int MtxRedistTime_
Definition: Amesos_Pardiso.h:186
Amesos_Pardiso::NumSymbolicFact
int NumSymbolicFact() const
Returns the number of symbolic factorizations performed by this object.
Definition: Amesos_Pardiso.h:114
Epetra_Comm.h
Amesos_Pardiso::PrintStatus
void PrintStatus() const
Prints information about the factorization and solution phases.
Definition: Amesos_Pardiso.cpp:545
Amesos_ConfigDefs.h
Amesos_Pardiso::NumSolve
int NumSolve() const
Returns the number of solves performed by this object.
Definition: Amesos_Pardiso.h:120
Amesos_Pardiso::~Amesos_Pardiso
~Amesos_Pardiso()
Destructor.
Definition: Amesos_Pardiso.cpp:111
Amesos_Pardiso::mnum_
int mnum_
Definition: Amesos_Pardiso.h:201
Amesos_Pardiso::SymFactTime_
int SymFactTime_
Definition: Amesos_Pardiso.h:187
Amesos_Utils.h
Amesos_Control.h
Amesos_Time::GetTiming
void GetTiming(Teuchos::ParameterList &list) const
Load up the current timing information into the parameter list.
Definition: Amesos_Time.h:124
Amesos_Pardiso::aa_
std::vector< double > aa_
Definition: Amesos_Pardiso.h:190
Amesos_Pardiso::SymbolicFactorization
int SymbolicFactorization()
Performs SymbolicFactorization on the matrix A.
Definition: Amesos_Pardiso.cpp:373
Amesos_Pardiso::Map_
const Epetra_Map * Map_
Definition: Amesos_Pardiso.h:177
Amesos_Pardiso::MtxConvTime_
int MtxConvTime_
Quick access pointers to the internal timing data.
Definition: Amesos_Pardiso.h:186
Teuchos::RCP::get
T * get() const
Epetra_Map.h
Amesos_Pardiso::GetTiming
void GetTiming(Teuchos::ParameterList &TimingParameterList) const
Extracts timing information from the current solver and places it in the parameter list.
Definition: Amesos_Pardiso.h:129
Amesos_Pardiso::pardiso_initialized_
bool pardiso_initialized_
Definition: Amesos_Pardiso.h:194
Teuchos::ParameterList
Amesos_Pardiso::Solve
int Solve()
Solves A X = B (or AT X = B)
Definition: Amesos_Pardiso.cpp:436
Amesos_Pardiso::Map
const Epetra_Map & Map() const
Definition: Amesos_Pardiso.h:137
Amesos_Time
Amesos_Time: Container for timing information.
Definition: Amesos_Time.h:50
Amesos_Pardiso::Matrix
const Epetra_RowMatrix & Matrix() const
Definition: Amesos_Pardiso.h:142
Amesos_Pardiso::NumNumericFact
int NumNumericFact() const
Returns the number of numeric factorizations performed by this object.
Definition: Amesos_Pardiso.h:117
Amesos_Pardiso::SerialMap_
Teuchos::RCP< Epetra_Map > SerialMap_
Definition: Amesos_Pardiso.h:172
Amesos_Pardiso::ja_
std::vector< int > ja_
Definition: Amesos_Pardiso.h:192
Amesos_Pardiso::msglvl_
int msglvl_
Actual matrix for solution phase (always 1)
Definition: Amesos_Pardiso.h:202
Amesos_Pardiso::mtype_
int mtype_
Definition: Amesos_Pardiso.h:195
Amesos_Pardiso::SerialCrsMatrix
Epetra_CrsMatrix & SerialCrsMatrix()
Definition: Amesos_Pardiso.h:157
Epetra_Map
Amesos_Pardiso::ConvertToPardiso
int ConvertToPardiso()
Definition: Amesos_Pardiso.cpp:173
Epetra_Import
Epetra_Time.h
Amesos_Status
Amesos_Status: Container for some status variables.
Definition: Amesos_Status.h:20
Amesos_Pardiso
Amesos_Pardiso: Interface to the PARDISO package.
Definition: Amesos_Pardiso.h:57
Amesos_Pardiso::VecRedistTime_
int VecRedistTime_
Definition: Amesos_Pardiso.h:186
Amesos_Status.h