From d980f4d2b911d754102d44c847c2e942a5d6dbb3 Mon Sep 17 00:00:00 2001 From: Achim Gsell Date: Fri, 18 Mar 2016 17:58:30 +0100 Subject: [PATCH] header files and documentation reorganized and reviewed --- src/include/H5Block_attribs.f90 | 226 ++++++++++++++++++++++---------- src/include/H5Block_attribs.h | 99 ++++++++++---- src/include/H5Block_io.f90 | 22 +++- src/include/H5Block_io.h | 28 ++-- 4 files changed, 252 insertions(+), 123 deletions(-) diff --git a/src/include/H5Block_attribs.f90 b/src/include/H5Block_attribs.f90 index c31a59a..ba2367e 100644 --- a/src/include/H5Block_attribs.f90 +++ b/src/include/H5Block_attribs.f90 @@ -25,8 +25,10 @@ ! |_| |___/ !> - !! See \ref H5BlockGetNumFieldAttribs - !! \return number of attributes or error code + !! Query the number of attributes of field \c field_name. + !! + !! \return number of attributes + !!\return \c H5_FAILURE on error INTEGER*8 FUNCTION h5bl_getnfieldattribs (filehandle, field_name) INTEGER*8, INTENT(IN) :: filehandle !< file handle @@ -34,8 +36,16 @@ END FUNCTION h5bl_getnfieldattribs !> - !! See \ref H5BlockGetFieldAttribInfo - !! \return 0 on success or error code + !! Gets the name, type and number of elements of the field attribute + !! specified by its index. + !! + !! This function can be used to retrieve all attributes bound to the + !! specified field by looping from \c 0 to the number of attribute + !! minus one. The number of attributes bound to the + !! field can be queried by calling \ref H5BlockGetNumFieldAttribs. + !! + !! \return \c H5_SUCCESS on success + !! \return \c H5_FAILURE on error INTEGER*8 FUNCTION h5bl_getfieldattribinfo (filehandle, field_name, idx, attrib_name, attrib_nelems) INTEGER*8,INTENT(IN) :: filehandle !< file handle @@ -53,8 +63,11 @@ ! |___/ !> - !! See \ref H5BlockWriteFieldAttribString - !! \return 0 on success or error code + !! Write the string in \c buffer as attribute \c attrib_name of field + !! \c field_name. + !! + !! \return \c H5_SUCCESS on success + !! \return \c H5_FAILURE on error INTEGER*8 FUNCTION h5bl_writefieldattrib_string (filehandle, field_name, attrib_name, attrib_value) INTEGER*8, INTENT(IN) :: filehandle !< file handle @@ -64,7 +77,11 @@ END FUNCTION h5bl_writefieldattrib_string !> - !! \return 0 on success or error code + !! Read the string value from attribute \c attrib_name of field + !! \c field_name into \c buffer. + !! + !! \return \c H5_SUCCESS on success + !! \return \c H5_FAILURE on error INTEGER*8 FUNCTION h5bl_readfieldattrib_string (filehandle, field_name, attrib_name, attrib_value) INTEGER*8, INTENT(IN) :: filehandle !< file handle @@ -80,8 +97,11 @@ ! |_/_/ \___/ |_| \___|\__,_|_| !> - !! See \ref H5BlockWriteFieldAttribFloat64 - !! \return 0 on success or error code + !! Write float64 \c values as attribute \c attrib_name of field + !! \c field_name. + !! + !! \return \c H5_SUCCESS on success + !! \return \c H5_FAILURE on error INTEGER*8 FUNCTION h5bl_writefieldattrib_r8 (filehandle, field_name, attrib_name, attrib_value, attrib_nelems) INTEGER*8,INTENT(IN) :: filehandle !< file handle @@ -92,8 +112,11 @@ END FUNCTION h5bl_writefieldattrib_r8 !> - !! See \ref H5BlockReadFieldAttribFloat64 - !! \return 0 on success or error code + !! Read float64 values from attribute \c attrib_name of field + !! \c field_name into a \c buffer. + !! + !! \return \c H5_SUCCESS on success + !! \return \c H5_FAILURE on error INTEGER*8 FUNCTION h5bl_readfieldattrib_r8 ( filehandle, field_name, attrib_name, attrib_value ) INTEGER*8,INTENT(IN) :: filehandle !< file handle @@ -103,8 +126,11 @@ END FUNCTION h5bl_readfieldattrib_r8 !> - !! See \ref H5BlockWriteFieldAttribFloat32 - !! \return 0 on success or error code + !! Write float32 \c values as attribute \c attrib_name of field + !! \c field_name. + !! + !! \return \c H5_SUCCESS on success + !! \return \c H5_FAILURE on error INTEGER*8 FUNCTION h5bl_writefieldattrib_r4 (filehandle, field_name, attrib_name, attrib_value, attrib_nelems) INTEGER*8,INTENT(IN) :: filehandle !< file handle @@ -115,8 +141,11 @@ END FUNCTION h5bl_writefieldattrib_r4 !> - !! See \ref H5BlockReadFieldAttribFloat32 - !! \return 0 on success or error code + !! Read float32 values from attribute \c attrib_name of field + !! \c field_name into a \c buffer. + !! + !! \return \c H5_SUCCESS on success + !! \return \c H5_FAILURE on error INTEGER*8 FUNCTION h5bl_readfieldattrib_r4 (filehandle, field_name, attrib_name, attrib_value) INTEGER*8,INTENT(IN) :: filehandle !< file handle @@ -133,9 +162,12 @@ ! |___/ !> - !! See \ref H5BlockWriteFieldAttribInt64 - !! \return 0 on success or error code - + !! Write int64 \c values as attribute \c attrib_name of field + !! \c field_name. + !! + !! \return \c H5_SUCCESS on success + !! \return \c H5_FAILURE on error + INTEGER*8 FUNCTION h5bl_writefieldattrib_i8 (filehandle, field_name, attrib_name, attrib_value, attrib_nelems) INTEGER*8,INTENT(IN) :: filehandle !< file handle CHARACTER(LEN=*), INTENT(IN) :: field_name !< name of field @@ -145,8 +177,11 @@ END FUNCTION h5bl_writefieldattrib_i8 !!> - !! See \ref H5BlockReadFieldAttribInt64 - !! \return 0 on success or error code + !! Read int64 values from attribute \c attrib_name of field + !! \c field_name into a \c buffer. + !! + !! \return \c H5_SUCCESS on success + !! \return \c H5_FAILURE on error INTEGER*8 FUNCTION h5bl_readfieldattrib_i8 (filehandle, field_name, attrib_name, attrib_value) INTEGER*8,INTENT(IN) :: filehandle !< file handle @@ -156,8 +191,11 @@ END FUNCTION h5bl_readfieldattrib_i8 !> - !! See \ref H5BlockWriteFieldAttribInt32 - !! \return 0 on success or error code + !! Write int32 \c values as attribute \c attrib_name of field + !! \c field_name. + !! + !! \return \c H5_SUCCESS on success + !! \return \c H5_FAILURE on error INTEGER*8 FUNCTION h5bl_writefieldattrib_i4 (filehandle, field_name, attrib_name, attrib_value, attrib_nelems) INTEGER*8,INTENT(IN) :: filehandle !< file handle @@ -168,8 +206,11 @@ END FUNCTION h5bl_writefieldattrib_i4 !> - !! See \ref H5BlockReadFieldAttribInt32 - !! \return 0 on success or error code + !! Read int32 values from attribute \c attrib_name of field + !! \c field_name into a \c buffer. + !! + !! \return \c H5_SUCCESS on success + !! \return \c H5_FAILURE on error INTEGER*8 FUNCTION h5bl_readfieldattrib_i4 (filehandle, field_name, attrib_name, attrib_value) INTEGER*8,INTENT(IN) :: filehandle !< file handle @@ -178,37 +219,6 @@ INTEGER*4,INTENT(OUT):: attrib_value(*) !< attribute data will be read into this array END FUNCTION h5bl_readfieldattrib_i4 - ! __ _ _ _ _ - ! / _(_) ___| | __| | ___ _ __ __ _ ___(_)_ __ __ _ - ! | |_| |/ _ \ |/ _` | / __| '_ \ / _` |/ __| | '_ \ / _` | - ! | _| | __/ | (_| | \__ \ |_) | (_| | (__| | | | | (_| | - ! |_| |_|\___|_|\__,_| |___/ .__/ \__,_|\___|_|_| |_|\__, | - ! |_| |___/ - - !> - !! See \ref H5Block3dGetFieldSpacing - !! \return 0 on success or error code - - INTEGER*8 FUNCTION h5bl_3d_get_field_spacing (filehandle, name, x, y, z) - INTEGER*8, INTENT(IN) :: filehandle - CHARACTER(LEN=*), INTENT(IN) :: name - REAL*8, INTENT(OUT) :: x - REAL*8, INTENT(OUT) :: y - REAL*8, INTENT(OUT) :: z - END FUNCTION h5bl_3d_get_field_spacing - - !> - !! See \ref H5Block3dSetFieldSpacing - !! \return 0 on success or error code - - INTEGER*8 FUNCTION h5bl_3d_set_field_spacing (filehandle, name, x, y, z) - INTEGER*8, INTENT(IN) :: filehandle - CHARACTER(LEN=*), INTENT(IN) :: name - REAL*8, INTENT(IN) :: x - REAL*8, INTENT(IN) :: y - REAL*8, INTENT(IN) :: z - END FUNCTION h5bl_3d_set_field_spacing - ! __ _ _ _ _ _ ! / _(_) ___| | __| | ___ _ __(_) __ _(_)_ __ ! | |_| |/ _ \ |/ _` | / _ \| '__| |/ _` | | '_ \ @@ -217,8 +227,10 @@ ! |___/ !> - !! See \ref H5Block3dGetFieldOrigin - !! \return 0 on success or error code + !! Get field origin. + !! + !! \return \c H5_SUCCESS on success + !! \return \c H5_FAILURE on error INTEGER*8 FUNCTION h5bl_3d_get_field_origin (filehandle, name, x, y, z) INTEGER*8, INTENT(IN) :: filehandle @@ -229,8 +241,10 @@ END FUNCTION h5bl_3d_get_field_origin !> - !! See \ref H5Block3dSetFieldOrigin - !! \return 0 on success or error code + !! Set field origin. + !! + !! \return \c H5_SUCCESS on success + !! \return \c H5_FAILURE on error INTEGER*8 FUNCTION h5bl_3d_set_field_origin (filehandle, name, x, y, z) INTEGER*8, INTENT(IN) :: filehandle @@ -240,6 +254,41 @@ REAL*8, INTENT(IN) :: z END FUNCTION h5bl_3d_set_field_origin + ! __ _ _ _ _ + ! / _(_) ___| | __| | ___ _ __ __ _ ___(_)_ __ __ _ + ! | |_| |/ _ \ |/ _` | / __| '_ \ / _` |/ __| | '_ \ / _` | + ! | _| | __/ | (_| | \__ \ |_) | (_| | (__| | | | | (_| | + ! |_| |_|\___|_|\__,_| |___/ .__/ \__,_|\___|_|_| |_|\__, | + ! |_| |___/ + + !> + !! Get field spacing. + !! + !! \return \c H5_SUCCESS on success + !! \return \c H5_FAILURE on error + + INTEGER*8 FUNCTION h5bl_3d_get_field_spacing (filehandle, name, x, y, z) + INTEGER*8, INTENT(IN) :: filehandle + CHARACTER(LEN=*), INTENT(IN) :: name + REAL*8, INTENT(OUT) :: x + REAL*8, INTENT(OUT) :: y + REAL*8, INTENT(OUT) :: z + END FUNCTION h5bl_3d_get_field_spacing + + !> + !! Set field spacing. + !! + !! \return \c H5_SUCCESS on success + !! \return \c H5_FAILURE on error + + INTEGER*8 FUNCTION h5bl_3d_set_field_spacing (filehandle, name, x, y, z) + INTEGER*8, INTENT(IN) :: filehandle + CHARACTER(LEN=*), INTENT(IN) :: name + REAL*8, INTENT(IN) :: x + REAL*8, INTENT(IN) :: y + REAL*8, INTENT(IN) :: z + END FUNCTION h5bl_3d_set_field_spacing + ! __ _ _ _ _ ! / _(_) ___| | __| | ___ ___ ___ _ __ __| |___ ! | |_| |/ _ \ |/ _` | / __/ _ \ / _ \| '__/ _` / __| @@ -247,8 +296,15 @@ ! |_| |_|\___|_|\__,_| \___\___/ \___/|_| \__,_|___/ !> - !! See \ref H5Block3dSetFieldXCoords - !! \return 0 on success -1 on error + !! Set an explicit list of X coordinates for field \c field_name in the current + !! time step. The coordinates are a 1D array of floating point values with + !! dimension \c n_coords. + !! + !! By convention, the \c coords array should have the same length as the X + !! dimension of the field, and a warning will be printed if not. + !! + !! \return \c H5_SUCCESS on success + !! \return \c H5_FAILURE on error INTEGER*8 FUNCTION h5bl_set_fieldxcoords (filehandle, field_name, coords, n_coords) INTEGER*8, INTENT(IN) :: filehandle @@ -258,8 +314,15 @@ END FUNCTION h5bl_set_fieldxcoords !> - !! See \ref H5Block3dGetFieldXCoords - !! \return 0 on success -1 on error + !! Get the explicit list of X coordinates for field \c field_name in the current + !! time step. The coordinates are read into the 1D array \c coords which has + !! length \c n_coords. + !! + !! By convention, the \c coords array should have the same length as the X + !! dimension of the field, and a warning will be printed if they differ. + !! + !! \return \c H5_SUCCESS on success + !! \return \c H5_FAILURE on error INTEGER*8 FUNCTION h5bl_get_fieldxcoords (filehandle, field_name, coords, n_coords) INTEGER*8, INTENT(IN) :: filehandle @@ -269,8 +332,13 @@ END FUNCTION h5bl_get_fieldxcoords !> - !! See \ref H5Block3dSetFieldYCoords - !! \return 0 on success -1 on error + !! Set an explicit list of Y coordinates for field \c field_name in the current + !! time step. + !! + !! \see h5bl_set_fieldxcoords() + !! + !! \return \c H5_SUCCESS on success + !! \return \c H5_FAILURE on error INTEGER*8 FUNCTION h5bl_set_fieldycoords (filehandle, field_name, coords, n_coords) INTEGER*8, INTENT(IN) :: filehandle @@ -280,8 +348,13 @@ END FUNCTION h5bl_set_fieldycoords !> - !! See \ref H5Block3dGetFieldYCoords - !! \return 0 on success -1 on error + !! Get the explicit list of Y coordinates for field \c field_name in the current + !! time step. + !! + !! \see h5bl_get_fieldxcoords() + !! + !! \return \c H5_SUCCESS on success + !! \return \c H5_FAILURE on error INTEGER*8 FUNCTION h5bl_get_fieldycoords (filehandle, field_name, coords, n_coords) INTEGER*8, INTENT(IN) :: filehandle @@ -291,8 +364,13 @@ END FUNCTION h5bl_get_fieldycoords !> - !! See \ref H5Block3dSetFieldZCoords - !! \return 0 on success -1 on error + !! Set an explicit list of Zcoordinates for field \c field_name in the current + !! time step. + !! + !! \see h5bl_set_fieldxcoords() + !! + !! \return \c H5_SUCCESS on success + !! \return \c H5_FAILURE on error INTEGER*8 FUNCTION h5bl_set_fieldzcoords (filehandle, field_name, coords, n_coords) INTEGER*8, INTENT(IN) :: filehandle @@ -302,8 +380,14 @@ END FUNCTION h5bl_set_fieldzcoords !> - !! See \ref H5Block3dGetFieldZCoords - !! \return 0 on success -1 on error + !> + !! Get the explicit list of Z coordinates for field \c field_name in the current + !! time step. + !! + !! \see h5bl_get_fieldxcoords() + !! + !! \return \c H5_SUCCESS on success + !! \return \c H5_FAILURE on error INTEGER*8 FUNCTION h5bl_get_fieldzcoords (filehandle, field_name, coords, n_coords) INTEGER*8, INTENT(IN) :: filehandle diff --git a/src/include/H5Block_attribs.h b/src/include/H5Block_attribs.h index 763a4b4..5801cb1 100644 --- a/src/include/H5Block_attribs.h +++ b/src/include/H5Block_attribs.h @@ -22,10 +22,20 @@ @{ */ -#ifdef __cplusplus -extern "C" { -#endif - +/* + ! __ _ _ _ _ _ _ _ _ + ! / _(_) ___| | __| | __ _| |_| |_ _ __(_) |__ _ _| |_ ___ ___ + ! | |_| |/ _ \ |/ _` | / _` | __| __| '__| | '_ \| | | | __/ _ \/ __| + ! | _| | __/ | (_| | | (_| | |_| |_| | | | |_) | |_| | || __/\__ \ + ! |_| |_|\___|_|\__,_| \__,_|\__|\__|_| |_|_.__/ \__,_|\__\___||___/ + ! + ! + ! __ _ _ _ ___ _ __ _ _ + ! / _` | | | |/ _ \ '__| | | | + ! | (_| | |_| | __/ | | |_| | + ! \__, |\__,_|\___|_| \__, | + ! |_| |___/ + */ /** Query the number of attributes of field \c field_name. @@ -88,7 +98,14 @@ H5BlockGetFieldAttribInfo ( attrib_nelem)); } -/********************** reading and writing attribute ************************/ +/* + ! _ __ _ _ + ! (_) / /__ ___| |_ _ __(_)_ __ __ _ + ! | | / / _ \ / __| __| '__| | '_ \ / _` | + ! | |/ / (_) | \__ \ |_| | | | | | | (_| | + ! |_/_/ \___/ |___/\__|_| |_|_| |_|\__, | + ! |___/ +*/ /** Write the string in \c buffer as attribute \c attrib_name of field @@ -155,6 +172,13 @@ H5BlockReadFieldAttribString ( (void*)buffer)); } +/* + ! _ __ _ + ! (_) / /__ _ __ ___ __ _| | + ! | | / / _ \ | '__/ _ \/ _` | | + ! | |/ / (_) | | | | __/ (_| | | + ! |_/_/ \___/ |_| \___|\__,_|_| + */ /** Write float64 \c values as attribute \c attrib_name of field @@ -267,6 +291,15 @@ H5BlockReadFieldAttribFloat32 ( buffer )); } +/* + ! _ __ _ _ + ! (_) / /__ (_)_ __ | |_ ___ __ _ ___ _ __ + ! | | / / _ \ | | '_ \| __/ _ \/ _` |/ _ \ '__| + ! | |/ / (_) | | | | | | || __/ (_| | __/ | + ! |_/_/ \___/ |_|_| |_|\__\___|\__, |\___|_| + ! |___/ +*/ + /** Write int64 \c values as attribute \c attrib_name of field \c field_name. @@ -376,6 +409,14 @@ H5BlockReadFieldAttribInt32 ( (void*)buffer )); } +/* + ! __ _ _ _ _ _ + ! / _(_) ___| | __| | ___ _ __(_) __ _(_)_ __ + ! | |_| |/ _ \ |/ _` | / _ \| '__| |/ _` | | '_ \ + ! | _| | __/ | (_| | | (_) | | | | (_| | | | | | + ! |_| |_|\___|_|\__,_| \___/|_| |_|\__, |_|_| |_| + ! |___/ +*/ /** Get field origin. @@ -436,6 +477,15 @@ H5Block3dSetFieldOrigin ( 3)); } +/* + ! __ _ _ _ _ + ! / _(_) ___| | __| | ___ _ __ __ _ ___(_)_ __ __ _ + ! | |_| |/ _ \ |/ _` | / __| '_ \ / _` |/ __| | '_ \ / _` | + ! | _| | __/ | (_| | \__ \ |_) | (_| | (__| | | | | (_| | + ! |_| |_|\___|_|\__,_| |___/ .__/ \__,_|\___|_|_| |_|\__, | + ! |_| |___/ +*/ + /** Get field spacing for field \c field_name in the current time step. @@ -494,6 +544,13 @@ H5Block3dSetFieldSpacing ( 3)); } +/* + ! __ _ _ _ _ + ! / _(_) ___| | __| | ___ ___ ___ _ __ __| |___ + ! | |_| |/ _ \ |/ _` | / __/ _ \ / _ \| '__/ _` / __| + ! | _| | __/ | (_| | | (_| (_) | (_) | | | (_| \__ \ + ! |_| |_|\___|_|\__,_| \___\___/ \___/|_| \__,_|___/ +*/ /** Set an explicit list of X coordinates for field \c field_name in the current time step. The coordinates are a 1D array of floating point values with @@ -557,11 +614,9 @@ H5Block3dGetFieldXCoords ( /** Set an explicit list of Y coordinates for field \c field_name in the current - time step. The coordinates are a 1D array of floating point values with - dimension \c n_coords. + time step. - By convention, the \c coords array should have the same length as the Y - dimension of the field, and a warning will be printed if not. + \see H5Block3dSetFieldXCoords() \return \c H5_SUCCESS on success \return \c H5_FAILURE on error @@ -588,11 +643,9 @@ H5Block3dSetFieldYCoords ( /** Get the explicit list of Y coordinates for field \c field_name in the current - time step. The coordinates are read into the 1D array \c coords which has - length \c n_coords. + time step. - By convention, the \c coords array should have the same length as the Y - dimension of the field, and a warning will be printed if they differ. + \see H5Block3dGetFieldXCoords() \return \c H5_SUCCESS on success \return \c H5_FAILURE on error @@ -618,11 +671,9 @@ H5Block3dGetFieldYCoords ( /** Set an explicit list of Z coordinates for field \c field_name in the current - time step. The coordinates are a 1D array of floating point values with - dimension \c n_coords. + time step. - By convention, the \c coords array should have the same length as the Z - dimension of the field, and a warning will be printed if not. + \see H5Block3dSetFieldXCoords() \return \c H5_SUCCESS on success \return \c H5_FAILURE on error @@ -648,12 +699,10 @@ H5Block3dSetFieldZCoords ( /** - Get the explicit list of Z coordinates for field \c field_name in the current - time step. The coordinates are read into the 1D array \c coords which has - length \c n_coords. + Get the explicit list of Y coordinates for field \c field_name in the current + time step. - By convention, the \c coords array should have the same length as the Z - dimension of the field, and a warning will be printed if they differ. + \see H5Block3dGetFieldXCoords() \return \c H5_SUCCESS on success \return \c H5_FAILURE on error @@ -676,11 +725,5 @@ H5Block3dGetFieldZCoords ( f, 2, field_name, H5BLOCK_FIELD_ZCOORD_NAME, coords, n_coords)); } - -#ifdef __cplusplus -} -#endif - ///< @} - #endif diff --git a/src/include/H5Block_io.f90 b/src/include/H5Block_io.f90 index 2e0a43a..799984c 100644 --- a/src/include/H5Block_io.f90 +++ b/src/include/H5Block_io.f90 @@ -7,13 +7,19 @@ ! License: see file COPYING in top level of source distribution. ! INTERFACE - !> \ingroup h5block_f90_api !! \addtogroup h5block_io_f !! @{ !> - !! See \ref H5Block3dWriteScalarFieldFloat64 - !! \return 0 on success or error code + !! Write the 3-dimensional field \p name from the array \p buffer + !! to the current step using the previously defined field + !! view. + !! + !! The data type is 64bit floating point (\c REAL*8). Ensure that + !! the number of items in the buffer matches the view. + !! + !! \return \c H5_SUCCESS on success + !! \return \c H5_FAILURE on error INTEGER*8 FUNCTION h5bl_3d_write_scalar_field_r8 ( filehandle, name, buffer ) INTEGER*8, INTENT(IN) :: filehandle !< the handle returned at file open @@ -22,8 +28,14 @@ END FUNCTION h5bl_3d_write_scalar_field_r8 !> - !! See \ref H5Block3dReadScalarFieldFloat64 - !! \return 0 on success or error code + !! Read the 3-dimensional field \c name into the array \p buffer + !!from the current step using the previously defined field layout. + !! + !! The data type is 64bit floating point (\c REAL*8). Ensure that + !! the number of items in the buffer matches the view. + !! + !! \return \c H5_SUCCESS on success + !! \return \c H5_FAILURE on error INTEGER*8 FUNCTION h5bl_3d_read_scalar_field_r8 ( filehandle, name, buffer ) INTEGER*8, INTENT(IN) :: filehandle !< the handle returned at file open diff --git a/src/include/H5Block_io.h b/src/include/H5Block_io.h index 8b96f2c..093286d 100644 --- a/src/include/H5Block_io.h +++ b/src/include/H5Block_io.h @@ -20,21 +20,15 @@ @{ */ -#ifdef __cplusplus -extern "C" { -#endif - /** - Attempts to write the 3-dimensional field \p name from the - buffer pointed to by \p buffer to the current step using the - previously defined field view. + Write the 3-dimensional field \p name from the buffer pointed to by + \p buffer to the current step using the previously defined field + view. The data type is 64bit floating point (\c h5_float64_t). Ensure that the number of items in the buffer matches the view. Use the FORTRAN indexing scheme to store data in the buffer. - You must use the Fortran indexing scheme to access items in \c data. - \return \c H5_SUCCESS on success \return \c H5_FAILURE on error */ @@ -51,11 +45,12 @@ H5Block3dWriteScalarFieldFloat64 ( } /** - Read a 3-dimensional field \c name into the buffer starting at \c data from - the current time-step using the defined field layout. Values are - floating points (64-bit). + Read the 3-dimensional field \c name into the buffer pointed to by + \p buffer from the current tep using the defined field layout. - You must use the Fortran indexing scheme to access items in \c data. + The data type is 64bit floating point (\c h5_float64_t). Ensure that + the number of items in the buffer matches the view. Use the FORTRAN + indexing scheme to access data in the buffer. \return \c H5_SUCCESS on success \return \c H5_FAILURE on error @@ -74,7 +69,7 @@ H5Block3dReadScalarFieldFloat64 ( } /** - Write a 3-dimensional field \c name with 3-dimensional vectors as values + Write the 3-dimensional field \c name with 3-dimensional vectors as values from the buffers starting at \c x_buf, \c y_buf and \c z_buf to the current time-step using the defined field layout. Values are 3-dimensional vectors with floating points (64-bit) values. @@ -432,10 +427,5 @@ H5Block3dReadVector3dFieldInt32 ( x_buf, y_buf, z_buf, H5T_NATIVE_INT32)); } -#ifdef __cplusplus -} -#endif - ///< @} - #endif