ForTrilinos
Data Types
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...

Functions/Subroutines

Constructor Functions
type(Epetra_ExportEpetra_Export (Source_Map, Target_Map)
 
Epetra_Export Constructor
type(Epetra_ExportEpetra_Export (this)
 
Constructs a copy of a Epetra_Export object
Public Member Functions
integer(c_int) NumSameIDs (this)
 Returns the number of elements that are identical between the source and target maps, up to the first different ID.
integer(c_int) NumPermuteIDs (this)
 Returns the number of elements that are local to the calling processor, but not part of the first NumSameIDs() elements.
integer(c_int) NumRemoteIDs (this)
 Returns the number of elements that are not on the calling processor.
integer(c_int) NumExportIDs (this)
 Returns the number of elements that must be sent by the calling processor to other processors.
integer(c_int) NumSend (this)
 Total number of elements to be sent.
integer(c_int) NumRecv (this)
 Total number of elements to be received.
type(Epetra_BlockMapSourceMap (this)
 Returns the SourceMap used to construct this exporter.
type(Epetra_BlockMapTargetMap (this)
 Returns the TargetMap used to construct this exporter.

Function/Subroutine Documentation

type(Epetra_Export) 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:
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.
Target_MapTargetMap (In) Map containing the GIDs that should be used for exporting data.
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) 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) 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) 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) FEpetra_Export::NumRecv ( class(Epetra_Export),intent(in)  this)

Total number of elements to be received.

integer(c_int) FEpetra_Export::NumRemoteIDs ( class(Epetra_Export),intent(in)  this)

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

integer(c_int) 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) FEpetra_Export::NumSend ( class(Epetra_Export),intent(in)  this)

Total number of elements to be sent.

type(Epetra_BlockMap) FEpetra_Export::SourceMap ( class(Epetra_Export),intent(in)  this)

Returns the SourceMap used to construct this exporter.

type(Epetra_BlockMap) FEpetra_Export::TargetMap ( class(Epetra_Export),intent(in)  this)

Returns the TargetMap used to construct this exporter.

 All Classes Namespaces Files Functions