Epetra Package Browser (Single Doxygen Collection)  Development
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Epetra_RowMatrixTransposer.h
Go to the documentation of this file.
1 /*
2 //@HEADER
3 // ************************************************************************
4 //
5 // Epetra: Linear Algebra Services Package
6 // Copyright 2011 Sandia Corporation
7 //
8 // Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
9 // the U.S. Government retains certain rights in this software.
10 //
11 // Redistribution and use in source and binary forms, with or without
12 // modification, are permitted provided that the following conditions are
13 // met:
14 //
15 // 1. Redistributions of source code must retain the above copyright
16 // notice, this list of conditions and the following disclaimer.
17 //
18 // 2. Redistributions in binary form must reproduce the above copyright
19 // notice, this list of conditions and the following disclaimer in the
20 // documentation and/or other materials provided with the distribution.
21 //
22 // 3. Neither the name of the Corporation nor the names of the
23 // contributors may be used to endorse or promote products derived from
24 // this software without specific prior written permission.
25 //
26 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
27 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
29 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
30 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
31 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
32 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
33 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
34 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
35 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
36 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37 //
38 // Questions? Contact Michael A. Heroux (maherou@sandia.gov)
39 //
40 // ************************************************************************
41 //@HEADER
42 */
43 
44 #ifndef EPETRA_ROWMATRIXTRANSPOSER_H
45 #define EPETRA_ROWMATRIXTRANSPOSER_H
46 
47 #if defined(Epetra_SHOW_DEPRECATED_WARNINGS)
48 #ifdef __GNUC__
49 #warning "The Epetra package is deprecated"
50 #endif
51 #endif
52 
53 
54 #include <Epetra_Object.h>
55 class Epetra_RowMatrix;
56 class Epetra_CrsMatrix;
57 class Epetra_Map;
58 class Epetra_Export;
59 
61 
66 class EPETRA_LIB_DLL_EXPORT Epetra_RowMatrixTransposer {
67 
68  public:
69 
71 
72 
81 
83 
85 
87 
88  virtual ~Epetra_RowMatrixTransposer();
90 
92 
93 
95 
108  int CreateTranspose(const bool MakeDataContiguous,
109  Epetra_CrsMatrix *& TransposeMatrix,
110  Epetra_Map * TransposeRowMap = 0);
111 
112 
114 
125  int UpdateTransposeValues(Epetra_RowMatrix * MatrixWithNewValues);
127 
129 
130  int UpdateOriginalMatrixValues();
133 
135 
136 
138 
142  const Epetra_Map & TransposeRowMap() const {return(*TransposeRowMap_);};
144 
148  const Epetra_Export & TransposeExporter() const{return(*TransposeExporter_);};
150 
151  private:
152  void DeleteData();
154 
164  int * Indices_;
165  double * Values_;
166  int * TransNumNz_;
167  int ** TransIndices_; // FIXME long long
168  double ** TransValues_;
171 
172 };
173 
174 #endif /* EPETRA_ROWMATRIXTRANSPOSER_H */
Epetra_Map: A class for partitioning vectors and matrices.
Definition: Epetra_Map.h:127
const Epetra_Export & TransposeExporter() const
Returns const reference to the Epetra_Export object used to redistribute the original matrix...
const Epetra_Map & TransposeRowMap() const
Returns const reference to the Epetra_Map object describing the row distribution of the transpose mat...
Epetra_Export: This class builds an export object for efficient exporting of off-processor elements...
Definition: Epetra_Export.h:70
Epetra_RowMatrixTransposer: A class for transposing an Epetra_RowMatrix object.
Epetra_CrsMatrix: A class for constructing and using real-valued double-precision sparse compressed r...
Epetra_RowMatrix: A pure virtual class for using real-valued double-precision row matrices...