Epetra_LocalMap: A class for replicating vectors and matrices across
multiple processors.
Small matrix and vector objects are often replicated on distributed
memory parallel machines. The Epetra_LocalMap class allows
construction of these replicated local objects and keeps information
that describes this distribution.
Epetra_LocalMap allows the storage and retrieval of the following
information. Once a Epetra_Map is constructed any of the following
attributes can be obtained by calling a query function that has the
name as the attribute, e.g. to get the value of NumGlobalPoints, you
can call a function NumGlobalElements(). For attributes that are
lists, the query functions return the list values in a user allocated
array.
NumMyElements - The number of elements owned by the calling processor.
IndexBase - The base integer value for indexed array references.
Typically this is 0 for C/C++ and 1 for Fortran, but it can be set to
any integer value.
Comm - The Epetra_Comm communicator. This communicator can in turn be
queried for processor rank and size information.
The Epetra_LocalMap class is actually a derived class of Epetra_Map.
Epetra_Map is in turn derived from Epetra_BlockMap. As such,
Epetra_LocalMap has full access to all the functions in these other
map classes.
In particular, the following function allows a boolean test:
DistributedGlobal() - Returns false for a Epetra_LocalMap object.
WARNING: A Epetra_Comm object is required for all Epetra_LocalMap
constructors.
C++ includes: Epetra_LocalMap.h