Epetra_LocalMap Class Reference

Epetra_LocalMap: A class for replicating vectors and matrices across multiple processors. More...

#include <Epetra_LocalMap.h>

Inheritance diagram for Epetra_LocalMap:

List of all members.

Public Member Functions

 Epetra_LocalMap (int NumMyElements, int IndexBase, const Epetra_Comm &Comm)
 Epetra_LocalMap constructor for a user-defined replicate distribution of elements.
 Epetra_LocalMap (const Epetra_LocalMap &map)
 Epetra_LocalMap copy constructor.
virtual ~Epetra_LocalMap ()
 Epetra_LocalMap destructor.
Epetra_LocalMapoperator= (const Epetra_LocalMap &map)
 Assignment Operator.

Private Member Functions

int CheckInput ()

Detailed Description

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.

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:

A Epetra_Comm object is required for all Epetra_LocalMap constructors.

Definition at line 76 of file Epetra_LocalMap.h.

Constructor & Destructor Documentation

Epetra_LocalMap::Epetra_LocalMap int  NumMyElements,
int  IndexBase,
const Epetra_Comm Comm

Epetra_LocalMap constructor for a user-defined replicate distribution of elements.

Creates a map that puts NumMyElements on the calling processor. Each processor should pass in the same value for NumMyElements.

In NumMyElements - Number of elements owned by the calling processor.
In IndexBase - Minimum index value used for arrays that use this map. Typically 0 for C/C++ and 1 for Fortran.
In Comm - Epetra_Comm communicator containing information on the number of processors.
Pointer to a Epetra_Map object.

Definition at line 34 of file Epetra_LocalMap.cpp.

Epetra_LocalMap::Epetra_LocalMap const Epetra_LocalMap map  ) 

Epetra_LocalMap copy constructor.

Definition at line 44 of file Epetra_LocalMap.cpp.

Epetra_LocalMap::~Epetra_LocalMap  )  [virtual]

Epetra_LocalMap destructor.

Definition at line 68 of file Epetra_LocalMap.cpp.

Member Function Documentation

Epetra_LocalMap & Epetra_LocalMap::operator= const Epetra_LocalMap map  ) 

Assignment Operator.

Definition at line 72 of file Epetra_LocalMap.cpp.

int Epetra_LocalMap::CheckInput  )  [private]

Definition at line 52 of file Epetra_LocalMap.cpp.

The documentation for this class was generated from the following files:
Generated on Thu Sep 18 12:38:05 2008 for Epetra Package Browser (Single Doxygen Collection) by doxygen