Epetra Package Browser (Single Doxygen Collection)  Development
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Epetra_Import.h
Go to the documentation of this file.
1 /*
2 //@HEADER
3 // ************************************************************************
4 //
5 // Epetra: Linear Algebra Services Package
6 // Copyright 2011 Sandia Corporation
7 //
8 // Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
9 // the U.S. Government retains certain rights in this software.
10 //
11 // Redistribution and use in source and binary forms, with or without
12 // modification, are permitted provided that the following conditions are
13 // met:
14 //
15 // 1. Redistributions of source code must retain the above copyright
16 // notice, this list of conditions and the following disclaimer.
17 //
18 // 2. Redistributions in binary form must reproduce the above copyright
19 // notice, this list of conditions and the following disclaimer in the
20 // documentation and/or other materials provided with the distribution.
21 //
22 // 3. Neither the name of the Corporation nor the names of the
23 // contributors may be used to endorse or promote products derived from
24 // this software without specific prior written permission.
25 //
26 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
27 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
29 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
30 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
31 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
32 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
33 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
34 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
35 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
36 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37 //
38 // Questions? Contact Michael A. Heroux (maherou@sandia.gov)
39 //
40 // ************************************************************************
41 //@HEADER
42 */
43 
44 #ifndef EPETRA_IMPORT_H
45 #define EPETRA_IMPORT_H
46 
47 #include "Epetra_Object.h"
48 #include "Epetra_BlockMap.h"
49 class Epetra_Distributor;
50 class Epetra_Export;
51 
53 
63 class EPETRA_LIB_DLL_EXPORT Epetra_Import: public Epetra_Object {
64  friend class Epetra_Export;
65  public:
66 
68 
232 
234 
239  Epetra_Import( const Epetra_BlockMap & TargetMap, const Epetra_BlockMap & SourceMap, int NumRemotePIDs,const int * RemotePIDs);
240 
242 
247  Epetra_Import( const Epetra_BlockMap & TargetMap, const Epetra_BlockMap & SourceMap, int NumRemotePIDs,const int * RemotePIDs,
248  const int & NumExportIDs, const int * ExportLIDs, const int * ExportPIDs);
249 
250 
252  Epetra_Import(const Epetra_Import& Importer);
253 
255  Epetra_Import(const Epetra_Export& Exporter);
256 
257 
259  virtual ~Epetra_Import(void);
260 
262  int NumSameIDs() const {return(NumSameIDs_);};
263 
265  int NumPermuteIDs() const {return(NumPermuteIDs_);};
266 
268  int * PermuteFromLIDs () const {return(PermuteFromLIDs_);};
270  int * PermuteToLIDs () const {return(PermuteToLIDs_);};
271 
273  int NumRemoteIDs() const {return(NumRemoteIDs_);};
274 
276  int * RemoteLIDs() const {return(RemoteLIDs_);};
277 
279  int NumExportIDs () const {return(NumExportIDs_);};
280 
282  int * ExportLIDs () const {return(ExportLIDs_);};
283 
285  int * ExportPIDs () const {return(ExportPIDs_);};
286 
288  int NumSend() const {return(NumSend_);};
289 
291  int NumRecv() const {return(NumRecv_);};
292 
294  const Epetra_BlockMap & SourceMap() const {return(SourceMap_);};
295 
297  const Epetra_BlockMap & TargetMap() const {return(TargetMap_);};
298 
299  Epetra_Distributor & Distributor() const {return(*Distor_);};
300 
301  const Epetra_Distributor * DistributorPtr() const {return(Distor_);}
302 
304 
305  virtual void Print(std::ostream & os) const;
307  protected:
308 
309  friend class Epetra_BlockMap;
310 
311  private:
313  {
314  (void)src;
315  //not currently supported
316  bool throw_error = true;
317  if (throw_error) {
318  throw ReportError("Epetra_Import::operator= not supported.",-1);
319  }
320  return(*this);
321  }
322 
325 
331  int * RemoteLIDs_;
332 
334  int * ExportLIDs_;
335  int * ExportPIDs_;
336 
337  int NumSend_;
338  int NumRecv_;
339 
341 
342 
343  template<typename int_type>
344  void Construct( const Epetra_BlockMap & targetMap, const Epetra_BlockMap & sourceMap, int NumRemotePIDs=-1, const int * UserRemotePIDs=0);
345 
346  template<typename int_type>
347  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);
348 
349 };
350 
351 #endif /* EPETRA_IMPORT_H */
352 
353 #if defined(Epetra_SHOW_DEPRECATED_WARNINGS)
354 #ifdef __GNUC__
355 #warning "The Epetra package is deprecated"
356 #endif
357 #endif
358 
virtual void Print(std::ostream &os) const
Print object to an output stream Print method.
int * ExportLIDs() const
List of elements that will be sent to other processors.
int * PermuteToLIDs_
Epetra_BlockMap SourceMap_
int NumRemoteIDs() const
Returns the number of elements that are not on the calling processor.
Epetra_Import & operator=(const Epetra_Import &src)
Epetra_Distributor: The Epetra Gather/Scatter Setup Base Class.
int NumSameIDs() const
Returns the number of elements that are identical between the source and target maps, up to the first different ID.
friend class Epetra_Import
Definition: Epetra_Export.h:63
const Epetra_BlockMap & TargetMap() const
Returns the TargetMap used to construct this exporter.
const Epetra_BlockMap & SourceMap() const
Returns the SourceMap used to construct this exporter.
Epetra_BlockMap TargetMap_
int * ExportPIDs() const
List of processors to which elements will be sent, ExportLIDs() [i] will be sent to processor ExportP...
Epetra_Export: This class builds an export object for efficient exporting of off-processor elements...
Definition: Epetra_Export.h:62
int * PermuteFromLIDs_
Epetra_Distributor & Distributor() const
Epetra_Import: This class builds an import object for efficient importing of off-processor elements...
Definition: Epetra_Import.h:63
int * ExportLIDs() const
List of elements that will be sent to other processors.
int NumExportIDs() const
Returns the number of elements that must be sent by the calling processor to other processors...
int * PermuteFromLIDs() const
List of elements in the source map that are permuted.
const Epetra_BlockMap & TargetMap() const
Returns the TargetMap used to construct this importer.
Epetra_Distributor * Distor_
Epetra_Object: The base Epetra class.
Definition: Epetra_Object.h:57
int * ExportPIDs() const
List of processors to which elements will be sent, ExportLIDs() [i] will be sent to processor ExportP...
Epetra_BlockMap: A class for partitioning block element vectors and matrices.
const Epetra_BlockMap & SourceMap() const
Returns the SourceMap used to construct this importer.
int * PermuteToLIDs_
int NumRecv() const
Total number of elements to be received.
Epetra_BlockMap TargetMap_
int NumPermuteIDs() const
Returns the number of elements that are local to the calling processor, but not part of the first Num...
Epetra_Distributor * Distor_
int NumExportIDs() const
Returns the number of elements that must be sent by the calling processor to other processors...
int * RemoteLIDs() const
List of elements in the target map that are coming from other processors.
int * PermuteFromLIDs_
virtual int ReportError(const std::string Message, int ErrorCode) const
Error reporting method.
const Epetra_Distributor * DistributorPtr() const
int NumSend() const
Total number of elements to be sent.
Epetra_BlockMap SourceMap_
int * PermuteToLIDs() const
List of elements in the target map that are permuted.