Epetra Package Browser (Single Doxygen Collection) Development
Private Member Functions | Private Attributes | Friends
Epetra_BlockMap Class Reference

Epetra_BlockMap: A class for partitioning block element vectors and matrices. More...

#include <Epetra_BlockMap.h>

Inheritance diagram for Epetra_BlockMap:
Inheritance graph
[legend]

List of all members.

Private Member Functions

void GlobalToLocalSetup ()
bool DetermineIsOneToOne () const
bool IsDistributedGlobal (long long NumGlobalElements, int NumMyElements) const
void CheckValidNGE (long long NumGlobalElements)
void EndOfConstructorOps ()
void CleanupData ()
void ConstructAutoUniform (long long NumGlobal_Elements, int Element_Size, long long Index_Base, const Epetra_Comm &comm, bool IsLongLong)
void ConstructUserLinear (long long NumGlobal_Elements, int NumMy_Elements, int Element_Size, long long Index_Base, const Epetra_Comm &comm, bool IsLongLong)
template<typename int_type >
void ConstructUserConstant (int_type NumGlobal_Elements, int NumMy_Elements, const int_type *myGlobalElements, int Element_Size, int_type indexBase, const Epetra_Comm &comm, bool IsLongLong)
template<typename int_type >
void ConstructUserVariable (int_type NumGlobal_Elements, int NumMy_Elements, const int_type *myGlobalElements, const int *elementSizeList, int_type indexBase, const Epetra_Comm &comm, bool IsLongLong)
template<typename int_type >
int_type & MyGlobalElementVal (int i)
template<typename int_type >
int_type MyGlobalElementValGet (int i)
template<typename int_type >
int SizeMyGlobalElement (int n)
template<typename int_type >
void TGlobalToLocalSetup ()

Private Attributes

Epetra_BlockMapDataBlockMapData_

Friends

class Epetra_Directory
class Epetra_LocalMap

Constructors/destructors

 Epetra_BlockMap (int NumGlobalElements, int ElementSize, int IndexBase, const Epetra_Comm &Comm)
 Epetra_BlockMap constructor for a Epetra-defined uniform linear distribution of constant size elements.
 Epetra_BlockMap (long long NumGlobalElements, int ElementSize, int IndexBase, const Epetra_Comm &Comm)
 Epetra_BlockMap (long long NumGlobalElements, int ElementSize, long long IndexBase, const Epetra_Comm &Comm)
 Epetra_BlockMap (int NumGlobalElements, int NumMyElements, int ElementSize, int IndexBase, const Epetra_Comm &Comm)
 Epetra_BlockMap constructor for a user-defined linear distribution of constant size elements.
 Epetra_BlockMap (long long NumGlobalElements, int NumMyElements, int ElementSize, int IndexBase, const Epetra_Comm &Comm)
 Epetra_BlockMap (long long NumGlobalElements, int NumMyElements, int ElementSize, long long IndexBase, const Epetra_Comm &Comm)
 Epetra_BlockMap (int NumGlobalElements, int NumMyElements, const int *MyGlobalElements, int ElementSize, int IndexBase, const Epetra_Comm &Comm)
 Epetra_BlockMap constructor for a user-defined arbitrary distribution of constant size elements.
 Epetra_BlockMap (long long NumGlobalElements, int NumMyElements, const long long *MyGlobalElements, int ElementSize, int IndexBase, const Epetra_Comm &Comm)
 Epetra_BlockMap (long long NumGlobalElements, int NumMyElements, const long long *MyGlobalElements, int ElementSize, long long IndexBase, const Epetra_Comm &Comm)
 Epetra_BlockMap (int NumGlobalElements, int NumMyElements, const int *MyGlobalElements, const int *ElementSizeList, int IndexBase, const Epetra_Comm &Comm)
 Epetra_BlockMap constructor for a user-defined arbitrary distribution of variable size elements.
 Epetra_BlockMap (long long NumGlobalElements, int NumMyElements, const long long *MyGlobalElements, const int *ElementSizeList, int IndexBase, const Epetra_Comm &Comm)
 Epetra_BlockMap (long long NumGlobalElements, int NumMyElements, const long long *MyGlobalElements, const int *ElementSizeList, long long IndexBase, const Epetra_Comm &Comm)
 Epetra_BlockMap (const Epetra_BlockMap &map)
 Epetra_BlockMap copy constructor.
virtual ~Epetra_BlockMap (void)
 Epetra_BlockMap destructor.

Local/Global ID accessor methods

int RemoteIDList (int NumIDs, const int *GIDList, int *PIDList, int *LIDList) const
 Returns the processor IDs and corresponding local index value for a given list of global indices.
int RemoteIDList (int NumIDs, const long long *GIDList, int *PIDList, int *LIDList) const
int RemoteIDList (int NumIDs, const int *GIDList, int *PIDList, int *LIDList, int *SizeList) const
 Returns the processor IDs, corresponding local index value, and element size for a given list of global indices.
int RemoteIDList (int NumIDs, const long long *GIDList, int *PIDList, int *LIDList, int *SizeList) const
int LID (int GID) const
 Returns local ID of global ID, return -1 if not found on this processor.
int LID (long long GID) const
int GID (int LID) const
 Returns global ID of local ID, return IndexBase-1 if not found on this processor.
long long GID64 (int LID) const
int FindLocalElementID (int PointID, int &ElementID, int &ElementOffset) const
 Returns the LID of the element that contains the given local PointID, and the Offset of the point in that element.
bool MyGID (int GID_in) const
 Returns true if the GID passed in belongs to the calling processor in this map, otherwise returns false.
bool MyGID (long long GID_in) const
bool MyLID (int LID_in) const
 Returns true if the LID passed in belongs to the calling processor in this map, otherwise returns false.
int MinAllGID () const
 Returns the minimum global ID across the entire map.
long long MinAllGID64 () const
int MaxAllGID () const
 Returns the maximum global ID across the entire map.
long long MaxAllGID64 () const
int MinMyGID () const
 Returns the maximum global ID owned by this processor.
long long MinMyGID64 () const
int MaxMyGID () const
 Returns the maximum global ID owned by this processor.
long long MaxMyGID64 () const
int MinLID () const
 The minimum local index value on the calling processor.
int MaxLID () const
 The maximum local index value on the calling processor.

Size and dimension accessor functions

int NumGlobalElements () const
 Number of elements across all processors.
long long NumGlobalElements64 () const
int NumMyElements () const
 Number of elements on the calling processor.
int MyGlobalElements (int *MyGlobalElementList) const
 Puts list of global elements on this processor into the user-provided array.
int MyGlobalElements (long long *MyGlobalElementList) const
int MyGlobalElementsPtr (int *&MyGlobalElementList) const
int MyGlobalElementsPtr (long long *&MyGlobalElementList) const
int ElementSize () const
 Returns the size of elements in the map; only valid if map has constant element size.
int ElementSize (int LID) const
 Size of element for specified LID.
int FirstPointInElement (int LID) const
 Returns the requested entry in the FirstPointInElementList; see FirstPointInElementList() for details.
int IndexBase () const
 Index base for this map.
long long IndexBase64 () const
int NumGlobalPoints () const
 Number of global points for this map; equals the sum of all element sizes across all processors.
long long NumGlobalPoints64 () const
int NumMyPoints () const
 Number of local points for this map; equals the sum of all element sizes on the calling processor.
int MinMyElementSize () const
 Minimum element size on the calling processor.
int MaxMyElementSize () const
 Maximum element size on the calling processor.
int MinElementSize () const
 Minimum element size across all processors.
int MaxElementSize () const
 Maximum element size across all processors.

Miscellaneous boolean tests

bool UniqueGIDs () const
 Returns true if map GIDs are 1-to-1.
bool GlobalIndicesInt () const
 Returns true if map create with int NumGlobalElements.
bool GlobalIndicesLongLong () const
 Returns true if map create with long long NumGlobalElements.
template<typename int_type >
bool GlobalIndicesIsType () const
bool GlobalIndicesTypeValid () const
bool GlobalIndicesTypeMatch (const Epetra_BlockMap &other) const
bool ConstantElementSize () const
 Returns true if map has constant element size.
bool SameAs (const Epetra_BlockMap &Map) const
 Returns true if this and Map are identical maps.
bool PointSameAs (const Epetra_BlockMap &Map) const
 Returns true if this and Map have identical point-wise structure.
bool LinearMap () const
 Returns true if the global ID space is contiguously divided (but not necessarily uniformly) across all processors.
bool DistributedGlobal () const
 Returns true if map is defined across more than one processor.

Array accessor functions

int * MyGlobalElements () const
 Pointer to internal array containing list of global IDs assigned to the calling processor.
long long * MyGlobalElements64 () const
void MyGlobalElements (const int *&IntGIDs, const long long *&LLGIDs) const
void MyGlobalElements (int *&IntGIDs, long long *&LLGIDs)
int * FirstPointInElementList () const
 Pointer to internal array containing a mapping between the local elements and the first local point number in each element.
int * ElementSizeList () const
 List of the element sizes corresponding to the array MyGlobalElements().
int * PointToElementList () const
 For each local point, indicates the local element ID that the point belongs to.
int ElementSizeList (int *ElementSizeList) const
 Same as ElementSizeList() except it fills the user array that is passed in.
int FirstPointInElementList (int *FirstPointInElementList) const
 Same as FirstPointInElementList() except it fills the user array that is passed in.
int PointToElementList (int *PointToElementList) const
 Same as PointToElementList() except it fills the user array that is passed in.

Miscellaneous

virtual void Print (ostream &os) const
 Print object to an output stream.
const Epetra_CommComm () const
 Access function for Epetra_Comm communicator.
bool IsOneToOne () const
Epetra_BlockMapoperator= (const Epetra_BlockMap &map)
 Assignment Operator.

Expert Users and Developers Only

int ReferenceCount () const
 Returns the reference count of BlockMapData.
const Epetra_BlockMapDataDataPtr () const
 Returns a pointer to the BlockMapData instance this BlockMap uses.

Detailed Description

Epetra_BlockMap: A class for partitioning block element vectors and matrices.

It is often the case that multiple matrix and vector objects have an identical distribution of elements on a parallel machine. The Epetra_BlockMap class keeps information that describes this distribution for matrices and vectors that have block elements. The definition of an element can vary depending on the situation. For vectors (and multi-vectors), an element is a span of one or more contiguous entries. For matrices, it is a span of one or more matrix rows. More generally, an element in the BlockMap class is an ordered list of points. (NOTE: Points do not have global ID's.) Two additional definitions useful in understanding the BlockMap class follow:

This class has a variety of constructors that can be separated into two categories:

  1. Fixed element size constructors: All map elements have an identical size. This corresponds to a block partitioning of matrices and vectors where the element size is the same for all elements. A common example is multiple degrees of freedom per mesh node in finite element computations where the number of degrees of freedom is the same for all nodes.
  2. Variable element size constructor: Map element sizes may vary and are individually defined via a list of element sizes. This is the most general case and corresponds to a variable block partitioning of the matrices and vectors. A common example is multiple degrees of freedom per mesh node in finite element computations where the number of degrees of freedom varies. This happens, for example, if regions have differing material types or there are chemical reactions in the simulation.

Epetra_BlockMap allows the storage and retrieval of the following information. Depending on the constructor that is used, some of the information is defined by the user and some is determined by the constructor. Once an Epetra_BlockMap is constructed any of the following can be obtained by calling a query function that has the same name as the attribute, e.g. to get the value of NumGlobalElements, you can call a function NumGlobalElements(). For attributes that are lists, the query functions return the list values in a user allocated array.

In addition to the information above that is passed in to or created by the Epetra_BlockMap constructor, the following attributes are computed and available via query to the user using the same scheme as above, e.g., use NumGlobalPoints() to get the value of NumGlobalPoints.

The following functions allow boolean tests for certain properties.

Warning:
A Epetra_Comm object is required for all Epetra_BlockMap constructors.

{error handling}

Most methods in Epetra_BlockMap return an integer error code. If the error code is 0, then no error occurred. If > 0 then a warning error occurred. If < 0 then a fatal error occurred.

Epetra_BlockMap constructors will throw an exception of an error occurrs. These exceptions will alway be negative integer values as follows:

  1. -1 NumGlobalElements < -1. Should be >= -1 (Should be >= 0 for first BlockMap constructor).
  2. -2 NumMyElements < 0. Should be >= 0.
  3. -3 ElementSize <= 0. Should be > 0.
  4. -4 Invalid NumGlobalElements. Should equal sum of MyGlobalElements, or set to -1 to compute automatically.
  5. -5 Minimum global element index is less than index base.
  6. -99 Internal Epetra_BlockMap error. Contact developer.

For robust code, Epetra_BlockMap constructor calls should be caught using the try {...} catch {...} mechanism. For example:

  try {

    Epetra_BlockMap * map = new Epetra_BlockMap(NumGlobalElements, ElementSize, IndexBase, Comm);
  }
  catch (int Error) {
    if (Error==-1) { // handle error }
    if (Error==-2) ...
Note:
{ In the current implementation, Epetra_BlockMap is the base class for: }

Definition at line 194 of file Epetra_BlockMap.h.


Constructor & Destructor Documentation

Epetra_BlockMap::Epetra_BlockMap ( int  NumGlobalElements,
int  ElementSize,
int  IndexBase,
const Epetra_Comm Comm 
)

Epetra_BlockMap constructor for a Epetra-defined uniform linear distribution of constant size elements.

Creates a map that distributes NumGlobalElements elements evenly across all processors in the Epetra_Comm communicator. If NumGlobalElements does not divide exactly into the number of processors, the first processors in the communicator get one extra element until the remainder is gone.

The elements are defined to have a constant fixed size specified by ElementSize.

Parameters:
InNumGlobalElements - Number of elements to distribute.
InElementSize - Number of points or vector entries per element.
InIndexBase - Minimum index value used for arrays that use this map. Typically 0 for C/C++ and 1 for Fortran.
InComm - Epetra_Comm communicator containing information on the number of processors.
Returns:
Pointer to a Epetra_BlockMap object.

Definition at line 125 of file Epetra_BlockMap.cpp.

Epetra_BlockMap::Epetra_BlockMap ( long long  NumGlobalElements,
int  ElementSize,
int  IndexBase,
const Epetra_Comm Comm 
)

Definition at line 107 of file Epetra_BlockMap.cpp.

Epetra_BlockMap::Epetra_BlockMap ( long long  NumGlobalElements,
int  ElementSize,
long long  IndexBase,
const Epetra_Comm Comm 
)

Definition at line 115 of file Epetra_BlockMap.cpp.

Epetra_BlockMap::Epetra_BlockMap ( int  NumGlobalElements,
int  NumMyElements,
int  ElementSize,
int  IndexBase,
const Epetra_Comm Comm 
)

Epetra_BlockMap constructor for a user-defined linear distribution of constant size elements.

Creates a map that puts NumMyElements on the calling processor. If NumGlobalElements=-1, the number of global elements will be the computed sum of NumMyElements across all processors in the Epetra_Comm communicator.

The elements are defined to have a constant fixed size specified by ElementSize.

Parameters:
InNumGlobalElements - Number of elements to distribute. Must be either -1 or equal to the computed sum of NumMyElements across all processors in the Epetra_Comm communicator.
InNumMyElements - Number of elements owned by the calling processor.
InElementSize - Number of points or vector entries per element.
InIndexBase - Minimum index value used for arrays that use this map. Typically 0 for C/C++ and 1 for Fortran.
InComm - Epetra_Comm communicator containing information on the number of processors.
Returns:
Pointer to a Epetra_BlockMap object.

Definition at line 229 of file Epetra_BlockMap.cpp.

Epetra_BlockMap::Epetra_BlockMap ( long long  NumGlobalElements,
int  NumMyElements,
int  ElementSize,
int  IndexBase,
const Epetra_Comm Comm 
)

Definition at line 209 of file Epetra_BlockMap.cpp.

Epetra_BlockMap::Epetra_BlockMap ( long long  NumGlobalElements,
int  NumMyElements,
int  ElementSize,
long long  IndexBase,
const Epetra_Comm Comm 
)

Definition at line 218 of file Epetra_BlockMap.cpp.

Epetra_BlockMap::Epetra_BlockMap ( int  NumGlobalElements,
int  NumMyElements,
const int *  MyGlobalElements,
int  ElementSize,
int  IndexBase,
const Epetra_Comm Comm 
)

Epetra_BlockMap constructor for a user-defined arbitrary distribution of constant size elements.

Creates a map that puts NumMyElements on the calling processor. The indices of the elements are determined from the list MyGlobalElements. If NumGlobalElements=-1, the number of global elements will be the computed sum of NumMyElements across all processors in the Epetra_Comm communicator.

The elements are defined to have a constant fixed size specified by ElementSize.

Parameters:
InNumGlobalElements - Number of elements to distribute. Must be either -1 or equal to the computed sum of NumMyElements across all processors in the Epetra_Comm communicator.
InNumMyElements - Number of elements owned by the calling processor.
InMyGlobalElements - Integer array of length NumMyElements. The ith entry contains the global index value of the ith element on this processor. Index values are not required to be contiguous on a processor, or to be within the range of 0 to NumGlobalElements. As long as the index values are consistently defined and used, any set of NumGlobalElements distinct integer values is acceptable.
InElementSize - Number of points or vector entries per element.
InIndexBase - Minimum index value used for arrays that use this map. Typically 0 for C/C++ and 1 for Fortran.
InComm - Epetra_Comm communicator containing information on the number of processors.
Returns:
Pointer to a Epetra_BlockMap object.

Definition at line 363 of file Epetra_BlockMap.cpp.

Epetra_BlockMap::Epetra_BlockMap ( long long  NumGlobalElements,
int  NumMyElements,
const long long *  MyGlobalElements,
int  ElementSize,
int  IndexBase,
const Epetra_Comm Comm 
)

Definition at line 337 of file Epetra_BlockMap.cpp.

Epetra_BlockMap::Epetra_BlockMap ( long long  NumGlobalElements,
int  NumMyElements,
const long long *  MyGlobalElements,
int  ElementSize,
long long  IndexBase,
const Epetra_Comm Comm 
)

Definition at line 349 of file Epetra_BlockMap.cpp.

Epetra_BlockMap::Epetra_BlockMap ( int  NumGlobalElements,
int  NumMyElements,
const int *  MyGlobalElements,
const int *  ElementSizeList,
int  IndexBase,
const Epetra_Comm Comm 
)

Epetra_BlockMap constructor for a user-defined arbitrary distribution of variable size elements.

Creates a map that puts NumMyElements on the calling processor. If NumGlobalElements=-1, the number of global elements will be the computed sum of NumMyElements across all processors in the Epetra_Comm communicator.

The elements are defined to have a variable size defined by ElementSizeList.

Parameters:
InNumGlobalElements - Number of elements to distribute. Must be either -1 or equal to the computed sum of NumMyElements across all processors in the Epetra_Comm communicator.
InNumMyElements - Number of elements owned by the calling processor.
InMyGlobalElements - Integer array of length NumMyElements. The ith entry contains the global index value of the ith element on this processor. Index values are not required to be contiguous on a processor, or to be within the range of 0 to NumGlobalElements. As long as the index values are consistently defined and used, any set of NumGlobalElements distinct integer values is acceptable.
InElementSizeList - A list of the element sizes for elements owned by the calling processor. The ith entry contains the element size of the ith element on this processor.
InIndexBase - Minimum index value used for arrays that use this map. Typically 0 for C/C++ and 1 for Fortran.
InComm - Epetra_Comm communicator containing information on the number of processors.
Returns:
Pointer to a Epetra_BlockMap object.

Definition at line 530 of file Epetra_BlockMap.cpp.

Epetra_BlockMap::Epetra_BlockMap ( long long  NumGlobalElements,
int  NumMyElements,
const long long *  MyGlobalElements,
const int *  ElementSizeList,
int  IndexBase,
const Epetra_Comm Comm 
)

Definition at line 504 of file Epetra_BlockMap.cpp.

Epetra_BlockMap::Epetra_BlockMap ( long long  NumGlobalElements,
int  NumMyElements,
const long long *  MyGlobalElements,
const int *  ElementSizeList,
long long  IndexBase,
const Epetra_Comm Comm 
)

Definition at line 516 of file Epetra_BlockMap.cpp.

Epetra_BlockMap::Epetra_BlockMap ( const Epetra_BlockMap map)

Epetra_BlockMap copy constructor.

Definition at line 544 of file Epetra_BlockMap.cpp.

Epetra_BlockMap::~Epetra_BlockMap ( void  ) [virtual]

Epetra_BlockMap destructor.

Definition at line 1347 of file Epetra_BlockMap.cpp.


Member Function Documentation

int Epetra_BlockMap::RemoteIDList ( int  NumIDs,
const int *  GIDList,
int *  PIDList,
int *  LIDList 
) const [inline]

Returns the processor IDs and corresponding local index value for a given list of global indices.

For each element (GID) of a given list of global element numbers (stored in GIDList) of length NumIDs, this function returns (in PIDList) the ID (rank) of the processor that owns the GID for this map and returns the local index (in LIDList) of the GID on that processor.

If a GID is present on more than one processor, the lowest rank processor ID is used, as is the LID for that processor. If a GID is not present on any processor, the corresponding PID will return as -1.

Definition at line 403 of file Epetra_BlockMap.h.

int Epetra_BlockMap::RemoteIDList ( int  NumIDs,
const long long *  GIDList,
int *  PIDList,
int *  LIDList 
) const [inline]

Definition at line 408 of file Epetra_BlockMap.h.

int Epetra_BlockMap::RemoteIDList ( int  NumIDs,
const int *  GIDList,
int *  PIDList,
int *  LIDList,
int *  SizeList 
) const

Returns the processor IDs, corresponding local index value, and element size for a given list of global indices.

For each element (GID) of a given a list of global element numbers (stored in GIDList) of length NumIDs, this function returns (in PIDList) the with processor that owns the GID for this map and returns the local index (in LIDList) of the GID on that processor. Finally it returns the element sizes in SizeList.

Definition at line 1150 of file Epetra_BlockMap.cpp.

int Epetra_BlockMap::RemoteIDList ( int  NumIDs,
const long long *  GIDList,
int *  PIDList,
int *  LIDList,
int *  SizeList 
) const

Definition at line 1174 of file Epetra_BlockMap.cpp.

int Epetra_BlockMap::LID ( int  GID) const

Returns local ID of global ID, return -1 if not found on this processor.

Definition at line 1043 of file Epetra_BlockMap.cpp.

int Epetra_BlockMap::LID ( long long  GID) const

Definition at line 1002 of file Epetra_BlockMap.cpp.

int Epetra_BlockMap::GID ( int  LID) const

Returns global ID of local ID, return IndexBase-1 if not found on this processor.

Definition at line 1107 of file Epetra_BlockMap.cpp.

long long Epetra_BlockMap::GID64 ( int  LID) const

Definition at line 1077 of file Epetra_BlockMap.cpp.

int Epetra_BlockMap::FindLocalElementID ( int  PointID,
int &  ElementID,
int &  ElementOffset 
) const

Returns the LID of the element that contains the given local PointID, and the Offset of the point in that element.

Definition at line 1129 of file Epetra_BlockMap.cpp.

bool Epetra_BlockMap::MyGID ( int  GID_in) const [inline]

Returns true if the GID passed in belongs to the calling processor in this map, otherwise returns false.

Definition at line 451 of file Epetra_BlockMap.h.

bool Epetra_BlockMap::MyGID ( long long  GID_in) const [inline]

Definition at line 454 of file Epetra_BlockMap.h.

bool Epetra_BlockMap::MyLID ( int  LID_in) const [inline]

Returns true if the LID passed in belongs to the calling processor in this map, otherwise returns false.

Definition at line 458 of file Epetra_BlockMap.h.

int Epetra_BlockMap::MinAllGID ( ) const [inline]

Returns the minimum global ID across the entire map.

Definition at line 462 of file Epetra_BlockMap.h.

long long Epetra_BlockMap::MinAllGID64 ( ) const [inline]

Definition at line 468 of file Epetra_BlockMap.h.

int Epetra_BlockMap::MaxAllGID ( ) const [inline]

Returns the maximum global ID across the entire map.

Definition at line 472 of file Epetra_BlockMap.h.

long long Epetra_BlockMap::MaxAllGID64 ( ) const [inline]

Definition at line 478 of file Epetra_BlockMap.h.

int Epetra_BlockMap::MinMyGID ( ) const [inline]

Returns the maximum global ID owned by this processor.

Definition at line 482 of file Epetra_BlockMap.h.

long long Epetra_BlockMap::MinMyGID64 ( ) const [inline]

Definition at line 488 of file Epetra_BlockMap.h.

int Epetra_BlockMap::MaxMyGID ( ) const [inline]

Returns the maximum global ID owned by this processor.

Definition at line 492 of file Epetra_BlockMap.h.

long long Epetra_BlockMap::MaxMyGID64 ( ) const [inline]

Definition at line 498 of file Epetra_BlockMap.h.

int Epetra_BlockMap::MinLID ( ) const [inline]

The minimum local index value on the calling processor.

Definition at line 501 of file Epetra_BlockMap.h.

int Epetra_BlockMap::MaxLID ( ) const [inline]

The maximum local index value on the calling processor.

Definition at line 504 of file Epetra_BlockMap.h.

int Epetra_BlockMap::NumGlobalElements ( ) const [inline]

Number of elements across all processors.

Definition at line 511 of file Epetra_BlockMap.h.

long long Epetra_BlockMap::NumGlobalElements64 ( ) const [inline]

Definition at line 517 of file Epetra_BlockMap.h.

int Epetra_BlockMap::NumMyElements ( ) const [inline]

Number of elements on the calling processor.

Definition at line 520 of file Epetra_BlockMap.h.

int Epetra_BlockMap::MyGlobalElements ( int *  MyGlobalElementList) const

Puts list of global elements on this processor into the user-provided array.

Definition at line 673 of file Epetra_BlockMap.cpp.

int Epetra_BlockMap::MyGlobalElements ( long long *  MyGlobalElementList) const

Definition at line 647 of file Epetra_BlockMap.cpp.

int Epetra_BlockMap::MyGlobalElementsPtr ( int *&  MyGlobalElementList) const

Definition at line 704 of file Epetra_BlockMap.cpp.

int Epetra_BlockMap::MyGlobalElementsPtr ( long long *&  MyGlobalElementList) const

Definition at line 696 of file Epetra_BlockMap.cpp.

int Epetra_BlockMap::ElementSize ( ) const [inline]

Returns the size of elements in the map; only valid if map has constant element size.

Definition at line 538 of file Epetra_BlockMap.h.

int Epetra_BlockMap::ElementSize ( int  LID) const

Size of element for specified LID.

Definition at line 886 of file Epetra_BlockMap.cpp.

int Epetra_BlockMap::FirstPointInElement ( int  LID) const

Returns the requested entry in the FirstPointInElementList; see FirstPointInElementList() for details.

This function provides similar functionality to FirstPointInElementList(), but for simple maps may avoid the explicit construction of the FirstPointInElementList array. Returns -1 if LID is out-of-range.

Definition at line 753 of file Epetra_BlockMap.cpp.

int Epetra_BlockMap::IndexBase ( ) const [inline]

Index base for this map.

Definition at line 551 of file Epetra_BlockMap.h.

long long Epetra_BlockMap::IndexBase64 ( ) const [inline]

Definition at line 557 of file Epetra_BlockMap.h.

int Epetra_BlockMap::NumGlobalPoints ( ) const [inline]

Number of global points for this map; equals the sum of all element sizes across all processors.

Definition at line 561 of file Epetra_BlockMap.h.

long long Epetra_BlockMap::NumGlobalPoints64 ( ) const [inline]

Definition at line 567 of file Epetra_BlockMap.h.

int Epetra_BlockMap::NumMyPoints ( ) const [inline]

Number of local points for this map; equals the sum of all element sizes on the calling processor.

Definition at line 570 of file Epetra_BlockMap.h.

int Epetra_BlockMap::MinMyElementSize ( ) const [inline]

Minimum element size on the calling processor.

Definition at line 573 of file Epetra_BlockMap.h.

int Epetra_BlockMap::MaxMyElementSize ( ) const [inline]

Maximum element size on the calling processor.

Definition at line 576 of file Epetra_BlockMap.h.

int Epetra_BlockMap::MinElementSize ( ) const [inline]

Minimum element size across all processors.

Definition at line 579 of file Epetra_BlockMap.h.

int Epetra_BlockMap::MaxElementSize ( ) const [inline]

Maximum element size across all processors.

Definition at line 582 of file Epetra_BlockMap.h.

bool Epetra_BlockMap::UniqueGIDs ( ) const [inline]

Returns true if map GIDs are 1-to-1.

Certain operations involving Epetra_BlockMap and Epetra_Map objects are well-defined only if the map GIDs are uniquely present in the map. In other words, if a GID occurs in the map, it occurs only once on a single processor and nowhere else. This boolean test returns true if this property is true, otherwise it returns false.

Definition at line 593 of file Epetra_BlockMap.h.

bool Epetra_BlockMap::GlobalIndicesInt ( ) const [inline]

Returns true if map create with int NumGlobalElements.

Definition at line 618 of file Epetra_BlockMap.h.

bool Epetra_BlockMap::GlobalIndicesLongLong ( ) const [inline]

Returns true if map create with long long NumGlobalElements.

Definition at line 620 of file Epetra_BlockMap.h.

bool Epetra_BlockMap::GlobalIndicesIsType< int > ( ) const [inline]

Definition at line 798 of file Epetra_BlockMap.h.

bool Epetra_BlockMap::GlobalIndicesTypeValid ( ) const [inline]

Definition at line 625 of file Epetra_BlockMap.h.

bool Epetra_BlockMap::GlobalIndicesTypeMatch ( const Epetra_BlockMap other) const [inline]

Definition at line 627 of file Epetra_BlockMap.h.

bool Epetra_BlockMap::ConstantElementSize ( ) const [inline]

Returns true if map has constant element size.

Definition at line 640 of file Epetra_BlockMap.h.

bool Epetra_BlockMap::SameAs ( const Epetra_BlockMap Map) const

Returns true if this and Map are identical maps.

Definition at line 555 of file Epetra_BlockMap.cpp.

bool Epetra_BlockMap::PointSameAs ( const Epetra_BlockMap Map) const

Returns true if this and Map have identical point-wise structure.

If both maps have the same number of global points and the same point distribution across processors then this method returns true.

Definition at line 620 of file Epetra_BlockMap.cpp.

bool Epetra_BlockMap::LinearMap ( ) const [inline]

Returns true if the global ID space is contiguously divided (but not necessarily uniformly) across all processors.

Definition at line 652 of file Epetra_BlockMap.h.

bool Epetra_BlockMap::DistributedGlobal ( ) const [inline]

Returns true if map is defined across more than one processor.

Definition at line 655 of file Epetra_BlockMap.h.

int * Epetra_BlockMap::MyGlobalElements ( ) const

Pointer to internal array containing list of global IDs assigned to the calling processor.

Definition at line 712 of file Epetra_BlockMap.cpp.

long long * Epetra_BlockMap::MyGlobalElements64 ( ) const

Definition at line 733 of file Epetra_BlockMap.cpp.

void Epetra_BlockMap::MyGlobalElements ( const int *&  IntGIDs,
const long long *&  LLGIDs 
) const [inline]

Definition at line 670 of file Epetra_BlockMap.h.

void Epetra_BlockMap::MyGlobalElements ( int *&  IntGIDs,
long long *&  LLGIDs 
) [inline]

Definition at line 686 of file Epetra_BlockMap.h.

int * Epetra_BlockMap::FirstPointInElementList ( ) const

Pointer to internal array containing a mapping between the local elements and the first local point number in each element.

This array is a scan sum of the ElementSizeList such that the ith entry in FirstPointInElementList is the sum of the first i-1 entries of ElementSizeList().

Definition at line 796 of file Epetra_BlockMap.cpp.

int * Epetra_BlockMap::ElementSizeList ( ) const

List of the element sizes corresponding to the array MyGlobalElements().

Definition at line 834 of file Epetra_BlockMap.cpp.

int * Epetra_BlockMap::PointToElementList ( ) const

For each local point, indicates the local element ID that the point belongs to.

Definition at line 869 of file Epetra_BlockMap.cpp.

int Epetra_BlockMap::ElementSizeList ( int *  ElementSizeList) const

Same as ElementSizeList() except it fills the user array that is passed in.

Definition at line 814 of file Epetra_BlockMap.cpp.

int Epetra_BlockMap::FirstPointInElementList ( int *  FirstPointInElementList) const

Same as FirstPointInElementList() except it fills the user array that is passed in.

Definition at line 770 of file Epetra_BlockMap.cpp.

int Epetra_BlockMap::PointToElementList ( int *  PointToElementList) const

Same as PointToElementList() except it fills the user array that is passed in.

Definition at line 847 of file Epetra_BlockMap.cpp.

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

Print object to an output stream.

Reimplemented from Epetra_Object.

Definition at line 1256 of file Epetra_BlockMap.cpp.

const Epetra_Comm& Epetra_BlockMap::Comm ( ) const [inline]

Access function for Epetra_Comm communicator.

Definition at line 731 of file Epetra_BlockMap.h.

bool Epetra_BlockMap::IsOneToOne ( ) const

Definition at line 895 of file Epetra_BlockMap.cpp.

Epetra_BlockMap & Epetra_BlockMap::operator= ( const Epetra_BlockMap map)

Assignment Operator.

Definition at line 1365 of file Epetra_BlockMap.cpp.

int Epetra_BlockMap::ReferenceCount ( ) const [inline]

Returns the reference count of BlockMapData.

(Intended for testing purposes.)

Definition at line 745 of file Epetra_BlockMap.h.

const Epetra_BlockMapData* Epetra_BlockMap::DataPtr ( ) const [inline]

Returns a pointer to the BlockMapData instance this BlockMap uses.

(Intended for developer use only for testing purposes.)

Definition at line 749 of file Epetra_BlockMap.h.

void Epetra_BlockMap::GlobalToLocalSetup ( ) [private]

Definition at line 976 of file Epetra_BlockMap.cpp.

bool Epetra_BlockMap::DetermineIsOneToOne ( ) const [private]

Definition at line 1198 of file Epetra_BlockMap.cpp.

bool Epetra_BlockMap::IsDistributedGlobal ( long long  NumGlobalElements,
int  NumMyElements 
) const [private]

Definition at line 1217 of file Epetra_BlockMap.cpp.

void Epetra_BlockMap::CheckValidNGE ( long long  NumGlobalElements) [private]

Definition at line 1235 of file Epetra_BlockMap.cpp.

void Epetra_BlockMap::EndOfConstructorOps ( ) [private]

Definition at line 1248 of file Epetra_BlockMap.cpp.

void Epetra_BlockMap::CleanupData ( ) [private]

Definition at line 1352 of file Epetra_BlockMap.cpp.

void Epetra_BlockMap::ConstructAutoUniform ( long long  NumGlobal_Elements,
int  Element_Size,
long long  Index_Base,
const Epetra_Comm comm,
bool  IsLongLong 
) [private]

Definition at line 56 of file Epetra_BlockMap.cpp.

void Epetra_BlockMap::ConstructUserLinear ( long long  NumGlobal_Elements,
int  NumMy_Elements,
int  Element_Size,
long long  Index_Base,
const Epetra_Comm comm,
bool  IsLongLong 
) [private]

Definition at line 136 of file Epetra_BlockMap.cpp.

template<typename int_type >
void Epetra_BlockMap::ConstructUserConstant ( int_type  NumGlobal_Elements,
int  NumMy_Elements,
const int_type *  myGlobalElements,
int  Element_Size,
int_type  indexBase,
const Epetra_Comm comm,
bool  IsLongLong 
) [private]

Definition at line 241 of file Epetra_BlockMap.cpp.

template<typename int_type >
void Epetra_BlockMap::ConstructUserVariable ( int_type  NumGlobal_Elements,
int  NumMy_Elements,
const int_type *  myGlobalElements,
const int *  elementSizeList,
int_type  indexBase,
const Epetra_Comm comm,
bool  IsLongLong 
) [private]

Definition at line 379 of file Epetra_BlockMap.cpp.

int & Epetra_BlockMap::MyGlobalElementVal< int > ( int  i) [inline, private]

Definition at line 799 of file Epetra_BlockMap.h.

int Epetra_BlockMap::MyGlobalElementValGet< int > ( int  i) [inline, private]

Definition at line 800 of file Epetra_BlockMap.h.

int Epetra_BlockMap::SizeMyGlobalElement< int > ( int  n) [inline, private]

Definition at line 801 of file Epetra_BlockMap.h.

template<typename int_type >
void Epetra_BlockMap::TGlobalToLocalSetup ( ) [private]

Definition at line 905 of file Epetra_BlockMap.cpp.


Friends And Related Function Documentation

friend class Epetra_Directory [friend]

Definition at line 195 of file Epetra_BlockMap.h.

friend class Epetra_LocalMap [friend]

Definition at line 196 of file Epetra_BlockMap.h.


Member Data Documentation

Definition at line 762 of file Epetra_BlockMap.h.


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