files_utilities.f90

Go to the documentation of this file.

!------------------------------------------------------------------------------!
!------------------------------------------------------------------------------!
module files_utilities
#include <PB3D_macros.h>
    use str_utilities
    use messages
    use num_vars, only: dp, max_str_ln
    implicit none
    private
    public nextunit, get_file_info, get_full_pb3d_name, delete_file, &
        &skip_comment, count_lines
 
contains
    integer function nextunit(unit)
        ! input / output
        integer, intent(out), optional :: unit
        
        ! local variables
        integer, parameter :: lun_min=70, lun_max=1000
        logical :: file_open
        integer :: lun
        
        ! iterate over permitted luns until available one found
        nextunit=-1
        do lun=lun_min,lun_max
            inquire(unit=lun,opened=file_open)
            if (.not.file_open) then
                nextunit=lun
                exit
            end if
        end do
        
        ! return unit number if present
        if (present(unit)) unit=nextunit
    end function nextunit
    
    integer function skip_comment(file_i,file_name) result(ierr)
        character(*), parameter :: rout_name = 'skip_comment'
        
        ! input / output
        integer, intent(in) :: file_i                                           ! file identifier
        character(len=*), intent(in), optional :: file_name                     ! file name
        
        ! local variables
        character(len=1) :: loc_data_char                                       ! first data character
        character(len=max_str_ln) :: err_msg                                    ! error message
        
        ! initialize ierr
        ierr = 0
        
        loc_data_char = '#'
        do while (loc_data_char.eq.'#')
            read(file_i,*,iostat=ierr) loc_data_char
            if (present(file_name)) then
                err_msg = 'failed to read "'//trim(file_name)//'"'
            else
                err_msg = 'failed to read file'
            end if
            chckerr(err_msg)
        end do
        backspace(file_i)
    end function skip_comment
    
    subroutine get_file_info(file_name,file_size,acc_time,mod_time)
        ! input / output
        character(len=*), intent(in) :: file_name
        integer, intent(inout), optional :: file_size
        integer, intent(inout), optional :: acc_time
        integer, intent(inout), optional :: mod_time
        
        ! local variables
        integer :: vals(13)                                                     ! values
        integer :: istat                                                        ! status
        
        ! call stat
        call stat(trim(file_name),vals,istat)
        
        ! check status
        if (istat.ne.0) then
            call writo('call to stat failed',warning=.true.)
            if (present(file_size)) file_size = 0
            if (present(acc_time)) acc_time = 0
            if (present(mod_time)) mod_time = 0
        else
            if (present(file_size)) file_size = vals(8)
            if (present(acc_time)) acc_time = vals(9)
            if (present(mod_time)) mod_time = vals(10)
        end if
    end subroutine get_file_info
    
    character(len=max_str_ln) function get_full_pb3d_name(rich_lvl) &
        &result(full_pb3d_name)
        use num_vars, only: pb3d_name
        
        ! input / output
        integer, intent(in), optional :: rich_lvl                               ! optional richardson level to be appended
        
        ! local variables
        integer :: rich_lvl_loc                                                 ! local richardson level
        
        ! set local rich_lvl
        rich_lvl_loc = 0
        if (present(rich_lvl)) rich_lvl_loc = rich_lvl
        
        ! set ouput
        if (rich_lvl_loc.gt.0) then
            full_pb3d_name = trim(pb3d_name)//'_R_'//&
                &trim(i2str(rich_lvl_loc))//'.h5'
        else
            full_pb3d_name = trim(pb3d_name)//'.h5'
        end if
    end function get_full_pb3d_name
 
    integer function delete_file(file_name) result(istat)
        ! input / output
        character(len=*), intent(inout) :: file_name
        
        ! local variables
        integer :: file_i                                                       ! file unit
        logical :: file_open                                                    ! whether file is open
        
        ! initialize istat
        istat = 0 
        
        ! check if opened and open if not
        inquire(file=trim(file_name),opened=file_open,number=file_i,&
            &iostat=istat)
        chckstt
        if (.not.file_open) then
            open(unit=nextunit(file_i),file=trim(file_name),iostat=istat)
        end if
        chckstt
        
        ! remove open file
        close(unit=file_i,status='delete',iostat=istat)
        chckstt
    end function delete_file
    
    integer function count_lines(file_i) result(nr_lines)
        ! input / output
        integer, intent(in) :: file_i
        
        ! local variables
        integer :: istat                                                        ! status
        character(len=1) :: loc_data_char                                       ! first data character
        
        ! initialize istat
        istat = 0
        
        nr_lines = 0
        rewind(file_i)
        do while (istat.eq.0)
            ! read first character of data
            read(file_i,*,iostat=istat) loc_data_char
            if (istat.eq.0 .and. loc_data_char.ne.'#') then                     ! exclude comment lines
                nr_lines = nr_lines + 1
            end if
        end do
        rewind(file_i)
    end function count_lines
end module files_utilities