10.7.1 Initialize_Overlapped_Vector Procedure

The Initialize_Overlapped_Vector procedure allocates and initializes a Overlapped_Vector object. There are two ways to initialize an Overlapped_Vector object, depending on whether or not the underlying Distributed_Vector object is internally created.

Calling syntax:

call Initialize (OV, DV, Many_of_One_Index, Name, status) or
call Initialize (OV, Many_of_One_Index, Dimensionality, Name, status, dim1, dim2, dim3)  

Input variables:

 OV  The Overlapped_Vector object to be initialized.
 DV  The Distributed_Vector object which the Overlapped_Vector is to be based on.
 Many_of_One_Index  An index giving the relationship of the ``Many'' and ``One'' axes to each other for this Overlapped_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 Overlapped Vectors). [Optional]
 dim{n}  The dimensions for this ``vector''. There must be dimensions specified up to a number one less than the Dimensionality. These are only needed in the second form of the call.

Output variables:

 OV  The Overlapped_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.

The Initialize_Overlapped_Vector code listing contains additional documentation.

Michael L. Hall