ForTrilinos
Data Types
FEpetra_BlockMap Module Reference

Data Types

type  Epetra_BlockMap

Functions/Subroutines

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

Function/Subroutine Documentation

logical FEpetra_BlockMap::DistributedGlobal ( type(Epetra_BlockMap),intent(in)  this)


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

integer(c_int) 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) 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) 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:
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.
Num_MyElementsNumber of elements owned by the calling processor.
Element_SizeNumber of points or vector entries per element.
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) FEpetra_BlockMap::Epetra_BlockMap ( integer(c_int),intent(in)  Num_GlobalElements,
integer(c_int),intent(in)  Num_MyElements,
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:
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.
Num_MyElementsNumber of elements owned by the calling processor.
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.
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.
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) FEpetra_BlockMap::Epetra_BlockMap ( type(Epetra_BlockMap),intent(in)  this)


Epetra_BlockMap copy constructor

Parameters:
thisEpetra_BlockMap object to copy
type(Epetra_BlockMap) 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:
Num_GlobalElementsNumber of elements to distribute.
Element_SizeNumber of points or vector entries per element.
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) FEpetra_BlockMap::Epetra_BlockMap ( integer(c_int),intent(in)  Num_GlobalElements,
integer(c_int),intent(in)  Num_MyElements,
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:
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.
Num_MyElementsNumber of elements owned by the calling processor.
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.
Element_SizeNumber of points or vector entries per element.
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) FEpetra_BlockMap::IndexBase ( type(Epetra_BlockMap),intent(in)  this)


Index base for this map.

logical 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),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) FEpetra_BlockMap::NumGlobalElements ( type(Epetra_BlockMap),intent(in)  this)


Number of elements across all processors.

integer(c_int) FEpetra_BlockMap::NumMyElements ( type(Epetra_BlockMap),intent(in)  this)


Number of elements on the calling processor.

logical 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 FEpetra_BlockMap::SameAs ( type(Epetra_BlockMap),intent(in)  lhs,
type(Epetra_BlockMap),intent(in)  rhs 
)


Returns true if this and Map are identical maps.

 All Classes Namespaces Files Functions