gtool_history Module Reference

module Gtool_History More...

Functions/Subroutines
subroutine, public	historyinit (item_count, variant_count, isize, jsize, ksize, master, myrank, rankidx, title, source, institution, time_start, time_interval, time_units, time_since, default_basename, default_zcoord, default_tinterval, default_tunit, default_taverage, default_datatype, namelist_filename, namelist_fid)
subroutine, public	historycheck (existed, item, zcoord)
subroutine, public	historyaddvariable (nregist, item, dims, desc, units, now_step, zcoord, options, start, count, comm)
subroutine	historyputaxissp (name, desc, units, dim, var, datatype, down, gsize, start)
subroutine	historyputaxisdp (name, desc, units, dim, var, datatype, down, gsize, start)
subroutine	historyput1dassociatedcoordinatessp (name, desc, units, dims, var, datatype, start)
subroutine	historyput1dassociatedcoordinatesdp (name, desc, units, dims, var, datatype, start)
subroutine	historyput2dassociatedcoordinatessp (name, desc, units, dims, var, datatype, start)
subroutine	historyput2dassociatedcoordinatesdp (name, desc, units, dims, var, datatype, start)
subroutine	historyput3dassociatedcoordinatessp (name, desc, units, dims, var, datatype, start)
subroutine	historyput3dassociatedcoordinatesdp (name, desc, units, dims, var, datatype, start)
subroutine	historyput4dassociatedcoordinatessp (name, desc, units, dims, var, datatype, start)
subroutine	historyput4dassociatedcoordinatesdp (name, desc, units, dims, var, datatype, start)
subroutine, public	historysettattr (varname, key, val)
subroutine, public	historyquery (item, step_now, answer)
subroutine, public	historywriteall (step_now)
subroutine, public	historywriteaxes
subroutine, public	historywrite (id, step_now)
subroutine	historyget1ddp (var, basename, varname, step, allow_missing, single)
subroutine	historyget1dsp (var, basename, varname, step, allow_missing, single)
subroutine	historyget2ddp (var, basename, varname, step, allow_missing, single)
subroutine	historyget2dsp (var, basename, varname, step, allow_missing, single)
subroutine	historyget3ddp (var, basename, varname, step, allow_missing, single)
subroutine	historyget3dsp (var, basename, varname, step, allow_missing, single)
subroutine, public	historyoutputlist
subroutine, public	historyfinalize

Detailed Description

module Gtool_History

NAMELIST

• PARAM_HISTORY

  name	type	default value	comment
  HISTORY_TITLE	character(len=File_HMID)		> Header information of the output file: title
  HISTORY_SOURCE	character(len=File_HMID)		> Header information of the output file: model name
  HISTORY_INSTITUTION	character(len=File_HMID)		> Header information of the output file: institution
  HISTORY_TIME_UNITS	character(len=File_HMID)		> Unit for time axis
  HISTORY_DEFAULT_BASENAME	character(len=File_HLONG)		> base name of the file
  HISTORY_DEFAULT_TINTERVAL	real(DP)		> time interval
  HISTORY_DEFAULT_TUNIT	character(len=File_HSHORT)		> time unit
  HISTORY_DEFAULT_TAVERAGE	logical		> apply time average?
  HISTORY_DEFAULT_ZCOORD	character(len=File_HSHORT)		> default z-coordinate
  HISTORY_DEFAULT_DATATYPE	character(len=File_HSHORT)		> data type
  HISTORY_OUTPUT_STEP0	logical	.false.	> Output value at step=0?
  HISTORY_OUTPUT_WAIT	real(DP)	0.0_DP	> Time length to suppress output [sec]
  HISTORY_ERROR_PUTMISS	logical	.true.	> Abort if the value is never stored after last output?
  DEBUG	logical	.false.

  
  
• HISTITEM

  name	type	default value	comment
  ITEM	character(len=*)
  OUTNAME	character(len=File_HSHORT)		> name of variable (for output)
  BASENAME	character(len=*)
  TINTERVAL	real(DP)		> time interval
  TUNIT	character(len=File_HSHORT)		> time unit
  TAVERAGE	logical		> apply time average?
  ZCOORD	character(len=*)
  DATATYPE	character(len=*)

  
  

History Output

No history output

Description

module library for history output

Author

Team SCALE

History

• 2012-06-11 (S.Nishizawa) [new] imported from SCALE-LES

Function/Subroutine Documentation

historyinit()

subroutine, public gtool_history::historyinit	(	integer, intent(out)	item_count,
		integer, intent(out)	variant_count,
		integer, intent(in)	isize,
		integer, intent(in)	jsize,
		integer, intent(in)	ksize,
		integer, intent(in)	master,
		integer, intent(in)	myrank,
		integer, dimension(:), intent(in)	rankidx,
		character(len=*), intent(in)	title,
		character(len=*), intent(in)	source,
		character(len=*), intent(in)	institution,
		real(dp), intent(in)	time_start,
		real(dp), intent(in)	time_interval,
		character(len=*), intent(in), optional	time_units,
		character(len=*), intent(in), optional	time_since,
		character(len=*), intent(in), optional	default_basename,
		character(len=*), intent(in), optional	default_zcoord,
		real(dp), intent(in), optional	default_tinterval,
		character(len=*), intent(in), optional	default_tunit,
		logical, intent(in), optional	default_taverage,
		character(len=*), intent(in), optional	default_datatype,
		character(len=*), intent(in), optional	namelist_filename,
		integer, intent(in), optional	namelist_fid
	)

REAL4 : single precision REAL8 : double precision

Unit for time axis

base name of the file

time interval

time unit

apply time average?

default z-coordinate

data type

Definition at line 237 of file gtool_history.f90.

References gtool_file_h::file_preclist, gtool_file_h::file_real4, and gtool_file_h::file_real8.

Referenced by scale_history::hist_setup().

#if defined(PGI) || defined(SX)
    use dc_log, only: &
       log_master_nml
#endif
    use dc_calendar, only: &
       calendarymdhms2sec
    use gtool_file_h, only: &
       file_real4, &
       file_real8, &
       file_preclist
    implicit none

    integer,          intent(out)          :: item_count
    integer,          intent(out)          :: variant_count
    integer,          intent(in)           :: isize
    integer,          intent(in)           :: jsize
    integer,          intent(in)           :: ksize
    integer,          intent(in)           :: master
    integer,          intent(in)           :: myrank
    integer,          intent(in)           :: rankidx(:)
    character(len=*), intent(in)           :: title
    character(len=*), intent(in)           :: source
    character(len=*), intent(in)           :: institution
    real(DP),         intent(in)           :: time_start
    real(DP),         intent(in)           :: time_interval
    character(len=*), intent(in), optional :: time_units
    character(len=*), intent(in), optional :: time_since
    character(len=*), intent(in), optional :: default_basename
    character(len=*), intent(in), optional :: default_zcoord
    real(DP),         intent(in), optional :: default_tinterval
    character(len=*), intent(in), optional :: default_tunit
    logical,          intent(in), optional :: default_taverage
    character(len=*), intent(in), optional :: default_datatype
    character(len=*), intent(in), optional :: namelist_filename
    integer         , intent(in), optional :: namelist_fid

    character(len=File_HLONG)  :: History_DEFAULT_BASENAME
    real(DP)                   :: History_DEFAULT_TINTERVAL
    character(len=File_HSHORT) :: History_DEFAULT_TUNIT
    logical                    :: History_DEFAULT_TAVERAGE
    character(len=File_HSHORT) :: History_DEFAULT_ZCOORD
    character(len=File_HSHORT) :: History_DEFAULT_DATATYPE

    namelist / param_history / &
       history_title,             &
       history_source,            &
       history_institution,       &
       history_time_units,        &
       history_default_basename,  &
       history_default_tinterval, &
       history_default_tunit,     &
       history_default_taverage,  &
       history_default_zcoord,    &
       history_default_datatype,  &
       history_output_step0,      &
       history_output_wait,       &
       history_error_putmiss,     &
       debug

    character(len=File_HSHORT) :: ITEM
    character(len=File_HSHORT) :: OUTNAME

    character(len=File_HLONG)  :: BASENAME
    real(DP)                   :: TINTERVAL
    character(len=File_HSHORT) :: TUNIT
    logical                    :: TAVERAGE
    character(len=File_HSHORT) :: ZCOORD
    character(len=File_HSHORT) :: DATATYPE

    namelist / histitem / &
       item,      &
       outname,   &
       basename,  &
       tinterval, &
       tunit,     &
       taverage,  &
       zcoord,    &
       datatype

    integer  :: array_size
    integer  :: memsize
    integer  :: reqid
    real(DP) :: item_dtsec
    integer  :: item_dstep

    integer                    :: id1, id2, count
    character(len=File_HSHORT) :: item1, item2

    integer  :: fid, ierr
    integer  :: n, id

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

    call log('I','')
    call log('I','###### Module[HISTORY] / Origin[gtoollib]')

    ! setup
    allocate( history_rankidx(size(rankidx)) )
    history_master      = master
    history_myrank      = myrank
    history_rankidx(:)  = rankidx(:)

    history_startdaysec = time_start
    history_dtsec       = time_interval
    if( present(time_since) ) then
      history_time_since = time_since
    else
      history_time_since        = ''
    end if

    history_time_units        = 'seconds'
    history_default_basename  = ''
    history_default_tinterval = -1.0_dp
    history_default_tunit     = 'sec'
    history_default_taverage  = .false.
    history_default_zcoord    = ''
    history_default_datatype  = 'REAL4'

    !--- read namelist
    history_title       = title
    history_source      = source
    history_institution = institution
    if( present(time_units)        ) history_time_units        = time_units
    if( present(default_basename)  ) history_default_basename  = default_basename
    if( present(default_tinterval) ) history_default_tinterval = default_tinterval
    if( present(default_tunit)     ) history_default_tunit     = default_tunit
    if( present(default_taverage)  ) history_default_taverage  = default_taverage
    if( present(default_zcoord)    ) history_default_zcoord    = default_zcoord
    if( present(default_datatype)  ) history_default_datatype  = default_datatype

    fid = -1
    if ( present(namelist_fid) ) then
       fid = namelist_fid
    elseif( present(namelist_filename) ) then
       if ( namelist_filename /= '' ) then
          open( unit   = fid,                     &
                file   = trim(namelist_filename), &
                form   = 'formatted',             &
                status = 'old'                    )
       endif
    endif

    if ( fid <= 0 ) then
       call log('E','xxx No namelist file is specified. Check!')
    endif

    rewind(fid)
    read(fid,nml=param_history,iostat=ierr)
    if    ( ierr < 0 ) then !--- missing
       call log('I','*** Not found namelist. Default used.')
    elseif( ierr > 0 ) then !--- fatal error
       call log('E','xxx Not appropriate names in namelist PARAM_HISTORY. Check!')
    endif

#if defined(PGI) || defined(SX)
    if ( log_master_nml ) write(log_fid_nml,nml=param_history)
#else
    write(message,nml=param_history)
    call log_nml('I',message)
#endif

    if ( history_output_wait < 0.0_dp ) then
       write(message,*) 'xxx History_OUTPUT_WAIT must be positive. STOP'
       call log('E',message)
    endif

    array_size = isize * jsize * ksize

    ! count history request
    history_req_count = 0
    rewind(fid)
    do n = 1, history_req_limit
       item      = ''
       outname   = 'undefined'
       basename  = history_default_basename

       read(fid,nml=histitem,iostat=ierr)
       if( ierr /= 0 ) exit
       if( basename == '' .OR. item == '' .OR. outname == '' ) cycle ! invalid HISTITEM

       history_req_count = history_req_count + 1
    enddo

    item_count    = history_req_count
    variant_count = 1

    if    ( history_req_count > history_req_limit ) then
       write(message,*) 'xxx request of history file is exceed! n >', history_req_limit
       call log('E',message)
    elseif( history_req_count == 0 ) then
       call log('I','*** No history file specified.')
       return
    endif


    allocate( history_req(history_req_count) )

    ! allows PnetCDF to use an internal buffer to aggregate write requests
    io_buffer_size = array_size * history_req_count * 8

    ! read history request


    memsize = 0
    reqid   = 0
    if ( fid > 0 ) rewind(fid)
    do n = 1, history_req_limit
       ! set default
       item      = ''
       outname   = 'undefined'
       basename  = history_default_basename
       tinterval = history_default_tinterval
       tunit     = history_default_tunit
       taverage  = history_default_taverage
       zcoord    = history_default_zcoord
       datatype  = history_default_datatype

       read(fid,nml=histitem,iostat=ierr)
       if( ierr /= 0 ) exit
       if( basename == '' .OR. item == '' .OR. outname == '' ) cycle ! invalid HISTITEM

       if ( log_fid_nml /= log_fid ) then
#if defined(PGI) || defined(SX)
          if ( log_master_nml ) write(log_fid_nml,nml=histitem)
#else
          write(message,nml=histitem)
          call log_nml('I',message)
#endif
       endif

       ! check duplicated request
       if ( outname == 'undefined' ) outname = item ! set default name
       do id = 1, reqid
          if ( history_req(id)%outname == outname ) then
             write(message,*) &
             'xxx Same name of history output is already registered. Check!', trim(outname)
             call log('E',message)
          endif
       enddo

       reqid = reqid + 1

       history_req(reqid)%item     = item
       history_req(reqid)%outname  = outname
       history_req(reqid)%basename = basename
       history_req(reqid)%taverage = taverage

       call calendarymdhms2sec( item_dtsec, tinterval, tunit )
       item_dstep = int( item_dtsec / history_dtsec )

       if ( item_dtsec <= 0.d0 ) then
          write(message,*) &
          'xxx Not appropriate time interval. Check!', trim(item), tinterval, trim(tunit)
          call log('E',message)
       endif

       if ( abs(item_dtsec-real(item_dstep,kind=dp)*history_dtsec ) > eps ) then
          write(message,*) &
          'xxx time interval must be a multiple of delta t. (interval,dt)=', item_dtsec, history_dtsec
          call log('E',message)
       endif

       history_req(reqid)%dstep  = item_dstep
       history_req(reqid)%zcoord = zcoord

       if    ( datatype == 'REAL4' ) then
          history_req(reqid)%dtype  = file_real4
          memsize = memsize + array_size * file_preclist(file_real4)
       elseif( datatype == 'REAL8' ) then
          history_req(reqid)%dtype  = file_real8
          memsize = memsize + array_size * file_preclist(file_real8)
       else
          write(message,*) 'xxx Not appropriate DATATYPE. Check!', datatype
          call log('E',message)
       endif
    enddo

    call log('I','')
    write(message,'(A,I4)') '*** Number of requested history item             : ', history_req_count
    call log('I',message)
    write(message,'(A,A)')  '*** Output default data type                     : ', history_default_datatype
    call log('I',message)
    write(message,'(A,I8)') '*** Memory usage for history data buffer [Mbyte] : ', memsize / 1024 / 1024
    call log('I',message)
    write(message,'(A,L4)') '*** Output value at the initial step?            : ', history_output_step0
    call log('I',message)
    write(message,'(A,L4)') '*** Check if requested item is not registered?   : ', history_error_putmiss
    call log('I',message)
    if ( history_output_wait > 0.0_dp ) then
       write(message,'(A,F10.3)') '*** Time to suppress output [sec]                : ', history_output_wait
       call log('I',message)
    endif

    if ( .NOT. present(namelist_fid) ) then
       if( fid > 0 ) close(fid)
    endif

    history_id_count = 0
    allocate( history_vars(  history_req_count) )
    allocate( history_axis_written(0:history_req_count) )

    do n = 1, history_req_count
       allocate( history_vars(n)%varsum(array_size) )
    enddo

    ! count number of items and variants
    do id1 = 1, item_count
       item1 = history_req(id1)%item
       count = 1
       do id2 = id1, item_count
          item2 = history_req(id2)%item
          if( item1 == item2 ) count = count + 1
       enddo
       variant_count = max( variant_count, count)
    enddo

    return

Here is the caller graph for this function:

historycheck()

subroutine, public gtool_history::historycheck	(	logical, intent(out)	existed,
		character(len=*), intent(in)	item,
		character(len=*), intent(in), optional	zcoord
	)

Definition at line 564 of file gtool_history.f90.

Referenced by scale_history::hist_reg(), and historyaddvariable().

    implicit none

    logical,          intent(out)          :: existed
    character(len=*), intent(in)           :: item
    character(len=*), intent(in), optional :: zcoord

    integer :: max_count
    integer :: n

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

    existed = .false.

    max_count = min( history_id_count, history_req_count )

    do n = 1, max_count

       !--- search existing item
       if ( item == history_vars(n)%item ) then ! match (at least one) existing item
          !--- check z-coordinate
          if ( present(zcoord) ) then
             if ( history_vars(n)%zcoord == zcoord ) then
                existed = .true.
                return
             endif
          else
             existed = .true.
             return
          endif

       end if

    enddo

    return

Here is the caller graph for this function:

historyaddvariable()

subroutine, public gtool_history::historyaddvariable	(	integer, intent(out)	nregist,
		character(len=*), intent(in)	item,
		character(len=*), dimension(:), intent(in)	dims,
		character(len=*), intent(in)	desc,
		character(len=*), intent(in)	units,
		integer, intent(in)	now_step,
		character(len=*), intent(in), optional	zcoord,
		character(len=*), intent(in), optional	options,
		integer, dimension(:), intent(in), optional	start,
		integer, dimension(:), intent(in), optional	count,
		integer, intent(in), optional	comm
	)

Definition at line 615 of file gtool_history.f90.

References gtool_file::fileattachbuffer(), gtool_file::filecreate(), gtool_file::filedefassociatedcoordinates(), gtool_file::filedefaxis(), gtool_file::filesetoption(), gtool_file::filesettattr(), historycheck(), and dc_log::log().

Referenced by scale_history::hist_reg().

    use gtool_file, only: &
       filecreate,      &
       filesetoption,   &
       fileaddvariable, &
       filesettattr,    &
       filedefaxis,     &
       filedefassociatedcoordinates, &
       fileattachbuffer
    use mpi, only: &
       mpi_comm_null
    implicit none

    integer,          intent(out) :: nregist
    character(len=*), intent(in)  :: item
    character(len=*), intent(in)  :: dims(:)
    character(len=*), intent(in)  :: desc
    character(len=*), intent(in)  :: units
    integer,          intent(in)  :: now_step
    character(len=*), intent(in), optional :: zcoord
    character(len=*), intent(in), optional :: options  ! 'filetype1:key1=val1&filetype2:key2=val2&...'
    integer,          intent(in), optional :: start(:) ! global subarray starting indices of this process's write request
    integer,          intent(in), optional :: count(:) ! lengths of this process's write request along each dimension
    integer,          intent(in), optional :: comm     ! MPI communicator

    character(len=File_HMID) :: tunits
    logical                  :: fileexisted
    integer                  :: ic, ie, is, lo
    real(DP)                 :: dtsec
    logical                  :: existed
    integer                  :: ndim

    logical                  :: shared_file_io
    integer                  :: reqid
    integer                  :: id, fid
    integer                  :: m, dim_size

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

    nregist = 0

    ! check whether shared-file I/O method is enabled
    shared_file_io = .false.
    if ( present(comm) .AND. comm .NE. mpi_comm_null ) shared_file_io = .true.

    call historycheck( existed, & ! [OUT]
                       item,    & ! [IN]
                       zcoord   ) ! [IN]

    if ( .NOT. existed ) then ! request-register matching check

       ! new file registration
       if ( history_time_since == '' ) then
          tunits = trim(history_time_units)
       else
          tunits = trim(history_time_units)//' since '//trim(history_time_since)
       endif

       ndim = size(dims)

       do reqid = 1, history_req_count

          ! note: plural requests are allowed for each item
          if ( item == history_req(reqid)%item ) then

             if ( present(zcoord) ) then
                if ( history_req(reqid)%zcoord /= zcoord ) cycle
             end if

             existed = .true.
             nregist = nregist + 1

             history_id_count = history_id_count + 1
             id               = history_id_count

             history_vars(id)%item     = history_req(reqid)%item
             history_vars(id)%outname  = history_req(reqid)%outname

             call filecreate( fid,                         & ! [OUT]
                              fileexisted,                 & ! [OUT]
                              history_req(reqid)%basename, & ! [IN]
                              history_title,               & ! [IN]
                              history_source,              & ! [IN]
                              history_institution,         & ! [IN]
                              history_master,              & ! [IN]
                              history_myrank,              & ! [IN]
                              history_rankidx(:),          & ! [IN]
                              time_units = tunits,         & ! [IN]
                              comm = comm                  ) ! [IN]

             history_vars(id)%fid      = fid
             history_vars(id)%dstep    = history_req(reqid)%dstep
             history_vars(id)%taverage = history_req(reqid)%taverage
             history_vars(id)%zcoord   = history_req(reqid)%zcoord

             if ( .NOT. fileexisted ) then ! new file

                ! write options
                if ( present(options) ) then
                   ic = -1 ! index of ':'
                   ie = -1 ! index of '='
                   is =  1 ! start index
                   lo = len_trim(options)
                   do m = 1, lo+1
                      if ( m == lo+1 .OR. options(m:m) == '&' ) then
                         if ( ic == -1 .OR. ie == -1 ) then
                            call log('E','xxx option is invalid: '//trim(options))
                         endif

                         call filesetoption( fid,                & ! [IN]
                                             options(is  :ic-1), & ! [IN]
                                             options(ic+1:ie-1), & ! [IN]
                                             options(ie+1:m -1)  ) ! [IN]

                         ic = -1
                         ie = -1
                         is = m+1
                      elseif( options(m:m) == ':' ) then
                         ic = m
                      elseif( options(m:m) == '=' ) then
                         ie = m
                      endif
                   enddo
                endif

                ! define registered history axis variables in the newly created file
                ! actual writing axis variables are deferred to HistoryWriteAxes
                do m = 1, history_axis_count
                   if ( shared_file_io ) then ! for shared-file I/O, define axis in its global size
                      dim_size = history_axis(m)%gdim_size ! axis global size
                   else
                      dim_size = history_axis(m)%dim_size
                   end if

                   call filedefaxis( fid,                     & ! [IN]
                                     history_axis(m)%name,    & ! [IN]
                                     history_axis(m)%desc,    & ! [IN]
                                     history_axis(m)%units,   & ! [IN]
                                     history_axis(m)%dim,     & ! [IN]
                                     history_axis(m)%dtype,   & ! [IN]
                                     dim_size                 ) ! [IN]
                enddo

                ! define registered history associated coordinate variables in the newly created file
                ! actual writing coordinate variables are deferred to HistoryWriteAxes
                do m = 1, history_assoc_count

                   if ( shared_file_io ) then
                      dim_size = history_axis(m)%gdim_size
                   else
                      dim_size = history_axis(m)%dim_size
                   end if

                   call filedefassociatedcoordinates( fid,                                             & ! [IN]
                                                      history_assoc(m)%name,                           & ! [IN]
                                                      history_assoc(m)%desc,                           & ! [IN]
                                                      history_assoc(m)%units,                          & ! [IN]
                                                      history_assoc(m)%dims(1:history_assoc(m)%ndims), & ! [IN]
                                                      history_assoc(m)%dtype                           ) ! [IN]
                enddo

                ! allows PnetCDF to allocate an internal buffer of size io_buffer_size
                ! to aggregate write requests for history variables
                call fileattachbuffer( fid, io_buffer_size )

                history_axis_written(fid) = .false.

             endif ! new file?

             ! Add new variable
             dtsec = real(History_vars(id)%dstep,kind=DP) * History_DTSEC

             ! history variable has been reshaped to 1D, we preserve the
             ! original shape in count(:) and History_count(:,id)
             ! History_ndims(id) stores number of dimensions of original shape
             history_vars(id)%ndims    = size(dims)

             history_vars(id)%start(:) = 1
             history_vars(id)%count(:) = 1
             if ( present(start) ) history_vars(id)%start(:) = start(:)
             if ( present(count) ) history_vars(id)%count(:) = count(:)

             call fileaddvariable( history_vars(id)%vid,     & ! [OUT]
                                   fid,                      & ! [IN]
                                   history_vars(id)%outname, & ! [IN]
                                   desc,                     & ! [IN]
                                   units,                    & ! [IN]
                                   dims(1:ndim),             & ! [IN]
                                   history_req(reqid)%dtype, & ! [IN]
                                   dtsec,                    & ! [IN]
                                   history_vars(id)%taverage ) ! [IN]

             if ( .not. fileexisted ) then
                do m = 1, history_axis_count
                   if ( history_axis(m)%down ) then
                      call filesettattr( fid, history_axis(m)%name, 'positive', 'down' )
                   endif
                enddo
             endif

             ! initialize
             history_vars(id)%size         = 0
             history_vars(id)%waitsec      = history_output_wait
             if ( history_output_step0 .AND. now_step == 1 ) then
                history_vars(id)%laststep_write = 1 - history_vars(id)%dstep
             else
                history_vars(id)%laststep_write = 1
             endif
             history_vars(id)%laststep_put = history_vars(id)%laststep_write
             history_vars(id)%timesum      = 0.0_dp
             history_vars(id)%varsum(:)    = 0.0_dp

             if ( debug ) then
                write(message,*) '*** [HIST] Item registration No.= ', id
                call log('I',message)
                write(message,*) '] Item name           : ', trim(history_vars(id)%item)
                call log('I',message)
                write(message,*) '] Output name         : ', trim(history_vars(id)%outname)
                call log('I',message)
                write(message,*) '] Description         : ', trim(desc)
                call log('I',message)
                write(message,*) '] Unit                : ', trim(units)
                call log('I',message)
                write(message,*) '] Z-coordinate        : ', trim(history_vars(id)%zcoord)
                call log('I',message)
                write(message,*) '] Interval [sec,step] : ', dtsec, history_vars(id)%dstep
                call log('I',message)
                write(message,*) '] Time Average?       : ', history_vars(id)%taverage
                call log('I',message)
                write(message,*) '] axis name           : ', dims(1:ndim)
                call log('I',message)
                call log('I','')
             endif

          endif ! match item?
       enddo

    endif ! new items?

    return

Here is the call graph for this function:

Here is the caller graph for this function:

historyputaxissp()

subroutine gtool_history::historyputaxissp	(	character(len=*), intent(in)	name,
		character(len=*), intent(in)	desc,
		character(len=*), intent(in)	units,
		character(len=*), intent(in)	dim,
		real(sp), dimension(:), intent(in)	var,
		character(len=*), intent(in), optional	datatype,
		logical, intent(in), optional	down,
		integer, intent(in), optional	gsize,
		integer, intent(in), optional	start
	)

Definition at line 871 of file gtool_history.f90.

References gtool_file_h::file_real4, gtool_file_h::file_real8, and dc_log::log().

    use gtool_file_h, only: &
       file_real4, &
       file_real8
    implicit none

    character(len=*), intent(in) :: name
    character(len=*), intent(in) :: desc
    character(len=*), intent(in) :: units
    character(len=*), intent(in) :: dim
    real(SP),         intent(in) :: var(:)
    character(len=*), intent(in), optional :: datatype
    logical,          intent(in), optional :: down
    integer,          intent(in), optional :: gsize ! global dim size
    integer,          intent(in), optional :: start ! global subarray start indices

    integer :: dtype
    integer :: dim_size
    integer :: id

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

    if ( present(datatype) ) then
       if ( datatype == 'REAL4' ) then
          dtype = file_real4
       elseif( datatype == 'REAL8' ) then
          dtype = file_real8
       else
          write(message,*) 'xxx Not appropriate datatype. Check!', datatype
          call log('E',message)
       endif
    else
       dtype = file_real4
    endif

    dim_size = size(var)

    if ( history_axis_count < history_axis_limit ) then
       history_axis_count = history_axis_count + 1
       id                 = history_axis_count

       allocate( history_axis(id)%var(dim_size) )

       history_axis(id)%name     = name
       history_axis(id)%desc     = desc
       history_axis(id)%units    = units
       history_axis(id)%dim      = dim
       history_axis(id)%dtype    = dtype
       history_axis(id)%dim_size = dim_size
       history_axis(id)%var(:)   = var(:)

       if ( present(down) ) then
          history_axis(history_axis_count)%down = down
       else
          history_axis(history_axis_count)%down = .false.
       endif
       if ( present(gsize) ) &  ! global dimension size
          history_axis(history_axis_count)%gdim_size = gsize
       if ( present(start) ) then  ! global subarray starting indices
          history_axis(history_axis_count)%start(1) = start
       else
          history_axis(history_axis_count)%start(1) = 1
       end if
    else
       write(message,*) 'xxx Number of axis exceeds the limit.'
       call log('E',message)
    endif

    return

Here is the call graph for this function:

historyputaxisdp()

subroutine gtool_history::historyputaxisdp	(	character(len=*), intent(in)	name,
		character(len=*), intent(in)	desc,
		character(len=*), intent(in)	units,
		character(len=*), intent(in)	dim,
		real(dp), dimension(:), intent(in)	var,
		character(len=*), intent(in), optional	datatype,
		logical, intent(in), optional	down,
		integer, intent(in), optional	gsize,
		integer, intent(in), optional	start
	)

Definition at line 953 of file gtool_history.f90.

References gtool_file_h::file_real4, gtool_file_h::file_real8, and dc_log::log().

    use gtool_file_h, only: &
       file_real4, &
       file_real8
    implicit none

    character(len=*), intent(in) :: name
    character(len=*), intent(in) :: desc
    character(len=*), intent(in) :: units
    character(len=*), intent(in) :: dim
    real(DP),         intent(in) :: var(:)
    character(len=*), intent(in), optional :: datatype
    logical,          intent(in), optional :: down
    integer,          intent(in), optional :: gsize ! global dim size
    integer,          intent(in), optional :: start ! global subarray start indices

    integer :: dtype
    integer :: dim_size
    integer :: id

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

    if ( present(datatype) ) then
       if ( datatype == 'REAL4' ) then
          dtype = file_real4
       elseif( datatype == 'REAL8' ) then
          dtype = file_real8
       else
          write(message,*) 'xxx Not appropriate datatype. Check!', datatype
          call log('E',message)
       endif
    else
       dtype = file_real8
    endif

    dim_size = size(var)

    if ( history_axis_count < history_axis_limit ) then
       history_axis_count = history_axis_count + 1
       id                 = history_axis_count

       allocate( history_axis(id)%var(dim_size) )

       history_axis(id)%name     = name
       history_axis(id)%desc     = desc
       history_axis(id)%units    = units
       history_axis(id)%dim      = dim
       history_axis(id)%dtype    = dtype
       history_axis(id)%dim_size = dim_size
       history_axis(id)%var(:)   = var(:)

       if ( present(down) ) then
          history_axis(history_axis_count)%down = down
       else
          history_axis(history_axis_count)%down = .false.
       endif
       if ( present(gsize) ) &  ! global dimension size
          history_axis(history_axis_count)%gdim_size = gsize
       if ( present(start) ) then  ! global subarray starting indices
          history_axis(history_axis_count)%start(1) = start
       else
          history_axis(history_axis_count)%start(1) = 1
       end if
    else
       write(message,*) 'xxx Number of axis exceeds the limit.'
       call log('E',message)
    endif

    return

Here is the call graph for this function:

historyput1dassociatedcoordinatessp()

subroutine gtool_history::historyput1dassociatedcoordinatessp	(	character(len=*), intent(in)	name,
		character(len=*), intent(in)	desc,
		character(len=*), intent(in)	units,
		character(len=*), dimension(:), intent(in)	dims,
		real(sp), dimension(:), intent(in)	var,
		character(len=*), intent(in), optional	datatype,
		integer, dimension(:), intent(in), optional	start
	)

Definition at line 1033 of file gtool_history.f90.

References gtool_file_h::file_real4, gtool_file_h::file_real8, and dc_log::log().

    use gtool_file_h, only: &
       file_real4, &
       file_real8
    implicit none

    character(len=*), intent(in) :: name
    character(len=*), intent(in) :: desc
    character(len=*), intent(in) :: units
    character(len=*), intent(in) :: dims(:)
    real(SP),         intent(in) :: var(:)
    character(len=*), intent(in), optional :: datatype
    integer,          intent(in), optional :: start(:)

    integer :: dtype
    integer :: dim_size
    integer :: id

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

    if ( present(datatype) ) then
       if    ( datatype == 'REAL4' ) then
          dtype = file_real4
       elseif( datatype == 'REAL8' ) then
          dtype = file_real8
       else
          write(message,*) 'xxx Not appropriate datatype. Check!', datatype
          call log('E',message)
       endif
    else
       dtype = file_real4
    endif

    dim_size = size(var)

    if ( history_assoc_count < history_assoc_limit ) then
       history_assoc_count = history_assoc_count + 1
       id                  = history_assoc_count

       allocate( history_assoc(id)%var(dim_size) )

       history_assoc(id)%name      = name
       history_assoc(id)%desc      = desc
       history_assoc(id)%units     = units
       history_assoc(id)%ndims     = 1
       history_assoc(id)%dims(:)   = ''
       history_assoc(id)%dims(1:1) = dims(1:1)
       history_assoc(id)%dtype     = dtype
       history_assoc(id)%var(:)    = reshape( var, (/ dim_size /) )

       ! start and count are used for parallel I/O to a single shared file
       ! since var is reshaped into 1D array, we need to preserve its original shape in count
       history_assoc(id)%count(1:1) = shape(var)
       if ( present(start) ) then
          history_assoc(id)%start(1:1) = start(1:1)
       else
          history_assoc(id)%start = (/ 1, 1, 1, 1 /)
       end if
    else
       write(message,*) 'xxx Number of associate coordinates exceeds the limit.'
       call log('E',message)
    endif

    return

Here is the call graph for this function:

historyput1dassociatedcoordinatesdp()

subroutine gtool_history::historyput1dassociatedcoordinatesdp	(	character(len=*), intent(in)	name,
		character(len=*), intent(in)	desc,
		character(len=*), intent(in)	units,
		character(len=*), dimension(:), intent(in)	dims,
		real(dp), dimension(:), intent(in)	var,
		character(len=*), intent(in), optional	datatype,
		integer, dimension(:), intent(in), optional	start
	)

Definition at line 1108 of file gtool_history.f90.

References gtool_file_h::file_real4, gtool_file_h::file_real8, and dc_log::log().

    use gtool_file_h, only: &
       file_real4, &
       file_real8
    implicit none

    character(len=*), intent(in) :: name
    character(len=*), intent(in) :: desc
    character(len=*), intent(in) :: units
    character(len=*), intent(in) :: dims(:)
    real(DP),         intent(in) :: var(:)
    character(len=*), intent(in), optional :: datatype
    integer,          intent(in), optional :: start(:)

    integer :: dtype
    integer :: dim_size
    integer :: id

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

    if ( present(datatype) ) then
       if    ( datatype == 'REAL4' ) then
          dtype = file_real4
       elseif( datatype == 'REAL8' ) then
          dtype = file_real8
       else
          write(message,*) 'xxx Not appropriate datatype. Check!', datatype
          call log('E',message)
       endif
    else
       dtype = file_real8
    endif

    dim_size = size(var)

    if ( history_assoc_count < history_assoc_limit ) then
       history_assoc_count = history_assoc_count + 1
       id                  = history_assoc_count

       allocate( history_assoc(id)%var(dim_size) )

       history_assoc(id)%name      = name
       history_assoc(id)%desc      = desc
       history_assoc(id)%units     = units
       history_assoc(id)%ndims     = 1
       history_assoc(id)%dims(:)   = ''
       history_assoc(id)%dims(1:1) = dims(1:1)
       history_assoc(id)%dtype     = dtype
       history_assoc(id)%var(:)    = reshape( var, (/ dim_size /) )

       ! start and count are used for parallel I/O to a single shared file
       ! since var is reshaped into 1D array, we need to preserve its original shape in count
       history_assoc(id)%count(1:1) = shape(var)
       if ( present(start) ) then
          history_assoc(id)%start(1:1) = start(1:1)
       else
          history_assoc(id)%start = (/ 1, 1, 1, 1 /)
       end if
    else
       write(message,*) 'xxx Number of associate coordinates exceeds the limit.'
       call log('E',message)
    endif

    return

Here is the call graph for this function:

historyput2dassociatedcoordinatessp()

subroutine gtool_history::historyput2dassociatedcoordinatessp	(	character(len=*), intent(in)	name,
		character(len=*), intent(in)	desc,
		character(len=*), intent(in)	units,
		character(len=*), dimension(:), intent(in)	dims,
		real(sp), dimension(:,:), intent(in)	var,
		character(len=*), intent(in), optional	datatype,
		integer, dimension(:), intent(in), optional	start
	)

Definition at line 1183 of file gtool_history.f90.

References gtool_file_h::file_real4, gtool_file_h::file_real8, and dc_log::log().

    use gtool_file_h, only: &
       file_real4, &
       file_real8
    implicit none

    character(len=*), intent(in) :: name
    character(len=*), intent(in) :: desc
    character(len=*), intent(in) :: units
    character(len=*), intent(in) :: dims(:)
    real(SP),         intent(in) :: var(:,:)
    character(len=*), intent(in), optional :: datatype
    integer,          intent(in), optional :: start(:)

    integer :: dtype
    integer :: dim_size
    integer :: id

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

    if ( present(datatype) ) then
       if    ( datatype == 'REAL4' ) then
          dtype = file_real4
       elseif( datatype == 'REAL8' ) then
          dtype = file_real8
       else
          write(message,*) 'xxx Not appropriate datatype. Check!', datatype
          call log('E',message)
       endif
    else
       dtype = file_real4
    endif

    dim_size = size(var)

    if ( history_assoc_count < history_assoc_limit ) then
       history_assoc_count = history_assoc_count + 1
       id                  = history_assoc_count

       allocate( history_assoc(id)%var(dim_size) )

       history_assoc(id)%name      = name
       history_assoc(id)%desc      = desc
       history_assoc(id)%units     = units
       history_assoc(id)%ndims     = 2
       history_assoc(id)%dims(:)   = ''
       history_assoc(id)%dims(1:2) = dims(1:2)
       history_assoc(id)%dtype     = dtype
       history_assoc(id)%var(:)    = reshape( var, (/ dim_size /) )

       ! start and count are used for parallel I/O to a single shared file
       ! since var is reshaped into 1D array, we need to preserve its original shape in count
       history_assoc(id)%count(1:2) = shape(var)
       if ( present(start) ) then
          history_assoc(id)%start(1:2) = start(1:2)
       else
          history_assoc(id)%start = (/ 1, 1, 1, 1 /)
       end if
    else
       write(message,*) 'xxx Number of associate coordinates exceeds the limit.'
       call log('E',message)
    endif

    return

Here is the call graph for this function:

historyput2dassociatedcoordinatesdp()

subroutine gtool_history::historyput2dassociatedcoordinatesdp	(	character(len=*), intent(in)	name,
		character(len=*), intent(in)	desc,
		character(len=*), intent(in)	units,
		character(len=*), dimension(:), intent(in)	dims,
		real(dp), dimension(:,:), intent(in)	var,
		character(len=*), intent(in), optional	datatype,
		integer, dimension(:), intent(in), optional	start
	)

Definition at line 1258 of file gtool_history.f90.

References gtool_file_h::file_real4, gtool_file_h::file_real8, and dc_log::log().

    use gtool_file_h, only: &
       file_real4, &
       file_real8
    implicit none

    character(len=*), intent(in) :: name
    character(len=*), intent(in) :: desc
    character(len=*), intent(in) :: units
    character(len=*), intent(in) :: dims(:)
    real(DP),         intent(in) :: var(:,:)
    character(len=*), intent(in), optional :: datatype
    integer,          intent(in), optional :: start(:)

    integer :: dtype
    integer :: dim_size
    integer :: id

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

    if ( present(datatype) ) then
       if    ( datatype == 'REAL4' ) then
          dtype = file_real4
       elseif( datatype == 'REAL8' ) then
          dtype = file_real8
       else
          write(message,*) 'xxx Not appropriate datatype. Check!', datatype
          call log('E',message)
       endif
    else
       dtype = file_real8
    endif

    dim_size = size(var)

    if ( history_assoc_count < history_assoc_limit ) then
       history_assoc_count = history_assoc_count + 1
       id                  = history_assoc_count

       allocate( history_assoc(id)%var(dim_size) )

       history_assoc(id)%name      = name
       history_assoc(id)%desc      = desc
       history_assoc(id)%units     = units
       history_assoc(id)%ndims     = 2
       history_assoc(id)%dims(:)   = ''
       history_assoc(id)%dims(1:2) = dims(1:2)
       history_assoc(id)%dtype     = dtype
       history_assoc(id)%var(:)    = reshape( var, (/ dim_size /) )

       ! start and count are used for parallel I/O to a single shared file
       ! since var is reshaped into 1D array, we need to preserve its original shape in count
       history_assoc(id)%count(1:2) = shape(var)
       if ( present(start) ) then
          history_assoc(id)%start(1:2) = start(1:2)
       else
          history_assoc(id)%start = (/ 1, 1, 1, 1 /)
       end if
    else
       write(message,*) 'xxx Number of associate coordinates exceeds the limit.'
       call log('E',message)
    endif

    return

Here is the call graph for this function:

historyput3dassociatedcoordinatessp()

subroutine gtool_history::historyput3dassociatedcoordinatessp	(	character(len=*), intent(in)	name,
		character(len=*), intent(in)	desc,
		character(len=*), intent(in)	units,
		character(len=*), dimension(:), intent(in)	dims,
		real(sp), dimension(:,:,:), intent(in)	var,
		character(len=*), intent(in), optional	datatype,
		integer, dimension(:), intent(in), optional	start
	)

Definition at line 1333 of file gtool_history.f90.

References gtool_file_h::file_real4, gtool_file_h::file_real8, and dc_log::log().

    use gtool_file_h, only: &
       file_real4, &
       file_real8
    implicit none

    character(len=*), intent(in) :: name
    character(len=*), intent(in) :: desc
    character(len=*), intent(in) :: units
    character(len=*), intent(in) :: dims(:)
    real(SP),         intent(in) :: var(:,:,:)
    character(len=*), intent(in), optional :: datatype
    integer,          intent(in), optional :: start(:)

    integer :: dtype
    integer :: dim_size
    integer :: id

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

    if ( present(datatype) ) then
       if    ( datatype == 'REAL4' ) then
          dtype = file_real4
       elseif( datatype == 'REAL8' ) then
          dtype = file_real8
       else
          write(message,*) 'xxx Not appropriate datatype. Check!', datatype
          call log('E',message)
       endif
    else
       dtype = file_real4
    endif

    dim_size = size(var)

    if ( history_assoc_count < history_assoc_limit ) then
       history_assoc_count = history_assoc_count + 1
       id                  = history_assoc_count

       allocate( history_assoc(id)%var(dim_size) )

       history_assoc(id)%name      = name
       history_assoc(id)%desc      = desc
       history_assoc(id)%units     = units
       history_assoc(id)%ndims     = 3
       history_assoc(id)%dims(:)   = ''
       history_assoc(id)%dims(1:3) = dims(1:3)
       history_assoc(id)%dtype     = dtype
       history_assoc(id)%var(:)    = reshape( var, (/ dim_size /) )

       ! start and count are used for parallel I/O to a single shared file
       ! since var is reshaped into 1D array, we need to preserve its original shape in count
       history_assoc(id)%count(1:3) = shape(var)
       if ( present(start) ) then
          history_assoc(id)%start(1:3) = start(1:3)
       else
          history_assoc(id)%start = (/ 1, 1, 1, 1 /)
       end if
    else
       write(message,*) 'xxx Number of associate coordinates exceeds the limit.'
       call log('E',message)
    endif

    return

Here is the call graph for this function:

historyput3dassociatedcoordinatesdp()

subroutine gtool_history::historyput3dassociatedcoordinatesdp	(	character(len=*), intent(in)	name,
		character(len=*), intent(in)	desc,
		character(len=*), intent(in)	units,
		character(len=*), dimension(:), intent(in)	dims,
		real(dp), dimension(:,:,:), intent(in)	var,
		character(len=*), intent(in), optional	datatype,
		integer, dimension(:), intent(in), optional	start
	)

Definition at line 1408 of file gtool_history.f90.

References gtool_file_h::file_real4, gtool_file_h::file_real8, and dc_log::log().

    use gtool_file_h, only: &
       file_real4, &
       file_real8
    implicit none

    character(len=*), intent(in) :: name
    character(len=*), intent(in) :: desc
    character(len=*), intent(in) :: units
    character(len=*), intent(in) :: dims(:)
    real(DP),         intent(in) :: var(:,:,:)
    character(len=*), intent(in), optional :: datatype
    integer,          intent(in), optional :: start(:)

    integer :: dtype
    integer :: dim_size
    integer :: id

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

    if ( present(datatype) ) then
       if    ( datatype == 'REAL4' ) then
          dtype = file_real4
       elseif( datatype == 'REAL8' ) then
          dtype = file_real8
       else
          write(message,*) 'xxx Not appropriate datatype. Check!', datatype
          call log('E',message)
       endif
    else
       dtype = file_real8
    endif

    dim_size = size(var)

    if ( history_assoc_count < history_assoc_limit ) then
       history_assoc_count = history_assoc_count + 1
       id                  = history_assoc_count

       allocate( history_assoc(id)%var(dim_size) )

       history_assoc(id)%name      = name
       history_assoc(id)%desc      = desc
       history_assoc(id)%units     = units
       history_assoc(id)%ndims     = 3
       history_assoc(id)%dims(:)   = ''
       history_assoc(id)%dims(1:3) = dims(1:3)
       history_assoc(id)%dtype     = dtype
       history_assoc(id)%var(:)    = reshape( var, (/ dim_size /) )

       ! start and count are used for parallel I/O to a single shared file
       ! since var is reshaped into 1D array, we need to preserve its original shape in count
       history_assoc(id)%count(1:3) = shape(var)
       if ( present(start) ) then
          history_assoc(id)%start(1:3) = start(1:3)
       else
          history_assoc(id)%start = (/ 1, 1, 1, 1 /)
       end if
    else
       write(message,*) 'xxx Number of associate coordinates exceeds the limit.'
       call log('E',message)
    endif

    return

Here is the call graph for this function:

historyput4dassociatedcoordinatessp()

subroutine gtool_history::historyput4dassociatedcoordinatessp	(	character(len=*), intent(in)	name,
		character(len=*), intent(in)	desc,
		character(len=*), intent(in)	units,
		character(len=*), dimension(:), intent(in)	dims,
		real(sp), dimension(:,:,:,:), intent(in)	var,
		character(len=*), intent(in), optional	datatype,
		integer, dimension(:), intent(in), optional	start
	)

Definition at line 1483 of file gtool_history.f90.

References gtool_file_h::file_real4, gtool_file_h::file_real8, and dc_log::log().

    use gtool_file_h, only: &
       file_real4, &
       file_real8
    implicit none

    character(len=*), intent(in) :: name
    character(len=*), intent(in) :: desc
    character(len=*), intent(in) :: units
    character(len=*), intent(in) :: dims(:)
    real(SP),         intent(in) :: var(:,:,:,:)
    character(len=*), intent(in), optional :: datatype
    integer,          intent(in), optional :: start(:)

    integer :: dtype
    integer :: dim_size
    integer :: id

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

    if ( present(datatype) ) then
       if    ( datatype == 'REAL4' ) then
          dtype = file_real4
       elseif( datatype == 'REAL8' ) then
          dtype = file_real8
       else
          write(message,*) 'xxx Not appropriate datatype. Check!', datatype
          call log('E',message)
       endif
    else
       dtype = file_real4
    endif

    dim_size = size(var)

    if ( history_assoc_count < history_assoc_limit ) then
       history_assoc_count = history_assoc_count + 1
       id                  = history_assoc_count

       allocate( history_assoc(id)%var(dim_size) )

       history_assoc(id)%name      = name
       history_assoc(id)%desc      = desc
       history_assoc(id)%units     = units
       history_assoc(id)%ndims     = 4
       history_assoc(id)%dims(:)   = ''
       history_assoc(id)%dims(1:4) = dims(1:4)
       history_assoc(id)%dtype     = dtype
       history_assoc(id)%var(:)    = reshape( var, (/ dim_size /) )

       ! start and count are used for parallel I/O to a single shared file
       ! since var is reshaped into 1D array, we need to preserve its original shape in count
       history_assoc(id)%count(1:4) = shape(var)
       if ( present(start) ) then
          history_assoc(id)%start(1:4) = start(1:4)
       else
          history_assoc(id)%start = (/ 1, 1, 1, 1 /)
       end if
    else
       write(message,*) 'xxx Number of associate coordinates exceeds the limit.'
       call log('E',message)
    endif

    return

Here is the call graph for this function:

historyput4dassociatedcoordinatesdp()

subroutine gtool_history::historyput4dassociatedcoordinatesdp	(	character(len=*), intent(in)	name,
		character(len=*), intent(in)	desc,
		character(len=*), intent(in)	units,
		character(len=*), dimension(:), intent(in)	dims,
		real(dp), dimension(:,:,:,:), intent(in)	var,
		character(len=*), intent(in), optional	datatype,
		integer, dimension(:), intent(in), optional	start
	)

Definition at line 1558 of file gtool_history.f90.

References gtool_file_h::file_real4, gtool_file_h::file_real8, and dc_log::log().

    use gtool_file_h, only: &
       file_real4, &
       file_real8
    implicit none

    character(len=*), intent(in) :: name
    character(len=*), intent(in) :: desc
    character(len=*), intent(in) :: units
    character(len=*), intent(in) :: dims(:)
    real(DP),         intent(in) :: var(:,:,:,:)
    character(len=*), intent(in), optional :: datatype
    integer,          intent(in), optional :: start(:)

    integer :: dtype
    integer :: dim_size
    integer :: id

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

    if ( present(datatype) ) then
       if    ( datatype == 'REAL4' ) then
          dtype = file_real4
       elseif( datatype == 'REAL8' ) then
          dtype = file_real8
       else
          write(message,*) 'xxx Not appropriate datatype. Check!', datatype
          call log('E',message)
       endif
    else
       dtype = file_real8
    endif

    dim_size = size(var)

    if ( history_assoc_count < history_assoc_limit ) then
       history_assoc_count = history_assoc_count + 1
       id                  = history_assoc_count

       allocate( history_assoc(id)%var(dim_size) )

       history_assoc(id)%name      = name
       history_assoc(id)%desc      = desc
       history_assoc(id)%units     = units
       history_assoc(id)%ndims     = 4
       history_assoc(id)%dims(:)   = ''
       history_assoc(id)%dims(1:4) = dims(1:4)
       history_assoc(id)%dtype     = dtype
       history_assoc(id)%var(:)    = reshape( var, (/ dim_size /) )

       ! start and count are used for parallel I/O to a single shared file
       ! since var is reshaped into 1D array, we need to preserve its original shape in count
       history_assoc(id)%count(1:4) = shape(var)
       if ( present(start) ) then
          history_assoc(id)%start(1:4) = start(1:4)
       else
          history_assoc(id)%start = (/ 1, 1, 1, 1 /)
       end if
    else
       write(message,*) 'xxx Number of associate coordinates exceeds the limit.'
       call log('E',message)
    endif

    return

Here is the call graph for this function:

historysettattr()

subroutine, public gtool_history::historysettattr	(	character(len=*), intent(in)	varname,
		character(len=*), intent(in)	key,
		character(len=*), intent(in)	val
	)

Definition at line 1629 of file gtool_history.f90.

References gtool_file::filesettattr().

    use gtool_file, only: &
       filesettattr
    implicit none

    character(len=*), intent(in) :: varname
    character(len=*), intent(in) :: key
    character(len=*), intent(in) :: val

    integer :: id
    !---------------------------------------------------------------------------

    do id = 1, history_id_count
       call filesettattr( history_vars(id)%fid, & ! [IN]
                          varname,              & ! [IN]
                          key,                  & ! [IN]
                          val                   ) ! [IN]
    enddo

Here is the call graph for this function:

historyquery()

subroutine, public gtool_history::historyquery	(	character(len=*), intent(in)	item,
		integer, intent(in)	step_now,
		logical, intent(out)	answer
	)

Definition at line 1654 of file gtool_history.f90.

References dc_log::log().

Referenced by scale_history::hist_query().

    implicit none

    character(len=*), intent(in)  :: item
    integer,          intent(in)  :: step_now
    logical,          intent(out) :: answer

    integer :: id
    !---------------------------------------------------------------------------

    answer  = .false.

    ! note: multiple put may be necessary for the item
    do id = 1, history_id_count
       if ( item == history_vars(id)%item ) then
          if    ( history_vars(id)%taverage ) then
             answer = .true.
          elseif( step_now == history_vars(id)%laststep_write + history_vars(id)%dstep ) then
             answer = .true.
          endif
       endif
    enddo

    return

Here is the call graph for this function:

Here is the caller graph for this function:

historywriteall()

subroutine, public gtool_history::historywriteall

(

integer, intent(in)

step_now

)

Definition at line 2108 of file gtool_history.f90.

References gtool_file::fileflush(), historywrite(), and historywriteaxes().

Referenced by scale_history::hist_write().

    use gtool_file, only: &
       fileflush
    implicit none
    integer, intent(in) :: step_now

    integer :: id
    integer :: fid, prev_fid
    !---------------------------------------------------------------------------

    ! Note this subroutine must be called after all HIST_reg calls are completed
    ! Write registered history axes to history file
    call historywriteaxes

    ! Write registered history variables to history file
    do id = 1, history_id_count
       call historywrite( id,      & ! [IN]
                          step_now ) ! [IN]
    enddo

    prev_fid = -1
    do id = 1, history_id_count
       fid = history_vars(id)%fid
       if ( fid .NE. prev_fid ) then
          ! when using PnetCDF, the above HistoryWrite() only posts write requests
          ! Now we need to commit the requests to the file
          call fileflush( fid )
          prev_fid = fid
       end if
    end do

    return

Here is the call graph for this function:

Here is the caller graph for this function:

historywriteaxes()

subroutine, public gtool_history::historywriteaxes

(

)

Definition at line 2143 of file gtool_history.f90.

References gtool_file::fileenddef(), and gtool_file::fileflush().

Referenced by historywriteall().

    use gtool_file, only: &
       fileenddef,    &
       fileflush,     &
       filewriteaxis, &
       filewriteassociatedcoordinates
    implicit none

    integer :: m, id, fid
    integer :: start(1)
    !---------------------------------------------------------------------------

    if( history_req_count  == 0 ) return
    if( history_axis_count == 0 ) return

    do id = 1, history_id_count

       fid = history_vars(id)%fid

       if ( history_axis_written(fid) ) cycle

       call fileenddef( fid )

       ! write registered history variables to file
       do m = 1, history_axis_count
          if ( history_axis(m)%start(1) > 0 ) then
             start(1) = history_axis(m)%start(1)
             call filewriteaxis( fid,                  & ! [IN]
                                 history_axis(m)%name, & ! [IN]
                                 history_axis(m)%var,  & ! [IN]
                                 start                 ) ! [IN]
          end if
       enddo

       do m = 1, history_assoc_count
          call filewriteassociatedcoordinates( fid,   & ! [IN]
                                               history_assoc(m)%name,  & ! [IN]
                                               history_assoc(m)%var,   & ! [IN]
                                               history_assoc(m)%start, & ! [IN]
                                               history_assoc(m)%count, & ! [IN]
                                               history_assoc(m)%ndims  ) ! [IN]
       enddo

       ! for PnetCDF I/O, flush all pending nonblocking write requests
       call fileflush( fid )

       ! mark the axes have been written
       history_axis_written( fid ) = .true.

    end do

    return

Here is the call graph for this function:

Here is the caller graph for this function:

historywrite()

subroutine, public gtool_history::historywrite	(	integer, intent(in)	id,
		integer, intent(in)	step_now
	)

Definition at line 2200 of file gtool_history.f90.

References historyoutputlist(), and dc_log::log().

Referenced by historywriteall().

    use dc_calendar, only: &
       calendarsec2ymdhms
    use gtool_file, only: &
       filewrite
    implicit none

    integer, intent(in) :: id
    integer, intent(in) :: step_now

    integer  :: isize
    real(DP) :: time_str, time_end
    real(DP) :: sec_str,  sec_end
    !---------------------------------------------------------------------------

    if( history_req_count == 0 ) return

    if ( step_now < history_vars(id)%laststep_write + history_vars(id)%dstep ) then
       return
    endif

    if ( history_vars(id)%laststep_put == history_vars(id)%laststep_write ) then
       write(message,*) 'xxx History variable was never put after the last output!: ', &
                        trim(history_vars(id)%item)
       if ( history_error_putmiss ) then
          call log('E',message)
       else
          call log('I',message)
       endif
    endif

    isize = history_vars(id)%size

    if ( history_vars(id)%taverage ) then
       history_vars(id)%varsum(1:isize) = history_vars(id)%varsum(1:isize) / history_vars(id)%timesum
    endif

    if ( firsttime ) then
       firsttime = .false.
       call historyoutputlist
    endif

    sec_str = history_startdaysec + real(History_vars(id)%laststep_write-1,kind=DP) * History_DTSEC
    sec_end = history_startdaysec + real(step_now                       -1,kind=DP) * History_DTSEC

    if ( sec_end >= history_startdaysec + history_vars(id)%waitsec ) then
       if ( laststep_write < step_now ) then ! log only once in this step
          write(message,'(A)') '*** Output History'
          call log('I',message)
       endif

       ! convert time units [sec]->[sec,min,hour,day,month,year]
       call calendarsec2ymdhms( time_str, sec_str, history_time_units )
       call calendarsec2ymdhms( time_end, sec_end, history_time_units )

       if ( history_vars(id)%count(1) .GT. 0 ) then

          ! for one-file-per-process I/O method, History_vars(:)%count(1) == 1 always
          ! for one file shared by all processes, History_vars(:)%count(1) >= 0,
          ! being 0 indicates a 1D history variable, which will only be written by the
          ! south-most processes in parallel, or a z axis to be written by rank 0 only
          call filewrite( history_vars(id)%fid,             & ! [IN]
                          history_vars(id)%vid,             & ! [IN]
                          history_vars(id)%varsum(1:isize), & ! [IN]
                          time_str,                         & ! [IN]
                          time_end,                         & ! [IN]
                          history_vars(id)%start,           & ! global subarray start indices
                          history_vars(id)%count,           & ! global subarray lengths
                          history_vars(id)%ndims            ) ! ndims before reshape
       end if
    else
       if ( laststep_write < step_now ) then
          write(message,'(A)') '*** Output History: Suppressed.'
          call log('I',message)
       endif
    endif

    history_vars(id)%laststep_write = step_now
    history_vars(id)%laststep_put   = step_now
    history_vars(id)%timesum        = 0.0_dp
    history_vars(id)%varsum(:)      = 0.0_dp

    laststep_write = step_now ! remember for multiple call in the same step

    return

Here is the call graph for this function:

Here is the caller graph for this function:

historyget1ddp()

subroutine gtool_history::historyget1ddp	(	real(dp), dimension(:), intent(out)	var,
		character(len=*), intent(in)	basename,
		character(len=*), intent(in)	varname,
		integer, intent(in)	step,
		logical, intent(in), optional	allow_missing,
		logical, intent(in), optional	single
	)

Definition at line 2295 of file gtool_history.f90.

    use gtool_file, only: &
       fileread
    implicit none

    real(DP),         intent(out) :: var(:)
    character(len=*), intent(in)  :: basename
    character(len=*), intent(in)  :: varname
    integer,          intent(in)  :: step
    logical,          intent(in), optional :: allow_missing
    logical,          intent(in), optional :: single

    logical :: allow_missing_
    logical :: single_
    !---------------------------------------------------------------------------

    allow_missing_ = .false.
    single_        = .false.

    if ( present(allow_missing) ) then
       allow_missing_ = allow_missing
    endif

    if ( present(single) ) then
       single_ = single
    endif

    call fileread( var,             & ! [OUT]
                   basename,        & ! [IN]
                   varname,         & ! [IN]
                   step,            & ! [IN]
                   history_myrank,  & ! [IN]
                   allow_missing_,  & ! [IN]
                   single_          ) ! [IN]

    return

historyget1dsp()

subroutine gtool_history::historyget1dsp	(	real(sp), dimension(:), intent(out)	var,
		character(len=*), intent(in)	basename,
		character(len=*), intent(in)	varname,
		integer, intent(in)	step,
		logical, intent(in), optional	allow_missing,
		logical, intent(in), optional	single
	)

Definition at line 2340 of file gtool_history.f90.

    use gtool_file, only: &
       fileread
    implicit none

    real(SP),         intent(out) :: var(:)
    character(len=*), intent(in)  :: basename
    character(len=*), intent(in)  :: varname
    integer,          intent(in)  :: step
    logical,          intent(in), optional :: allow_missing
    logical,          intent(in), optional :: single

    logical :: allow_missing_
    logical :: single_
    !---------------------------------------------------------------------------

    allow_missing_ = .false.
    single_        = .false.

    if ( present(allow_missing) ) then
       allow_missing_ = allow_missing
    endif

    if ( present(single) ) then
       single_ = single
    endif

    call fileread( var,             & ! [OUT]
                   basename,        & ! [IN]
                   varname,         & ! [IN]
                   step,            & ! [IN]
                   history_myrank,  & ! [IN]
                   allow_missing_,  & ! [IN]
                   single_          ) ! [IN]

    return

historyget2ddp()

subroutine gtool_history::historyget2ddp	(	real(dp), dimension(:,:), intent(out)	var,
		character(len=*), intent(in)	basename,
		character(len=*), intent(in)	varname,
		integer, intent(in)	step,
		logical, intent(in), optional	allow_missing,
		logical, intent(in), optional	single
	)

Definition at line 2385 of file gtool_history.f90.

    use gtool_file, only: &
       fileread
    implicit none

    real(DP),         intent(out) :: var(:,:)
    character(len=*), intent(in)  :: basename
    character(len=*), intent(in)  :: varname
    integer,          intent(in)  :: step
    logical,          intent(in), optional :: allow_missing
    logical,          intent(in), optional :: single

    logical :: allow_missing_
    logical :: single_
    !---------------------------------------------------------------------------

    allow_missing_ = .false.
    single_        = .false.

    if ( present(allow_missing) ) then
       allow_missing_ = allow_missing
    endif

    if ( present(single) ) then
       single_ = single
    endif

    call fileread( var,             & ! [OUT]
                   basename,        & ! [IN]
                   varname,         & ! [IN]
                   step,            & ! [IN]
                   history_myrank,  & ! [IN]
                   allow_missing_,  & ! [IN]
                   single_          ) ! [IN]

    return

historyget2dsp()

subroutine gtool_history::historyget2dsp	(	real(sp), dimension(:,:), intent(out)	var,
		character(len=*), intent(in)	basename,
		character(len=*), intent(in)	varname,
		integer, intent(in)	step,
		logical, intent(in), optional	allow_missing,
		logical, intent(in), optional	single
	)

Definition at line 2430 of file gtool_history.f90.

    use gtool_file, only: &
       fileread
    implicit none

    real(SP),         intent(out) :: var(:,:)
    character(len=*), intent(in)  :: basename
    character(len=*), intent(in)  :: varname
    integer,          intent(in)  :: step
    logical,          intent(in), optional :: allow_missing
    logical,          intent(in), optional :: single

    logical :: allow_missing_
    logical :: single_
    !---------------------------------------------------------------------------

    allow_missing_ = .false.
    single_        = .false.

    if ( present(allow_missing) ) then
       allow_missing_ = allow_missing
    endif

    if ( present(single) ) then
       single_ = single
    endif

    call fileread( var,             & ! [OUT]
                   basename,        & ! [IN]
                   varname,         & ! [IN]
                   step,            & ! [IN]
                   history_myrank,  & ! [IN]
                   allow_missing_,  & ! [IN]
                   single_          ) ! [IN]

    return

historyget3ddp()

subroutine gtool_history::historyget3ddp	(	real(dp), dimension(:,:,:), intent(out)	var,
		character(len=*), intent(in)	basename,
		character(len=*), intent(in)	varname,
		integer, intent(in)	step,
		logical, intent(in), optional	allow_missing,
		logical, intent(in), optional	single
	)

Definition at line 2475 of file gtool_history.f90.

    use gtool_file, only: &
       fileread
    implicit none

    real(DP),         intent(out) :: var(:,:,:)
    character(len=*), intent(in)  :: basename
    character(len=*), intent(in)  :: varname
    integer,          intent(in)  :: step
    logical,          intent(in), optional :: allow_missing
    logical,          intent(in), optional :: single

    logical :: allow_missing_
    logical :: single_
    !---------------------------------------------------------------------------

    allow_missing_ = .false.
    single_        = .false.

    if ( present(allow_missing) ) then
       allow_missing_ = allow_missing
    endif

    if ( present(single) ) then
       single_ = single
    endif

    call fileread( var,             & ! [OUT]
                   basename,        & ! [IN]
                   varname,         & ! [IN]
                   step,            & ! [IN]
                   history_myrank,  & ! [IN]
                   allow_missing_,  & ! [IN]
                   single_          ) ! [IN]

    return

historyget3dsp()

subroutine gtool_history::historyget3dsp	(	real(sp), dimension(:,:,:), intent(out)	var,
		character(len=*), intent(in)	basename,
		character(len=*), intent(in)	varname,
		integer, intent(in)	step,
		logical, intent(in), optional	allow_missing,
		logical, intent(in), optional	single
	)

Definition at line 2520 of file gtool_history.f90.

    use gtool_file, only: &
       fileread
    implicit none

    real(SP),         intent(out) :: var(:,:,:)
    character(len=*), intent(in)  :: basename
    character(len=*), intent(in)  :: varname
    integer,          intent(in)  :: step
    logical,          intent(in), optional :: allow_missing
    logical,          intent(in), optional :: single

    logical :: allow_missing_
    logical :: single_
    !---------------------------------------------------------------------------

    allow_missing_ = .false.
    single_        = .false.

    if ( present(allow_missing) ) then
       allow_missing_ = allow_missing
    endif

    if ( present(single) ) then
       single_ = single
    endif

    call fileread( var,             & ! [OUT]
                   basename,        & ! [IN]
                   varname,         & ! [IN]
                   step,            & ! [IN]
                   history_myrank,  & ! [IN]
                   allow_missing_,  & ! [IN]
                   single_          ) ! [IN]

    return

historyoutputlist()

subroutine, public gtool_history::historyoutputlist

(

)

Definition at line 2559 of file gtool_history.f90.

References dc_log::log().

Referenced by historywrite().

    implicit none

    real(DP) :: dtsec
    integer  :: id
    !---------------------------------------------------------------------------

    call log('I','')
    write(message,'(A)') '*** [HIST] Output item list '
    call log('I',message)
    write(message,'(A,I4)') '*** Number of history item :', history_req_count
    call log('I',message)
    write(message,'(2A)') 'ITEM                    :OUTNAME                 ', &
                          ':    size:interval[sec]:    step:timeavg?:zcoord'
    call log('I',message)
    write(message,'(2A)') '=================================================', &
                          '================================================'
    call log('I',message)

    do id = 1, history_id_count
       dtsec = real(History_vars(id)%dstep,kind=DP) * History_DTSEC

       write(message,'(A24,1x,A24,1x,I8,1x,F13.3,1x,I8,1x,L8,1x,A6)') history_vars(id)%item,     &
                                                                      history_vars(id)%outname,  &
                                                                      history_vars(id)%size,     &
                                                                      dtsec,                     &
                                                                      history_vars(id)%dstep,    &
                                                                      history_vars(id)%taverage, &
                                                                      history_vars(id)%zcoord
       call log('I',message)
    enddo

    write(message,'(2A)') '=================================================', &
                          '================================================'
    call log('I',message)
    call log('I','')

    return

Here is the call graph for this function:

Here is the caller graph for this function:

historyfinalize()

subroutine, public gtool_history::historyfinalize

(

)

Definition at line 2600 of file gtool_history.f90.

References gtool_file::fileclose(), and gtool_file::filedetachbuffer().

    use gtool_file, only: &
       filedetachbuffer, &
       fileclose
    implicit none

    integer :: id
    integer :: fid, prev_fid
    !---------------------------------------------------------------------------

    prev_fid = -1
    do id = 1, history_id_count
       fid = history_vars(id)%fid
       if ( fid .NE. prev_fid ) then
          ! Release the internal buffer previously allowed to be used by PnetCDF
          call filedetachbuffer( fid )
          call fileclose( fid )
          prev_fid =  fid
       end if
    enddo

    return

Here is the call graph for this function: