ForTrilinos
 All Classes Files Functions Pages
Data Types | List of all members
fepetra_blockmap Module Reference

Data Types

type  epetra_blockmap
 

Public Member Functions

Constructor Functions
type(epetra_blockmap) function epetra_blockmap (Num_GlobalElements, Element_Size, IndexBase, comm)
 
Epetra_BlockMap constructor for a Epetra-defined uniform linear distribution of constant size elements. More...
 
type(epetra_blockmap) function epetra_blockmap (Num_GlobalElements, Num_MyElements, Element_Size, IndexBase, comm)
 
Epetra_BlockMap constructor for a user-defined linear distribution of constant size elements. More...
 
type(epetra_blockmap) function epetra_blockmap (Num_GlobalElements, My_GlobalElements, Element_Size, IndexBase, comm)
 
Epetra_BlockMap constructor for a user-defined arbitrary distribution of constant size elements. More...
 
type(epetra_blockmap) function epetra_blockmap (Num_GlobalElements, My_GlobalElements, Element_SizeList, IndexBase, comm)
 
Epetra_BlockMap constructor for a user-defined arbitrary distribution of variable size elements. More...
 
type(epetra_blockmap) function epetra_blockmap (this)
 
Epetra_BlockMap copy constructor More...
 
Size and dimension accessor functions
integer(c_int) function numglobalelements (this)
 
Number of elements across all processors. More...
 
integer(c_int) function nummyelements (this)
 
Number of elements on the calling processor. More...
 
integer(c_int) function indexbase (this)
 
Index base for this map. More...
 
integer(c_int) function elementsize (this)
 
Returns the size of elements in the map; only valid if map has constant element size. More...
 
integer(c_int) function elementsize (this, L_ID)
 
Size of element for specified L_ID More...
 
Miscellaneous boolean tests
logical function sameas (lhs, rhs)
 
Returns true if this and Map are identical maps. More...
 
logical function pointsameas (lhs, rhs)
 
Returns true if this and Map have identical point-wise structure. More...
 
logical function linearmap (this)
 
Returns true if the global ID space is contiguously divided (but not necessarily uniformly) across all processors. More...
 
logical function distributedglobal (this)
 
Returns true if map is defined across more than one processor. More...
 
Array accessor functions
integer(c_int) function,
dimension(:), allocatable 
myglobalelements (this)
 
Array containing list of global IDs assigned to the calling processor. More...
 

Member Function/Subroutine Documentation

logical function fepetra_blockmap::distributedglobal ( type(epetra_blockmap), intent(in)  this)


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

integer(c_int) function fepetra_blockmap::elementsize ( type(epetra_blockmap), intent(in)  this)


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

integer(c_int) function fepetra_blockmap::elementsize ( type(epetra_blockmap), intent(in)  this,
integer(c_int), intent(in)  L_ID 
)


Size of element for specified L_ID

type(epetra_blockmap) function fepetra_blockmap::epetra_blockmap ( integer(c_int), intent(in)  Num_GlobalElements,
integer(c_int), intent(in)  Num_MyElements,
integer(c_int), intent(in)  Element_Size,
integer(c_int), intent(in)  IndexBase,
class(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
[in]num_globalelementsNumber of elements to distribute. Must be either -1 or equal to the computed sum of NumMyElements across all processors in the Epetra_Comm communicator.
[in]num_myelementsNumber of elements owned by the calling processor.
[in]element_sizeNumber of points or vector entries per element.
[in]indexbaseMinimum index value used for arrays that use this map. Typically 1 for Fortran.
commPolymorphic type Epetra_Comm communicator containing information on the number of processors.
type(epetra_blockmap) function fepetra_blockmap::epetra_blockmap ( integer(c_int), intent(in)  Num_GlobalElements,
integer(c_int), dimension(:), intent(in)  My_GlobalElements,
integer(c_int), dimension(:), intent(in)  Element_SizeList,
integer(c_int), intent(in)  IndexBase,
class(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
[in]num_globalelementsNumber of elements to distribute. Must be either -1 or equal to the computed sum of NumMyElements across all processors in the Epetra_Comm communicator.
[in]my_globalelementsInteger 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 1 to NumGlobalElements. As long as the index values are consistently defined and used, any set of NumGlobalElements distinct integer values is acceptable.
[in]element_sizelistA 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.
[in]indexbaseMinimum index value used for arrays that use this map. Typically 1 for Fortran.
commPolymorphic type Epetra_Comm communicator containing information on the number of processors.
type(epetra_blockmap) function fepetra_blockmap::epetra_blockmap ( type(epetra_blockmap), intent(in)  this)


Epetra_BlockMap copy constructor

Parameters
[in]thisEpetra_BlockMap object to copy
type(epetra_blockmap) function fepetra_blockmap::epetra_blockmap ( integer(c_int), intent(in)  Num_GlobalElements,
integer(c_int), intent(in)  Element_Size,
integer(c_int), intent(in)  IndexBase,
class(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
[in]num_globalelementsNumber of elements to distribute.
[in]element_sizeNumber of points or vector entries per element.
[in]indexbaseMinimum index value used for arrays that use this map. Typically 1 for Fortran.
commPolymorphic type Epetra_Comm communicator containing information on the number of processors.
type(epetra_blockmap) function fepetra_blockmap::epetra_blockmap ( integer(c_int), intent(in)  Num_GlobalElements,
integer(c_int), dimension(:), intent(in)  My_GlobalElements,
integer(c_int), intent(in)  Element_Size,
integer(c_int), intent(in)  IndexBase,
class(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
[in]num_globalelementsNumber of elements to distribute. Must be either -1 or equal to the computed sum of NumMyElements across all processors in the Epetra_Comm communicator.
[in]my_globalelementsInteger 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 1 to NumGlobalElements. As long as the index values are consistently defined and used, any set of NumGlobalElements distinct integer values is acceptable.
[in]element_sizeNumber of points or vector entries per element.
[in]indexbaseMinimum index value used for arrays that use this map. Typically 1 for Fortran.
commPolymorphic type Epetra_Comm communicator containing information on the number of processors.
integer(c_int) function fepetra_blockmap::indexbase ( type(epetra_blockmap), intent(in)  this)


Index base for this map.

logical function fepetra_blockmap::linearmap ( type(epetra_blockmap), intent(in)  this)


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

integer(c_int) function, dimension(:), allocatable fepetra_blockmap::myglobalelements ( type(epetra_blockmap), intent(in)  this)


Array containing list of global IDs assigned to the calling processor.

integer(c_int) function fepetra_blockmap::numglobalelements ( type(epetra_blockmap), intent(in)  this)


Number of elements across all processors.

integer(c_int) function fepetra_blockmap::nummyelements ( type(epetra_blockmap), intent(in)  this)


Number of elements on the calling processor.

logical function fepetra_blockmap::pointsameas ( type(epetra_blockmap), intent(in)  lhs,
type(epetra_blockmap), intent(in)  rhs 
)


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

logical function fepetra_blockmap::sameas ( type(epetra_blockmap), intent(in)  lhs,
type(epetra_blockmap), intent(in)  rhs 
)


Returns true if this and Map are identical maps.


The documentation for this module was generated from the following file: