EpetraExt Package Browser (Single Doxygen Collection)  Development
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
EpetraExt_PETScAIJMatrix.h
Go to the documentation of this file.
1 //@HEADER
2 // ***********************************************************************
3 //
4 // EpetraExt: Epetra Extended - Linear Algebra Services Package
5 // Copyright (2011) Sandia Corporation
6 //
7 // Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
8 // the U.S. Government retains certain rights in this software.
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 Michael A. Heroux (maherou@sandia.gov)
38 //
39 // ***********************************************************************
40 //@HEADER
41 
42 /*#############################################################################
43 # CVS File Information
44 # Current revision: $Revision$
45 # Last modified: $Date$
46 # Modified by: $Author$
47 #############################################################################*/
48 
49 #ifndef _EPETRAEXT_PETSCAIJMATRIX_H_
50 #define _EPETRAEXT_PETSCAIJMATRIX_H_
51 
52 #if defined(EpetraExt_SHOW_DEPRECATED_WARNINGS)
53 #ifdef __GNUC__
54 #warning "The EpetraExt package is deprecated"
55 #endif
56 #endif
57 
58 #include "Epetra_Object.h"
59 #include "Epetra_CompObject.h"
60 #include "Epetra_RowMatrix.h"
61 #include "Epetra_Map.h"
62 #ifdef HAVE_MPI
63 #include "Epetra_MpiComm.h"
64 #else
65 #include "Epetra_SerialComm.h"
66 #endif
67 //Petsc headers.
68 //Note: Petsc internally hard-codes paths to headers, relative to the PETSC home
69 // directory. This means that --with-incdirs must contain the full path(s)
70 // to the header below plus the PETSc home directory.
71 #include "src/mat/impls/aij/mpi/mpiaij.h"
72 
73 class Epetra_Import;
74 class Epetra_Export;
75 class Epetra_Vector;
76 class Epetra_MultiVector;
77 
79 
88 
89  public:
90 
92 
93 
100 
102  virtual ~Epetra_PETScAIJMatrix();
104 
106 
107 
109 
123  int ExtractMyRowCopy(int MyRow, int Length, int & NumEntries, double *Values, int * Indices) const;
124 
126 
132  int ExtractDiagonalCopy(Epetra_Vector & Diagonal) const;
134 
136 
137 
139 
149  int Multiply(bool TransA, const Epetra_MultiVector& X, Epetra_MultiVector& Y) const;
150 
152 
166  int Solve(bool Upper, bool Trans, bool UnitDiagonal, const Epetra_MultiVector& X, Epetra_MultiVector& Y) const;
167 
169 
179  int InvRowSums(Epetra_Vector& x) const;
180 
182 
189  int LeftScale(const Epetra_Vector& x);
190 
192 
202  int InvColSums(Epetra_Vector& x) const;
203 
205 
212  int RightScale(const Epetra_Vector& x);
214 
216 
217 
218 
220  bool Filled() const {return(true);};
221 
223  bool LowerTriangular() const {return(false);};
224 
226  bool UpperTriangular() const {return(false);};
227 
229 
231 
232 
234  Mat Amat() const {return(Amat_);};
235 
237  /* Returns the quantity \f$ \| A \|_\infty\f$ such that
238  \f[\| A \|_\infty = \max_{1\lei\lem} \sum_{j=1}^n |a_{ij}| \f].
239  */
240  double NormInf() const;
241 
243  /* Returns the quantity \f$ \| A \|_1\f$ such that
244  \f[\| A \|_1= \max_{1\lej\len} \sum_{i=1}^m |a_{ij}| \f].
245  */
246  double NormOne() const;
247 
248 #ifndef EPETRA_NO_32BIT_GLOBAL_INDICES
249  int NumGlobalNonzeros() const {return(NumGlobalNonzeros_);};
251 
253  int NumGlobalRows() const {return(OperatorRangeMap().NumGlobalPoints());};
254 
256  int NumGlobalCols() const {return(OperatorDomainMap().NumGlobalPoints());};
257 
259  int NumGlobalDiagonals() const{return(OperatorDomainMap().NumGlobalPoints());};
260 #endif
261  long long NumGlobalNonzeros64() const {return(NumGlobalNonzeros_);};
263 
265  long long NumGlobalRows64() const {return(OperatorRangeMap().NumGlobalPoints64());};
266 
268  long long NumGlobalCols64() const {return(OperatorDomainMap().NumGlobalPoints64());};
269 
271  long long NumGlobalDiagonals64() const{return(OperatorDomainMap().NumGlobalPoints64());};
272 
274  int NumMyNonzeros() const {return(NumMyNonzeros_);};
275 
277  int NumMyRows() const {return(OperatorRangeMap().NumMyPoints());};
278 
280  int NumMyCols() const {return(RowMatrixColMap().NumMyPoints());};
281 
283  int NumMyDiagonals() const {return(OperatorRangeMap().NumMyPoints());};
284 
286  const Epetra_Map & OperatorDomainMap() const {return(*DomainMap_);};
287 
289  const Epetra_Map & OperatorRangeMap() const {return(*DomainMap_);};
290 
292  const Epetra_BlockMap& Map() const {return(RowMatrixRowMap());}
293 
295  const Epetra_Map & RowMatrixRowMap() const {return(OperatorRangeMap());};
296 
298  const Epetra_Map & RowMatrixColMap() const {return(*ColMap_);};
299 
301  virtual const Epetra_Import * RowMatrixImporter() const {return(Importer_);};
302 
304  const Epetra_Comm & Comm() const {return(*Comm_);};
306 
307 
309 
310 
312  virtual void Print(std::ostream & os) const;
314 
316 
317 
319  const char * Label() const {return(Epetra_Object::Label());};
320 
322 
332  {(void)UseTranspose; return(-1);}
333 
335 
343  int Apply(const Epetra_MultiVector& X, Epetra_MultiVector& Y) const {
345 
347 
361  Epetra_MultiVector& Y) const
362  {(void)X; (void)Y; return(-1);}
363 
365  virtual bool HasNormInf() const {return(true);}
366 
368  virtual bool UseTranspose() const {return(false);}
369 
371 
373 
375 
384  int NumMyRowEntries(int MyRow, int & NumEntries) const;
385 
387  int MaxNumEntries() const;
389 
390  private:
391 
392  int GetRow(int Row) const;
393  Mat Amat_; //general PETSc matrix type
394  mutable double * Values_;
395  mutable int * Indices_;
396  mutable int MaxNumEntries_;
397 
398 #ifdef HAVE_MPI
400 #else
402 #endif
407 
416  MatType MatType_; //really const char*
417  mutable double NormInf_;
418  mutable double NormOne_;
419 
420 
422  //FIXME we need a copy ctor
423  //Epetra_PETScAIJMatrix(const Epetra_PETScAIJMatrix & Matrix) {(void)Matrix;}
424 };
425 #endif /* _EPETRAEXT_PETSCAIJMATRIX_H_ */
int ExtractDiagonalCopy(Epetra_Vector &Diagonal) const
Returns a copy of the main diagonal in a user-provided vector.
int NumMyRowEntries(int MyRow, int &NumEntries) const
Return the current number of values stored for the specified local row.
int NumMyNonzeros() const
Returns the number of nonzero entries in the calling processor's portion of the matrix.
Epetra_PETScAIJMatrix(Mat Amat)
Epetra_PETScAIJMatrix constructor.
const int MatType
virtual const Epetra_Import * RowMatrixImporter() const
Returns the Epetra_Import object that contains the import operations for distributed operations...
const Epetra_Map & OperatorDomainMap() const
Returns the Epetra_Map object associated with the domain of this operator.
const Epetra_BlockMap & Map() const
Implement the Epetra_SrcDistObjec::Map() function.
long long NumGlobalDiagonals64() const
Returns the number of global nonzero diagonal entries.
int ExtractMyRowCopy(int MyRow, int Length, int &NumEntries, double *Values, int *Indices) const
Returns a copy of the specified local row in user-provided arrays.
int InvRowSums(Epetra_Vector &x) const
Computes the sum of absolute values of the rows of the Epetra_PETScAIJMatrix, results returned in x...
int RightScale(const Epetra_Vector &x)
Scales the Epetra_PETScAIJMatrix on the right with a Epetra_Vector x.
virtual ~Epetra_PETScAIJMatrix()
Epetra_PETScAIJMatrix Destructor.
double NormOne() const
Returns the one norm of the global matrix.
Epetra_MultiVector * ImportVector_
const char * Label() const
Returns a character string describing the operator.
int SetUseTranspose(bool UseTranspose)
If set true, transpose of this operator will be applied.
int NumGlobalRows() const
Returns the number of global matrix rows.
int LeftScale(const Epetra_Vector &x)
Scales the Epetra_PETScAIJMatrix on the left with a Epetra_Vector x.
int NumGlobalDiagonals() const
Returns the number of global nonzero diagonal entries.
int ApplyInverse(const Epetra_MultiVector &X, Epetra_MultiVector &Y) const
Returns the result of a Epetra_Operator inverse applied to an Epetra_MultiVector X in Y...
bool Filled() const
If FillComplete() has been called, this query returns true, otherwise it returns false.
virtual void Print(std::ostream &os) const
Print method.
int NumGlobalCols() const
Returns the number of global matrix columns.
int NumMyCols() const
Returns the number of matrix columns owned by the calling processor.
int NumMyDiagonals() const
Returns the number of local nonzero diagonal entries.
int InvColSums(Epetra_Vector &x) const
Computes the sum of absolute values of the columns of the Epetra_PETScAIJMatrix, results returned in ...
int NumGlobalNonzeros() const
Returns the number of nonzero entries in the global matrix.
long long NumGlobalNonzeros64() const
Returns the number of nonzero entries in the global matrix.
const Epetra_Comm & Comm() const
Returns a pointer to the Epetra_Comm communicator associated with this matrix.
int Solve(bool Upper, bool Trans, bool UnitDiagonal, const Epetra_MultiVector &X, Epetra_MultiVector &Y) const
Returns the result of a Epetra_PETScAIJMatrix multiplied by a Epetra_MultiVector X in Y...
Mat Amat() const
Returns a pointer to the PETSc matrix used to create this object.
const Epetra_Map & RowMatrixRowMap() const
Returns the Row Map object needed for implementing Epetra_RowMatrix.
bool LowerTriangular() const
If matrix is lower triangular, this query returns true, otherwise it returns false.
const Epetra_Map & RowMatrixColMap() const
Returns the Column Map object needed for implementing Epetra_RowMatrix.
const Epetra_Map & OperatorRangeMap() const
Returns the Epetra_Map object associated with the range of this operator (same as domain)...
int GetRow(int Row) const
int MaxNumEntries() const
Returns the maximum of NumMyRowEntries() over all rows.
Epetra_PETScAIJMatrix: A class for constructing and using real-valued sparse compressed row matrices...
virtual bool UseTranspose() const
Returns the current UseTranspose setting.
int Multiply(bool TransA, const Epetra_MultiVector &X, Epetra_MultiVector &Y) const
Returns the result of a Epetra_PETScAIJMatrix multiplied by a Epetra_MultiVector X in Y...
long long NumGlobalRows64() const
Returns the number of global matrix rows.
int Apply(const Epetra_MultiVector &X, Epetra_MultiVector &Y) const
Returns the result of a Epetra_Operator applied to a Epetra_MultiVector X in Y.
virtual bool HasNormInf() const
Returns true because this class can compute an Inf-norm.
double NormInf() const
Returns the infinity norm of the global matrix.
bool UpperTriangular() const
If matrix is upper triangular, this query returns true, otherwise it returns false.
long long NumGlobalCols64() const
Returns the number of global matrix columns.
int NumMyRows() const
Returns the number of matrix rows owned by the calling processor.