HDF5_vars.f90

Go to the documentation of this file.

!------------------------------------------------------------------------------!
!> Variables pertaining to HDF5 and XDMF.
!------------------------------------------------------------------------------!
module hdf5_vars
#include <PB3D_macros.h>
    use num_vars, only: max_str_ln, dp, plot_dir, data_dir, script_dir
    use messages
    use str_utilities, only: i2str, r2str, r2strt
    use hdf5
    
    implicit none
    private
    public init_hdf5, dealloc_xml_str, dealloc_var_1d, &
        &xmf_fmt, xdmf_num_types, xdmf_format_types, xdmf_geom_types, &
        &xdmf_top_types, xdmf_att_types, xdmf_center_types, xdmf_grid_types, &
        &max_dim_var_1d
    
    ! global variables
    integer, parameter :: max_xml_ln = 300                                      !< max. length of xml string
    character(len=6) :: xmf_fmt = '(999A)'                                      !< format to write the xmf file
    integer, parameter :: max_dim_var_1d = 100000                               !< maximum dimension of var_1D
    
    ! XDMF possibilities
    character(len=max_str_ln) :: xdmf_num_types(2)                              !< possible XDMF number types
    character(len=max_str_ln) :: xdmf_format_types(2)                           !< possible XDMF format types
    character(len=max_str_ln) :: xdmf_geom_types(2)                             !< possible XDMF geometry types
    character(len=max_str_ln) :: xdmf_top_types(2)                              !< possible XDMF topology types
    character(len=max_str_ln) :: xdmf_att_types(2)                              !< possible XDMF attribute types
    character(len=max_str_ln) :: xdmf_center_types(2)                           !< possible XDMF attribute center types
    character(len=max_str_ln) :: xdmf_grid_types(3)                             !< possible XDMF grid types
    
    !> XML strings used in XDMF
    type, public :: xml_str_type
        character(len=max_str_ln) :: name                                       !< name of this item
        integer :: max_xml_ln = 300                                             !< max. length of xml string
        character(len=max_xml_ln), allocatable :: xml_str(:)                    !< XML string
    end type xml_str_type
    
    !> HDF5 data type, containing the information about HDF5 files.
    type, public :: hdf5_file_type                                              
        integer(HID_T) :: hdf5_i                                                !< HDF5 file handle
        integer :: xdmf_i                                                       !< XDMF file handle
        character(len=max_str_ln) :: name                                       !< name of files (without extensions ".h5" and ".xmf")
    end type hdf5_file_type
    
    !> 1D  equivalent  of multidimensional  variables,  used  for internal  HDF5
    !! storage.
    type, public :: var_1d_type
        real(dp), allocatable :: p(:)                                           !< 1D equivalent of data of variable
        integer, allocatable :: tot_i_min(:)                                    !< total min.of indices of variable
        integer, allocatable :: tot_i_max(:)                                    !< total max.of indices of variable
        integer, allocatable :: loc_i_min(:)                                    !< group min.of indices of variable
        integer, allocatable :: loc_i_max(:)                                    !< group max.of indices of variable
        character(len=max_str_ln) :: var_name                                   !< name of variable
    end type var_1d_type
    
    ! interfaces
    
    !> \public Deallocates XML_str_type.
    interface dealloc_xml_str
        !> \public
        module procedure dealloc_xml_str_ind
        !> \public
        module procedure dealloc_xml_str_arr
    end interface
 
    !> \public Deallocates 1D variable.
    interface dealloc_var_1d
        !> \public
        module procedure dealloc_var_1d_ind
        !> \public
        module procedure dealloc_var_1d_arr
        !> \public
        module procedure dealloc_var_1d_arr_2
    end interface
    
contains
    !> Initializes the HDF5 types.
    !!
    !! Has to be called once.
    subroutine init_hdf5
        ! XDMF_num_types
        xdmf_num_types(1) = "Int"
        xdmf_num_types(2) = "Float"
        
        ! XDMF_format_types
        xdmf_format_types(1) = "XML"
        xdmf_format_types(2) = "HD5"
        
        ! XDMF_geom_types
        xdmf_geom_types(1) = "X_Y"
        xdmf_geom_types(2) = "X_Y_Z"
        
        ! XDMF_top_types
        xdmf_top_types(1) = "2DSMesh"
        xdmf_top_types(2) = "3DSMesh"
        
        ! XDMF_att_types
        xdmf_att_types(1) = "Scalar"
        xdmf_att_types(2) = "Vector"
        
        ! XDMF_center_types
        xdmf_center_types(1) = "Node"
        xdmf_center_types(2) = "Cell"
        
        ! XDMF_grid_types
        xdmf_grid_types(1) = "None"
        xdmf_grid_types(2) = "Temporal"
        xdmf_grid_types(3) = "Spatial"
    end subroutine init_hdf5
    
    !> \private array version
    subroutine dealloc_xml_str_arr(XML_str)
        ! input / output
        type(xml_str_type), intent(inout), allocatable :: XML_str(:)            !> array of XML strings to be deallocated
        
        ! local variables
        integer :: id                                                           ! counter
        
        ! deallocate individual arrays
        do id = 1,size(xml_str)
            call dealloc_xml_str_ind(xml_str(id))
        end do
        
        ! deallocate the array
        deallocate(xml_str)
    end subroutine dealloc_xml_str_arr
    !> \private individual version
    subroutine dealloc_xml_str_ind(XML_str)
        ! input / output
        type(xml_str_type), intent(out) :: XML_str                              !< XML string to be deallocated
    end subroutine dealloc_xml_str_ind
    
    !> \private rank 2 array version
    subroutine dealloc_var_1d_arr_2(var_1D)
        ! input / output
        type(var_1d_type), intent(inout), allocatable :: var_1D(:,:)            !< array of 1D variables to be deallocated
        
        ! local variables
        integer :: id, jd                                                       ! counters
        
        ! deallocate individual arrays
        do jd = 1,size(var_1d,2)
            do id = 1,size(var_1d,1)
                call dealloc_var_1d_ind(var_1d(id,jd))
            end do
        end do
        
        ! deallocate the array
        deallocate(var_1d)
    end subroutine dealloc_var_1d_arr_2
    !> \private array version
    subroutine dealloc_var_1d_arr(var_1D)
        ! input / output
        type(var_1d_type), intent(inout), allocatable :: var_1D(:)              !< array of 1D variables to be deallocated
        
        ! local variables
        integer :: id                                                           ! counter
        
        ! deallocate individual arrays
        do id = 1,size(var_1d)
            call dealloc_var_1d_ind(var_1d(id))
        end do
        
        ! deallocate the array
        deallocate(var_1d)
    end subroutine dealloc_var_1d_arr
    !> \private individual version
    subroutine dealloc_var_1d_ind(var_1D)
        ! input / output
        type(var_1d_type), intent(out) :: var_1D                                !< 1D variable to be deallocated
    end subroutine dealloc_var_1d_ind
end module hdf5_vars