10.3.1 Initialize_Base_Structure Procedure

The Initialize_Base_Structure procedure allocates and initializes a Base_Structure object.

Calling syntax:

call Initialize (Structure, Length_Vector, Locus, status)

Input variables:

Structure The Base_Structure object to be initialized.

Length_Vector A vector containing the length of the distributed axis for each PE.

Locus The location or variable name which is distributed over the processors (Cells, Nodes, Faces, Equations, Variables, etc.). [Optional]

Output variables:

Structure The Base_Structure 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.

The Initialize_Base_Structure code listing contains additional documentation.

Michael L. Hall

	`Structure`		The Base_Structure object to be initialized.
	`Length_Vector`		A vector containing the length of the distributed axis for each PE.
	`Locus`		The location or variable name which is distributed over the processors (Cells, Nodes, Faces, Equations, Variables, etc.). [Optional]

	`Structure`		The Base_Structure 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.