Epetra_Import.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_H
#define EPETRA_IMPORT_H
 
#include "Epetra_Object.h"
#include "Epetra_BlockMap.h"
class Epetra_Distributor;
class Epetra_Export;
 
 
class EPETRA_LIB_DLL_EXPORT Epetra_Import: public Epetra_Object {
  friend class Epetra_Export;
  public:
 
 
  Epetra_Import( const Epetra_BlockMap & TargetMap, const Epetra_BlockMap & SourceMap );
 
 
  Epetra_Import( const Epetra_BlockMap & TargetMap, const Epetra_BlockMap & SourceMap, int NumRemotePIDs,const int * RemotePIDs);
 
 
  Epetra_Import( const Epetra_BlockMap & TargetMap, const Epetra_BlockMap & SourceMap, int NumRemotePIDs,const int * RemotePIDs,    
     const int & NumExportIDs, const int * ExportLIDs,  const int * ExportPIDs);
 
 
  Epetra_Import(const Epetra_Import& Importer);
 
  Epetra_Import(const Epetra_Export& Exporter);
 
 
  virtual ~Epetra_Import(void);
 
  int NumSameIDs() const {return(NumSameIDs_);};
 
  int NumPermuteIDs() const {return(NumPermuteIDs_);};
 
  int * PermuteFromLIDs () const {return(PermuteFromLIDs_);};
  int * PermuteToLIDs () const {return(PermuteToLIDs_);};
 
  int NumRemoteIDs() const {return(NumRemoteIDs_);};
 
  int * RemoteLIDs() const {return(RemoteLIDs_);};
 
  int  NumExportIDs () const {return(NumExportIDs_);};
 
  int * ExportLIDs () const {return(ExportLIDs_);};
 
  int * ExportPIDs () const {return(ExportPIDs_);};
 
  int NumSend() const {return(NumSend_);};
 
  int NumRecv() const {return(NumRecv_);};
 
  const Epetra_BlockMap & SourceMap() const {return(SourceMap_);};
 
  const Epetra_BlockMap & TargetMap() const {return(TargetMap_);};
 
  Epetra_Distributor & Distributor() const {return(*Distor_);};
 
 
  virtual void Print(std::ostream & os) const;
 protected:
 
 friend class Epetra_BlockMap;
 
 private:
 Epetra_Import& operator=(const Epetra_Import& src)
   {
     (void)src;
     //not currently supported
     bool throw_error = true;
     if (throw_error) {
       throw ReportError("Epetra_Import::operator= not supported.",-1);
     }
     return(*this);
   }
 
 Epetra_BlockMap TargetMap_;
 Epetra_BlockMap SourceMap_;
 
  int  NumSameIDs_;
  int  NumPermuteIDs_;
  int * PermuteToLIDs_;
  int * PermuteFromLIDs_;
  int  NumRemoteIDs_;
  int * RemoteLIDs_;
 
  int  NumExportIDs_;
  int * ExportLIDs_;
  int * ExportPIDs_;
 
  int NumSend_;
  int NumRecv_;
 
  Epetra_Distributor * Distor_;
 
 
  template<typename int_type>
  void Construct( const Epetra_BlockMap &  targetMap, const Epetra_BlockMap & sourceMap, int NumRemotePIDs=-1, const int * UserRemotePIDs=0);
 
  template<typename int_type>
    void Construct_Expert( const Epetra_BlockMap & TargetMap, const Epetra_BlockMap & SourceMap, int NumRemotePIDs,const int * RemotePIDs, const int & NumExportIDs, const int * ExportLIDs,  const int * ExportPIDs);
 
};
 
#endif /* EPETRA_IMPORT_H */