Epetra_Export Class Reference

Epetra_Export: This class builds an export object for efficient exporting of off-processor elements. More...

#include <Epetra_Export.h>

Inheritance diagram for Epetra_Export:

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

Public Member Functions

 Epetra_Export (const Epetra_BlockMap &SourceMap, const Epetra_BlockMap &TargetMap)
 Constructs a Epetra_Export object from the source and target maps.
 Epetra_Export (const Epetra_Export &Exporter)
 Epetra_Export copy constructor.
virtual ~Epetra_Export (void)
 Epetra_Export 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 exporter.
const Epetra_BlockMapTargetMap () const
 Returns the TargetMap used to construct this exporter.
Epetra_DistributorDistributor () const
Print object to an output stream
virtual void Print (ostream &os) const

Friends

class Epetra_BlockMap

Detailed Description

Epetra_Export: This class builds an export object for efficient exporting of off-processor elements.

Epetra_Export 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 send data to a target processor.

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


Constructor & Destructor Documentation

Epetra_Export::Epetra_Export const Epetra_BlockMap SourceMap,
const Epetra_BlockMap TargetMap
 

Constructs a Epetra_Export object from the source and target maps.

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

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


Member Function Documentation

virtual void Epetra_Export::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