Epetra Package Browser (Single Doxygen Collection) Development
Private Member Functions | Private Attributes
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]

List of all members.

Private Member Functions

Epetra_BasicDirectoryoperator= (const Epetra_BasicDirectory &src)
void create_ProcListArrays ()
void addProcToList (int proc, int LID)
template<typename int_type >
int Generate (const Epetra_BlockMap &Map)
 Generate: Sets up Directory tables.
const Epetra_MapDirectoryMap () const
 Returns the Epetra_Map containing the directory.
template<typename int_type >
const int_type * AllMinGIDs () const
template<typename int_type >
int GetDirectoryEntries (const Epetra_BlockMap &Map, const int NumEntries, const int_type *GlobalEntries, int *Procs, int *LocalEntries, int *EntrySizes, bool high_rank_sharing_procs) const

Private Attributes

Epetra_MapDirectoryMap_
int * ProcList_
int ** ProcListLists_
int * ProcListLens_
int numProcLists_
bool entryOnMultipleProcs_
int * LocalIndexList_
int * SizeList_
bool SizeIsConst_
int * AllMinGIDs_int_
long long * AllMinGIDs_LL_

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.

Definition at line 63 of file Epetra_BasicDirectory.h.


Constructor & Destructor Documentation

Epetra_BasicDirectory::Epetra_BasicDirectory ( const Epetra_BlockMap Map)

Epetra_BasicDirectory constructor.

Definition at line 53 of file Epetra_BasicDirectory.cpp.

Epetra_BasicDirectory::Epetra_BasicDirectory ( const Epetra_BasicDirectory Directory)

Epetra_BasicDirectory copy constructor.

Definition at line 132 of file Epetra_BasicDirectory.cpp.

Epetra_BasicDirectory::~Epetra_BasicDirectory ( void  ) [virtual]

Epetra_BasicDirectory destructor.

Definition at line 206 of file Epetra_BasicDirectory.cpp.


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.

Definition at line 714 of file Epetra_BasicDirectory.cpp.

int Epetra_BasicDirectory::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 [virtual]

Implements Epetra_Directory.

Definition at line 734 of file Epetra_BasicDirectory.cpp.

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.

Definition at line 402 of file Epetra_BasicDirectory.cpp.

void Epetra_BasicDirectory::Print ( std::ostream &  os) const [virtual]

Print method.

Definition at line 751 of file Epetra_BasicDirectory.cpp.

Epetra_BasicDirectory & Epetra_BasicDirectory::operator= ( const Epetra_BasicDirectory src) [private]

Definition at line 776 of file Epetra_BasicDirectory.cpp.

void Epetra_BasicDirectory::create_ProcListArrays ( ) [private]

Definition at line 237 of file Epetra_BasicDirectory.cpp.

void Epetra_BasicDirectory::addProcToList ( int  proc,
int  LID 
) [private]

Definition at line 250 of file Epetra_BasicDirectory.cpp.

template<typename int_type >
int Epetra_BasicDirectory::Generate ( const Epetra_BlockMap Map) [private]

Generate: Sets up Directory tables.

Definition at line 265 of file Epetra_BasicDirectory.cpp.

const Epetra_Map& Epetra_BasicDirectory::DirectoryMap ( ) const [inline, private]

Returns the Epetra_Map containing the directory.

Definition at line 156 of file Epetra_BasicDirectory.h.

const long long * Epetra_BasicDirectory::AllMinGIDs ( ) const [inline, private]

Definition at line 219 of file Epetra_BasicDirectory.h.

template<typename int_type >
int Epetra_BasicDirectory::GetDirectoryEntries ( const Epetra_BlockMap Map,
const int  NumEntries,
const int_type *  GlobalEntries,
int *  Procs,
int *  LocalEntries,
int *  EntrySizes,
bool  high_rank_sharing_procs 
) const [private]

Definition at line 412 of file Epetra_BasicDirectory.cpp.


Member Data Documentation

Definition at line 156 of file Epetra_BasicDirectory.h.

Definition at line 166 of file Epetra_BasicDirectory.h.

Definition at line 186 of file Epetra_BasicDirectory.h.

Definition at line 187 of file Epetra_BasicDirectory.h.

Definition at line 188 of file Epetra_BasicDirectory.h.

Definition at line 191 of file Epetra_BasicDirectory.h.

Definition at line 193 of file Epetra_BasicDirectory.h.

Definition at line 194 of file Epetra_BasicDirectory.h.

Definition at line 195 of file Epetra_BasicDirectory.h.

Definition at line 198 of file Epetra_BasicDirectory.h.

Definition at line 201 of file Epetra_BasicDirectory.h.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines