10.3 Base_Structure Class

The Base_Structure Class is used to describe a base structure in the CÆSAR Code Package. A Base_Structure is part of the overall data structure strategy in CÆSAR, which is made up of the following classes: Base_Structure, Data_Index, Assembled_Vector, Distributed_Vector, Overlapped_Vector, and Collected_Array. A description of the overall data structure strategy can be found in the Data_Structures Module.

Base_Structure public procedures:

	Fundamental procedures
	Initialize		Initializes a Base_Structure object.
	Finalize		Finalizes a Base_Structure object.
	Valid_State		Returns false iff a Base_Structure object is in an invalid state.
	Initialized		Returns true iff a Base_Structure object has been initialized.
	Operations
	First_PE		Returns the first global index number on this PE.
	Generate_Even_Distribution		Returns an even distribution of items in a vector.
	Generate_Multiple		Generates a Base_Structure object which is a multiple of another Base_Structure object.
	Last_PE		Returns the last global index number on this PE.
	Length_PE		Returns the length of the distributed axis on this PE.
	Length_Total		Returns the total the distributed axis of the entire vector (including all PEs).
	Length_Vector		Returns a vector containing the length of the distributed axis for each PE.
	Locus		Returns the locus of the Base_Structure object.
	Output		Writes out the Base_Structure object.
	Range_PE		Returns the range of global index numbers on this PE.

Base_Structure public variable:

name_length

Length of the character strings for names.

Base_Structure public defined type:

	Base_Structure type
	First_PE		First global index number for this PE.
	Initialized		Initialization status.
	Last_PE		Last global index number for this PE.
	Length_Total		Total length of the distributed axis of the entire vector (including all PEs).
	Length_PE		Length of the distributed axis on this PE.
	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.).
	Range_PE		The range of global index numbers for this PE.

The Base_Structure Class code listing contains additional documentation. The Base_Structure Class also contains a Unit Test Program.