From: Daniel Garcia-Sanchez Date: Fri, 14 Aug 2020 13:40:23 +0000 (+0200) Subject: Add declarations of internal functions X-Git-Tag: v9.3.0-rc1~1169^2~1 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=fd1f05ed8175dd98758b98197dd60e1fa716cf89;p=dealii.git Add declarations of internal functions --- diff --git a/include/deal.II/base/hdf5.h b/include/deal.II/base/hdf5.h index 8a6a9c179b..fe6a76bb65 100644 --- a/include/deal.II/base/hdf5.h +++ b/include/deal.II/base/hdf5.h @@ -1106,21 +1106,145 @@ namespace HDF5 const MPI_Comm mpi_communicator); }; + namespace internal + { + /** This function returns the HDF5 datatype corresponding to the C++ type. + * In the case of std::complex types the HDF5 handlers are automatically + * freed using the destructor of `std::shared_ptr`. `std::shared_ptr` is + * used instead of `std::unique_ptr` because the destructor of + * `std::shared_ptr` doesn't have to be defined in the template argument. In + * the other hand, the destructor of `std::unique` has to be defined in the + * template argument. Native types such as `H5T_NATIVE_DOUBLE` do not + * require a destructor, but compound types such as std::complex + * require a destructor to free the HDF5 resources. + */ + template + std::shared_ptr + get_hdf5_datatype(); + + /** Return the dimensions of `data`. For a std::vector this function returns + * `std::vector{vector_size}`. + * + * Several HDF5 functions such as H5Screate_simple() require a + * one-dimensional array that specifies the size of each dimension of the + * container, see: + * https://support.hdfgroup.org/HDF5/doc1.8/RM/RM_H5S.html#Dataspace-CreateSimple + */ + template + std::vector + get_container_dimensions(const std::vector &data); + + /** Return the dimensions of `data`. For a Vector this function returns + * `std::vector{vector_size}`. + */ + template + std::vector + get_container_dimensions(const Vector &data); + + /** Return the dimensions of `data`. For a FullMatrix the function returns + * `std::vector{rows, columns}`. + */ + template + std::vector + get_container_dimensions(const FullMatrix &data); + + /** This function returns the total size of the container. For a std::vector + * the function returns `int(vector_size)`. + */ + template + unsigned int + get_container_size(const std::vector &data); + + /** This function returns the total size of the container. For a Vector the + * function returns `int(vector_size)`. + */ + template + unsigned int + get_container_size(const Vector &data); + + /** This function returns the total size of the container. For a FullMatrix + * the function returns `int(rows*columns)`. + */ + template + unsigned int + get_container_size(const FullMatrix &data); + + /** This function initializes and returns a container of type std::vector, + * Vector or FullMatrix. The function does not set the values of the + * elements of the container. The container can store data of a HDF5 dataset + * or a HDF5 selection. The dimensions parameter holds the dimensions of the + * HDF5 dataset or selection. + * + * In the case of a std::vector, the size of the vector will be the total + * size given by dimensions. For example in the case of a dataset of rank 3, + * the dimensions are `std::vector{dim_0,dim_1,dim_2}`. The size of + * the returned std::vector will be `dim_0*dim_1*dim_2`. + * + * In the case of a dealii::Vector, the size of the returned dealii::Vector + * will be as well `dim_0*dim_1*dim_2`. + * + * A FullMatrix can store only data of HDF5 datasets with rank 2. The size + * of the FullMatrix will be FullMatrix(dim_0,dim_2) + */ + template + typename std::enable_if< + std::is_same>::value, + Container>::type + initialize_container(const std::vector &dimensions); + + /** Same as above. + */ + template + typename std::enable_if< + std::is_same>::value, + Container>::type + initialize_container(const std::vector &dimensions); + + /** Same as above. + */ + template + typename std::enable_if< + std::is_same>::value, + Container>::type + initialize_container(const std::vector &dimensions); + + /** This helper function sets the property list of the read and write + * operations of DataSet. A property list has to be created for the MPI + * driver. For the serial driver the default H5P_DEFAULT can be used. In + * addition H5Pset_dxpl_mpio is used to set the MPI mode to collective. + */ + inline void + set_plist(hid_t &plist, const bool mpi); + + /** This helper function releases the property list handler of the read and + * write operations of DataSet. For the serial version there is no need to + * release the property list handler because H5P_DEFAULT has been used. If + * query_io_mode is True then H5Pget_mpio_actual_io_mode and + * H5Pget_mpio_no_collective_cause are used to check if the operation has + * been collective. + */ + inline void + release_plist(hid_t & plist, + H5D_mpio_actual_io_mode_t &io_mode, + uint32_t & local_no_collective_cause, + uint32_t & global_no_collective_cause, + const bool mpi, + const bool query_io_mode); + + /** Convert a HDF5 no_collective_cause code to a human readable string. + */ + inline std::string + no_collective_cause_to_string(const uint32_t no_collective_cause); + } // namespace internal + // definitions namespace internal { - // This function gives the HDF5 datatype corresponding to the C++ type. In - // the case of std::complex types the HDF5 handlers are automatically freed - // using the destructor of std::shared_ptr. - // std::shared_ptr is used instead of std::unique_ptr because the destructor - // of std::shared_ptr doesn't have to be defined in the template argument. - // In the other hand, the destructor of std::unique has to be defined in the - // template argument. Native types such as H5T_NATIVE_DOUBLE do not - // require a destructor, but compound types such as std::complex - // require a destructor to free the HDF5 resources. template std::shared_ptr get_hdf5_datatype() @@ -1192,15 +1316,6 @@ namespace HDF5 - // Several HDF5 functions such as H5Screate_simple() require a - // one-dimensional array that specifies the size of each dimension of the - // container, see: - // https://support.hdfgroup.org/HDF5/doc1.8/RM/RM_H5S.html#Dataspace-CreateSimple - // The function get_container_dimensions returns a vector with the - // dimensions of the container. - // For a std::vector the function returns std::vector{vector_size} - // For a Vector the function returns std::vector{vector_size} - // For a FullMatrix the function returns std::vector{rows, columns} template std::vector get_container_dimensions(const std::vector &data) @@ -1231,10 +1346,6 @@ namespace HDF5 - // This function returns the total size of the container. - // For a std::vector the function returns int(vector_size) - // For a Vector the function returns int(vector_size) - // For a FullMatrix the function returns int(rows*columns) template unsigned int get_container_size(const std::vector &data) @@ -1262,22 +1373,6 @@ namespace HDF5 - // This function initializes and returns a container of type std::vector, - // Vector or FullMatrix. The function does not set the values of the - // elements of the container. The container can store data of a HDF5 dataset - // or a HDF5 selection. The dimensions parameter holds the dimensions of the - // HDF5 dataset or selection. - // - // In the case of a std::vector, the size of the vector will be the total - // size given by dimensions. For example in the case of a dataset of rank 3, - // the dimensions are std::vector{dim_0,dim_1,dim_2}. The size of - // the returned std::vector will be dim_0*dim_1*dim_2 - // - // In the case of a dealii::Vector, the size of the returned dealii::Vector - // will be as well dim_0*dim_1*dim_2 - // - // A FullMatrix can store only data of HDF5 datasets with rank 2. The size - // of the FullMatrix will be FullMatrix(dim_0,dim_2) template typename std::enable_if< std::is_same