EpetraExt: EpetraExt_BlockUtility.h Source File

Go to the documentation of this file.
00001 //@HEADER
00002 // ***********************************************************************
00003 //
00004 //     EpetraExt: Epetra Extended - Linear Algebra Services Package
00005 //                 Copyright (2011) Sandia Corporation
00006 //
00007 // Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
00008 // the U.S. Government retains certain rights in this software.
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 // Questions? Contact Michael A. Heroux (maherou@sandia.gov)
00038 //
00039 // ***********************************************************************
00040 //@HEADER
00041 
00042 #ifndef EPETRAEXT_BLOCKUTILITY_H
00043 #define EPETRAEXT_BLOCKUTILITY_H
00044 
00045 #include <vector>
00046 
00047 #include <Epetra_ConfigDefs.h>
00048 #include <Epetra_CrsGraph.h>
00049 #include <Epetra_RowMatrix.h>
00050 
00052 
00053 namespace EpetraExt {
00054 
00055 class BlockUtility {
00056  public:
00057 
00065 #ifndef EPETRA_NO_32BIT_GLOBAL_INDICES
00066   static Epetra_Map * GenerateBlockMap( const Epetra_BlockMap & BaseMap, const int*  RowIndices, int num_indices, const Epetra_Comm & GlobalComm, int Offset = 0 );
00067 #endif
00068 #ifndef EPETRA_NO_64BIT_GLOBAL_INDICES
00069   static Epetra_Map * GenerateBlockMap( const Epetra_BlockMap & BaseMap, const long long*  RowIndices, int num_indices, const Epetra_Comm & GlobalComm, long long Offset = 0 );
00070 #endif
00071 
00079 #ifndef EPETRA_NO_32BIT_GLOBAL_INDICES
00080   static Epetra_Map * GenerateBlockMap( const Epetra_BlockMap & BaseMap, const std::vector<int> & RowIndices, const Epetra_Comm & GlobalComm, int Offset = 0 );
00081 #endif
00082 #ifndef EPETRA_NO_64BIT_GLOBAL_INDICES
00083   static Epetra_Map * GenerateBlockMap( const Epetra_BlockMap & BaseMap, const std::vector<long long> & RowIndices, const Epetra_Comm & GlobalComm, long long Offset = 0 );
00084 #endif
00085 
00093   static Epetra_Map * GenerateBlockMap( const Epetra_BlockMap & BaseMap, const Epetra_BlockMap& BlockMap, const Epetra_Comm & GlobalComm, int Offset = 0 );
00094 
00096 
00105 #ifndef EPETRA_NO_32BIT_GLOBAL_INDICES
00106   static Epetra_CrsGraph * GenerateBlockGraph( const Epetra_CrsGraph & BaseGraph, const std::vector< std::vector<int> > & RowStencil, const std::vector<int> & RowIndices, const Epetra_Comm & GlobalComm );
00107 #endif
00108 #ifndef EPETRA_NO_64BIT_GLOBAL_INDICES
00109   static Epetra_CrsGraph * GenerateBlockGraph( const Epetra_CrsGraph & BaseGraph, const std::vector< std::vector<long long> > & RowStencil, const std::vector<long long> & RowIndices, const Epetra_Comm & GlobalComm );
00110 #endif
00111 
00112   // Nearly identical version yet using RowMatrix interface instead of CrsGraph
00113 #ifndef EPETRA_NO_32BIT_GLOBAL_INDICES
00114   static Epetra_CrsGraph * GenerateBlockGraph( const Epetra_RowMatrix & BaseMatrix, const std::vector< std::vector<int> > & RowStencil, const std::vector<int> & RowIndices, const Epetra_Comm & GlobalComm );
00115 #endif
00116 
00117 #ifndef EPETRA_NO_64BIT_GLOBAL_INDICES
00118   static Epetra_CrsGraph * GenerateBlockGraph( const Epetra_RowMatrix & BaseMatrix, const std::vector< std::vector<long long> > & RowStencil, const std::vector<long long> & RowIndices, const Epetra_Comm & GlobalComm );
00119 #endif
00120 
00122   static Epetra_CrsGraph * GenerateBlockGraph( const Epetra_CrsGraph & BaseGraph, const Epetra_CrsGraph& LocalBlockGraph, const Epetra_Comm & GlobalComm );
00123 
00125 #ifndef EPETRA_NO_32BIT_GLOBAL_INDICES
00126   static void GenerateRowStencil(const Epetra_CrsGraph& LocalBlockGraph, std::vector<int> RowIndices, std::vector< std::vector<int> >& RowStencil);
00127 #endif
00128 #ifndef EPETRA_NO_64BIT_GLOBAL_INDICES
00129   static void GenerateRowStencil(const Epetra_CrsGraph& LocalBlockGraph, std::vector<long long> RowIndices, std::vector< std::vector<long long> >& RowStencil);
00130 #endif
00131 
00133 #ifndef EPETRA_NO_32BIT_GLOBAL_INDICES
00134   static int CalculateOffset(const Epetra_BlockMap & BaseMap);
00135 #endif
00136 
00137   static long long CalculateOffset64(const Epetra_BlockMap & BaseMap);
00138 
00139 private:
00140 
00141   template<typename int_type>
00142   static int_type TCalculateOffset(const Epetra_BlockMap & BaseMap);
00143 
00144   template<typename int_type>
00145   static Epetra_Map * TGenerateBlockMap( const Epetra_BlockMap & BaseMap, const int_type*  RowIndices, int num_indices, const Epetra_Comm & GlobalComm, int_type Offset = 0);
00146 
00147   template<typename int_type>
00148   static Epetra_CrsGraph * TGenerateBlockGraph( const Epetra_CrsGraph & BaseGraph, const std::vector< std::vector<int_type> > & RowStencil, const std::vector<int_type> & RowIndices, const Epetra_Comm & GlobalComm );
00149 
00150   template<typename int_type>
00151   static Epetra_CrsGraph * TGenerateBlockGraph( const Epetra_RowMatrix & BaseMatrix, const std::vector< std::vector<int_type> > & RowStencil, const std::vector<int_type> & RowIndices, const Epetra_Comm & GlobalComm );
00152 
00153   template<typename int_type>
00154   static Epetra_CrsGraph * TGenerateBlockGraph( const Epetra_CrsGraph & BaseGraph, const Epetra_CrsGraph& LocalBlockGraph, const Epetra_Comm & GlobalComm );
00155 
00156   template<typename int_type>
00157   static void TGenerateRowStencil(const Epetra_CrsGraph& LocalBlockGraph, std::vector<int_type> RowIndices, std::vector< std::vector<int_type> >& RowStencil);
00158 };
00159 
00160 } //namespace EpetraExt
00161 
00162 #endif /* EPETRA_CRSMATRIX_H */