Epetra_MapColoring.h

Go to the documentation of this file.

/*
//@HEADER
// ************************************************************************
//
//               Epetra: Linear Algebra Services Package
//                 Copyright 2011 Sandia Corporation
//
// Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
// the U.S. Government retains certain rights in this software.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// 3. Neither the name of the Corporation nor the names of the
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Questions? Contact Michael A. Heroux (maherou@sandia.gov)
//
// ************************************************************************
//@HEADER
*/

#ifndef EPETRA_MAPCOLORING_H
#define EPETRA_MAPCOLORING_H

#include "Epetra_ConfigDefs.h"
#include "Epetra_DistObject.h"
#include "Epetra_BlockMap.h"
#include "Epetra_Distributor.h"

template<typename value_type> class Epetra_HashTable;
class Epetra_Map;


class EPETRA_LIB_DLL_EXPORT Epetra_MapColoring: public Epetra_DistObject {

  public:



  Epetra_MapColoring(const Epetra_BlockMap& Map, const int DefaultColor = 0);


  Epetra_MapColoring(const Epetra_BlockMap& Map, int * ElementColors, const int DefaultColor = 0);


  Epetra_MapColoring(const Epetra_MapColoring& Source);


  virtual ~Epetra_MapColoring();




  int& operator [] (int LID) {ListsAreValid_ = false; return ElementColors_[LID];};


  int& operator () (long long GID) {ListsAreValid_ = false; return ElementColors_[Map().LID(GID)];};



  const int& operator [] (int LID) const { return ElementColors_[LID];};


  const int& operator () (long long GID) const {return ElementColors_[Map().LID(GID)];};


  int NumColors() const {if (!ListsAreValid_) GenerateLists(); return(NumColors_);};

  int MaxNumColors() const;


  int * ListOfColors() const {if (!ListsAreValid_) GenerateLists(); return(ListOfColors_);};

  int DefaultColor() const {return(DefaultColor_);};

  int NumElementsWithColor(int Color) const;


  int * ColorLIDList(int Color) const;


  int * ElementColors() const{if (!ListsAreValid_) GenerateLists(); return(ElementColors_);};



  Epetra_Map * GenerateMap(int Color) const;


  Epetra_BlockMap * GenerateBlockMap(int Color) const;



  virtual void Print(std::ostream & os) const;

 private:
  int Allocate(int * ElementColors, int Increment);
  int GenerateLists() const;
  int DeleteLists() const;
  bool InItemList(int ColorValue) const;

   // Routines to implement Epetra_DistObject virtual methods

  int CheckSizes(const Epetra_SrcDistObject& A);
  int CopyAndPermute(const Epetra_SrcDistObject & Source,
                     int NumSameIDs,
                     int NumPermuteIDs,
                     int * PermuteToLIDs,
                     int * PermuteFromLIDs,
                     const Epetra_OffsetIndex * Indexor,
                     Epetra_CombineMode CombineMode = Zero);

  int PackAndPrepare(const Epetra_SrcDistObject & Source,
                     int NumExportIDs,
                     int * ExportLIDs,
                     int & LenExports,
                     char * & Exports,
                     int & SizeOfPacket,
                     int * Sizes,
                     bool & VarSizes,
                     Epetra_Distributor & Distor);

  int UnpackAndCombine(const Epetra_SrcDistObject & Source,
           int NumImportIDs,
                       int * ImportLIDs,
                       int LenImports,
           char * Imports,
                       int & SizeOfPacket,
           Epetra_Distributor & Distor,
                       Epetra_CombineMode CombineMode,
                       const Epetra_OffsetIndex * Indexor );


  struct ListItem {
    int ItemValue;
    ListItem * NextItem;

    ListItem( const int itemValue = 0, ListItem * nextItem = 0)
      : ItemValue(itemValue), NextItem(nextItem){}

    // Constructors commented out due to Intel v.7.1 compiler error (4/2005).
    //ListItem(const Epetra_MapColoring::ListItem & Item); // Make these inaccessible
    //ListItem & operator=(const Epetra_MapColoring::ListItem & Item);
  };

  int DefaultColor_;
  mutable Epetra_HashTable<int> * ColorIDs_;
  mutable ListItem * FirstColor_;
  mutable int NumColors_;
  mutable int * ListOfColors_;
  mutable int * ColorCount_;
  mutable int * ElementColors_;
  mutable int ** ColorLists_;
  bool Allocated_;
  mutable bool ListsAreGenerated_;
  mutable bool ListsAreValid_;

  Epetra_MapColoring & operator=(const Epetra_MapColoring & Coloring); // Make these inaccessible

  template<typename int_type>
  Epetra_Map * TGenerateMap(int Color) const;

  template<typename int_type>
  Epetra_BlockMap * TGenerateBlockMap(int Color) const;
 };

#endif /* EPETRA_MAPCOLORING_H */

#if defined(Epetra_SHOW_DEPRECATED_WARNINGS)
#ifdef __GNUC__
#warning "The Epetra package is deprecated"
#endif
#endif