Epetra Package Browser (Single Doxygen Collection) Development
Epetra_Import.h
Go to the documentation of this file.
00001 /*
00002 //@HEADER
00003 // ************************************************************************
00004 // 
00005 //               Epetra: Linear Algebra Services Package 
00006 //                 Copyright 2011 Sandia Corporation
00007 // 
00008 // Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
00009 // the U.S. Government retains certain rights in this software.
00010 //
00011 // Redistribution and use in source and binary forms, with or without
00012 // modification, are permitted provided that the following conditions are
00013 // met:
00014 //
00015 // 1. Redistributions of source code must retain the above copyright
00016 // notice, this list of conditions and the following disclaimer.
00017 //
00018 // 2. Redistributions in binary form must reproduce the above copyright
00019 // notice, this list of conditions and the following disclaimer in the
00020 // documentation and/or other materials provided with the distribution.
00021 //
00022 // 3. Neither the name of the Corporation nor the names of the
00023 // contributors may be used to endorse or promote products derived from
00024 // this software without specific prior written permission.
00025 //
00026 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
00027 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00028 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00029 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
00030 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00031 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00032 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00033 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00034 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00035 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00036 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00037 //
00038 // Questions? Contact Michael A. Heroux (maherou@sandia.gov) 
00039 // 
00040 // ************************************************************************
00041 //@HEADER
00042 */
00043 
00044 #ifndef EPETRA_IMPORT_H
00045 #define EPETRA_IMPORT_H
00046 
00047 #include "Epetra_Object.h"
00048 #include "Epetra_BlockMap.h"
00049 class Epetra_Distributor;
00050 class Epetra_Export;
00051 
00053 
00063 class EPETRA_LIB_DLL_EXPORT Epetra_Import: public Epetra_Object {
00064   friend class Epetra_Export;
00065   public:
00066 
00068 
00231   Epetra_Import( const Epetra_BlockMap & TargetMap, const Epetra_BlockMap & SourceMap );
00232 
00234 
00239   Epetra_Import( const Epetra_BlockMap & TargetMap, const Epetra_BlockMap & SourceMap, int NumRemotePIDs,const int * RemotePIDs);
00240 
00242 
00247   Epetra_Import( const Epetra_BlockMap & TargetMap, const Epetra_BlockMap & SourceMap, int NumRemotePIDs,const int * RemotePIDs,     
00248      const int & NumExportIDs, const int * ExportLIDs,  const int * ExportPIDs);
00249 
00250 
00252   Epetra_Import(const Epetra_Import& Importer);
00253 
00255   Epetra_Import(const Epetra_Export& Exporter);
00256 
00257 
00259   virtual ~Epetra_Import(void);
00260 
00262   int NumSameIDs() const {return(NumSameIDs_);};
00263 
00265   int NumPermuteIDs() const {return(NumPermuteIDs_);};
00266 
00268   int * PermuteFromLIDs () const {return(PermuteFromLIDs_);};
00270   int * PermuteToLIDs () const {return(PermuteToLIDs_);};
00271 
00273   int NumRemoteIDs() const {return(NumRemoteIDs_);};
00274   
00276   int * RemoteLIDs() const {return(RemoteLIDs_);};
00277 
00279   int  NumExportIDs () const {return(NumExportIDs_);};
00280 
00282   int * ExportLIDs () const {return(ExportLIDs_);};
00283 
00285   int * ExportPIDs () const {return(ExportPIDs_);};
00286 
00288   int NumSend() const {return(NumSend_);};
00289 
00291   int NumRecv() const {return(NumRecv_);};
00292 
00294   const Epetra_BlockMap & SourceMap() const {return(SourceMap_);};
00295 
00297   const Epetra_BlockMap & TargetMap() const {return(TargetMap_);};
00298 
00299   Epetra_Distributor & Distributor() const {return(*Distor_);};
00300 
00302 
00303   virtual void Print(std::ostream & os) const;
00305  protected:
00306 
00307  friend class Epetra_BlockMap;
00308 
00309  private:
00310  Epetra_Import& operator=(const Epetra_Import& src)
00311    {
00312      (void)src;
00313      //not currently supported
00314      bool throw_error = true;
00315      if (throw_error) {
00316        throw ReportError("Epetra_Import::operator= not supported.",-1);
00317      }
00318      return(*this);
00319    }
00320 
00321  Epetra_BlockMap TargetMap_;
00322  Epetra_BlockMap SourceMap_;
00323 
00324   int  NumSameIDs_;
00325   int  NumPermuteIDs_;
00326   int * PermuteToLIDs_;
00327   int * PermuteFromLIDs_;
00328   int  NumRemoteIDs_;
00329   int * RemoteLIDs_;
00330 
00331   int  NumExportIDs_;
00332   int * ExportLIDs_;
00333   int * ExportPIDs_;
00334 
00335   int NumSend_;
00336   int NumRecv_;
00337 
00338   Epetra_Distributor * Distor_;
00339   
00340 
00341   template<typename int_type>
00342   void Construct( const Epetra_BlockMap &  targetMap, const Epetra_BlockMap & sourceMap, int NumRemotePIDs=-1, const int * UserRemotePIDs=0);
00343 
00344   template<typename int_type>
00345     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);
00346 
00347 };
00348 
00349 #endif /* EPETRA_IMPORT_H */
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines