HDF5Declarations Module Reference

Declarations file for the Chombo output format. More...

Collaboration diagram for HDF5Declarations:

List of all members.

Public Member Functions
subroutine	CatchHDF5Error (s_function_name, i_err, target_code)
	kills the program upon detecting an HDF5 error.
subroutine	HDF5Init ()
	A combination function that initializes all relevant chombo data types.
subroutine	HDF5Finalize ()
	Closes down data types.
LOGICAL function	HandleIsValid (handle)
	Returns true if the input is a valid (open) HDF5 handle.
subroutine	CreateHDF5FloatVector (hid_floatvect_id)
	Initializes the FloatVector type used in the chombo specification.
INTEGER(HSIZE_T) function	GetChunkSize (hid_type_id)
	Returns the maximum chunk size in terms of the input type (I_MAX_CHUNK_SIZE is given in bytes).
HDF5 Type Definitions
subroutine	CreateHDF5IntVector (hid_intvect_id)
	Initializes the IntVector type used in the chombo specification.
subroutine	CreateHDF5BoxType (hid_box_id)
	Initializes the Box type used in the chombo specification.
HDF5 Read Function
subroutine	Read_Slab_From_Dataset_Box (s_name, hid_group_id, box_data, i_offset)
	Reads in a slab of data from a a Chombo dataset of type Box.
subroutine	Read_Slab_From_Dataset_Double (s_name, hid_group_id, dbla_data, i_offset)
	Reads in a slab of data from a a Chombo dataset of type Double.
subroutine	Read_Slab_From_Dataset_Int (s_name, hid_group_id, int_data, i_offset)
	Reads in a slab of data from a a Chombo dataset of type Integer.
INTEGER function	Read_HDF5_Attribute_Int (s_name, hid_group_id)
	Reads in an Integer attribute from an HDF5 file.
REAL(KIND=xPrec) function	Read_HDF5_Attribute_Double (s_name, hid_group_id)
	Reads in a double-precision attribute from an HDF5 file.
INTEGER function	IO_GetDatasetElementCount (group_id, s_name)
	Returns the number of elements in a Chombo HDF5 dataset.
HDF5 Write Functions
subroutine	CreateHDF5Group (s_name, location_id, hid_group_id)
	Creates a new group in an HDF5 file.
subroutine	Add_HDF5_Attribute_Int (s_name, hid_group_id, i_value)
	Adds an integer attribute to an HDF5 file.
subroutine	Add_HDF5_Attribute_Double (s_name, hid_group_id, dbl_value)
	Adds an double-precision attribute to an HDF5 file.
subroutine	Add_HDF5_Attribute_IntVector (s_name, hid_type_id, hid_group_id, ia_value, i_size)
	Adds a three-element integer vector attribute to an HDF5 file.
subroutine	Add_HDF5_Attribute_FloatVector (s_name, hid_group_id, dbla_value, i_size)
	Adds a three-element double-precision vector attribute to an HDF5 file.
subroutine	Add_HDF5_Attribute_String (s_name, hid_group_id, s_value)
	Adds a string object to an HDF5 file.
subroutine	Add_HDF5_Attribute_Box (s_name, hid_type_id, hid_group_id, ia_value, i_size)
	Adds a Box (six-element integer) attribute to an HDF5 file.
subroutine	Initialize_HDF5_Dataset_Double (s_name, hid_group_id, raw_data_size, lExtensible)
	Initializes a double-precision dataset within a HDF5 file.
subroutine	Write_Slab_To_Dataset_Double (s_dataset_name, hid_group_id, dbla_data, i_offset)
	Writes a slab of data to a dataset.
subroutine	Initialize_HDF5_Dataset_Box (s_name, hid_group_id, raw_data_size, lExtensible)
	Initializes a Box-type dataset within a HDF5 file.
subroutine	Write_Slab_To_Dataset_Box (s_dataset_name, hid_group_id, box_data, i_offset)
	Writes a slab of data to a Box-type dataset.
subroutine	Initialize_HDF5_Dataset_Int (s_name, hid_group_id, raw_data_size, lExtensible)
	Initializes an integer dataset within the HDF5 file.
subroutine	Write_Slab_To_Dataset_Int (s_dataset_name, hid_group_id, int_data, i_offset)
	Writes a slab of data to a dataset.
Public Attributes
CHARACTER(LEN=1), parameter	S_ROOT_GROUP = '/'
REAL(KIND=qPrec), parameter	DBL_TEST_REAL_DAT = 1.0
INTEGER(HID_T), parameter	HID_ATTRIBUTE_RANK = 0
INTEGER(HSIZE_T), dimension(1), parameter	IA_SCALAR_ATTRIB_DIMS = (/1/)
INTEGER, parameter	I_MAX_COMPONENTS = 100
INTEGER, parameter	I_MAX_CNAME_LENGTH = 100
INTEGER, parameter	I_MAX_LEVELNAME_LENGTH = 12
INTEGER, parameter	I_FILENAME_LENGTH = 19
INTEGER, parameter	I_DATASET_RANK = 1
INTEGER, parameter	I_DEFLATE_LEVEL = 6
INTEGER, parameter	I_CHOMBO_BOX_SIZE = 6
INTEGER, parameter	I_MAX_CHUNK_SIZE = 1073741824
INTEGER(HID_T)	hid_intvect_id
INTEGER(HID_T)	hid_floatvect_id
INTEGER(HID_T)	hid_box_id
LOGICAL, parameter	L_EXTENSIBLE = .TRUE.
LOGICAL, parameter	L_NON_EXTENSIBLE = .FALSE.

---

Detailed Description

Declarations file for the Chombo output format.

Author:

Brandon D. Shroyer

Date:

10-12-2010

Definition at line 34 of file hdf5_declarations.f90.

---

Member Function/Subroutine Documentation

subroutine CatchHDF5Error	(	CHARACTER(LEN=*), intent(in)	s_function_name,
		INTEGER	i_err,
		INTEGER, optional	target_code
	)

kills the program upon detecting an HDF5 error.

Parameters:

s_function_name	An error string containing the name of the function being checked.
i_err	the error value being tested.
target_code	An optional integer value that becomes the condition for success or failure.

Definition at line 78 of file hdf5_declarations.f90.

subroutine HDF5Init

(

)

A combination function that initializes all relevant chombo data types.

Definition at line 103 of file hdf5_declarations.f90.

subroutine HDF5Finalize

(

)

Closes down data types.

Definition at line 118 of file hdf5_declarations.f90.

LOGICAL function HandleIsValid

(

INTEGER(HID_T)

handle

)

Returns true if the input is a valid (open) HDF5 handle.

Parameters:

handle

An integer of type HID_T--the HDF5 handle being tested.

Definition at line 136 of file hdf5_declarations.f90.

subroutine CreateHDF5IntVector

(

INTEGER(HID_T)

hid_intvect_id

)

Initializes the IntVector type used in the chombo specification.

Parameters:

hid_intvect_id

A chombo handle that will be associated with the type.

Definition at line 157 of file hdf5_declarations.f90.

subroutine CreateHDF5FloatVector

(

INTEGER(HID_T)

hid_floatvect_id

)

Initializes the FloatVector type used in the chombo specification.

Parameters:

hid_floatvect_id

A chombo handle that will be associated with the type.

Definition at line 202 of file hdf5_declarations.f90.

subroutine CreateHDF5BoxType

(

INTEGER(HID_T)

hid_box_id

)

Initializes the Box type used in the chombo specification.

Parameters:

hid_box_id

A chombo handle that will be associated with the type.

Definition at line 242 of file hdf5_declarations.f90.

subroutine Read_Slab_From_Dataset_Box	(	CHARACTER(LEN=*), intent(in)	s_name,
		INTEGER(HID_T), intent(in)	hid_group_id,
		INTEGER, dimension(6), intent(out)	box_data,
		INTEGER(HSIZE_T), intent(in)	i_offset
	)

Reads in a slab of data from a a Chombo dataset of type Box.

Parameters:

s_name	The relative name of the Chombo dataset.
hid_group_id	The group within the HDF5 file containing the desired dataset.
box_data	A pointer to the six-element integer array that will store the read-in data.
i_offset	The offset of the target data section (hyperslab) within the Chombo dataset.

Definition at line 302 of file hdf5_declarations.f90.

subroutine Read_Slab_From_Dataset_Double	(	CHARACTER(LEN=*), intent(in)	s_name,
		INTEGER(HID_T), intent(in)	hid_group_id,
		REAL(KIND=qPrec), dimension(:), intent(out), pointer	dbla_data,
		INTEGER(HSIZE_T), intent(in)	i_offset
	)

Reads in a slab of data from a a Chombo dataset of type Double.

Parameters:

s_name	The relative name of the Chombo dataset.
hid_group_id	The group within the HDF5 file containing the desired dataset.
dbla_data	A pointer to the 1D double array that will store the read-in data.
i_offset	The offset of the target data section (hyperslab) within the Chombo dataset.

Definition at line 371 of file hdf5_declarations.f90.

subroutine Read_Slab_From_Dataset_Int	(	CHARACTER(LEN=*), intent(in)	s_name,
		INTEGER(HID_T), intent(in)	hid_group_id,
		INTEGER, dimension(:), intent(out)	int_data,
		INTEGER(HSIZE_T), intent(in)	i_offset
	)

Reads in a slab of data from a a Chombo dataset of type Integer.

Parameters:

s_name	The relative name of the Chombo dataset.
hid_group_id	The group within the HDF5 file containing the desired dataset.
int_data	A pointer to the 1D integer array that will store the read-in data.
i_offset	The offset of the target data section (hyperslab) within the Chombo dataset.

Definition at line 437 of file hdf5_declarations.f90.

INTEGER function Read_HDF5_Attribute_Int	(	CHARACTER(LEN=*), intent(in)	s_name,
		INTEGER(HID_T), intent(in)	hid_group_id
	)

Reads in an Integer attribute from an HDF5 file.

Parameters:

s_name	The relative name within the HDF5 file.
hid_group_id	The group within the HDF5 file containing the desired attribute.

Definition at line 505 of file hdf5_declarations.f90.

REAL(KIND=xPrec) function Read_HDF5_Attribute_Double	(	CHARACTER(LEN=*), intent(in)	s_name,
		INTEGER(HID_T), intent(in)	hid_group_id
	)

Reads in a double-precision attribute from an HDF5 file.

Parameters:

s_name	The relative name within the HDF5 file.
hid_group_id	The group within the HDF5 file containing the desired attribute.

Definition at line 564 of file hdf5_declarations.f90.

INTEGER function IO_GetDatasetElementCount	(	INTEGER(HID_T)	group_id,
		CHARACTER(LEN=*)	s_name
	)

Returns the number of elements in a Chombo HDF5 dataset.

Parameters:

group_id	An integer of type HID_T (a group handle).
s_name	The name of the dataset being queried.

Definition at line 621 of file hdf5_declarations.f90.

subroutine CreateHDF5Group	(	CHARACTER(LEN=*)	s_name,
		INTEGER(HID_T)	location_id,
		INTEGER(HID_T)	hid_group_id
	)

Creates a new group in an HDF5 file.

Parameters:

s_name	The new group's name.
location_id	The ID of the file or group in which the new group will be created.
hid_group_id	The group ID to which the new group will be assigned.

Definition at line 665 of file hdf5_declarations.f90.

subroutine Add_HDF5_Attribute_Int	(	CHARACTER(LEN=*), intent(in)	s_name,
		INTEGER(HID_T), intent(in)	hid_group_id,
		INTEGER	i_value
	)

Adds an integer attribute to an HDF5 file.

Parameters:

s_name	The attribute's name.
hid_group_id	The group ID within the file where the attribute will reside.
i_value	The value of the attribute.

Definition at line 693 of file hdf5_declarations.f90.

subroutine Add_HDF5_Attribute_Double	(	CHARACTER(LEN=*), intent(in)	s_name,
		INTEGER(HID_T), intent(in)	hid_group_id,
		REAL(8)	dbl_value
	)

Adds an double-precision attribute to an HDF5 file.

Parameters:

s_name	The attribute's name.
hid_group_id	The group ID within the file where the attribute will reside.
dbl_value	The value of the attribute.

Definition at line 743 of file hdf5_declarations.f90.

subroutine Add_HDF5_Attribute_IntVector	(	CHARACTER(LEN=*), intent(in)	s_name,
		INTEGER(HID_T), intent(in)	hid_type_id,
		INTEGER(HID_T), intent(in)	hid_group_id,
		INTEGER, dimension(3)	ia_value,
		INTEGER(size_t), intent(in), optional	i_size
	)

Adds a three-element integer vector attribute to an HDF5 file.

Parameters:

s_name	The attribute's name.
hid_type_id	The integer vector data type handle.
hid_group_id	The group ID within the file where the attribute will reside.
ia_value	The value(s) of the attribute.
i_size	(optional) the size of the data type.

Definition at line 792 of file hdf5_declarations.f90.

subroutine Add_HDF5_Attribute_FloatVector	(	CHARACTER(LEN=*), intent(in)	s_name,
		INTEGER(HID_T), intent(in)	hid_group_id,
		REAL(KIND=qPrec), dimension(3)	dbla_value,
		INTEGER(size_t), intent(in), optional	i_size
	)

Adds a three-element double-precision vector attribute to an HDF5 file.

Parameters:

s_name	The attribute's name.
hid_group_id	The group ID within the file where the attribute will reside.
dbla_value	The value(s) of the attribute.
i_size	(optional) the size of the data type.

Definition at line 847 of file hdf5_declarations.f90.

subroutine Add_HDF5_Attribute_String	(	CHARACTER(LEN=*), intent(in)	s_name,
		INTEGER(HID_T), intent(in)	hid_group_id,
		CHARACTER(LEN=*)	s_value
	)

Adds a string object to an HDF5 file.

Parameters:

s_name	The attribute's name.
hid_group_id	The group ID within the file where the attribute will reside.
s_value	The value of the attribute.

Definition at line 899 of file hdf5_declarations.f90.

subroutine Add_HDF5_Attribute_Box	(	CHARACTER(LEN=*), intent(in)	s_name,
		INTEGER(HID_T), intent(in)	hid_type_id,
		INTEGER(HID_T), intent(in)	hid_group_id,
		INTEGER, dimension(i_chombo_box_size)	ia_value,
		INTEGER(size_t), intent(in), optional	i_size
	)

Adds a Box (six-element integer) attribute to an HDF5 file.

Parameters:

s_name	The attribute's name.
hid_type_id	The box data type handle.
hid_group_id	The group ID within the file where the attribute will reside.
ia_value	The value(s) of the attribute.
i_size	(optional) the size of the data type.

Definition at line 959 of file hdf5_declarations.f90.

subroutine Initialize_HDF5_Dataset_Double	(	CHARACTER(LEN=*), intent(in)	s_name,
		INTEGER(HID_T), intent(in)	hid_group_id,
		INTEGER	raw_data_size,
		LOGICAL, optional	lExtensible
	)

Initializes a double-precision dataset within a HDF5 file.

Parameters:

s_name	The dataset's name.
hid_group_id	The group ID within the file where the dataset will reside.
i_dataset_size	The size of the dataset.
lExtensible	An optional logical flag indicating whether or not the dataset will be extensible.

Definition at line 1013 of file hdf5_declarations.f90.

subroutine Write_Slab_To_Dataset_Double	(	CHARACTER(LEN=*), intent(in)	s_dataset_name,
		INTEGER(HID_T)	hid_group_id,
		REAL(KIND=qPrec), dimension(:)	dbla_data,
		INTEGER(HSIZE_T)	i_offset
	)

Writes a slab of data to a dataset.

Parameters:

s_dataset_name	The dataset's name.
hid_group_id	The group ID within the file where the dataset will reside.
dbla_data	The slab of data to be written to the dataset.
i_offset	The offset within the dataset to where the hyperslab should begin writing.

Definition at line 1097 of file hdf5_declarations.f90.

subroutine Initialize_HDF5_Dataset_Box	(	CHARACTER(LEN=*), intent(in)	s_name,
		INTEGER(HID_T), intent(in)	hid_group_id,
		INTEGER	raw_data_size,
		LOGICAL, optional	lExtensible
	)

Initializes a Box-type dataset within a HDF5 file.

Parameters:

s_name	The dataset's name.
hid_group_id	The group ID within the file where the dataset will reside.
i_dataset_size	The size of the dataset.
lExtensible	An optional parameter controlling the extensibility of the dataset.

Definition at line 1184 of file hdf5_declarations.f90.

subroutine Write_Slab_To_Dataset_Box	(	CHARACTER(LEN=*), intent(in)	s_dataset_name,
		INTEGER(HID_T)	hid_group_id,
		INTEGER, dimension(i_chombo_box_size)	box_data,
		INTEGER(HSIZE_T)	i_offset
	)

Writes a slab of data to a Box-type dataset.

Parameters:

s_dataset_name	The dataset's name.
hid_group_id	The group ID within the file where the dataset will reside.
box_data	The slab of data to be written to the dataset.
i_offset	The offset within the dataset to where the hyperslab should begin writing.

Definition at line 1267 of file hdf5_declarations.f90.

subroutine Initialize_HDF5_Dataset_Int	(	CHARACTER(LEN=*), intent(in)	s_name,
		INTEGER(HID_T), intent(in)	hid_group_id,
		INTEGER	raw_data_size,
		LOGICAL, optional	lExtensible
	)

Initializes an integer dataset within the HDF5 file.

Parameters:

s_name	The dataset's name.
hid_group_id	The group ID within the file where the dataset will reside.
raw_data_size	The size of the dataset.
lExtensible	An optional parameter controlling the extensibility of the dataset.

Definition at line 1353 of file hdf5_declarations.f90.

subroutine Write_Slab_To_Dataset_Int	(	CHARACTER(LEN=*), intent(in)	s_dataset_name,
		INTEGER(HID_T)	hid_group_id,
		INTEGER, dimension(:)	int_data,
		INTEGER(HSIZE_T)	i_offset
	)

Writes a slab of data to a dataset.

Parameters:

s_dataset_name	The dataset's name.
hid_group_id	The group ID within the file where the dataset will reside.
int_data	The slab of data to be written to the dataset.
i_offset	The offset within the dataset to where the hyperslab should begin writing.

Definition at line 1435 of file hdf5_declarations.f90.

INTEGER(HSIZE_T) function GetChunkSize

(

INTEGER(HID_T)

hid_type_id

)

Returns the maximum chunk size in terms of the input type (I_MAX_CHUNK_SIZE is given in bytes).

Parameters:

hid_type_id

A chombo type ID handle.

Definition at line 1517 of file hdf5_declarations.f90.

---

Member Data Documentation

CHARACTER(LEN = 1), parameter S_ROOT_GROUP = '/'

Definition at line 45 of file hdf5_declarations.f90.

REAL(KIND = qPrec), parameter DBL_TEST_REAL_DAT = 1.0

Definition at line 46 of file hdf5_declarations.f90.

INTEGER(HID_T), parameter HID_ATTRIBUTE_RANK = 0

Definition at line 47 of file hdf5_declarations.f90.

INTEGER(HSIZE_T), dimension(1), parameter IA_SCALAR_ATTRIB_DIMS = (/1/)

Definition at line 48 of file hdf5_declarations.f90.

INTEGER, parameter I_MAX_COMPONENTS = 100

Definition at line 49 of file hdf5_declarations.f90.

INTEGER, parameter I_MAX_CNAME_LENGTH = 100

Definition at line 50 of file hdf5_declarations.f90.

INTEGER, parameter I_MAX_LEVELNAME_LENGTH = 12

Definition at line 51 of file hdf5_declarations.f90.

INTEGER, parameter I_FILENAME_LENGTH = 19

Definition at line 52 of file hdf5_declarations.f90.

INTEGER, parameter I_DATASET_RANK = 1

Definition at line 53 of file hdf5_declarations.f90.

INTEGER, parameter I_DEFLATE_LEVEL = 6

Definition at line 54 of file hdf5_declarations.f90.

INTEGER, parameter I_CHOMBO_BOX_SIZE = 6

Definition at line 57 of file hdf5_declarations.f90.

INTEGER, parameter I_MAX_CHUNK_SIZE = 1073741824

Definition at line 61 of file hdf5_declarations.f90.

INTEGER(HID_T) hid_intvect_id

Definition at line 63 of file hdf5_declarations.f90.

INTEGER(HID_T) hid_floatvect_id

Definition at line 64 of file hdf5_declarations.f90.

INTEGER(HID_T) hid_box_id

Definition at line 65 of file hdf5_declarations.f90.

LOGICAL, parameter L_EXTENSIBLE = .TRUE.

Definition at line 67 of file hdf5_declarations.f90.

LOGICAL, parameter L_NON_EXTENSIBLE = .FALSE.

Definition at line 68 of file hdf5_declarations.f90.

---

The documentation for this module was generated from the following file:

• hdf5_declarations.f90