Epetra_Import_Util.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_IMPORT_UTIL_H
#define EPETRA_IMPORT_UTIL_H

#include "Epetra_ConfigDefs.h"
#include "Epetra_Object.h"
#include "Epetra_CrsMatrix.h"
#include <vector>
class Epetra_Map;
class Epetra_CrsMatrix;
class Epetra_Import;


namespace Epetra_Import_Util {

//=========================================================================

int EPETRA_LIB_DLL_EXPORT PackAndPrepareWithOwningPIDs(
         const Epetra_CrsMatrix & SourceMatrix,
         int NumExportIDs,
         int * ExportLIDs,
         int & LenExports,
         char *& Exports,
         int & SizeOfPacket,
         int * Sizes,
         bool & VarSizes,
         std::vector<int>& SourcePids);

// ===================================================================

int EPETRA_LIB_DLL_EXPORT UnpackWithOwningPIDsCount(
          const Epetra_CrsMatrix& SourceMatrix,
            int NumSameIDs,
            int NumRemoteIDs,
            const int * RemoteLIDs,
            int NumPermuteIDs,
            const int *PermuteToLIDs,
            const int *PermuteFromLIDs,
            int LenImports,
            char* Imports);

// ===================================================================

int EPETRA_LIB_DLL_EXPORT UnpackAndCombineIntoCrsArrays(
          const Epetra_CrsMatrix& SourceMatrix,
          int NumSameIDs,
          int NumRemoteIDs,
          const int * RemoteLIDs,
          int NumPermuteIDs,
          const int *PermuteToLIDs,
          const int *PermuteFromLIDs,
          int LenImports,
          char* Imports,
          int TargetNumRows,
          int TargetNumNonzeros,
          int MyTargetPID,
          int * CSR_rowptr,
          int * CSR_colind,
          double * CSR_values,
          const std::vector<int> &SourcePids,
          std::vector<int> &TargetPids);
// ===================================================================

int EPETRA_LIB_DLL_EXPORT UnpackAndCombineIntoCrsArrays(
          const Epetra_CrsMatrix& SourceMatrix,
          int NumSameIDs,
          int NumRemoteIDs,
          const int * RemoteLIDs,
          int NumPermuteIDs,
          const int *PermuteToLIDs,
          const int *PermuteFromLIDs,
          int LenImports,
          char* Imports,
          int TargetNumRows,
          int TargetNumNonzeros,
          int MyTargetPID,
          int * CSR_rowptr,
          long long * CSR_colind,
          double * CSR_values,
          const std::vector<int> &SourcePids,
          std::vector<int> &TargetPids);



// ===================================================================

#ifndef EPETRA_NO_32BIT_GLOBAL_INDICES
int LowCommunicationMakeColMapAndReindex(int N, const int *rowptr, int *colind, const Epetra_Map& domainMap,
           const int *owningPIDs, bool SortGhostsAssociatedWithEachProcessor,
           std::vector<int>& RemotePIDs, Epetra_BlockMap & NewColMap);
#endif
// ===================================================================

#ifndef EPETRA_NO_64BIT_GLOBAL_INDICES
int LowCommunicationMakeColMapAndReindex(int N, const int *rowptr, int *colind_LID, long long *colind_GID, const Epetra_Map& domainMap,
           const int *owningPIDs, bool SortGhostsAssociatedWithEachProcessor, std::vector<int>& RemotePIDs, Epetra_BlockMap & NewColMap);
#endif

} /* Epetra_Import_Util namespace */

#endif /* EPETRA_IMPORT_UTIL_H */

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