Setting up the Data Model

Functions/Subroutines
integer *8 function	h5pt_getdatasetname (filehandle, index, name)
integer *8 function	h5pt_getndatasets (filehandle)
integer *8 function	h5pt_getnpoints (filehandle)
integer *8 function	h5pt_getnsteps (filehandle)
integer *8 function	h5pt_getview (filehandle, start, end)
integer *8 function	h5pt_hasview (filehandle)
integer *8 function	h5pt_resetview (filehandle)
integer *8 function	h5pt_setnpoints (filehandle, npoints)
integer *8 function	h5pt_setnpoints_strided (filehandle, npoints, stride)
integer *8 function	h5pt_setstep (filehandle, step)
integer *8 function	h5pt_setview (filehandle, start, end)
integer *8 function	h5pt_setview_indices (filehandle, indices, nelem)

Detailed Description

Function/Subroutine Documentation

h5pt_getdatasetname()

integer*8 function h5pt_getdatasetname	(	integer*8, intent(in)	filehandle,
		integer*8, intent(in)	index,
		character(len=*), intent(out)	name
	)

See H5PartGetDatasetName

Returns

0 on success or error code

Parameters

[in]	filehandle	the handle returned during file open
[in]	index	index of dataset to query (starting from 0)
[out]	name	buffer to read the dataset name into

h5pt_getndatasets()

integer*8 function h5pt_getndatasets

(

integer*8, intent(in)

filehandle

)

See H5PartGetNumDatasets

Returns

the number of datasets or error code

Parameters

[in]

filehandle

the handle returned during file open

h5pt_getnpoints()

integer*8 function h5pt_getnpoints

(

integer*8, intent(in)

filehandle

)

See H5PartGetNumParticles

Returns

the number of particles or error code

Parameters

[in]

filehandle

the handle returned during file open

h5pt_getnsteps()

integer*8 function h5pt_getnsteps

(

integer*8, intent(in)

filehandle

)

See H5PartGetNumSteps

Returns

the number of steps or error code

Parameters

[in]

filehandle

the handle returned during file open

h5pt_getview()

integer*8 function h5pt_getview	(	integer*8, intent(in)	filehandle,
		integer*8, intent(out)	start,
		integer*8, intent(out)	end
	)

See H5PartGetView

Returns

0 on success or error code

Parameters

[in]	filehandle	the handle returned during file open
[out]	start	buffer to store the offset of the first particle in the view
[out]	end	buffer to store the offset of the last particle in the view (inclusive)

h5pt_hasview()

integer*8 function h5pt_hasview

(

integer*8, intent(in)

filehandle

)

See H5PartResetView

Returns

1 if true, 0 if false, or error code

Parameters

[in]

filehandle

the handle returned during file open

h5pt_resetview()

integer*8 function h5pt_resetview

(

integer*8, intent(in)

filehandle

)

See H5PartResetView

Returns

0 on success or error code

Parameters

[in]

filehandle

the handle returned during file open

h5pt_setnpoints()

integer*8 function h5pt_setnpoints	(	integer*8, intent(in)	filehandle,
		integer*8, intent(in)	npoints
	)

See H5PartSetNumParticles

Returns

0 on success or error code

Parameters

[in]	filehandle	the handle returned during file open
[in]	npoints	the number of particles on this processor

h5pt_setnpoints_strided()

integer*8 function h5pt_setnpoints_strided	(	integer*8, intent(in)	filehandle,
		integer*8, intent(in)	npoints,
		integer*8, intent(in)	stride
	)

See H5PartSetNumParticlesStrided

Returns

0 on success or error code

Parameters

[in]	filehandle	the handle returned during file open
[in]	npoints	the number of particles on this processor
[in]	stride	the stride value (e.g. the number of fields in the particle data array)

h5pt_setstep()

integer*8 function h5pt_setstep	(	integer*8, intent(in)	filehandle,
		integer*8, intent(in)	step
	)

See H5PartSetStep

Returns

0 on success or error code

Parameters

[in]	filehandle	the handle returned during file open
[in]	step	a timestep value >= 1

h5pt_setview()

integer*8 function h5pt_setview	(	integer*8, intent(in)	filehandle,
		integer*8, intent(in)	start,
		integer*8, intent(in)	end
	)

See H5PartSetView

Returns

0 on success or error code

Parameters

[in]	filehandle	the handle returned during file open
[in]	start	offset of the first particle in the view
[in]	end	offset of the last particle in the view (inclusive)

h5pt_setview_indices()

integer*8 function h5pt_setview_indices	(	integer*8, intent(in)	filehandle,
		integer*8, dimension(*), intent(in)	indices,
		integer*8, intent(in)	nelem
	)

See H5PartSetViewIndices

Returns

0 on success or error code

Parameters

[in]	filehandle	the handle returned during file open
[in]	indices	list of indicies to select in this view
[in]	nelem	number of particles in the list