From: Daniel Garcia-Sanchez Date: Mon, 29 Oct 2018 20:44:04 +0000 (+0100) Subject: Improve the documentation X-Git-Tag: v9.1.0-rc1~453^2~22 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=73d5b90e4f0d3254e7e55ae2f797ac10a63ac283;p=dealii.git Improve the documentation Modify the location of clang off Add in the documentation the MPI requirements Fix typos --- diff --git a/include/deal.II/base/hdf5.h b/include/deal.II/base/hdf5.h index 765562cb40..a51feb221d 100644 --- a/include/deal.II/base/hdf5.h +++ b/include/deal.II/base/hdf5.h @@ -28,6 +28,9 @@ DEAL_II_NAMESPACE_OPEN +// It is necessary to turn clang-format off in order to maintain the Doxygen +// links because the they are longer than 80 characters +// clang-format off /** * Namespace containing the HDF5 interface. * @@ -122,7 +125,8 @@ DEAL_II_NAMESPACE_OPEN * allows MPI to do optimizations. In these set of classes all the calls are set * to collective in order to maximize the performance. This means that all the * MPI processes have to contribute to every single call, even if they don't - * have data to write. + * have data to write. MPI HDF5 requires that dealii and HDF5 have been compiled + * with MPI support. * * ## Write a hyperslab in parallel * Hyperslabs are portions of datasets. A hyperslab can be a contiguous @@ -158,17 +162,10 @@ DEAL_II_NAMESPACE_OPEN * dataset.write_none(); * } * @endcode - */ -// It is necessary to turn clang-format off in order to maintain the Doxygen -// link -// clang-format off -/** + * * The function * DataSet::write_hyperslab(const Container &,const std::vector &, const std::vector &, const std::vector &, const std::vector &, const std::vector &) * can be used to write complex hyperslabs. - */ -// clang-format on -/** * * ## Write unordered data in parallel * The example below shows how to write a selection of data. @@ -311,6 +308,7 @@ DEAL_II_NAMESPACE_OPEN * * @author Daniel Garcia-Sanchez, 2018 */ +// clang-format on namespace HDF5 { /** @@ -616,22 +614,15 @@ namespace HDF5 write_selection(const std::vector & data, const std::vector &coordinates); + // clang-format off /** * Writes a data hyperslab to the dataset. The parameters are summarized * below: * - Offset: The starting location for the hyperslab. * - Count: The number of elements to select along each dimension. - */ - // It is necessary to turn clang-format off in order to maintain the Doxygen - // link - // clang-format off - /** * * Stride and block are set to NULL. For complex hyperslabs see * write_hyperslab(const Container &data, const std::vector &data_dimensions, const std::vector &offset, const std::vector &stride, const std::vector &count, const std::vector &block). - */ - // clang-format on - /** * * See the Dataspaces @@ -646,6 +637,7 @@ namespace HDF5 * Transfer: Datatype Conversion and Selection section in the HDF5 * User's Guide. */ + // clang-format on template void write_hyperslab(const Container & data, @@ -709,7 +701,7 @@ namespace HDF5 write_none(); /** - * This funcion returns the I/O mode that was used on the last + * This function returns the I/O mode that was used on the last * parallel I/O call. See H5Pget_mpio_actual_io_mode. * @@ -726,7 +718,7 @@ namespace HDF5 get_io_mode(); /** - * This funcion returns the I/O mode that was used on the last + * This function returns the I/O mode that was used on the last * parallel I/O call. See H5Pget_mpio_actual_io_mode. * The return type is `H5D_mpio_actual_io_mode_t` which corresponds to the @@ -746,7 +738,7 @@ namespace HDF5 /** - * This funcion returns the local causes that broke collective I/O on the + * This function returns the local causes that broke collective I/O on the * last parallel I/O call. See H5Pget_mpio_no_collective_cause. * @@ -767,7 +759,7 @@ namespace HDF5 get_local_no_collective_cause(); /** - * This funcion returns the local causes that broke collective I/O on the + * This function returns the local causes that broke collective I/O on the * last parallel I/O call. See H5Pget_mpio_no_collective_cause. * The return type is `uint32_t` and corresponds to the value returned by @@ -790,8 +782,8 @@ namespace HDF5 get_local_no_collective_cause_as_hdf5_type(); /** - * This funcion retrieves the global causes that broke collective I/O on the - * last parallel I/O call. See H5Pget_mpio_no_collective_cause. * * The return value is a std::string and can be @@ -811,7 +803,7 @@ namespace HDF5 get_global_no_collective_cause(); /** - * This funcion returns the global causes that broke collective I/O on the + * This function returns the global causes that broke collective I/O on the * last parallel I/O call. See H5Pget_mpio_no_collective_cause. * The return type is `uint32_t` and corresponds to the value returned by @@ -859,21 +851,21 @@ namespace HDF5 set_query_io_mode(bool query_io_mode); /** - * This funcion returns the dimensions of the dataset. The vector dimensions - * is a one-dimensional array of size rank specifying the size of each - * dimension of the dataset. + * This function returns the dimensions of the dataset. The vector + * dimensions is a one-dimensional array of size rank specifying the size of + * each dimension of the dataset. */ std::vector get_dimensions() const; /** - * This funcion returns the total number of elements in the dataset. + * This function returns the total number of elements in the dataset. */ unsigned int get_size() const; /** - * This funcion returns the rank of the dataset. + * This function returns the rank of the dataset. */ unsigned int get_rank() const;