gtool_file Module Reference

module GTOOL_FILE More...

Functions/Subroutines
subroutine, public	filecreate (fid, existed, basename, title, source, institution, master, myrank, rankidx, single, time_units, append, comm)
subroutine	filegetglobalattributetext (fid, key, val)
subroutine, public	filesetoption (fid, filetype, key, val)
subroutine, public	fileopen (fid, basename, mode, single, comm, myrank)
subroutine, public	filedefaxis (fid, name, desc, units, dim_name, dtype, dim_size)
subroutine, public	filedefassociatedcoordinates (fid, name, desc, units, dim_names, dtype)
subroutine, public	filedefinevariable (fid, vid, varname, desc, units, ndims, dims, dtype, tint, tavg)
subroutine, public	filesettattr (fid, vname, key, val)
subroutine, public	filegetshape (dims, basename, varname, myrank, single, error)
subroutine	filereadvar1drealdp (var, fid, varname, step, allow_missing, single, ntypes, dtype, start, count)
subroutine	filereadvar2drealsp (var, fid, varname, step, allow_missing, single, ntypes, dtype, start, count)
subroutine	filereadvar2drealdp (var, fid, varname, step, allow_missing, single, ntypes, dtype, start, count)
subroutine	filereadvar3drealsp (var, fid, varname, step, allow_missing, single, ntypes, dtype, start, count)
subroutine	filereadvar3drealdp (var, fid, varname, step, allow_missing, single, ntypes, dtype, start, count)
subroutine	filereadvar4drealsp (var, fid, varname, step, allow_missing, single, ntypes, dtype, start, count)
subroutine	filereadvar4drealdp (var, fid, varname, step, allow_missing, single, ntypes, dtype, start, count)
subroutine	filewrite1drealsp (fid, vid, var, t_start, t_end, start, count, ndims)
subroutine, public	fileenddef (fid)
subroutine, public	fileattachbuffer (fid, buf_amount)
subroutine, public	filedetachbuffer (fid)
subroutine, public	fileflush (fid)
subroutine, public	fileclose (fid)
subroutine, public	filecloseall
subroutine, public	filemakefname (fname, basename, prefix, myrank, len)

Variables
real(dp), parameter, public	rmiss = -9.9999e+30

Detailed Description

module GTOOL_FILE

Description

unified hundring of various kinds of files

Author

Team SCALE

History

• 2012-06-12 (S.Nishizawa) [new] Imported from SCALE-LES

Function/Subroutine Documentation

filecreate()

subroutine, public gtool_file::filecreate	(	integer, intent(out)	fid,
		logical, intent(out)	existed,
		character(len=*), intent(in)	basename,
		character(len=*), intent(in)	title,
		character(len=*), intent(in)	source,
		character(len=*), intent(in)	institution,
		integer, intent(in)	master,
		integer, intent(in)	myrank,
		integer, dimension(:), intent(in)	rankidx,
		logical, intent(in), optional	single,
		character(len=*), intent(in), optional	time_units,
		logical, intent(in), optional	append,
		integer, intent(in), optional	comm
	)

Definition at line 191 of file gtool_file.f90.

References gtool_file_h::file_fappend, gtool_file_h::file_fwrite, file_set_tunits(), dc_log::log(), and gtool_file_h::success_code.

Referenced by scale_fileio::fileio_create(), scale_fileio::fileio_write_1d(), scale_fileio::fileio_write_2d(), scale_fileio::fileio_write_3d(), scale_fileio::fileio_write_3d_t(), scale_fileio::fileio_write_4d(), and gtool_history::historyaddvariable().

    use mpi, only : mpi_comm_null
    implicit none

    integer,          intent(out)           :: fid
    logical,          intent(out)           :: existed
    character(len=*), intent( in)           :: basename
    character(len=*), intent( in)           :: title
    character(len=*), intent( in)           :: source
    character(len=*), intent( in)           :: institution
    integer,          intent( in)           :: master
    integer,          intent( in)           :: myrank
    integer,          intent( in)           :: rankidx(:)
    character(len=*), intent( in), optional :: time_units
    logical,          intent( in), optional :: single
    logical,          intent( in), optional :: append
    integer,          intent( in), optional :: comm ! MPI communicator

    character(len=File_HMID) :: time_units_
    logical :: single_
    integer :: mode
    integer :: error

    intrinsic size

    if ( present(time_units) ) then
       time_units_ = time_units
    else
       time_units_ = 'seconds'
    end if

    mpi_myrank = myrank

    if ( present(single) ) then
       if ( single .and. (myrank .ne. master) ) return
       single_ = single
    else
       single_ = .false.
    endif

    mode = file_fwrite
    if ( present(append) ) then
       if ( append ) mode = file_fappend
    end if

    call filegetfid( &
         fid,        & ! (out)
         existed,    & ! (out)
         basename,   & ! (in)
         mode,       & ! (in)
         single_,    & ! (in)
         comm        & ! (in)
         )

    if ( existed ) return

    !--- append package header to the file
    call filesetglobalattribute( fid, & ! (in)
         "title", title               ) ! (in)
    call filesetglobalattribute( fid, & ! (in)
         "source", source             ) ! (in)
    call filesetglobalattribute( fid, & ! (in)
         "institution", institution   ) ! (in)

    if ( .NOT. present(comm) .OR. comm == mpi_comm_null ) then
       ! for shared-file parallel I/O, skip attributes related to MPI processes
       call filesetglobalattribute( fid, & ! (in)
            "myrank", (/myrank/)         ) ! (in)
       call filesetglobalattribute( fid, & ! (in)
            "rankidx", rankidx           ) ! (in)
    end if

    call file_set_tunits( fid, & ! (in)
         time_units_,          & ! (in)
         error                 ) ! (out)
    if ( error /= success_code ) then
       call log('E', 'xxx failed to set time units')
    end if

    return

Here is the call graph for this function:

Here is the caller graph for this function:

filegetglobalattributetext()

subroutine gtool_file::filegetglobalattributetext	(	integer, intent(in)	fid,
		character(len=*), intent(in)	key,
		character(len=*), intent(out)	val
	)

Definition at line 278 of file gtool_file.f90.

References file_get_global_attribute_double(), file_get_global_attribute_float(), file_get_global_attribute_int(), file_get_global_attribute_text(), file_set_global_attribute_double(), file_set_global_attribute_float(), file_set_global_attribute_int(), file_set_global_attribute_text(), dc_log::log(), and gtool_file_h::success_code.

    integer,          intent(in) :: fid
    character(len=*), intent(in) :: key
    character(len=*), intent(out) :: val

    integer error

    intrinsic size

    call file_get_global_attribute_text( & ! (in)
         fid, key,                       & ! (in)
         val, error                      ) ! (out)
    if ( error /= success_code ) then
       call log('E', 'xxx failed to get text global attribute: '//trim(key))
    end if

    return

Here is the call graph for this function:

filesetoption()

subroutine, public gtool_file::filesetoption	(	integer, intent(in)	fid,
		character(len=*), intent(in)	filetype,
		character(len=*), intent(in)	key,
		character(len=*), intent(in)	val
	)

Definition at line 470 of file gtool_file.f90.

References file_set_option(), dc_log::log(), and gtool_file_h::success_code.

Referenced by gtool_history::historyaddvariable().

    integer,          intent(in) :: fid
    character(len=*), intent(in) :: filetype
    character(len=*), intent(in) :: key
    character(len=*), intent(in) :: val

    integer error

    call file_set_option( fid, filetype, key, val, & ! (in)
                          error                    ) ! (out)
    if ( error /= success_code ) then
       call log('E', 'xxx failed to set option')
    end if

    return

Here is the call graph for this function:

Here is the caller graph for this function:

fileopen()

subroutine, public gtool_file::fileopen	(	integer, intent(out)	fid,
		character(len=*), intent(in)	basename,
		integer, intent(in)	mode,
		logical, intent(in), optional	single,
		integer, intent(in), optional	comm,
		integer, intent(in), optional	myrank
	)

Definition at line 495 of file gtool_file.f90.

References gtool_file_h::already_existed_code, dc_types::dp, file_put_axis(), dc_log::log(), dc_types::sp, and gtool_file_h::success_code.

Referenced by scale_external_input::extin_regist(), filegetshape(), and scale_fileio::fileio_open().

    implicit none

    integer,          intent(out) :: fid
    character(len=*), intent( in) :: basename
    integer,          intent( in) :: mode
    logical,          intent( in), optional :: single
    integer,          intent( in), optional :: comm
    integer,          intent( in), optional :: myrank

    logical :: existed
    logical :: single_

    single_ = .false.

    if ( present(single) ) single_ = single
    if ( present(myrank) ) mpi_myrank = myrank

    call filegetfid( fid, existed,     & ! (out)
         basename, mode, single_, comm ) ! (in)

    return

Here is the call graph for this function:

Here is the caller graph for this function:

filedefaxis()

subroutine, public gtool_file::filedefaxis	(	integer, intent(in)	fid,
		character(len=*), intent(in)	name,
		character(len=*), intent(in)	desc,
		character(len=*), intent(in)	units,
		character(len=*), intent(in)	dim_name,
		integer, intent(in)	dtype,
		integer, intent(in)	dim_size
	)

Definition at line 584 of file gtool_file.f90.

References gtool_file_h::already_existed_code, dc_types::dp, file_def_axis(), file_put_associated_coordinates(), file_write_axis(), dc_log::log(), dc_types::sp, and gtool_file_h::success_code.

Referenced by scale_fileio::fileio_def_axes(), and gtool_history::historyaddvariable().

    integer,          intent(in) :: fid
    character(len=*), intent(in) :: name
    character(len=*), intent(in) :: desc
    character(len=*), intent(in) :: units
    character(len=*), intent(in) :: dim_name
    integer,          intent(in) :: dtype
    integer,          intent(in) :: dim_size

    integer error
    intrinsic size

    call file_def_axis( fid, name, desc, units, dim_name, dtype, dim_size, & ! (in)
         error                                                             ) ! (out)
    if ( error /= success_code .and. error /= already_existed_code ) then
       call log('E', 'xxx failed to define axis')
    end if

    return

Here is the call graph for this function:

Here is the caller graph for this function:

filedefassociatedcoordinates()

subroutine, public gtool_file::filedefassociatedcoordinates	(	integer, intent(in)	fid,
		character(len=*), intent(in)	name,
		character(len=*), intent(in)	desc,
		character(len=*), intent(in)	units,
		character(len=*), dimension(:), intent(in)	dim_names,
		integer, intent(in)	dtype
	)

Definition at line 903 of file gtool_file.f90.

References gtool_file_h::already_existed_code, dc_types::dp, file_add_variable(), file_def_associated_coordinates(), file_write_associated_coordinates(), dc_log::log(), dc_types::sp, and gtool_file_h::success_code.

Referenced by scale_fileio::fileio_def_axes(), and gtool_history::historyaddvariable().

    integer,          intent(in) :: fid
    character(len=*), intent(in) :: name
    character(len=*), intent(in) :: desc
    character(len=*), intent(in) :: units
    character(len=*), intent(in) :: dim_names(:)
    integer,          intent(in) :: dtype

    integer error
    intrinsic size

    call file_def_associated_coordinates( fid,                 & ! (in)
         name, desc, units, dim_names, size(dim_names), dtype, & ! (in)
         error                                                 ) ! (out)
    if ( error /= success_code .and. error /= already_existed_code ) then
       call log('E', 'xxx failed to put associated coordinates')
    end if

    return

Here is the call graph for this function:

Here is the caller graph for this function:

filedefinevariable()

subroutine, public gtool_file::filedefinevariable	(	integer, intent(in)	fid,
		integer, intent(out)	vid,
		character(len=*), intent(in)	varname,
		character(len=*), intent(in)	desc,
		character(len=*), intent(in)	units,
		integer, intent(in)	ndims,
		character(len=*), dimension(:), intent(in)	dims,
		integer, intent(in)	dtype,
		real(dp), intent(in), optional	tint,
		logical, intent(in), optional	tavg
	)

Definition at line 1427 of file gtool_file.f90.

References file_add_variable(), dc_log::log(), and gtool_file_h::success_code.

Referenced by scale_fileio::fileio_def_var().

    integer,          intent(out) :: vid
    integer,          intent( in) :: fid
    character(len=*), intent( in) :: varname
    character(len=*), intent( in) :: desc
    character(len=*), intent( in) :: units
    integer,          intent( in) :: ndims
    character(len=*), intent( in) :: dims(:)
    integer,          intent( in) :: dtype
    real(DP),         intent( in), optional :: tint
    logical,          intent( in), optional :: tavg

    real(DP) :: tint_
    integer  :: itavg
    integer  :: error
    integer  :: n

    intrinsic size
    !---------------------------------------------------------------------------

    vid = -1
    do n = 1, file_vid_count
       if ( file_vid_fid_list(n) == fid .and. &
            varname == file_vname_list(n) ) then
          vid = file_vid_list(n)
       end if
    enddo

    if ( vid < 0 ) then ! variable registration
       !--- register new variable
       write(message,'(2A)') '###### Variable registration : name = ', trim(varname)
       call log("I",message)

       if ( present(tint) ) then
          tint_ = tint
       else
          tint_ = -1.0_dp
       endif

       if ( present(tavg) ) then
          if ( tavg ) then
             itavg = 1
          else
             itavg = 0
          end if
       else
          itavg = 0
       end if

       call file_add_variable( vid,                        & ! (out)
            fid, varname, desc, units, dims, ndims, dtype, & ! (in)
            tint_, itavg,                                  & ! (in)
            error                                          ) ! (out)
       if ( error /= success_code ) then
          call log('E', 'xxx failed to add variable: '//trim(varname))
       end if

       file_vname_list(file_vid_count) = trim(varname)
       file_vid_list(file_vid_count) = vid
       file_vid_fid_list(file_vid_count) = fid
       file_vid_count                    = file_vid_count + 1
    endif

    return

Here is the call graph for this function:

Here is the caller graph for this function:

filesettattr()

subroutine, public gtool_file::filesettattr	(	integer, intent(in)	fid,
		character(len=*), intent(in)	vname,
		character(len=*), intent(in)	key,
		character(len=*), intent(in)	val
	)

Definition at line 1501 of file gtool_file.f90.

References gtool_file_h::already_existed_code, file_set_tattr(), dc_log::log(), and gtool_file_h::success_code.

Referenced by scale_fileio::fileio_def_axes(), gtool_history::historyaddvariable(), and gtool_history::historysettattr().

    integer,          intent(in) :: fid
    character(len=*), intent(in) :: vname
    character(len=*), intent(in) :: key
    character(len=*), intent(in) :: val

    integer :: error

    call file_set_tattr( &
         fid, vname, & ! (in)
         key, val,   & ! (in)
         error       ) ! (out)
    if ( error /= success_code .and. error /= already_existed_code ) then
       call log('E', 'xxx failed to set attr for axis')
    end if

    return

Here is the call graph for this function:

Here is the caller graph for this function:

filegetshape()

subroutine, public gtool_file::filegetshape	(	integer, dimension(:), intent(out)	dims,
		character(len=*), intent(in)	basename,
		character(len=*), intent(in)	varname,
		integer, intent(in)	myrank,
		logical, intent(in), optional	single,
		logical, intent(out), optional	error
	)

Definition at line 1529 of file gtool_file.f90.

References dc_types::dp, gtool_file_h::file_fread, file_get_datainfo(), file_read_data(), file_read_data_par(), fileopen(), dc_log::log(), rmiss, dc_types::sp, and gtool_file_h::success_code.

Referenced by scale_grid_nest::nest_setup(), mod_realinput_nicam::parentatomsetupnicam(), mod_realinput_nicam::parentlandsetupnicam(), mod_realinput_nicam::parentoceansetupnicam(), and mod_mkinit::read_sounding().

    implicit none

    integer,          intent(out)           :: dims(:)
    character(len=*), intent( in)           :: basename
    character(len=*), intent( in)           :: varname
    integer,          intent( in)           :: myrank
    logical,          intent( in), optional :: single
    logical,          intent(out), optional :: error

    integer :: fid
    type(datainfo) :: dinfo
    integer :: ierror
    integer :: n

    logical :: single_
    logical :: suppress

    intrinsic size
    intrinsic shape
    !---------------------------------------------------------------------------

    mpi_myrank = myrank

    if ( present(single) ) then
       single_ = single
    else
       single_ = .false.
    end if

    if ( present(error) ) then
       suppress = .true.
    else
       suppress = .false.
    end if

    !--- search/register file
    call fileopen( fid,                & ! (out)
         basename, file_fread, single_ ) ! (in)

    !--- get data information
    call file_get_datainfo( dinfo,  & ! (out)
         fid, varname, 1, suppress, & ! (in)
         ierror                     ) ! (out)

    !--- verify
    if ( ierror /= success_code ) then
       if ( present(error) ) then
          error = .true.
          return
       else
          call log('E', 'xxx failed to get data information :'//trim(varname))
       end if
    end if

    if ( dinfo%rank /= size(dims) ) then
       write(message,*) 'xxx rank is different, ', size(dims), dinfo%rank
       call log('E', message)
    end if
    do n = 1, size(dims)
       dims(n) = dinfo%dim_size(n)
    end do

    if ( present(error) ) error = .false.

    return

Here is the call graph for this function:

Here is the caller graph for this function:

filereadvar1drealdp()

subroutine gtool_file::filereadvar1drealdp	(	real(dp), dimension(:), intent(out)	var,
		integer, intent(in)	fid,
		character(len=*), intent(in)	varname,
		integer, intent(in)	step,
		logical, intent(in), optional	allow_missing,
		logical, intent(in), optional	single,
		integer, intent(in), optional	ntypes,
		integer, intent(in), optional	dtype,
		integer, dimension(:), intent(in), optional	start,
		integer, dimension(:), intent(in), optional	count
	)

Definition at line 2677 of file gtool_file.f90.

References dc_types::dp, file_get_datainfo(), file_read_data(), file_read_data_par(), dc_log::log(), and gtool_file_h::success_code.

    use mpi, only : mpi_comm_null
    implicit none

    real(DP),    intent(out)           :: var(:)
    integer,          intent( in)           :: fid
    character(len=*), intent( in)           :: varname
    integer,          intent( in)           :: step
    logical,          intent( in), optional :: allow_missing !--- if data is missing, set value to zero
    logical,          intent( in), optional :: single
    integer,          intent( in), optional :: ntypes      ! number of dtypes
    integer,          intent( in), optional :: dtype       ! MPI derived datatype for read buffer
    integer,          intent( in), optional :: start(:)    ! request starts to global variable
    integer,          intent( in), optional :: count(:)    ! request sizes to global variable

    type(datainfo) :: dinfo
    integer :: error

    intrinsic size, shape
    !---------------------------------------------------------------------------

    !--- get data information
    call file_get_datainfo( dinfo,    & ! (out)
         fid, varname, step, .false., & ! (in)
         error                        ) ! (out)

    !--- verify
    if ( error /= success_code ) then
       if ( present(allow_missing) ) then
          if ( allow_missing ) then
             write(message,*) 'xxx [INPUT]/[File] data not found! : ', &
                  'varname= ',trim(varname),', step=',step
             call log('I', message)
             call log('I', 'xxx [INPUT]/[File] Value is set to 0.')
             var(:) = 0.0_dp
          else
             call log('E', 'xxx failed to get data information :'//trim(varname))
          end if
       else
          call log('E', 'xxx failed to get data information :'//trim(varname))
       end if
    end if

    if ( dinfo%rank /= 1 ) then
       write(message,*) 'xxx rank is not 1', dinfo%rank
       call log('E', message)
    end if

    if (present(ntypes) ) then
       call file_read_data_par( var(:),                    & ! (out)
            dinfo, size(shape(var)), ntypes, dtype, start, count, & ! (in)
            error                                                 ) ! (out)
    else
       call file_read_data( var(:), & ! (out)
            dinfo, dp,                & ! (in)
            error                          ) ! (out)
    end if
    if ( error /= success_code ) then
       call log('E', 'xxx failed to get data value')
    end if

    return

Here is the call graph for this function:

filereadvar2drealsp()

subroutine gtool_file::filereadvar2drealsp	(	real(sp), dimension(:,:), intent(out)	var,
		integer, intent(in)	fid,
		character(len=*), intent(in)	varname,
		integer, intent(in)	step,
		logical, intent(in), optional	allow_missing,
		logical, intent(in), optional	single,
		integer, intent(in), optional	ntypes,
		integer, intent(in), optional	dtype,
		integer, dimension(:), intent(in), optional	start,
		integer, dimension(:), intent(in), optional	count
	)

Definition at line 2751 of file gtool_file.f90.

References file_get_datainfo(), file_read_data(), file_read_data_par(), dc_log::log(), dc_types::sp, and gtool_file_h::success_code.

    use mpi, only : mpi_comm_null
    implicit none

    real(SP),    intent(out)           :: var(:,:)
    integer,          intent( in)           :: fid
    character(len=*), intent( in)           :: varname
    integer,          intent( in)           :: step
    logical,          intent( in), optional :: allow_missing !--- if data is missing, set value to zero
    logical,          intent( in), optional :: single
    integer,          intent( in), optional :: ntypes      ! number of dtypes
    integer,          intent( in), optional :: dtype       ! MPI derived datatype for read buffer
    integer,          intent( in), optional :: start(:)    ! request starts to global variable
    integer,          intent( in), optional :: count(:)    ! request sizes to global variable

    type(datainfo) :: dinfo
    integer :: error

    intrinsic size, shape
    !---------------------------------------------------------------------------

    !--- get data information
    call file_get_datainfo( dinfo,    & ! (out)
         fid, varname, step, .false., & ! (in)
         error                        ) ! (out)

    !--- verify
    if ( error /= success_code ) then
       if ( present(allow_missing) ) then
          if ( allow_missing ) then
             write(message,*) 'xxx [INPUT]/[File] data not found! : ', &
                  'varname= ',trim(varname),', step=',step
             call log('I', message)
             call log('I', 'xxx [INPUT]/[File] Value is set to 0.')
             var(:,:) = 0.0_sp
          else
             call log('E', 'xxx failed to get data information :'//trim(varname))
          end if
       else
          call log('E', 'xxx failed to get data information :'//trim(varname))
       end if
    end if

    if ( dinfo%rank /= 2 ) then
       write(message,*) 'xxx rank is not 2', dinfo%rank
       call log('E', message)
    end if

    if (present(ntypes) ) then
       call file_read_data_par( var(:,:),                    & ! (out)
            dinfo, size(shape(var)), ntypes, dtype, start, count, & ! (in)
            error                                                 ) ! (out)
    else
       call file_read_data( var(:,:), & ! (out)
            dinfo, sp,                & ! (in)
            error                          ) ! (out)
    end if
    if ( error /= success_code ) then
       call log('E', 'xxx failed to get data value')
    end if

    return

Here is the call graph for this function:

filereadvar2drealdp()

subroutine gtool_file::filereadvar2drealdp	(	real(dp), dimension(:,:), intent(out)	var,
		integer, intent(in)	fid,
		character(len=*), intent(in)	varname,
		integer, intent(in)	step,
		logical, intent(in), optional	allow_missing,
		logical, intent(in), optional	single,
		integer, intent(in), optional	ntypes,
		integer, intent(in), optional	dtype,
		integer, dimension(:), intent(in), optional	start,
		integer, dimension(:), intent(in), optional	count
	)

Definition at line 2825 of file gtool_file.f90.

References dc_types::dp, file_get_datainfo(), file_read_data(), file_read_data_par(), dc_log::log(), and gtool_file_h::success_code.

    use mpi, only : mpi_comm_null
    implicit none

    real(DP),    intent(out)           :: var(:,:)
    integer,          intent( in)           :: fid
    character(len=*), intent( in)           :: varname
    integer,          intent( in)           :: step
    logical,          intent( in), optional :: allow_missing !--- if data is missing, set value to zero
    logical,          intent( in), optional :: single
    integer,          intent( in), optional :: ntypes      ! number of dtypes
    integer,          intent( in), optional :: dtype       ! MPI derived datatype for read buffer
    integer,          intent( in), optional :: start(:)    ! request starts to global variable
    integer,          intent( in), optional :: count(:)    ! request sizes to global variable

    type(datainfo) :: dinfo
    integer :: error

    intrinsic size, shape
    !---------------------------------------------------------------------------

    !--- get data information
    call file_get_datainfo( dinfo,    & ! (out)
         fid, varname, step, .false., & ! (in)
         error                        ) ! (out)

    !--- verify
    if ( error /= success_code ) then
       if ( present(allow_missing) ) then
          if ( allow_missing ) then
             write(message,*) 'xxx [INPUT]/[File] data not found! : ', &
                  'varname= ',trim(varname),', step=',step
             call log('I', message)
             call log('I', 'xxx [INPUT]/[File] Value is set to 0.')
             var(:,:) = 0.0_dp
          else
             call log('E', 'xxx failed to get data information :'//trim(varname))
          end if
       else
          call log('E', 'xxx failed to get data information :'//trim(varname))
       end if
    end if

    if ( dinfo%rank /= 2 ) then
       write(message,*) 'xxx rank is not 2', dinfo%rank
       call log('E', message)
    end if

    if (present(ntypes) ) then
       call file_read_data_par( var(:,:),                    & ! (out)
            dinfo, size(shape(var)), ntypes, dtype, start, count, & ! (in)
            error                                                 ) ! (out)
    else
       call file_read_data( var(:,:), & ! (out)
            dinfo, dp,                & ! (in)
            error                          ) ! (out)
    end if
    if ( error /= success_code ) then
       call log('E', 'xxx failed to get data value')
    end if

    return

Here is the call graph for this function:

filereadvar3drealsp()

subroutine gtool_file::filereadvar3drealsp	(	real(sp), dimension(:,:,:), intent(out)	var,
		integer, intent(in)	fid,
		character(len=*), intent(in)	varname,
		integer, intent(in)	step,
		logical, intent(in), optional	allow_missing,
		logical, intent(in), optional	single,
		integer, intent(in), optional	ntypes,
		integer, intent(in), optional	dtype,
		integer, dimension(:), intent(in), optional	start,
		integer, dimension(:), intent(in), optional	count
	)

Definition at line 2899 of file gtool_file.f90.

References file_get_datainfo(), file_read_data(), file_read_data_par(), dc_log::log(), dc_types::sp, and gtool_file_h::success_code.

    use mpi, only : mpi_comm_null
    implicit none

    real(SP),    intent(out)           :: var(:,:,:)
    integer,          intent( in)           :: fid
    character(len=*), intent( in)           :: varname
    integer,          intent( in)           :: step
    logical,          intent( in), optional :: allow_missing !--- if data is missing, set value to zero
    logical,          intent( in), optional :: single
    integer,          intent( in), optional :: ntypes      ! number of dtypes
    integer,          intent( in), optional :: dtype       ! MPI derived datatype for read buffer
    integer,          intent( in), optional :: start(:)    ! request starts to global variable
    integer,          intent( in), optional :: count(:)    ! request sizes to global variable

    type(datainfo) :: dinfo
    integer :: error

    intrinsic size, shape
    !---------------------------------------------------------------------------

    !--- get data information
    call file_get_datainfo( dinfo,    & ! (out)
         fid, varname, step, .false., & ! (in)
         error                        ) ! (out)

    !--- verify
    if ( error /= success_code ) then
       if ( present(allow_missing) ) then
          if ( allow_missing ) then
             write(message,*) 'xxx [INPUT]/[File] data not found! : ', &
                  'varname= ',trim(varname),', step=',step
             call log('I', message)
             call log('I', 'xxx [INPUT]/[File] Value is set to 0.')
             var(:,:,:) = 0.0_sp
          else
             call log('E', 'xxx failed to get data information :'//trim(varname))
          end if
       else
          call log('E', 'xxx failed to get data information :'//trim(varname))
       end if
    end if

    if ( dinfo%rank /= 3 ) then
       write(message,*) 'xxx rank is not 3', dinfo%rank
       call log('E', message)
    end if

    if (present(ntypes) ) then
       call file_read_data_par( var(:,:,:),                    & ! (out)
            dinfo, size(shape(var)), ntypes, dtype, start, count, & ! (in)
            error                                                 ) ! (out)
    else
       call file_read_data( var(:,:,:), & ! (out)
            dinfo, sp,                & ! (in)
            error                          ) ! (out)
    end if
    if ( error /= success_code ) then
       call log('E', 'xxx failed to get data value')
    end if

    return

Here is the call graph for this function:

filereadvar3drealdp()

subroutine gtool_file::filereadvar3drealdp	(	real(dp), dimension(:,:,:), intent(out)	var,
		integer, intent(in)	fid,
		character(len=*), intent(in)	varname,
		integer, intent(in)	step,
		logical, intent(in), optional	allow_missing,
		logical, intent(in), optional	single,
		integer, intent(in), optional	ntypes,
		integer, intent(in), optional	dtype,
		integer, dimension(:), intent(in), optional	start,
		integer, dimension(:), intent(in), optional	count
	)

Definition at line 2973 of file gtool_file.f90.

References dc_types::dp, file_get_datainfo(), file_read_data(), file_read_data_par(), dc_log::log(), and gtool_file_h::success_code.

    use mpi, only : mpi_comm_null
    implicit none

    real(DP),    intent(out)           :: var(:,:,:)
    integer,          intent( in)           :: fid
    character(len=*), intent( in)           :: varname
    integer,          intent( in)           :: step
    logical,          intent( in), optional :: allow_missing !--- if data is missing, set value to zero
    logical,          intent( in), optional :: single
    integer,          intent( in), optional :: ntypes      ! number of dtypes
    integer,          intent( in), optional :: dtype       ! MPI derived datatype for read buffer
    integer,          intent( in), optional :: start(:)    ! request starts to global variable
    integer,          intent( in), optional :: count(:)    ! request sizes to global variable

    type(datainfo) :: dinfo
    integer :: error

    intrinsic size, shape
    !---------------------------------------------------------------------------

    !--- get data information
    call file_get_datainfo( dinfo,    & ! (out)
         fid, varname, step, .false., & ! (in)
         error                        ) ! (out)

    !--- verify
    if ( error /= success_code ) then
       if ( present(allow_missing) ) then
          if ( allow_missing ) then
             write(message,*) 'xxx [INPUT]/[File] data not found! : ', &
                  'varname= ',trim(varname),', step=',step
             call log('I', message)
             call log('I', 'xxx [INPUT]/[File] Value is set to 0.')
             var(:,:,:) = 0.0_dp
          else
             call log('E', 'xxx failed to get data information :'//trim(varname))
          end if
       else
          call log('E', 'xxx failed to get data information :'//trim(varname))
       end if
    end if

    if ( dinfo%rank /= 3 ) then
       write(message,*) 'xxx rank is not 3', dinfo%rank
       call log('E', message)
    end if

    if (present(ntypes) ) then
       call file_read_data_par( var(:,:,:),                    & ! (out)
            dinfo, size(shape(var)), ntypes, dtype, start, count, & ! (in)
            error                                                 ) ! (out)
    else
       call file_read_data( var(:,:,:), & ! (out)
            dinfo, dp,                & ! (in)
            error                          ) ! (out)
    end if
    if ( error /= success_code ) then
       call log('E', 'xxx failed to get data value')
    end if

    return

Here is the call graph for this function:

filereadvar4drealsp()

subroutine gtool_file::filereadvar4drealsp	(	real(sp), dimension(:,:,:,:), intent(out)	var,
		integer, intent(in)	fid,
		character(len=*), intent(in)	varname,
		integer, intent(in)	step,
		logical, intent(in), optional	allow_missing,
		logical, intent(in), optional	single,
		integer, intent(in), optional	ntypes,
		integer, intent(in), optional	dtype,
		integer, dimension(:), intent(in), optional	start,
		integer, dimension(:), intent(in), optional	count
	)

Definition at line 3047 of file gtool_file.f90.

References file_get_datainfo(), file_read_data(), file_read_data_par(), dc_log::log(), dc_types::sp, and gtool_file_h::success_code.

    use mpi, only : mpi_comm_null
    implicit none

    real(SP),    intent(out)           :: var(:,:,:,:)
    integer,          intent( in)           :: fid
    character(len=*), intent( in)           :: varname
    integer,          intent( in)           :: step
    logical,          intent( in), optional :: allow_missing !--- if data is missing, set value to zero
    logical,          intent( in), optional :: single
    integer,          intent( in), optional :: ntypes      ! number of dtypes
    integer,          intent( in), optional :: dtype       ! MPI derived datatype for read buffer
    integer,          intent( in), optional :: start(:)    ! request starts to global variable
    integer,          intent( in), optional :: count(:)    ! request sizes to global variable

    type(datainfo) :: dinfo
    integer :: error

    intrinsic size, shape
    !---------------------------------------------------------------------------

    !--- get data information
    call file_get_datainfo( dinfo,    & ! (out)
         fid, varname, step, .false., & ! (in)
         error                        ) ! (out)

    !--- verify
    if ( error /= success_code ) then
       if ( present(allow_missing) ) then
          if ( allow_missing ) then
             write(message,*) 'xxx [INPUT]/[File] data not found! : ', &
                  'varname= ',trim(varname),', step=',step
             call log('I', message)
             call log('I', 'xxx [INPUT]/[File] Value is set to 0.')
             var(:,:,:,:) = 0.0_sp
          else
             call log('E', 'xxx failed to get data information :'//trim(varname))
          end if
       else
          call log('E', 'xxx failed to get data information :'//trim(varname))
       end if
    end if

    if ( dinfo%rank /= 4 ) then
       write(message,*) 'xxx rank is not 4', dinfo%rank
       call log('E', message)
    end if

    if (present(ntypes) ) then
       call file_read_data_par( var(:,:,:,:),                    & ! (out)
            dinfo, size(shape(var)), ntypes, dtype, start, count, & ! (in)
            error                                                 ) ! (out)
    else
       call file_read_data( var(:,:,:,:), & ! (out)
            dinfo, sp,                & ! (in)
            error                          ) ! (out)
    end if
    if ( error /= success_code ) then
       call log('E', 'xxx failed to get data value')
    end if

    return

Here is the call graph for this function:

filereadvar4drealdp()

subroutine gtool_file::filereadvar4drealdp	(	real(dp), dimension(:,:,:,:), intent(out)	var,
		integer, intent(in)	fid,
		character(len=*), intent(in)	varname,
		integer, intent(in)	step,
		logical, intent(in), optional	allow_missing,
		logical, intent(in), optional	single,
		integer, intent(in), optional	ntypes,
		integer, intent(in), optional	dtype,
		integer, dimension(:), intent(in), optional	start,
		integer, dimension(:), intent(in), optional	count
	)

Definition at line 3121 of file gtool_file.f90.

References dc_types::dp, file_get_datainfo(), file_read_data(), file_read_data_par(), dc_log::log(), and gtool_file_h::success_code.

    use mpi, only : mpi_comm_null
    implicit none

    real(DP),    intent(out)           :: var(:,:,:,:)
    integer,          intent( in)           :: fid
    character(len=*), intent( in)           :: varname
    integer,          intent( in)           :: step
    logical,          intent( in), optional :: allow_missing !--- if data is missing, set value to zero
    logical,          intent( in), optional :: single
    integer,          intent( in), optional :: ntypes      ! number of dtypes
    integer,          intent( in), optional :: dtype       ! MPI derived datatype for read buffer
    integer,          intent( in), optional :: start(:)    ! request starts to global variable
    integer,          intent( in), optional :: count(:)    ! request sizes to global variable

    type(datainfo) :: dinfo
    integer :: error

    intrinsic size, shape
    !---------------------------------------------------------------------------

    !--- get data information
    call file_get_datainfo( dinfo,    & ! (out)
         fid, varname, step, .false., & ! (in)
         error                        ) ! (out)

    !--- verify
    if ( error /= success_code ) then
       if ( present(allow_missing) ) then
          if ( allow_missing ) then
             write(message,*) 'xxx [INPUT]/[File] data not found! : ', &
                  'varname= ',trim(varname),', step=',step
             call log('I', message)
             call log('I', 'xxx [INPUT]/[File] Value is set to 0.')
             var(:,:,:,:) = 0.0_dp
          else
             call log('E', 'xxx failed to get data information :'//trim(varname))
          end if
       else
          call log('E', 'xxx failed to get data information :'//trim(varname))
       end if
    end if

    if ( dinfo%rank /= 4 ) then
       write(message,*) 'xxx rank is not 4', dinfo%rank
       call log('E', message)
    end if

    if (present(ntypes) ) then
       call file_read_data_par( var(:,:,:,:),                    & ! (out)
            dinfo, size(shape(var)), ntypes, dtype, start, count, & ! (in)
            error                                                 ) ! (out)
    else
       call file_read_data( var(:,:,:,:), & ! (out)
            dinfo, dp,                & ! (in)
            error                          ) ! (out)
    end if
    if ( error /= success_code ) then
       call log('E', 'xxx failed to get data value')
    end if

    return

Here is the call graph for this function:

filewrite1drealsp()

subroutine gtool_file::filewrite1drealsp	(	integer, intent(in)	fid,
		integer, intent(in)	vid,
		real(sp), dimension(:), intent(in)	var,
		real(dp), intent(in)	t_start,
		real(dp), intent(in)	t_end,
		integer, dimension(:), intent(in), optional	start,
		integer, dimension(:), intent(in), optional	count,
		integer, intent(in), optional	ndims
	)

Definition at line 3197 of file gtool_file.f90.

References dc_types::dp, file_write_data(), dc_log::log(), dc_types::sp, and gtool_file_h::success_code.

    implicit none

    real(SP), intent(in) :: var(:)
    integer,  intent(in)           :: fid
    integer,  intent(in)           :: vid
    real(DP), intent(in)           :: t_start
    real(DP), intent(in)           :: t_end
    integer,  intent(in), optional :: start(:)
    integer,  intent(in), optional :: count(:) ! when var has been reshaped to 1D
    integer,  intent(in), optional :: ndims    ! when var has been reshaped to 1D

    real(DP) :: ts, te

    integer :: start_(1)

    integer :: error, n
    character(len=100) :: str

    intrinsic shape
    !---------------------------------------------------------------------------

    ts = t_start
    te = t_end

    if ( present(ndims) ) then
       ! history variable has been reshaped to 1D
       ! In this case, start and count must be present

       if ( .not. present(start) ) then
          call log('E', 'start argument is neccessary when ndims is specified')
       end if
       if ( .not. present(count) ) then
          call log('E', 'count argument is neccessary when ndims is specified')
       end if

       call file_write_data( fid, vid, var(:), ts, te, sp, & ! (in)
            ndims, start, count,                                       & ! (in)
            error                                                      ) ! (out)
    else
       ! this is for restart variable which keeps its original shape
       if ( present(start) ) then
          start_(:) = start(:)
       else
          start_(:) = 1
       end if
       call file_write_data( fid, vid, var(:), ts, te, sp, & ! (in)
            1, start_, shape(var),                                & ! (in)
            error                                                      ) ! (out)
    end if
    if ( error /= success_code ) then
       do n = 1, file_vid_count
          if ( file_vid_list(n) == vid ) then
             write(str,*) 'xxx failed to write data: ', trim(file_vname_list(n)), mpi_myrank
             exit
          end if
       enddo
       call log('E', trim(str))
    end if

    return

Here is the call graph for this function:

fileenddef()

subroutine, public gtool_file::fileenddef

(

integer, intent(in)

fid

)

Definition at line 3761 of file gtool_file.f90.

References file_enddef(), dc_log::log(), and gtool_file_h::success_code.

Referenced by scale_fileio::fileio_enddef(), and gtool_history::historywriteaxes().

    implicit none

    integer, intent(in) :: fid

    integer :: error, n
    !---------------------------------------------------------------------------

    if ( fid < 0 ) return

    do n = 1, file_fid_count-1
       if ( file_fid_list(n) == fid ) exit
    end do
    if ( fid .NE. file_fid_list(n) ) then
       write(message,*) 'xxx in FileEndDef invalid fid' , fid
       call log('E', message)
    end if

    call file_enddef( fid, error )

    if ( error == success_code ) then

       call log("I",'')
       write(message,'(A,I3.3,2A)') '###### File end define mode : No.', file_fid_list(n), &
                                                  ', name = ', trim(file_fname_list(n))
       call log("I",message)
       call log("I",'')

    else

       call log('E', 'xxx failed to exit define mode')

    end if

    return

Here is the call graph for this function:

Here is the caller graph for this function:

fileattachbuffer()

subroutine, public gtool_file::fileattachbuffer	(	integer, intent(in)	fid,
		integer, intent(in)	buf_amount
	)

Definition at line 3802 of file gtool_file.f90.

References file_attach_buffer(), dc_log::log(), and gtool_file_h::success_code.

Referenced by scale_fileio::fileio_enddef(), and gtool_history::historyaddvariable().

    implicit none

    integer, intent(in) :: fid
    integer, intent(in) :: buf_amount

    integer :: error, n
    !---------------------------------------------------------------------------

    if ( fid < 0 ) return

    do n = 1, file_fid_count-1
       if ( file_fid_list(n) == fid ) exit
    end do
    if ( fid .NE. file_fid_list(n) ) then
       write(message,*) 'xxx in FileAttachBuffer invalid fid' , fid
       call log('E', message)
    end if

    call file_attach_buffer( fid, buf_amount, error )

    if ( error == success_code ) then

       write(message,'(A,I3.3,3A,I10)') '###### File attach buffer : No.', file_fid_list(n),  &
                                                       ', name = ', trim(file_fname_list(n)), &
                                                       ', size = ', buf_amount
       call log("I",message)

    else

       call log('E', 'xxx failed to attach buffer in PnetCDF')

    end if

    return

Here is the call graph for this function:

Here is the caller graph for this function:

filedetachbuffer()

subroutine, public gtool_file::filedetachbuffer

(

integer, intent(in)

fid

)

Definition at line 3842 of file gtool_file.f90.

References file_detach_buffer(), dc_log::log(), and gtool_file_h::success_code.

Referenced by scale_fileio::fileio_close(), and gtool_history::historyfinalize().

    implicit none

    integer, intent(in) :: fid

    integer :: error, n
    !---------------------------------------------------------------------------

    if ( fid < 0 ) return

    do n = 1, file_fid_count-1
       if ( file_fid_list(n) == fid ) exit
    end do
    if ( n == file_fid_count ) return  ! already closed

    if ( fid .NE. file_fid_list(n) ) then
       write(message,*) 'xxx in FileDetachBuffer invalid fid' , fid
       call log('E', message)
    end if

    call file_detach_buffer( fid, error )

    if ( error == success_code ) then

       write(message,'(A,I3.3,2A)') '###### File detach buffer : No.', file_fid_list(n), &
                                                   ', name = ', trim(file_fname_list(n))
       call log("I",message)

    else

       call log('E', 'xxx failed to detach buffer in PnetCDF')

    end if

    return

Here is the call graph for this function:

Here is the caller graph for this function:

fileflush()

subroutine, public gtool_file::fileflush

(

integer, intent(in)

fid

)

Definition at line 3883 of file gtool_file.f90.

References file_flush(), dc_log::log(), and gtool_file_h::success_code.

Referenced by scale_fileio::fileio_close(), scale_fileio::fileio_enddef(), scale_fileio::fileio_flush(), gtool_history::historywriteall(), and gtool_history::historywriteaxes().

    implicit none

    integer, intent(in) :: fid

    integer :: error, n
    !---------------------------------------------------------------------------

    if ( fid < 0 ) return
    if ( file_fid_count == 1 ) return

    do n = 1, file_fid_count-1
       if ( file_fid_list(n) == fid ) exit
    end do
    if ( n == file_fid_count ) return  ! already closed

    if ( fid .NE. file_fid_list(n) ) then
       write(message,*) 'xxx in FileFlush invalid fid' , fid
       call log('E', message)
    end if

    call file_flush( fid, error )

    if ( error == success_code ) then

       write(message,'(A,I3.3,2A)') '###### File flush : No.', file_fid_list(n), &
                                                  ', name = ', trim(file_fname_list(n))
       call log("I",message)
       call log("I",'')

    else

       call log('E', 'xxx failed to flush PnetCDF pending requests')

    end if

    return

Here is the call graph for this function:

Here is the caller graph for this function:

fileclose()

subroutine, public gtool_file::fileclose

(

integer, intent(in)

fid

)

Definition at line 3925 of file gtool_file.f90.

References gtool_file_h::already_closed_code, file_close(), dc_log::log(), and gtool_file_h::success_code.

Referenced by filecloseall(), scale_fileio::fileio_close(), and gtool_history::historyfinalize().

    implicit none

    integer, intent(in) :: fid

    character(len=File_HLONG) :: fname
    integer                   :: error
    integer                   :: n
    !---------------------------------------------------------------------------

    if ( fid < 0 ) return

    do n = 1, file_fid_count-1
       if ( file_fid_list(n) == fid ) exit
    end do
    if ( n == file_fid_count ) return  ! already closed

    if ( fid /= file_fid_list(n) ) then
       write(message,*) 'xxx in FileClose invalid fid ', fid
       call log('E', message)
    end if

    call file_close( fid, error )

    if ( error == success_code ) then

       write(message,'(A,I3.3,2A)') '###### File close : No.', file_fid_list(n), &
                                                  ', name = ', trim(file_fname_list(n))
       call log("I",message)
       call log("I",'')

    elseif( error /= already_closed_code ) then

       call log('E', 'xxx failed to close file')

    end if

    do n = 1, file_fid_count-1
       if ( file_fid_list(n) == fid ) then
          file_fid_list(n) = -1
          file_fname_list(n) = ''
       end if
    end do

    return

Here is the call graph for this function:

Here is the caller graph for this function:

filecloseall()

subroutine, public gtool_file::filecloseall

(

)

Definition at line 3972 of file gtool_file.f90.

References fileclose().

Referenced by scale_process::prc_mpitimestat(), mod_rm_driver::scalerm(), scalerm_launcher(), and mod_rm_prep::scalerm_prep().

    implicit none

    integer n
    !---------------------------------------------------------------------------

    do n = 1, file_fid_count-1
       call fileclose( file_fid_list(n) )
    enddo

    return

Here is the call graph for this function:

Here is the caller graph for this function:

filemakefname()

subroutine, public gtool_file::filemakefname	(	character(len=*), intent(out)	fname,
		character(len=*), intent(in)	basename,
		character(len=*), intent(in)	prefix,
		integer, intent(in)	myrank,
		integer, intent(in)	len
	)

Definition at line 3993 of file gtool_file.f90.

References file_open(), dc_log::log(), and gtool_file_h::success_code.

Referenced by scale_external_io::externalfilereadoffset4drealdp().

    character(len=*), intent(out) :: fname
    character(len=*), intent( in) :: basename
    character(len=*), intent( in) :: prefix
    integer,          intent( in) :: myrank
    integer,          intent( in) :: len

    !                           12345678901234567
    character(len=17) :: fmt = "(A, '.', A, I*.*)"
    !---------------------------------------------------------------------------

    if ( len < 1 .or. len > 9 ) then
       call log('E', 'xxx len is invalid')
    end if

    write(fmt(14:14),'(I1)') len
    write(fmt(16:16),'(I1)') len
    write(fname, fmt) trim(basename), trim(prefix), myrank

    return

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

rmiss

real(dp), parameter, public gtool_file::rmiss = -9.9999e+30

Definition at line 150 of file gtool_file.f90.

Referenced by filegetshape(), scale_fileio::fileio_write_3d(), scale_fileio::fileio_write_4d(), scale_fileio::fileio_write_var_2d(), scale_fileio::fileio_write_var_3d(), scale_fileio::fileio_write_var_3d_t(), scale_fileio::fileio_write_var_4d(), scale_history::hist_put_2d(), and scale_history::hist_put_3d().

  real(DP), parameter, public :: RMISS = -9.9999e+30