The Initialize_Distributed_Vector procedure allocates and initializes a Distributed_Vector object.
Calling syntax:
call Initialize (DV, Structure, Dimensionality, Name, status, dim1, dim2, dim3) |
Input variables:
DV | The Distributed_Vector object to be initialized. | ||
Structure | The basic data structure for this Distributed_Vector. | ||
Dimensionality | The number of dimensions that the ``vector'' has, including the dimension that is spread over the processors. ``Ragged_Right'' vectors are signified by a Dimensionality of -1. | ||
Name | The name for this variable (especially useful in a vector of Distributed Vectors). [Optional] | ||
dim{n} | The dimensions for this ``vector''. There must be dimensions specified up to a number one less than the Dimensionality. [Optional] |
Output variables:
DV | The Distributed_Vector object has been allocated and initialized. | ||
status | If present, the status variable is set to either 'Memory Error' or 'Success' depending on program execution. If not present, the procedure aborts if unsuccessful when the DEBUG_LEVEL is set high enough. |
Internal variables:
allocate_status | Allocation Status. | ||
consolidated_status | Consolidated Status. | ||
NSlice | Number of values that are on one slice, given by a constant location on the distributed axis. |
The Initialize_Distributed_Vector code listing contains additional documentation.
Michael L. Hall