Epetra Development
Epetra_BasicDirectory Class Reference

Epetra_BasicDirectory: This class allows Epetra_Map objects to reference non-local elements. More...

#include <Epetra_BasicDirectory.h>

Inheritance diagram for Epetra_BasicDirectory:
Inheritance graph
[legend]
Collaboration diagram for Epetra_BasicDirectory:
Collaboration graph
[legend]

List of all members.

Public Member Functions

Constructors/Destructor
 Epetra_BasicDirectory (const Epetra_BlockMap &Map)
 Epetra_BasicDirectory constructor.
 Epetra_BasicDirectory (const Epetra_BasicDirectory &Directory)
 Epetra_BasicDirectory copy constructor.
virtual ~Epetra_BasicDirectory (void)
 Epetra_BasicDirectory destructor.
Query method
int GetDirectoryEntries (const Epetra_BlockMap &Map, const int NumEntries, const int *GlobalEntries, int *Procs, int *LocalEntries, int *EntrySizes, bool high_rank_sharing_procs=false) const
 GetDirectoryEntries : Returns proc and local id info for non-local map entries.
int GetDirectoryEntries (const Epetra_BlockMap &Map, const int NumEntries, const long long *GlobalEntries, int *Procs, int *LocalEntries, int *EntrySizes, bool high_rank_sharing_procs=false) const
bool GIDsAllUniquelyOwned () const
 GIDsAllUniquelyOwned: returns true if all GIDs appear on just one processor.
I/O Methods
virtual void Print (std::ostream &os) const
 Print method.

Detailed Description

Epetra_BasicDirectory: This class allows Epetra_Map objects to reference non-local elements.

For Epetra_BlockMap objects, a Epetra_Directory object must be created to allow referencing of non-local elements. The Epetra_BasicDirectory produces and contains a uniform linear Epetra_BlockMap and a ProcList_ allowing blocks of non-local elements to be accessed by dereferencing through the Epetra_BasicDirectory.

This class currently has one constructor, taking a Epetra_BlockMap object.


Member Function Documentation

int Epetra_BasicDirectory::GetDirectoryEntries ( const Epetra_BlockMap Map,
const int  NumEntries,
const int *  GlobalEntries,
int *  Procs,
int *  LocalEntries,
int *  EntrySizes,
bool  high_rank_sharing_procs = false 
) const [virtual]

GetDirectoryEntries : Returns proc and local id info for non-local map entries.

Given a list of Global Entry IDs, this function returns the list of processor IDs and local IDs on the owning processor that correspond to the list of entries. If LocalEntries is 0, then local IDs are not returned. If EntrySizes is nonzero, it will contain a list of corresponding element sizes for the requested global entries.

Parameters:
InNumEntries - Number of Global IDs being passed in.
InGlobalEntries - List of Global IDs being passed in.
InOutProcs - User allocated array of length at least NumEntries. On return contains list of processors owning the Global IDs in question. If any of the GIDs is shared by more than one processor, then the lowest-numbered processor is listed in this array, unless the optional argument 'high_rank_sharing_procs' is given as true.
InOutLocalEntries - User allocated array of length at least NumEntries. On return contains the local ID of the global on the owning processor. If LocalEntries is zero, no local ID information is returned.
InOutEntrySizes - User allocated array of length at least NumEntries. On return contains the size of the object associated with this global ID. If LocalEntries is zero, no size information is returned.
Inhigh_rank_sharing_procs Optional argument, defaults to true. If any GIDs appear on multiple processors (referred to as "sharing procs"), this specifies whether the lowest-rank proc or the highest-rank proc is chosen as the "owner".
Returns:
Integer error code, set to 0 if successful.

Implements Epetra_Directory.

bool Epetra_BasicDirectory::GIDsAllUniquelyOwned ( ) const [virtual]

GIDsAllUniquelyOwned: returns true if all GIDs appear on just one processor.

If any GIDs are owned by multiple processors, returns false.

Implements Epetra_Directory.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Enumerations Enumerator