Epetra_Import Class Reference

Epetra_Import: This class builds an import object for efficient importing of off-processor elements. More...

#include <Epetra_Import.h>

Inheritance diagram for Epetra_Import:

[legend]
Collaboration diagram for Epetra_Import:
[legend]
List of all members.

Public Member Functions

 Epetra_Import (const Epetra_BlockMap &TargetMap, const Epetra_BlockMap &SourceMap)
 Constructs a Epetra_Import object from the source and target maps.
 Epetra_Import (const Epetra_Import &Importer)
 Epetra_Import copy constructor.
virtual ~Epetra_Import (void)
 Epetra_Import destructor.
int NumSameIDs () const
 Returns the number of elements that are identical between the source and target maps, up to the first different ID.
int NumPermuteIDs () const
 Returns the number of elements that are local to the calling processor, but not part of the first NumSameIDs() elements.
int * PermuteFromLIDs () const
 List of elements in the source map that are permuted.
int * PermuteToLIDs () const
 List of elements in the target map that are permuted.
int NumRemoteIDs () const
 Returns the number of elements that are not on the calling processor.
int * RemoteLIDs () const
 List of elements in the target map that are coming from other processors.
int NumExportIDs () const
 Returns the number of elements that must be sent by the calling processor to other processors.
int * ExportLIDs () const
 List of elements that will be sent to other processors.
int * ExportPIDs () const
 List of processors to which elements will be sent, ExportLIDs() [i] will be sent to processor ExportPIDs() [i].
int NumSend () const
 Total number of elements to be sent.
int NumRecv () const
 Total number of elements to be received.
const Epetra_BlockMapSourceMap () const
 Returns the SourceMap used to construct this importer.
const Epetra_BlockMapTargetMap () const
 Returns the TargetMap used to construct this importer.
Epetra_DistributorDistributor () const
Print object to an output stream
virtual void Print (ostream &os) const

Friends

class Epetra_BlockMap

Detailed Description

Epetra_Import: This class builds an import object for efficient importing of off-processor elements.

Epetra_Import is used to construct a communication plan that can be called repeatedly by computational classes such the Epetra matrix, vector and multivector classes to efficiently obtain off-processor elements.

This class currently has one constructor, taking two Epetra_Map or Epetra_BlockMap objects. The first map specifies the global IDs of elements that we want to import later. The second map specifies the global IDs that are owned by the calling processor.


Constructor & Destructor Documentation

Epetra_Import::Epetra_Import const Epetra_BlockMap TargetMap,
const Epetra_BlockMap SourceMap
 

Constructs a Epetra_Import object from the source and target maps.

This constructor builds an Epetra_Import object by comparing the GID lists of the source and target maps, as discussed above.

Parameters:
TargetMap (In) Map containing the GIDs from which data should be imported to each processor from the source map whenever an import operation is performed using this importer.
SourceMap (In) Map containing the GIDs that should be used for importing data.
Warning:
Note that the SourceMap must have GIDs uniquely owned, each GID of the source map can occur only once.


Member Function Documentation

virtual void Epetra_Import::Print ostream &  os  )  const [virtual]
 

Print object to an output stream Print method

Reimplemented from Epetra_Object.


The documentation for this class was generated from the following file:
Generated on Thu Sep 18 12:40:17 2008 for Epetra by doxygen 1.3.9.1