Isorropia: Partitioning, Load Balancing and more
Isorropia_EpetraColorer.hpp
Go to the documentation of this file.
00001 //@HEADER
00002 //************************************************************************
00003 //
00004 //              Isorropia: Partitioning and Load Balancing Package
00005 //                Copyright (2006) Sandia Corporation
00006 //
00007 //Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
00008 //license for use of this work by or on behalf of the U.S. Government.
00009 //
00010 // Redistribution and use in source and binary forms, with or without
00011 // modification, are permitted provided that the following conditions are
00012 // met:
00013 //
00014 // 1. Redistributions of source code must retain the above copyright
00015 // notice, this list of conditions and the following disclaimer.
00016 //
00017 // 2. Redistributions in binary form must reproduce the above copyright
00018 // notice, this list of conditions and the following disclaimer in the
00019 // documentation and/or other materials provided with the distribution.
00020 //
00021 // 3. Neither the name of the Corporation nor the names of the
00022 // contributors may be used to endorse or promote products derived from
00023 // this software without specific prior written permission.
00024 //
00025 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
00026 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00027 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00028 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
00029 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00030 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00031 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00032 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00033 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00034 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00035 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00036 //
00037 //************************************************************************
00038 //@HEADER
00039 
00040 #ifndef _Isorropia_EpetraColorer_hpp_
00041 #define _Isorropia_EpetraColorer_hpp_
00042 
00043 #include <Isorropia_ConfigDefs.hpp>
00044 #include <Teuchos_RCP.hpp>
00045 #include <Teuchos_ParameterList.hpp>
00046 
00047 #include <Isorropia_EpetraCostDescriber.hpp>
00048 #include <Isorropia_EpetraOperator.hpp>
00049 #include <Isorropia_Colorer.hpp>
00050 
00051 #ifdef HAVE_EPETRAEXT
00052 #include <Epetra_MapColoring.h>
00053 #endif /* HAVE_EPETRAEXT */
00054 
00055 #ifdef HAVE_EPETRA
00056 class Epetra_Map;
00057 class Epetra_BlockMap;
00058 class Epetra_Import;
00059 class Epetra_Vector;
00060 class Epetra_MultiVector;
00061 class Epetra_CrsGraph;
00062 class Epetra_CrsMatrix;
00063 class Epetra_RowMatrix;
00064 class Epetra_LinearProblem;
00065 
00066 namespace Isorropia {
00067 
00068 namespace Epetra {
00069 
00076 class Colorer : public Isorropia::Colorer, public Isorropia::Epetra::Operator {
00077 public:
00078 
00088   Colorer(Teuchos::RCP<const Epetra_CrsGraph> input_graph,
00089     const Teuchos::ParameterList& paramlist=Teuchos::ParameterList("EmptyParameterList"),
00090     bool compute_now=true);
00091 
00101   Colorer(const Epetra_CrsGraph * input_graph,
00102     const Teuchos::ParameterList& paramlist=Teuchos::ParameterList("EmptyParameterList"),
00103     bool compute_now=true);
00104 
00114   Colorer(Teuchos::RCP<const Epetra_RowMatrix> input_matrix,
00115     const Teuchos::ParameterList& paramlist=Teuchos::ParameterList("EmptyParameterList"),
00116     bool compute_now=true);
00117 
00118 
00128   Colorer(const Epetra_RowMatrix * input_matrix,
00129     const Teuchos::ParameterList& paramlist=Teuchos::ParameterList("EmptyParameterList"),
00130     bool compute_now=true);
00131 
00132 
00134   ~Colorer() {} ;
00135 
00144   void color(bool force_coloring=false);
00145 
00154   void compute(bool force_compute=false) {
00155     color(force_compute);
00156   }
00157 
00158 #ifdef HAVE_EPETRAEXT
00159 
00166   __deprecated Teuchos::RCP<Epetra_MapColoring> generateMapColoring() {
00167     return generateRowMapColoring();
00168   }
00169 
00170 
00178   Teuchos::RCP<Epetra_MapColoring> generateRowMapColoring() ;
00179 
00187   Teuchos::RCP<Epetra_MapColoring> generateColMapColoring() ;
00188 
00189 private:
00190   Teuchos::RCP<const Epetra_BlockMap> colmap_;
00191 
00192 #endif /* HAVE_EPETRAEXT */
00193 
00194 };//class Colorer
00195 
00196 }//namespace Epetra
00197 }//namespace Isorropia
00198 
00199 #endif //HAVE_EPETRA
00200 
00201 #endif
00202