Epetra_DistObject Class Reference

Epetra_DistObject: A class for constructing and using dense multi-vectors, vectors and matrices in parallel. More...

#include <Epetra_DistObject.h>

Inheritance diagram for Epetra_DistObject:

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

Public Member Functions
Constructors/Destructor
	Epetra_DistObject (const Epetra_BlockMap &Map)
	Basic Epetra_DistObject constuctor.
	Epetra_DistObject (const Epetra_BlockMap &Map, const char *const Label)
	Epetra_DistObject (const Epetra_DistObject &Source)
	Epetra_DistObject copy constructor.
virtual	~Epetra_DistObject ()
	Epetra_DistObject destructor.
Import/Export Methods
int	Import (const Epetra_SrcDistObject &A, const Epetra_Import &Importer, Epetra_CombineMode CombineMode, const Epetra_OffsetIndex *Indexor=0)
	Imports an Epetra_DistObject using the Epetra_Import object.
int	Import (const Epetra_SrcDistObject &A, const Epetra_Export &Exporter, Epetra_CombineMode CombineMode, const Epetra_OffsetIndex *Indexor=0)
	Imports an Epetra_DistObject using the Epetra_Export object.
int	Export (const Epetra_SrcDistObject &A, const Epetra_Import &Importer, Epetra_CombineMode CombineMode, const Epetra_OffsetIndex *Indexor=0)
	Exports an Epetra_DistObject using the Epetra_Import object.
int	Export (const Epetra_SrcDistObject &A, const Epetra_Export &Exporter, Epetra_CombineMode CombineMode, const Epetra_OffsetIndex *Indexor=0)
	Exports an Epetra_DistObject using the Epetra_Export object.
Attribute accessor methods
const Epetra_BlockMap &	Map () const
	Returns the address of the Epetra_BlockMap for this multi-vector.
const Epetra_Comm &	Comm () const
	Returns the address of the Epetra_Comm for this multi-vector.
bool	DistributedGlobal () const
	Returns true if this multi-vector is distributed global, i.e., not local replicated.
Miscellaneous
virtual void	Print (ostream &os) const
	Print method.
Protected Member Functions
Internal utilities
virtual int	DoTransfer (const Epetra_SrcDistObject &A, Epetra_CombineMode CombineMode, int NumSameIDs, int NumPermuteIDs, int NumRemoteIDs, int NumExportIDs, int *PermuteToLIDs, int *PermuteFromLIDs, int *RemoteLIDs, int *ExportLIDs, int &LenExports, char *&Exports, int &LenImports, char *&Imports, Epetra_Distributor &Distor, bool DoReverse, const Epetra_OffsetIndex *Indexor)
	Perform actual transfer (redistribution) of data across memory images, using Epetra_Distributor object.
Virtual methods to be implemented by derived class
virtual int	CheckSizes (const Epetra_SrcDistObject &Source)=0
	Allows the source and target (this) objects to be compared for compatibility, return nonzero if not.
virtual int	CopyAndPermute (const Epetra_SrcDistObject &Source, int NumSameIDs, int NumPermuteIDs, int *PermuteToLIDs, int *PermuteFromLIDs, const Epetra_OffsetIndex *Indexor)=0
	Perform ID copies and permutations that are on processor.
virtual int	PackAndPrepare (const Epetra_SrcDistObject &Source, int NumExportIDs, int *ExportLIDs, int &LenExports, char *&Exports, int &SizeOfPacket, int *Sizes, bool &VarSizes, Epetra_Distributor &Distor)=0
	Perform any packing or preparation required for call to DoTransfer().
virtual int	UnpackAndCombine (const Epetra_SrcDistObject &Source, int NumImportIDs, int *ImportLIDs, int LenImports, char *Imports, int &SizeOfPacket, Epetra_Distributor &Distor, Epetra_CombineMode CombineMode, const Epetra_OffsetIndex *Indexor)=0
	Perform any unpacking and combining after call to DoTransfer().
Protected Attributes
Epetra_BlockMap	Map_
const Epetra_Comm *	Comm_
bool	DistributedGlobal_
char *	Exports_
char *	Imports_
int	LenExports_
int	LenImports_
int *	Sizes_

---

Detailed Description

Epetra_DistObject: A class for constructing and using dense multi-vectors, vectors and matrices in parallel.

The Epetra_DistObject is a base class for all Epetra distributed global objects. It provides the basic mechanisms and interface specifications for importing and exporting operations using Epetra_Import and Epetra_Export objects.

Distributed Global vs. Replicated Local.

• Distributed Global objects - In most instances, a distributed object will be partitioned across multiple memory images associated with multiple processors. In this case, there is a unique copy of each element and elements are spread across all processors specified by the Epetra_Comm communicator.
• Replicated Local Objects - Some algorithms use objects that are too small to be distributed across all processors, the Hessenberg matrix in a GMRES computation. In other cases, such as with block iterative methods, block dot product functions produce small dense matrices that are required by all processors. Replicated local objectss handle these types of situation.

---

Constructor & Destructor Documentation

Epetra_DistObject::Epetra_DistObject (  const Epetra_BlockMap &  Map  )

Basic Epetra_DistObject constuctor. Creates a Epetra_DistObject object. Parameters: In  Map - A Epetra_LocalMap, Epetra_Map or Epetra_BlockMap. Warning: Note that, because Epetra_LocalMap derives from Epetra_Map and Epetra_Map derives from Epetra_BlockMap, this constructor works for all three types of Epetra map classes. Returns: Pointer to a Epetra_DistObject.

Epetra_DistObject::Epetra_DistObject (  const Epetra_BlockMap &  Map, const char *const   Label )

Creates a Epetra_DistObject object. Parameters: In  Map - A Epetra_LocalMap, Epetra_Map or Epetra_BlockMap. Warning: Note that, because Epetra_LocalMap derives from Epetra_Map and Epetra_Map derives from Epetra_BlockMap, this constructor works for all three types of Epetra map classes. Parameters: In  Label - An identifier for this object. By default, set to the name of the object class. Returns: Pointer to a Epetra_DistObject.

---

Member Function Documentation

int Epetra_DistObject::Export (  const Epetra_SrcDistObject &  A, const Epetra_Export &  Exporter, Epetra_CombineMode  CombineMode, const Epetra_OffsetIndex *  Indexor = 0 )

Exports an Epetra_DistObject using the Epetra_Export object. Parameters: In  Source - Distributed object that will be exported to the "\e this" multivector. In  Exporter - A Epetra_Export object specifying the communication required. In  CombineMode - A Epetra_CombineMode enumerated type specifying how results should be combined on the receiving processor. Returns: Integer error code, set to 0 if successful.

int Epetra_DistObject::Export (  const Epetra_SrcDistObject &  A, const Epetra_Import &  Importer, Epetra_CombineMode  CombineMode, const Epetra_OffsetIndex *  Indexor = 0 )

Exports an Epetra_DistObject using the Epetra_Import object. Parameters: In  Source - Distributed object that will be exported to the "\e this" object. In  Importer - A Epetra_Import object specifying the communication required. In  CombineMode - A Epetra_CombineMode enumerated type specifying how results should be combined on the receiving processor. Returns: Integer error code, set to 0 if successful.

int Epetra_DistObject::Import (  const Epetra_SrcDistObject &  A, const Epetra_Export &  Exporter, Epetra_CombineMode  CombineMode, const Epetra_OffsetIndex *  Indexor = 0 )

Imports an Epetra_DistObject using the Epetra_Export object. Parameters: In  Source - Distributed object that will be imported into the "\e this" object. In  Exporter - A Epetra_Export object specifying the communication required. In  CombineMode - A Epetra_CombineMode enumerated type specifying how results should be combined on the receiving processor. Returns: Integer error code, set to 0 if successful.

int Epetra_DistObject::Import (  const Epetra_SrcDistObject &  A, const Epetra_Import &  Importer, Epetra_CombineMode  CombineMode, const Epetra_OffsetIndex *  Indexor = 0 )

Imports an Epetra_DistObject using the Epetra_Import object. Parameters: In  Source - Distributed object that will be imported into the "\e this" object. In  Importer - A Epetra_Import object specifying the communication required. In  CombineMode - A Epetra_CombineMode enumerated type specifying how results should be combined on the receiving processor. Returns: Integer error code, set to 0 if successful.

---

The documentation for this class was generated from the following file:

• Epetra_DistObject.h

---