Isorropia: Partitioning, Load Balancing and more
Isorropia_EpetraOrderer.hpp
Go to the documentation of this file.
1 //@HEADER
2 //************************************************************************
3 //
4 // Isorropia: Partitioning and Load Balancing Package
5 // Copyright (2006) 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 //************************************************************************
38 //@HEADER
39 
40 #ifndef _Isorropia_EpetraOrderer_hpp_
41 #define _Isorropia_EpetraOrderer_hpp_
42 
43 #include <Isorropia_ConfigDefs.hpp>
44 #include <Teuchos_RCP.hpp>
45 #include <Teuchos_ParameterList.hpp>
46 
49 #include <Isorropia_Orderer.hpp>
50 
51 
52 #ifdef HAVE_EPETRA
53 class Epetra_Map;
54 class Epetra_BlockMap;
55 class Epetra_Import;
56 class Epetra_Vector;
57 class Epetra_MultiVector;
58 class Epetra_CrsGraph;
59 class Epetra_CrsMatrix;
60 class Epetra_RowMatrix;
61 class Epetra_LinearProblem;
62 
63 namespace Isorropia {
64 
65 namespace Epetra {
66 
73 public:
74 
75  Orderer(Teuchos::RCP<const Epetra_CrsGraph> input_graph,
76  const Teuchos::ParameterList& paramlist=Teuchos::ParameterList("EmptyParameterList"),
77  bool compute_now=true);
78 
79  Orderer(const Epetra_CrsGraph *input_graph,
80  const Teuchos::ParameterList& paramlist=Teuchos::ParameterList("EmptyParameterList"),
81  bool compute_now=true);
82 
83  Orderer(Teuchos::RCP<const Epetra_RowMatrix> input_matrix,
84  const Teuchos::ParameterList& paramlist=Teuchos::ParameterList("EmptyParameterList"),
85  bool compute_now=true);
86 
87  Orderer(const Epetra_RowMatrix * input_matrix,
88  const Teuchos::ParameterList& paramlist=Teuchos::ParameterList("EmptyParameterList"),
89  bool compute_now=true);
90 
92  ~Orderer() {} ;
93 
100  void order(bool force_ordering=false);
101 
102 
103  void compute(bool forceOrdering=false) {
104  return (order(forceOrdering));
105  }
106 
107 };//class Orderer
108 
109 }//namespace Epetra
110 }//namespace Isorropia
111 
112 #endif //HAVE_EPETRA
113 
114 #endif
115 
116 
117 #if defined(Isorropia_SHOW_DEPRECATED_WARNINGS)
118 #ifdef __GNUC__
119 #warning "The Isorropia package is deprecated"
120 #endif
121 #endif
122 
void order(bool force_ordering=false)
Method which does the work of computing a new ordering.
An implementation of the Partitioner interface that operates on Epetra matrices and linear systems...
Definition: Isorropia_EpetraOperator.hpp:72
~Orderer()
Destructor.
Definition: Isorropia_EpetraOrderer.hpp:92
Interface (abstract base class) for computing a new ordering and describing the layout of elements in...
Definition: Isorropia_Orderer.hpp:59
An implementation of the Orderer interface that operates on Epetra matrices and linear systems...
Definition: Isorropia_EpetraOrderer.hpp:72
Orderer(Teuchos::RCP< const Epetra_CrsGraph > input_graph, const Teuchos::ParameterList &paramlist=Teuchos::ParameterList("EmptyParameterList"), bool compute_now=true)
void compute(bool forceOrdering=false)
Method which does the work of computing a new partitioning/coloring/ordering, depending on the child ...
Definition: Isorropia_EpetraOrderer.hpp:103