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

Data Types

type  epetra_export
 
Epetra_Export: This class builds an export object for efficient exporting of off-processor elements. More...
 

Public Member Functions

Constructor Functions
type(epetra_export) function epetra_export (Source_Map, Target_Map)
 
Epetra_Export Constructor More...
 
type(epetra_export) function epetra_export (this)
 
Constructs a copy of a Epetra_Export object More...
 
Public Member Functions
integer(c_int) function numsameids (this)
 Returns the number of elements that are identical between the source and target maps, up to the first different ID. More...
 
integer(c_int) function numpermuteids (this)
 Returns the number of elements that are local to the calling processor, but not part of the first NumSameIDs() elements. More...
 
integer(c_int) function numremoteids (this)
 Returns the number of elements that are not on the calling processor. More...
 
integer(c_int) function numexportids (this)
 Returns the number of elements that must be sent by the calling processor to other processors. More...
 
integer(c_int) function numsend (this)
 Total number of elements to be sent. More...
 
integer(c_int) function numrecv (this)
 Total number of elements to be received. More...
 
type(epetra_blockmap) function sourcemap (this)
 Returns the SourceMap used to construct this exporter. More...
 
type(epetra_blockmap) function targetmap (this)
 Returns the TargetMap used to construct this exporter. More...
 

Member Function/Subroutine Documentation

type(epetra_export) function fepetra_export::epetra_export ( class(epetra_blockmap), intent(in)  Source_Map,
class(epetra_blockmap), intent(in)  Target_Map 
)


Epetra_Export Constructor

Constructs a Epetra_Export object from the source and target maps. This constructor builds an Epetra_Export object by comparing the GID lists of the source and target maps.

Parameters
[in]source_mapSourceMap (In) Map containing the GIDs from which data should be exported from each processor to the target map whenever an export operation is performed using this exporter.
[in]target_mapTargetMap (In) Map containing the GIDs that should be used for exporting data.
[in]target_map
Warning: Note that the TargetMap must have GIDs uniquely owned, each GID of the target map can occur only lds an export object that will transfer objects built with SourceMap to objects built with TargetMap.

A Epetra_Export object categorizes the elements of the target map into three sets as follows:
  • All elements in the target map that have the same GID as the corresponding element of the source map, starting with the first element in the target map, going up to the first element that is different from the source map. The number of these IDs is returned by NumSameIDs().
  • All elements that are local to the processor, but are not part of the first set of elements. These elements have GIDs that are owned by the calling processor, but at least the first element of this list is permuted. Even if subsequent elements are not permuted, they are included in this list. The number of permuted elements is returned by NumPermutedIDs(). The list of elements (local IDs) in the source map that are permuted can be found in the list PermuteFromLIDs(). The list of elements (local IDs) in the target map that are the new locations of the source elements can be found in the list PermuteToLIDs().
  • All remaining elements of the target map correspond to global IDs that are owned by remote processors. The number of these elements is returned by NumRemoteIDs() and the list of these is returned by RemoteLIDs().
    See Trilinos Epetra_Import documentation for an example.
type(epetra_export) function fepetra_export::epetra_export ( type(epetra_export), intent(in)  this)


Constructs a copy of a Epetra_Export object

This constructor returns a copy of an Epetra_Export object.

integer(c_int) function fepetra_export::numexportids ( class(epetra_export), intent(in)  this)

Returns the number of elements that must be sent by the calling processor to other processors.

integer(c_int) function fepetra_export::numpermuteids ( class(epetra_export), intent(in)  this)

Returns the number of elements that are local to the calling processor, but not part of the first NumSameIDs() elements.

integer(c_int) function fepetra_export::numrecv ( class(epetra_export), intent(in)  this)

Total number of elements to be received.

integer(c_int) function fepetra_export::numremoteids ( class(epetra_export), intent(in)  this)

Returns the number of elements that are not on the calling processor.

integer(c_int) function fepetra_export::numsameids ( class(epetra_export), intent(in)  this)

Returns the number of elements that are identical between the source and target maps, up to the first different ID.

integer(c_int) function fepetra_export::numsend ( class(epetra_export), intent(in)  this)

Total number of elements to be sent.

type(epetra_blockmap) function fepetra_export::sourcemap ( class(epetra_export), intent(in)  this)

Returns the SourceMap used to construct this exporter.

type(epetra_blockmap) function fepetra_export::targetmap ( class(epetra_export), intent(in)  this)

Returns the TargetMap used to construct this exporter.


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