module file More...

Functions/Subroutines
subroutine, public	file_setup (myrank)
	setup More...

subroutine, public	file_create (basename, title, source, institution, fid, existed, rankid, single, aggregate, time_units, calendar, append)
	create file fid is >= 1 More...

subroutine, public	file_add_associatedvariable (fid, vname, existed)

subroutine, public	file_set_option (fid, filetype, key, val)

subroutine, public	file_open (basename, fid, mode, single, aggregate, rankid, postfix)

logical function, public	file_opened (fid)
	check if the file is opened? More...

subroutine, public	file_get_dimlength (fid, dimname, len, error)
	get length of dimension More...

subroutine, public	file_def_axis (fid, name, desc, units, dim_name, dtype, dim_size, bounds)

subroutine, public	file_def_associatedcoordinate (fid, name, desc, units, dim_names, dtype)

subroutine, public	file_def_variable (fid, varname, desc, units, standard_name, ndims, dims, dtype, vid, time_int, time_avg, existed)

subroutine, public	file_get_stepsize (fid, varname, len, error)
	get number of steps More...

subroutine, public	file_enddef (fid)

subroutine, public	file_attach_buffer (fid, buf_amount)

subroutine, public	file_detach_buffer (fid)

subroutine, public	file_flush (fid)

subroutine, public	file_close (fid, skip_abort)

subroutine, public	file_close_all (skip_abort)

subroutine, public	file_make_fname (basename, prefix, rankid, len, fname)

subroutine, public	file_get_cftunits (date, tunits)
	get unit of time More...

logical function, public	file_get_aggregate (fid)

Variables
logical, public	file_aggregate = .false.

logical, public	do

logical, public	parallel

logical, public	i

logical, public	o

logical, public	through

logical, dimension(default setting), public	pnetcdf

Detailed Description

module file

Description: file I/O hundring

Author: Team SCALE

NAMELIST

PARAM_FILE

name type default value comment

FILE_AGGREGATE logical .false. > do parallel I/O through PnetCDF (default setting)

History Output: No history output

Function/Subroutine Documentation

◆ file_setup()

subroutine, public scale_file::file_setup ( integer, intent(in) myrank )

setup

Definition at line 208 of file scale_file.F90.

References file_aggregate, file_close_all(), scale_io::io_fid_conf, and scale_prc::prc_set_file_closer().

Referenced by scale_file_cartesc::file_cartesc_setup().

     use scale_prc, only: &
        prc_set_file_closer
     implicit none
 
     integer, intent(in) :: myrank
 
     namelist / param_file / &
          file_aggregate
 
     integer :: ierr
 
        !--- read namelist
     rewind(io_fid_conf)
     read(io_fid_conf,nml=param_file,iostat=ierr)
     if( ierr < 0 ) then !--- missing
        log_info("FILE_setup",*) 'Not found namelist. Default used.'
     elseif( ierr > 0 ) then !--- fatal error
        log_error("FILE_setup",*) 'Not appropriate names in namelist PARAM_FILE. Check!'
        call prc_abort
     endif
     log_nml(param_file)
 
     mpi_myrank = myrank
 
     call prc_set_file_closer( file_close_all )
 
     return

Here is the call graph for this function:

Here is the caller graph for this function:

◆ file_create()

subroutine, public scale_file::file_create	(	character(len=*), intent(in)	basename,
		character(len=*), intent(in)	title,
		character(len=*), intent(in)	source,
		character(len=*), intent(in)	institution,
		integer, intent(out)	fid,
		logical, intent(out)	existed,
		integer, intent(in), optional	rankid,
		logical, intent(in), optional	single,
		logical, intent(in), optional	aggregate,
		character(len=*), intent(in), optional	time_units,
		character(len=*), intent(in), optional	calendar,
		logical, intent(in), optional	append
	)

create file fid is >= 1

Definition at line 248 of file scale_file.F90.

References scale_file_h::file_fappend, scale_file_h::file_fwrite, file_get_nvars_c(), file_get_varname_c(), file_opened(), file_set_tunits_c(), scale_file_h::file_success_code, and scale_prc::prc_abort().

Referenced by scale_file_cartesc::file_cartesc_create(), and scale_file_history::file_history_finalize().

     implicit none
 
     character(len=*), intent(in)  :: basename
     character(len=*), intent(in)  :: title
     character(len=*), intent(in)  :: source
     character(len=*), intent(in)  :: institution
 
     integer,          intent(out) :: fid
     logical,          intent(out) :: existed
 
     integer,          intent(in), optional :: rankid
     logical,          intent(in), optional :: single
     logical,          intent(in), optional :: aggregate
     character(len=*), intent(in), optional :: time_units
     character(len=*), intent(in), optional :: calendar
     logical,          intent(in), optional :: append
 
     character(len=FILE_HMID)   :: time_units_
     character(len=FILE_HSHORT) :: calendar_
     integer :: rankid_
     logical :: single_
     integer :: mode
 
     integer :: error
     !---------------------------------------------------------------------------
 
 
     if ( present(rankid) ) then
        rankid_ = rankid
     else
        rankid_ = mpi_myrank
     end if
 
     single_ = .false.
     if ( present(single) ) then
        single_ = single
     endif
 
     if ( present(time_units) ) then
        time_units_ = time_units
     else
        time_units_ = 'seconds'
     endif
 
     if ( present(calendar) ) then
        calendar_ = calendar
     else
        calendar_ = ""
     end if
 
     mode = file_fwrite
     if ( present(append) ) then
        if( append ) mode = file_fappend
     endif
 
     if ( single_ .and. rankid_ /= 0 ) return
 
     call file_get_fid( basename, mode,     & ! [IN]
                        rankid_, single_,   & ! [IN]
                        fid, existed,       & ! [OUT]
                        aggregate=aggregate ) ! [IN]
 
     if( existed ) return
 
     !--- append package header to the file
     call file_set_attribute( fid, "global", "title"      , title       ) ! [IN]
     call file_set_attribute( fid, "global", "source"     , source      ) ! [IN]
     call file_set_attribute( fid, "global", "institution", institution ) ! [IN]
 
     if ( ( .not. present(aggregate) ) .or. .not. aggregate ) then
        ! for shared-file parallel I/O, skip attributes related to MPI processes
        call file_set_attribute( fid, "global", "rankid"  , (/rankid/)  ) ! [IN]
     endif
 
     call file_set_tunits_c( file_files(fid)%fid,    & ! [IN]
                             time_units_, calendar_, & ! [IN]
                             error                   ) ! [OUT]
 
     if ( error /= file_success_code ) then
        log_error("FILE_create",*) 'failed to set time units'
        call prc_abort
     endif
 
     return

Here is the call graph for this function:

Here is the caller graph for this function:

◆ file_add_associatedvariable()

subroutine, public scale_file::file_add_associatedvariable	(	integer, intent(in)	fid,
		character(len=*), intent(in)	vname,
		logical, intent(out), optional	existed
	)

Definition at line 399 of file scale_file.F90.

References file_add_associatedvariable_c(), scale_file_h::file_already_existed_code, file_opened(), scale_file_h::file_success_code, and scale_prc::prc_abort().

Referenced by scale_file_cartesc::file_cartesc_def_axes(), and scale_file_history::file_history_finalize().

     integer,           intent(in)  :: fid
     character(len=*),  intent(in)  :: vname
     logical, optional, intent(out) :: existed
 
     integer :: error
 
     if ( .not. file_opened(fid) ) then
        log_error("FILE_add_associatedVariable",*) 'File is not opened. fid = ', fid
        call prc_abort
     end if
 
     call file_add_associatedvariable_c( file_files(fid)%fid, vname , & ! (in)
                                         error                        ) ! (out)
 
     if ( present(existed) ) then
        if ( error == file_already_existed_code ) then
           existed = .true.
           return
        end if
        existed = .false.
     end if
 
     if ( error /= file_success_code ) then
        log_error("FILE_add_associatedvariable",*) 'failed to add associated variable: '//trim(vname)
        call prc_abort
     end if
 
     return

Here is the call graph for this function:

Here is the caller graph for this function:

◆ file_set_option()

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

Definition at line 433 of file scale_file.F90.

References file_opened(), file_set_option_c(), scale_file_h::file_success_code, and scale_prc::prc_abort().

Referenced by scale_file_history::file_history_finalize().

     integer,          intent(in) :: fid
     character(len=*), intent(in) :: filetype
     character(len=*), intent(in) :: key
     character(len=*), intent(in) :: val
 
     integer :: error
 
     if ( .not. file_opened(fid) ) then
        log_error("FILE_set_option",*) 'File is not opened. fid = ', fid
        call prc_abort
     end if
 
     call file_set_option_c( file_files(fid)%fid, filetype, key, val, & ! (in)
                             error                                    ) ! (out)
     if ( error /= file_success_code ) then
        log_error("FILE_set_option",*) 'failed to set option'
        call prc_abort
     end if
 
     return

Here is the call graph for this function:

Here is the caller graph for this function:

◆ file_open()

subroutine, public scale_file::file_open	(	character(len=*), intent(in)	basename,
		integer, intent(out)	fid,
		integer, intent(in), optional	mode,
		logical, intent(in), optional	single,
		logical, intent(in), optional	aggregate,
		integer, intent(in), optional	rankid,
		character(len=*), intent(in), optional	postfix
	)

Definition at line 464 of file scale_file.F90.

References scale_file_h::file_fread.

Referenced by scale_atmos_grid_cartesc::atmos_grid_cartesc_allocate(), scale_atmos_phy_rd_profile::atmos_phy_rd_profile_setup(), scale_comm_cartesc_nest::comm_cartesc_nest_setup(), mod_copytopo::copytopo(), scale_file_cartesc::file_cartesc_cleanup(), scale_file_cartesc::file_cartesc_open(), file_def_variable(), scale_file_external_input::file_external_input_regist(), scale_file_external_input::file_external_input_update_3d(), file_get_stepsize(), scale_land_grid_cartesc::land_grid_cartesc_setup(), scale_land_grid_icoa::land_grid_icoa_setup(), scale_ocean_grid_cartesc::ocean_grid_cartesc_setup(), scale_ocean_grid_icoa::ocean_grid_icoa_setup(), mod_realinput_scale::parentatmosinputscale(), mod_realinput_wrfarw::parentatmosinputwrfarw(), mod_realinput_nicam::parentatmosopennicam(), mod_realinput_scale::parentatmosopenscale(), mod_realinput_wrfarw::parentatmossetupwrfarw(), mod_realinput_scale::parentlandinputscale(), mod_realinput_wrfarw::parentlandinputwrfarw(), mod_realinput_wrfarw::parentlandsetupwrfarw(), mod_realinput_scale::parentoceaninputscale(), mod_realinput_wrfarw::parentoceaninputwrfarw(), mod_realinput_scale::parentoceanopenscale(), mod_realinput_wrfarw::parentoceansetupwrfarw(), scale_urban_grid_cartesc::urban_grid_cartesc_setup(), scale_urban_grid_icoa::urban_grid_icoa_setup(), and mod_realinput_wrfarw::wrf_arwpost_calc_uvmet().

     implicit none
 
     character(len=*), intent( in) :: basename
     integer,          intent(out) :: fid
     integer,          intent( in), optional :: mode
     logical,          intent( in), optional :: single
     logical,          intent( in), optional :: aggregate
     integer,          intent( in), optional :: rankid
     character(len=*), intent( in), optional :: postfix
 
     integer :: mode_
     integer :: rankid_
     logical :: existed
     logical :: single_
 
     single_ = .false.
 
     if ( present(mode) ) then
        mode_ = mode
     else
        mode_ = file_fread
     end if
 
     if ( present(single) ) single_ = single
     if ( present(rankid) ) then
        rankid_ = rankid
     else
        rankid_ = mpi_myrank
     end if
 
     call file_get_fid( basename, mode_, rankid_, single_,   & ! (in)
                        fid, existed,                        & ! (out)
                        aggregate=aggregate, postfix=postfix ) ! (in)
 
     return

Here is the caller graph for this function:

◆ file_opened()

logical function, public scale_file::file_opened ( integer, intent(in) fid )

check if the file is opened?

Definition at line 504 of file scale_file.F90.

     implicit none
 
     integer, intent( in) :: fid
     logical :: file_opened
 
     if ( fid < 1 ) then
        file_opened = .false.
     else
        file_opened = file_files(fid)%fid >= 0
     end if
 
     return

Here is the caller graph for this function:

◆ file_get_dimlength()

subroutine, public scale_file::file_get_dimlength	(	integer, intent(in)	fid,
		character(len=*), intent(in)	dimname,
		integer, intent(out)	len,
		logical, intent(out), optional	error
	)

get length of dimension

Definition at line 525 of file scale_file.F90.

References scale_precision::dp, scale_file_h::file_already_existed_code, file_get_dim_length_c(), file_opened(), file_put_axis_c(), scale_file_h::file_success_code, scale_prc::prc_abort(), and scale_precision::sp.

Referenced by mod_realinput_wrfarw::parentatmossetupwrfarw(), mod_realinput_wrfarw::parentlandsetupwrfarw(), and mod_realinput_wrfarw::parentoceansetupwrfarw().

     integer,          intent(in) :: fid
     character(len=*), intent(in) :: dimname
 
     integer, intent(out) :: len
 
     logical, intent(out), optional :: error
 
     integer :: ierror
 
 
     if ( .not. file_opened(fid) ) then
        log_error("FILE_get_dimLength",*) 'File is not opened. fid = ', fid
        call prc_abort
     end if
 
     call file_get_dim_length_c( file_files(fid)%fid, dimname, & ! (in)
                                 len, ierror                   ) ! (out)
     if ( ierror /= file_success_code .and. ierror /= file_already_existed_code ) then
        if ( present(error) ) then
           error = .true.
        else
           log_error("FILE_get_dimLength",*) 'failed to get dimension length'
           call prc_abort
        end if
     else
        if ( present(error) ) error = .false.
     end if
 
     return

Here is the call graph for this function:

Here is the caller graph for this function:

◆ file_def_axis()

subroutine, public scale_file::file_def_axis	(	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,
		logical, intent(in), optional	bounds
	)

Definition at line 627 of file scale_file.F90.

References scale_precision::dp, scale_file_h::file_already_existed_code, file_def_axis_c(), file_opened(), file_put_associatedcoordinate_c(), scale_file_h::file_success_code, file_write_axis_c(), scale_prc::prc_abort(), and scale_precision::sp.

Referenced by scale_file_cartesc::file_cartesc_def_axes(), and scale_file_history::file_history_finalize().

     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
 
     logical,          intent(in), optional :: bounds
 
     integer :: error
     integer :: bounds_
 
     bounds_ = 0 ! .false.
     if ( present(bounds) ) then
        if ( bounds ) bounds_ = 1 ! .true.
     end if
 
     if ( .not. file_opened(fid) ) then
        log_error("FILE_def_axis",*) 'File is not opened. fid = ', fid
        call prc_abort
     end if
 
     call file_def_axis_c( file_files(fid)%fid, &
          name, desc, units, dim_name, dtype, dim_size, bounds_, & ! (in)
          error                                                  ) ! (out)
     if ( error /= file_success_code .and. error /= file_already_existed_code ) then
        log_error("FILE_def_axis",*) 'failed to define axis'
        call prc_abort
     end if
 
     return

Here is the call graph for this function:

Here is the caller graph for this function:

◆ file_def_associatedcoordinate()

subroutine, public scale_file::file_def_associatedcoordinate	(	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 997 of file scale_file.F90.

References scale_precision::dp, file_add_variable_c(), scale_file_h::file_already_existed_code, file_def_associatedcoordinate_c(), file_opened(), scale_file_h::file_success_code, file_write_associatedcoordinate_c(), scale_prc::prc_abort(), and scale_precision::sp.

Referenced by scale_file_cartesc::file_cartesc_def_axes(), and scale_file_history::file_history_finalize().

     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
 
     if ( .not. file_opened(fid) ) then
        log_error("FILE_def_associatedCoordinate",*) 'File is not opened. fid = ', fid
        call prc_abort
     end if
 
     call file_def_associatedcoordinate_c( file_files(fid)%fid, & ! (in)
          name, desc, units, dim_names, size(dim_names), dtype, & ! (in)
          error                                                 ) ! (out)
     if ( error /= file_success_code .and. error /= file_already_existed_code ) then
        log_error("FILE_def_associatedCoordinate",*) 'failed to put associated coordinate: '//trim(name)
        call prc_abort
     end if
 
     return

Here is the call graph for this function:

Here is the caller graph for this function:

◆ file_def_variable()

subroutine, public scale_file::file_def_variable	(	integer, intent(in)	fid,
		character(len=*), intent(in)	varname,
		character(len=*), intent(in)	desc,
		character(len=*), intent(in)	units,
		character(len=*), intent(in)	standard_name,
		integer, intent(in)	ndims,
		character(len=*), dimension(:), intent(in)	dims,
		integer, intent(in)	dtype,
		integer, intent(out)	vid,
		real(dp), intent(in), optional	time_int,
		logical, intent(in), optional	time_avg,
		logical, intent(out), optional	existed
	)

Definition at line 1531 of file scale_file.F90.

References file_add_variable_c(), scale_file_h::file_already_existed_code, file_get_attribute_double_c(), file_get_attribute_float_c(), file_get_attribute_int_c(), file_get_attribute_text_c(), file_get_datainfo_c(), file_open(), file_opened(), file_set_attribute_double_c(), file_set_attribute_float_c(), file_set_attribute_int_c(), file_set_attribute_text_c(), scale_file_h::file_success_code, and scale_prc::prc_abort().

Referenced by scale_file_cartesc::file_cartesc_def_var().

     integer,          intent( in) :: fid
     character(len=*), intent( in) :: varname
     character(len=*), intent( in) :: desc
     character(len=*), intent( in) :: units
     character(len=*), intent( in) :: standard_name
     integer,          intent( in) :: ndims
     character(len=*), intent( in) :: dims(:)
     integer,          intent( in) :: dtype
     integer,          intent(out) :: vid
     real(DP),         intent( in), optional :: time_int
     logical,          intent( in), optional :: time_avg
     logical,          intent(out), optional :: existed
 
     real(DP) :: tint_
     integer  :: itavg
     integer  :: cvid
     integer  :: error
     integer  :: n
 
     !---------------------------------------------------------------------------
 
     if ( .not. file_opened(fid) ) then
        log_error("FILE_def_variable",*) 'File is not opened. fid = ', fid
        call prc_abort
     end if
 
     vid = -1
     do n = 1, file_nvars
        if ( file_vars(n)%fid == fid .and. file_vars(n)%name == varname ) then
           vid = n
        end if
     enddo
 
     if ( vid < 0 ) then ! variable registration
 
        if ( present(time_int) ) then
           tint_ = time_int
        else
           tint_ = -1.0_dp
        endif
 
        if ( present(time_avg) ) then
           if ( time_avg ) then
              itavg = 1
           else
              itavg = 0
           end if
        else
           itavg = 0
        end if
 
        call file_add_variable_c( file_files(fid)%fid,                 & ! (in)
                                  varname, desc, units, standard_name, & ! (in)
                                  dims, ndims, dtype,                  & ! (in)
                                  tint_, itavg,                        & ! (in)
                                  cvid, error                          ) ! (out)
        if ( error /= file_success_code ) then
           log_error("FILE_def_variable",*) 'failed to add variable: '//trim(varname)
           call prc_abort
        end if
 
        file_nvars = file_nvars + 1
        vid = file_nvars
        file_vars(vid)%name = varname
        file_vars(vid)%vid  = cvid
        file_vars(vid)%fid  = fid
 
        log_info("FILE_def_variable",'(1x,A,I3.3,A,I4.4,2A)') &
        'Variable registration : NO.', fid, ', vid = ', vid, ', name = ', trim(varname)
 
        if ( present(existed) ) existed = .false.
     else
        if ( present(existed) ) existed = .true.
     endif
 
     return

Here is the call graph for this function:

Here is the caller graph for this function:

◆ file_get_stepsize()

subroutine, public scale_file::file_get_stepsize	(	integer, intent(in)	fid,
		character(len=*), intent(in)	varname,
		integer, intent(out)	len,
		logical, intent(out), optional	error
	)

get number of steps

Definition at line 2240 of file scale_file.F90.

References scale_precision::dp, scale_file_h::file_already_existed_code, file_get_datainfo_c(), file_get_step_size_c(), file_open(), file_opened(), file_read_data_c(), scale_file_h::file_rmiss, scale_file_h::file_success_code, file_write_data_c(), scale_prc::prc_abort(), and scale_precision::sp.

     integer,          intent(in) :: fid
     character(len=*), intent(in) :: varname
 
     integer, intent(out) :: len
 
     logical, intent(out), optional :: error
 
     integer :: ierror
 
     if ( .not. file_opened(fid) ) then
        log_error("FILE_get_stepSize",*) 'File is not opened. fid = ', fid
        call prc_abort
     end if
 
     call file_get_step_size_c( file_files(fid)%fid, varname, & ! (in)
                                len, ierror                   ) ! (out)
     if ( ierror /= file_success_code .and. ierror /= file_already_existed_code ) then
        if ( present(error) ) then
           error = .true.
        else
           log_error("FILE_get_stepSize",*) 'failed to get number of steps'
           call prc_abort
        end if
     else
        if ( present(error) ) error = .false.
     end if
 
     return

Here is the call graph for this function:

◆ file_enddef()

subroutine, public scale_file::file_enddef ( integer, intent(in) fid )

Definition at line 4393 of file scale_file.F90.

References file_enddef_c(), file_opened(), scale_file_h::file_success_code, and scale_prc::prc_abort().

Referenced by scale_file_cartesc::file_cartesc_enddef(), scale_file_history::file_history_query_id(), and scale_file_history::file_history_write().

     implicit none
 
     integer, intent(in) :: fid
 
     integer :: error
     !---------------------------------------------------------------------------
 
     if ( .not. file_opened(fid) ) return
 
     call file_enddef_c( file_files(fid)%fid, error )
 
     if ( error == file_success_code ) then
 
        log_newline
        log_info("FILE_enddef",'(1x,A,I3.3,2A)') &
             'End define mode : No.', fid, ', name = ', trim(file_files(fid)%name)
 
     else
        log_error("FILE_enddef",*) 'failed to exit define mode'
        call prc_abort
     end if
 
     return

Here is the call graph for this function:

Here is the caller graph for this function:

◆ file_attach_buffer()

subroutine, public scale_file::file_attach_buffer	(	integer, intent(in)	fid,
		integer(8), intent(in)	buf_amount
	)

Definition at line 4423 of file scale_file.F90.

References file_attach_buffer_c(), file_opened(), scale_file_h::file_success_code, and scale_prc::prc_abort().

Referenced by scale_file_cartesc::file_cartesc_enddef(), and scale_file_history::file_history_finalize().

     implicit none
 
     integer,    intent(in) :: fid
     integer(8), intent(in) :: buf_amount
 
     integer :: error
     !---------------------------------------------------------------------------
 
     if ( .not. file_opened(fid) ) return
 
     call file_attach_buffer_c( file_files(fid)%fid, buf_amount, error )
 
     if ( error == file_success_code ) then
 
        log_newline
        log_info("FILE_attach_buffer",'(1x,A,I3.3,3A,I10)') &
             'Attach buffer : No.', fid, ', name = ', trim(file_files(fid)%name), &
             ', size = ', buf_amount
     else
        log_error("FILE_attach_buffer",*) 'failed to attach buffer in PnetCDF'
        call prc_abort
     end if
 
     return

Here is the call graph for this function:

Here is the caller graph for this function:

◆ file_detach_buffer()

subroutine, public scale_file::file_detach_buffer ( integer, intent(in) fid )

Definition at line 4452 of file scale_file.F90.

References file_detach_buffer_c(), file_opened(), scale_file_h::file_success_code, and scale_prc::prc_abort().

Referenced by scale_file_cartesc::file_cartesc_close(), and scale_file_history::file_history_finalize().

     implicit none
 
     integer, intent(in) :: fid
 
     integer :: error
     !---------------------------------------------------------------------------
 
     if ( .not. file_opened(fid) ) return
 
     if ( file_files(fid)%fid < 0 ) return  ! already closed
 
     call file_detach_buffer_c( file_files(fid)%fid, error )
 
     if ( error == file_success_code ) then
 
        log_newline
        log_info("FILE_detach_buffer",'(1x,A,I3.3,2A)') &
             'Detach buffer : No.', fid, ', name = ', trim(file_files(fid)%name)
 
     else
        log_error("FILE_detach_buffer",*) 'failed to detach buffer in PnetCDF'
        call prc_abort
     end if
 
     return

Here is the call graph for this function:

Here is the caller graph for this function:

◆ file_flush()

subroutine, public scale_file::file_flush ( integer, intent(in) fid )

Definition at line 4482 of file scale_file.F90.

References file_flush_c(), file_opened(), scale_file_h::file_success_code, and scale_prc::prc_abort().

Referenced by scale_file_cartesc::file_cartesc_close(), scale_file_cartesc::file_cartesc_enddef(), scale_file_cartesc::file_cartesc_flush(), scale_file_cartesc::file_cartesc_write_var_4d(), scale_file_history::file_history_query_id(), and scale_file_history::file_history_write().

     implicit none
 
     integer, intent(in) :: fid
 
     integer :: error
     !---------------------------------------------------------------------------
 
     if ( .not. file_opened(fid) ) return
 
     if ( file_files(fid)%fid < 0 ) return  ! already closed
 
     call file_flush_c( file_files(fid)%fid, error )
 
     if ( error == file_success_code ) then
 
 !!$       LOG_NEWLINE
 !!$       LOG_INFO("FILE_flush",'(1xA,I3.3,2A)') &
 !!$            'Flush : No.', fid, ', name = ', trim(FILE_files(fid)%name)
 
     else
        log_error("FILE_flush",*) 'failed to flush PnetCDF pending requests'
        call prc_abort
     end if
 
     return

Here is the call graph for this function:

Here is the caller graph for this function:

◆ file_close()

subroutine, public scale_file::file_close	(	integer, intent(in)	fid,
		logical, intent(in), optional	skip_abort
	)

Definition at line 4511 of file scale_file.F90.

References scale_file_h::file_already_closed_code, file_close_c(), file_opened(), scale_file_h::file_success_code, and scale_prc::prc_abort().

Referenced by scale_atmos_phy_rd_profile::atmos_phy_rd_profile_setup(), mod_copytopo::copytopo(), scale_file_cartesc::file_cartesc_close(), file_close_all(), and scale_file_history::file_history_finalize().

     implicit none
     integer, intent(in) :: fid
     logical, intent(in), optional :: skip_abort
 
     logical :: skip_abort_
     integer :: error
     integer :: n
     !---------------------------------------------------------------------------
 
     if ( .not. file_opened(fid) ) return
 
     if ( file_files(fid)%fid < 0 ) return  ! already closed
 
     if ( present(skip_abort) ) then
        skip_abort_ = skip_abort
     else
        skip_abort_ = .false.
     end if
 
     call file_close_c( file_files(fid)%fid, error )
 
     if ( error == file_success_code ) then
 
        log_newline
        log_info("FILE_close",'(1x,A,I3.3,2A)') &
             'Close : No.', fid, ', name = ', trim(file_files(fid)%name)
 
     elseif( error /= file_already_closed_code ) then
        log_error("FILE_close",*) 'failed to close file'
        if ( .not. skip_abort_ ) call prc_abort
     end if
 
     file_files(fid)%fid = -1
     file_files(fid)%name = ''
     file_files(fid)%aggregate = .false.
 
     do n = 1, file_nvars
        if ( file_vars(n)%fid == fid ) then
           file_vars(n)%vid = -1
           file_vars(n)%name = ''
        end if
     end do
 
     return

Here is the call graph for this function:

Here is the caller graph for this function:

◆ file_close_all()

subroutine, public scale_file::file_close_all ( logical, intent(in), optional skip_abort )

Definition at line 4559 of file scale_file.F90.

References file_close().

Referenced by file_setup(), mod_rm_driver::rm_driver(), mod_rm_prep::rm_prep(), and scale::scale_finalize().

     implicit none
     logical, intent(in), optional :: skip_abort
 
     integer :: fid
     !---------------------------------------------------------------------------
 
     do fid = 1, file_nfiles
        call file_close( fid, skip_abort )
     enddo
 
     return

Here is the call graph for this function:

Here is the caller graph for this function:

◆ file_make_fname()

subroutine, public scale_file::file_make_fname	(	character(len=*), intent(in)	basename,
		character(len=*), intent(in)	prefix,
		integer, intent(in)	rankid,
		integer, intent(in)	len,
		character(len=*), intent(out)	fname
	)

Definition at line 4578 of file scale_file.F90.

References scale_prc::prc_abort().

Referenced by file_get_aggregate().

     character(len=*), intent( in) :: basename
     character(len=*), intent( in) :: prefix
     integer,          intent( in) :: rankid
     integer,          intent( in) :: len
     character(len=*), intent(out) :: fname
 
     !                           12345678901234567
     character(len=17) :: fmt = "(A, '.', A, I*.*)"
     !---------------------------------------------------------------------------
 
     if ( len < 1 .or. len > 9 ) then
        log_error("FILE_make_fname",*) 'len is invalid'
        call prc_abort
     end if
 
     write(fmt(14:14),'(I1)') len
     write(fmt(16:16),'(I1)') len
     write(fname, fmt) trim(basename), trim(prefix), rankid
 
     return

Here is the call graph for this function:

Here is the caller graph for this function:

◆ file_get_cftunits()

subroutine, public scale_file::file_get_cftunits	(	integer, dimension(6), intent(in)	date,
		character(len=*), intent(out)	tunits
	)

get unit of time

Definition at line 4604 of file scale_file.F90.

Referenced by scale_file_cartesc::file_cartesc_create(), and scale_file_history_cartesc::file_history_cartesc_truncate_3d().

     implicit none
 
     integer,          intent(in)  :: date(6)
     character(len=*), intent(out) :: tunits
     !---------------------------------------------------------------------------
 
     write(tunits,'(a,i4.4,"-",i2.2,"-",i2.2," ",i2.2,":",i2.2,":",i2.2)') 'seconds since ', date
 
     return

Here is the caller graph for this function:

◆ file_get_aggregate()

logical function, public scale_file::file_get_aggregate ( integer, intent(in) fid )

Definition at line 4616 of file scale_file.F90.

References file_aggregate, file_make_fname(), file_open_c(), file_opened(), scale_file_h::file_success_code, scale_prc::prc_comm_null, and scale_prc::prc_local_comm_world.

     integer, intent(in) :: fid
     logical :: file_get_aggregate
 
     if ( .not. file_opened(fid) ) then
        file_get_aggregate = .false.
     else
        file_get_aggregate = file_files(fid)%aggregate
     end if
 
     return

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

◆ file_aggregate

logical, public scale_file::file_aggregate = .false.

Definition at line 171 of file scale_file.F90.

Referenced by mod_admin_restart::admin_restart_setup(), scale_atmos_grid_cartesc::atmos_grid_cartesc_setup(), scale_file_cartesc::file_cartesc_create(), scale_file_cartesc::file_cartesc_open(), file_get_aggregate(), scale_file_history::file_history_setup(), file_setup(), scale_land_grid_cartesc::land_grid_cartesc_setup(), scale_land_grid_icoa::land_grid_icoa_setup(), scale_landuse::landuse_setup(), scale_ocean_grid_cartesc::ocean_grid_cartesc_setup(), scale_ocean_grid_icoa::ocean_grid_icoa_setup(), scale_topography::topo_setup(), scale_urban_grid_cartesc::urban_grid_cartesc_setup(), and scale_urban_grid_icoa::urban_grid_icoa_setup().

171 logical, public :: file_aggregate = .false.

◆ do

logical, public scale_file::do

Definition at line 171 of file scale_file.F90.

◆ parallel

logical, public scale_file::parallel

Definition at line 171 of file scale_file.F90.

◆ i

logical, public scale_file::i

Definition at line 171 of file scale_file.F90.

Referenced by file_close_c(), and file_get_step_size_c().

◆ o

logical, public scale_file::o

Definition at line 171 of file scale_file.F90.

◆ through

logical, public scale_file::through

Definition at line 171 of file scale_file.F90.

◆ pnetcdf

logical, dimension (default setting), public scale_file::pnetcdf

Definition at line 171 of file scale_file.F90.

Functions/Subroutines

Variables

Detailed Description

Function/Subroutine Documentation

◆ file_setup()

◆ file_create()

◆ file_add_associatedvariable()

◆ file_set_option()

◆ file_open()

◆ file_opened()

◆ file_get_dimlength()

◆ file_def_axis()

◆ file_def_associatedcoordinate()

◆ file_def_variable()

◆ file_get_stepsize()

◆ file_enddef()

◆ file_attach_buffer()

◆ file_detach_buffer()

◆ file_flush()

◆ file_close()

◆ file_close_all()

◆ file_make_fname()

◆ file_get_cftunits()

◆ file_get_aggregate()

Variable Documentation

◆ file_aggregate

◆ do

◆ parallel

◆ i

◆ o

◆ through

◆ pnetcdf