H5Part_model.f90 5.02 KB
Newer Older
gsell's avatar
gsell committed
1
!
gsell's avatar
gsell committed
2
!  Copyright (c) 2006-2016, The Regents of the University of California,
gsell's avatar
gsell committed
3 4 5 6 7 8 9 10
!  through Lawrence Berkeley National Laboratory (subject to receipt of any
!  required approvals from the U.S. Dept. of Energy) and the Paul Scherrer
!  Institut (Switzerland).  All rights reserved.!
!
!  License: see file COPYING in top level of source distribution.
!
  INTERFACE
     !>
gsell's avatar
gsell committed
11 12 13 14 15
     !! \ingroup h5part_f90_api
     !! \addtogroup h5part_model_f
     !! @{
     
     !>
gsell's avatar
gsell committed
16 17
     !! See \ref H5PartSetNumParticles
     !! \return 0 on success or error code
gsell's avatar
gsell committed
18

gsell's avatar
gsell committed
19 20 21 22
     INTEGER*8 FUNCTION h5pt_setnpoints ( filehandle, npoints )
       INTEGER*8, INTENT(IN) :: filehandle !< the handle returned during file open
       INTEGER*8, INTENT(IN) :: npoints    !< the number of particles on *this* processor
     END FUNCTION h5pt_setnpoints
23

gsell's avatar
gsell committed
24 25 26
     !>
     !! See \ref H5PartSetNumParticlesStrided
     !! \return 0 on success or error code
gsell's avatar
gsell committed
27

gsell's avatar
gsell committed
28 29 30 31 32
     INTEGER*8 FUNCTION h5pt_setnpoints_strided ( filehandle, npoints, stride )
       INTEGER*8, INTENT(IN) :: filehandle !< the handle returned during file open
       INTEGER*8, INTENT(IN) :: npoints    !< the number of particles on *this* processor
       INTEGER*8, INTENT(IN) :: stride     !< the stride value (e.g. the number of fields in the particle data array)
     END FUNCTION h5pt_setnpoints_strided
33 34


gsell's avatar
gsell committed
35 36 37
     !>
     !! See \ref H5PartSetView
     !! \return 0 on success or error code
gsell's avatar
gsell committed
38

gsell's avatar
gsell committed
39 40 41 42 43
     INTEGER*8 FUNCTION h5pt_setview (filehandle,start,end)
       INTEGER*8, INTENT(IN) :: filehandle !< the handle returned during file open
       INTEGER*8, INTENT(IN) :: start      !< offset of the first particle in the view
       INTEGER*8, INTENT(IN) :: end        !< offset of the last particle in the view (inclusive)
     END FUNCTION h5pt_setview
44

gsell's avatar
gsell committed
45 46 47
     !>
     !! See \ref H5PartSetViewIndices
     !! \return 0 on success or error code
gsell's avatar
gsell committed
48

gsell's avatar
gsell committed
49 50 51 52 53
     INTEGER*8 FUNCTION h5pt_setview_indices (filehandle,indices,nelem)
       INTEGER*8, INTENT(IN) :: filehandle !< the handle returned during file open
       INTEGER*8, INTENT(IN) :: indices(*) !< list of indicies to select in this view
       INTEGER*8, INTENT(IN) :: nelem      !< number of particles in the list
     END FUNCTION h5pt_setview_indices
54

55 56 57
     !>
     !! See \ref H5PartSetCanonicalView
     !! \return 0 on success or error code
gsell's avatar
gsell committed
58

59 60 61 62
     INTEGER*8 FUNCTION h5pt_setcanonicalview (filehandle)
       INTEGER*8, INTENT(IN) :: filehandle !< the handle returned during file open
     END FUNCTION h5pt_setcanonicalview

gsell's avatar
gsell committed
63 64 65
     !>
     !! See \ref H5PartResetView
     !! \return 0 on success or error code
gsell's avatar
gsell committed
66

gsell's avatar
gsell committed
67 68 69
     INTEGER*8 FUNCTION h5pt_resetview (filehandle)
       INTEGER*8, INTENT(IN) :: filehandle !< the handle returned during file open
     END FUNCTION h5pt_resetview
70

gsell's avatar
gsell committed
71 72 73
     !>
     !! See \ref H5PartResetView
     !! \return 1 if true, 0 if false, or error code
gsell's avatar
gsell committed
74

gsell's avatar
gsell committed
75 76 77
     INTEGER*8 FUNCTION h5pt_hasview (filehandle)
       INTEGER*8, INTENT(IN) :: filehandle !< the handle returned during file open
     END FUNCTION h5pt_hasview
78

gsell's avatar
gsell committed
79 80 81
     !>
     !! See \ref H5PartGetView
     !! \return 0 on success or error code
gsell's avatar
gsell committed
82

gsell's avatar
gsell committed
83 84 85 86 87
     INTEGER*8 FUNCTION h5pt_getview (filehandle,start,end)
       INTEGER*8, INTENT(IN) :: filehandle !< the handle returned during file open
       INTEGER*8, INTENT(OUT) :: start     !< buffer to store the offset of the first particle in the view
       INTEGER*8, INTENT(OUT) :: end       !< buffer to store the offset of the last particle in the view (inclusive)
     END FUNCTION h5pt_getview
88

89 90 91
     !>
     !! See \ref H5PartGetNumDatasets
     !! \return the number of datasets or error code
gsell's avatar
gsell committed
92

93 94 95 96 97 98 99
     INTEGER*8 FUNCTION h5pt_getndatasets (filehandle)
       INTEGER*8, INTENT(IN) :: filehandle         !< the handle returned during file open
     END FUNCTION h5pt_getndatasets

     !>
     !! See \ref H5PartGetDatasetName
     !! \return 0 on success or error code
gsell's avatar
gsell committed
100

101 102 103 104 105 106 107 108 109
     INTEGER*8 FUNCTION h5pt_getdatasetname (filehandle,index,name)
       INTEGER*8, INTENT(IN) :: filehandle         !< the handle returned during file open
       INTEGER*8, INTENT(IN) :: index              !< index of dataset to query (starting from 0)
       CHARACTER(LEN=*), INTENT(OUT) :: name       !< buffer to read the dataset name into 
     END FUNCTION h5pt_getdatasetname

     !>
     !! See \ref H5PartGetDatasetInfo
     !! \return 0 on success or error code
gsell's avatar
gsell committed
110

111 112 113 114 115 116 117 118 119 120 121
     INTEGER*8 FUNCTION h5pt_getdatasetinfo (filehandle, idx, name, type, num_elems)
       INTEGER*8,INTENT(IN) :: filehandle          !< file handle
       INTEGER*8,INTENT(IN) :: idx                 !< index of dataset being queried
       CHARACTER(LEN=*), INTENT(OUT):: name        !< name of datset
       INTEGER*8,INTENT(OUT):: type                !< type of datset
       INTEGER*8,INTENT(OUT):: num_elems           !< number of elements in the dataset
     END FUNCTION h5pt_getdatasetinfo

     !>
     !! See \ref H5PartSetChunkSize
     !! \return 0 on success or -2 on error
gsell's avatar
gsell committed
122

123 124 125 126
     INTEGER*8 FUNCTION h5pt_getnpoints (filehandle)
       INTEGER*8, INTENT(IN) :: filehandle         !< the handle returned during file open
     END FUNCTION h5pt_getnpoints

gsell's avatar
gsell committed
127 128
     !> @}
     
gsell's avatar
gsell committed
129
  END INTERFACE