IFPACK  Development
Ifpack_AMDReordering.h
1 /*@HEADER
2 // ***********************************************************************
3 //
4 // Ifpack: Object-Oriented Algebraic Preconditioner Package
5 // Copyright (2002) 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 Michael A. Heroux (maherou@sandia.gov)
38 //
39 // ***********************************************************************
40 //@HEADER
41 */
42 
43 #ifndef IFPACK_AMDREORDERING_H
44 #define IFPACK_AMDREORDERING_H
45 
46 #include "Ifpack_ConfigDefs.h"
47 #include "Ifpack_Reordering.h"
48 
49 namespace Teuchos {
50  class ParameterList;
51 }
52 class Ifpack_Graph;
53 class Epetra_MultiVector;
54 class Epetra_RowMatrix;
55 
57 
59 
60 public:
61 
64 
67 
70 
72  virtual ~Ifpack_AMDReordering() {};
73 
75  int SetParameter(const std::string Name, const int Value);
76 
78  int SetParameter(const std::string Name, const double Value);
79 
81  int SetParameters(Teuchos::ParameterList& List);
82 
84  int Compute(const Ifpack_Graph& Graph);
85 
87  int Compute(const Epetra_RowMatrix& Matrix);
88 
90  bool IsComputed() const
91  {
92  return(IsComputed_);
93  }
94 
96  inline int Reorder(const int i) const;
97 
99  inline int InvReorder(const int i) const;
100 
102  int P(const Epetra_MultiVector& Xorig,
103  Epetra_MultiVector& Xreord) const;
104 
106  int Pinv(const Epetra_MultiVector& Xorig,
107  Epetra_MultiVector& Xinvreord) const;
108 
109 
111  std::ostream& Print(std::ostream& os) const;
112 
114  int NumMyRows() const
115  {
116  return(NumMyRows_);
117  }
118 
119 private:
121  int NumMyRows_;
123  bool IsComputed_;
125  std::vector<int> Reorder_;
127  std::vector<int> InvReorder_;
128 };
129 
130 #endif
std::ostream & Print(std::ostream &os) const
Prints basic information on iostream. This function is used by operator<<.
int InvReorder(const int i) const
Returns the inverse reordered index of row i.
Ifpack_AMDReordering()
Constructor for Ifpack_Graph&#39;s.
int SetParameters(Teuchos::ParameterList &List)
Sets all parameters.
Ifpack_AMDReordering: approximate minimum degree reordering.
int Pinv(const Epetra_MultiVector &Xorig, Epetra_MultiVector &Xinvreord) const
Applies inverse reordering to multivector X, whose local length equals the number of local rows...
Ifpack_AMDReordering & operator=(const Ifpack_AMDReordering &RHS)
Assignment operator.
int NumMyRows() const
Returns the number of local rows.
int Compute(const Ifpack_Graph &Graph)
Computes all it is necessary to initialize the reordering object.
int SetParameter(const std::string Name, const int Value)
Sets integer parameters ‘Name’.
Ifpack_Reordering: basic class for reordering for a Ifpack_Graph object.
bool IsComputed() const
Returns true is the reordering object has been successfully initialized, false otherwise.
virtual ~Ifpack_AMDReordering()
Destructor.
int Reorder(const int i) const
Returns the reordered index of row i.
Ifpack_Graph: a pure virtual class that defines graphs for IFPACK.
Definition: Ifpack_Graph.h:61
int P(const Epetra_MultiVector &Xorig, Epetra_MultiVector &Xreord) const
Applies reordering to multivector X, whose local length equals the number of local rows...