PyTrilinos::Epetra::Directory Class Reference
Inheritance diagram for PyTrilinos::Epetra::Directory:
Collaboration diagram for PyTrilinos::Epetra::Directory:
Public Member Functions | |
| def | __init__ |
| def | GetDirectoryEntries |
| def | GIDsAllUniquelyOwned |
| def | __init__ |
| def | GetDirectoryEntries |
| def | GIDsAllUniquelyOwned |
Detailed Description
Epetra_Directory: This class is a pure virtual class whose interface allows Epetra_Map and Epetr_BlockMap objects to reference non-local elements. For Epetra_BlockMap objects, a Epetra_Directory object must be created by a call to the Epetra_Comm CreateDirectory method. The Directory is needed to allow referencing of non-local elements. C++ includes: Epetra_Directory.h
Member Function Documentation
| def PyTrilinos::Epetra::Directory::GetDirectoryEntries | ( | self, | ||
| args | ||||
| ) |
GetDirectoryEntries(self, BlockMap Map, int NumEntries, int GlobalEntries, int Procs,
int LocalEntries, int EntrySizes, bool high_rank_sharing_procs = False) -> int
virtual
int Epetra_Directory::GetDirectoryEntries(const Epetra_BlockMap &Map,
const int NumEntries, const int *GlobalEntries, int *Procs, int
*LocalEntries, int *EntrySizes, bool high_rank_sharing_procs=false)
const =0
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:
-----------
In: NumEntries - Number of Global IDs being passed in.
In: GlobalEntries - List of Global IDs being passed in.
InOut: Procs - User allocated array of length at least NumEntries. On
return contains list of processors owning the Global IDs in question.
InOut: LocalEntries - 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.
InOut: EntrySizes - 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.
In: high_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".
Integer error code, set to 0 if successful.
Reimplemented in PyTrilinos::Epetra::BasicDirectory, and PyTrilinos::Epetra::BasicDirectory.
| def PyTrilinos::Epetra::Directory::GetDirectoryEntries | ( | self, | ||
| args | ||||
| ) |
GetDirectoryEntries(self, BlockMap Map, int NumEntries, int GlobalEntries, int Procs,
int LocalEntries, int EntrySizes, bool high_rank_sharing_procs = False) -> int
virtual
int Epetra_Directory::GetDirectoryEntries(const Epetra_BlockMap &Map,
const int NumEntries, const int *GlobalEntries, int *Procs, int
*LocalEntries, int *EntrySizes, bool high_rank_sharing_procs=false)
const =0
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:
-----------
In: NumEntries - Number of Global IDs being passed in.
In: GlobalEntries - List of Global IDs being passed in.
InOut: Procs - User allocated array of length at least NumEntries. On
return contains list of processors owning the Global IDs in question.
InOut: LocalEntries - 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.
InOut: EntrySizes - 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.
In: high_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".
Integer error code, set to 0 if successful.
Reimplemented in PyTrilinos::Epetra::BasicDirectory, and PyTrilinos::Epetra::BasicDirectory.
| def PyTrilinos::Epetra::Directory::GIDsAllUniquelyOwned | ( | self, | ||
| args | ||||
| ) |
GIDsAllUniquelyOwned(self) -> bool virtual bool Epetra_Directory::GIDsAllUniquelyOwned() const =0 GIDsAllUniquelyOwned: returns true if all GIDs appear on just one processor. If any GIDs are owned by multiple processors, returns false.
Reimplemented in PyTrilinos::Epetra::BasicDirectory, and PyTrilinos::Epetra::BasicDirectory.
| def PyTrilinos::Epetra::Directory::GIDsAllUniquelyOwned | ( | self, | ||
| args | ||||
| ) |
GIDsAllUniquelyOwned(self) -> bool virtual bool Epetra_Directory::GIDsAllUniquelyOwned() const =0 GIDsAllUniquelyOwned: returns true if all GIDs appear on just one processor. If any GIDs are owned by multiple processors, returns false.
Reimplemented in PyTrilinos::Epetra::BasicDirectory, and PyTrilinos::Epetra::BasicDirectory.
The documentation for this class was generated from the following files:
- build/lib.linux-x86_64-2.5/PyTrilinos/Epetra.py
- PyTrilinos/Epetra.py
