Next:
1 MCTWorld
Up:
mct_APIs
Previous:
Contents
Contents
1
Basic API's and associated communication routines
Subsections
1
MCTWorld
1
.
1
Module m_MCTWorld - MCTWorld Class (Source File: m_MCTWorld.F90)
1
.
1
.
1
initialized_ - determine if MCTWorld is initialized
1
.
1
.
2
initm_ - initialize MCTWorld
1
.
1
.
3
initd_ - initialize MCTWorld
1
.
1
.
4
initr_ - initialize MCTWorld from global root
1
.
1
.
5
clean_ - Destroy a MCTWorld
1
.
1
.
6
NumComponents_ - Determine number of components in World.
1
.
1
.
7
ComponentNumProcs_ - Number of processes a component owns.
1
.
1
.
8
ComponentRootRank_ - Rank of component root on COMM_WORLD.
2
The Attribute Vector
2
.
1
Module m_AttrVect - Multi-field Storage (Source File: m_AttrVect.F90)
2
.
1
.
1
init_ - Initialize an AttrVect Given Attribute Lists and Length
2
.
1
.
2
initv_ - Initialize One AttrVect from Another
2
.
1
.
3
initl_ - Initialize an AttrVect Using the List Type
2
.
1
.
4
clean_ - Deallocate Allocated Memory Structures of an AttrVect
2
.
1
.
5
lsize_ - Length of an AttrVect
2
.
1
.
6
nIAttr_ - Return the Number of Integer Attributes
2
.
1
.
7
getRList_ - Retrieve the Name of a Numbered Real Attribute
2
.
1
.
8
indexIA_ - Index an Integer Attribute
2
.
1
.
9
indexRA_ - Index a Real Attribute
2
.
1
.
10
appendIAttr_ - Append one or more attributes onto the INTEGER part of an AttrVect.
2
.
1
.
11
appendRAttr_ - Append one or more attributes onto the REAL part of an AttrVect.
2
.
1
.
12
exportIList_ - Return INTEGER Attribute List
2
.
1
.
13
exportRList_ - Return REAL attribute List
2
.
1
.
14
exportIListToChar_ - Return AttrVect%iList as CHARACTER
2
.
1
.
15
exportRListToChar_ - Return AttrVect%rList as CHARACTER
2
.
1
.
16
exportIAttr_ - Return INTEGER Attribute as a Vector
2
.
1
.
17
exportRAttrSP_ - Return REAL Attribute as a Pointer to Array
2
.
1
.
18
importIAttr_ - Import INTEGER Vector as an Attribute
2
.
1
.
19
importRAttrSP_ - Import REAL Vector as an Attribute
2
.
1
.
20
RCopy_ - Copy Real Attributes from One AttrVect to Another
2
.
1
.
21
RCopyL_ - Copy Specific Real Attributes from One AttrVect to Another
2
.
1
.
22
ICopy_ - Copy Integer Attributes from One AttrVect to Another
2
.
1
.
23
ICopyL_ - Copy Specific Integer Attributes from One AttrVect to Another
2
.
1
.
24
Copy_ - Copy Real and Integer Attributes from One AttrVect to Another
2
.
1
.
25
Sort_ - Use Attributes as Keys to Generate an Index Permutation
2
.
1
.
26
Permute_ - Permute AttrVect Elements
2
.
1
.
27
Unpermute_ - Unpermute AttrVect Elements
2
.
1
.
28
SortPermute_ - In-place Lexicographic Sort of an AttrVect
2
.
1
.
29
aVaVSharedAttrIndexList_ - AttrVect shared attributes.
2
.
1
.
30
SharedIndices_ - AttrVect shared attributes and auxiliary information
2
.
1
.
31
SharedIndicesOneType_ - AttrVect shared attributes and auxiliary information, for one data type
2
.
1
.
32
cleanSharedIndices_ - Deallocate allocated memory structures of an AVSharedIndices structure
2
.
1
.
33
cleanSharedIndicesOneType_ - Deallocate allocated memory structures of an AVSharedIndicesOneType structure
2
.
2
Module m_AttrVectComms - MPI Communications Methods for the AttrVect (Source File: m_AttrVectComms.F90)
2
.
2
.
1
send_ - Point-to-point Send of an AttrVect
2
.
2
.
2
recv_ - Point-to-point Receive of an AttrVect
2
.
2
.
3
GM_gather_ - Gather an AttrVect Distributed by a GlobalMap
2
.
2
.
4
GSM_gather_ - Gather an AttrVect Distributed by a GlobalSegMap
2
.
2
.
5
GM_scatter_ - Scatter an AttrVect Using a GlobalMap
2
.
2
.
6
GSM_scatter_ - Scatter an AttrVect using a GlobalSegMap
2
.
2
.
7
bcast_ - Broadcast an AttrVect
2
.
3
Module m_AttrVectReduce - Local/Distributed AttrVect Reduction Ops. (Source File: m_AttrVectReduce.F90)
2
.
3
.
1
LocalReduce_ - Local Reduction of INTEGER and REAL Attributes
2
.
3
.
2
LocalReduceRAttr_ - Local Reduction of REAL Attributes
2
.
3
.
3
AllReduce_ - Reduction of INTEGER and REAL Attributes
2
.
3
.
4
GlobalReduce_ - Reduction of INTEGER and REAL Attributes
2
.
3
.
5
LocalWeightedSumRAttrSP_ - Local Weighted Sum of REAL Attributes
2
.
3
.
6
GlobalWeightedSumRAttrSP_ - Global Weighted Sum of REAL Attributes
3
Global Segment Map
3
.
1
Module m_GlobalSegMap - a nontrivial 1-D decomposition of an array. (Source File: m_GlobalSegMap.F90)
3
.
1
.
1
initd_ - define the map from distributed data
3
.
1
.
2
initr_ initialize the map from the root
3
.
1
.
3
initp_ - define the map from replicated data.
3
.
1
.
4
initp1_ - define the map from replicated data using 1 array.
3
.
1
.
5
initp0_ - Null Constructor Using Replicated Data
3
.
1
.
6
init_index_ - initialize GSM from local index arrays
3
.
1
.
7
clean_ - clean the map
3
.
1
.
8
ngseg_ - Return the global number of segments from the map
3
.
1
.
9
nlseg_ - Return the local number of segments from the map
3
.
1
.
10
max_nlseg_ - Return the max number of segments over all procs
3
.
1
.
11
comp_id_ - Return the commponent ID from the GlobalSegMap.
3
.
1
.
12
gsize_ - Return the global vector size from the GlobalSegMap.
3
.
1
.
13
GlobalStorage_ - Return global storage space required.
3
.
1
.
14
ProcessStorage_ - Number of points on a given process.
3
.
1
.
15
OrderedPoints_ - The grid points on a given process
3
.
1
.
16
lsize_ - find the local storage size from the map
3
.
1
.
17
rank1_ - rank which process owns a datum with given global
3
.
1
.
18
rankm_ - rank which processes own a datum with given global
3
.
1
.
19
active_pes_ - number of processes that own data.
3
.
1
.
20
peLocs_ - process ID locations for distributed points.
3
.
1
.
21
haloed_ - test GlobalSegMap for presence of halo points.
3
.
1
.
22
Sort_ - generate index permutation for GlobalSegMap.
3
.
1
.
23
PermuteInPlace_ - apply index permutation to GlobalSegMap.
3
.
1
.
24
SortPermuteInPlace_ - Sort in-place GlobalSegMap components.
3
.
1
.
25
increasing_ - Return .TRUE. if GSMap has increasing indices
3
.
1
.
26
copy_ - Copy the gsmap to a new gsmap
3
.
2
Module m_GlobalSegMapComms - GlobalSegMap Communications Support (Source File: m_GlobalSegMapComms.F90)
3
.
2
.
1
send_ - Point-to-point blocking Send of a GlobalSegMap
3
.
2
.
2
isend_ - Point-to-point Non-blocking Send of a GlobalSegMap
3
.
2
.
3
recv_ - Point-to-point blocking Receive of a GlobalSegMap
3
.
2
.
4
bcast_ - broadcast a GlobalSegMap object
4
The Router
4
.
1
Module m_Router - Router class (Source File: m_Router.F90)
4
.
1
.
1
initd_ - initialize a Router between two seperate components
4
.
1
.
2
initp_ - initialize a Router from two GlobalSegMaps
4
.
1
.
3
clean_ - Destroy a Router
4
.
1
.
4
print_ - Print router info
5
The General Grid
5
.
1
Module m_GeneralGrid - Physical Coordinate Grid Information Storage (Source File: m_GeneralGrid.F90)
5
.
1
.
1
init_ - Create an Empty GeneralGrid
5
.
1
.
2
initl_ - Create an Empty GeneralGrid from Lists
5
.
1
.
3
initgg_ - Create a GeneralGrid from Another
5
.
1
.
4
initCartesianSP_ - Initialize a Cartesian GeneralGrid
5
.
1
.
5
initUnstructuredSP_ - Initialize an Unstructured GeneralGrid
5
.
1
.
6
clean_ - Destroy a GeneralGrid
5
.
1
.
7
zero_ - Set GeneralGrid Data to Zero
5
.
1
.
8
dims_ - Return the Dimensionality of a GeneralGrid
5
.
1
.
9
indexIA - Index an Integer Attribute
5
.
1
.
10
indexRA - Index a Real Attribute
5
.
1
.
11
lsize - Number of Grid Points
5
.
1
.
12
exportIAttr_ - Return GeneralGrid INTEGER Attribute as a Vector
5
.
1
.
13
exportRAttrSP_ - Return GeneralGrid REAL Attribute as a Vector
5
.
1
.
14
importIAttr_ - Import GeneralGrid INTEGER Attribute
5
.
1
.
15
importRAttrSP_ - Import GeneralGrid REAL Attribute
5
.
1
.
16
Sort_ - Generate Sort Permutation Defined by Arbitrary Keys.
5
.
1
.
17
Sortg_ - Generate Sort Permutation Based on GeneralGrid Keys.
5
.
1
.
18
Permute_ - Permute GeneralGrid Attributes Using Supplied Index Permutation
5
.
1
.
19
SortPermute_ - Sort and Permute GeneralGrid Attributes
5
.
2
Module m_GeneralGridComms - Communications for the GeneralGrid type. (Source File: m_GeneralGridComms.F90)
5
.
2
.
1
send_ - Point-to-point blocking send for the GeneralGrid.
5
.
2
.
2
recv_ - Point-to-point blocking recv for the GeneralGrid.
5
.
2
.
3
GM_gather_ - gather a GeneralGrid using input GlobalMap.
5
.
2
.
4
GSM_gather_ - gather a GeneralGrid using input GlobalSegMap.
5
.
2
.
5
GM_scatter_ - scatter a GeneralGrid using input GlobalMap.
5
.
2
.
6
GSM_scatter_ - scatter a GeneralGrid using input GlobalSegMap.
5
.
2
.
7
bcast_ - Broadcast a GeneralGrid.
5
.
2
.
8
bcastGeneralGridHeader_ - Broadcast the GeneralGrid Header.
5
.
2
.
9
copyGeneralGridHeader_ - Copy the GeneralGrid Header.
6
The Navigator
6
.
1
Module m_Navigator - An Object for Indexing Segments of a Vector (Source File: m_Navigator.F90)
6
.
1
.
1
init_ - Create a Navigator
6
.
1
.
2
clean_ - Destroy a Navigator
6
.
1
.
3
NumSegments_ - Return the Number of Segments
6
.
1
.
4
msize_ - Return the Maximum Capacity for Segment Storage
6
.
1
.
5
VectorLength_ - Return the Navigated Vector's Length
6
.
1
.
6
resize_ - Reset the Number of Segments
6
.
1
.
7
get_ - Retrieve Characteristics of a Segment
6
.
1
.
8
ptr_displs_ - Returns Pointer to the displs(:) Component
6
.
1
.
9
ptr_counts_ - Returns Pointer to counts(:) Component
7
The Global Map
7
.
1
Module m_GlobalMap - One-Dimensional Domain Decomposition Descriptor (Source File: m_GlobalMap.F90)
7
.
1
.
1
initd_ - Collective Creation on the Local Communicator
7
.
1
.
2
initr_ Create a GlobalMap from the Root Process
7
.
1
.
3
init_remote_ Initialize Remote GlobalMap from the Root
7
.
1
.
4
clean_ - Destroy a GlobalMap
7
.
1
.
5
lsize_ - Return Local Segment Length
7
.
1
.
6
gsize_ - Return Global Vector Length
7
.
1
.
7
rank_ - Process ID Location of a Given Vector Element
7
.
1
.
8
bounds_ - First/Last Global Indicies for a Process' Segment
7
.
1
.
9
comp_id_ - Return the Component ID Number
jacob@mcs.anl.gov
