hstnmlinfoadd.f90 File Reference

Add output information of a variable . More...

Go to the source code of this file.

Functions/Subroutines
recursive subroutine	hstnmlinfoadd (gthstnml, name, file, interval_value, interval_unit, precision, time_average, average, fileprefix, origin_value, origin_unit, terminus_value, terminus_unit, slice_start, slice_end, slice_stride, space_average, newfile_intvalue, newfile_intunit, err)

Detailed Description

Add output information of a variable

.

Author

Yasuhiro MORIKAWA

Copyright

Copyright (C) GFD Dennou Club, 2007-2026. All rights reserved.
License is BSD-2-Clause. See COPYRIGHT in detail

Definition in file hstnmlinfoadd.f90.

Function/Subroutine Documentation

hstnmlinfoadd()

recursive subroutine hstnmlinfoadd	(	type(gthst_nmlinfo), intent(inout)	gthstnml,
		character(*), intent(in), optional	name,
		character(*), intent(in), optional	file,
		real(dp), intent(in), optional	interval_value,
		character(*), intent(in), optional	interval_unit,
		character(*), intent(in), optional	precision,
		logical, intent(in), optional	time_average,
		logical, intent(in), optional	average,
		character(*), intent(in), optional	fileprefix,
		real(dp), intent(in), optional	origin_value,
		character(*), intent(in), optional	origin_unit,
		real(dp), intent(in), optional	terminus_value,
		character(*), intent(in), optional	terminus_unit,
		integer, dimension(:), intent(in), optional	slice_start,
		integer, dimension(:), intent(in), optional	slice_end,
		integer, dimension(:), intent(in), optional	slice_stride,
		logical, dimension(:), intent(in), optional	space_average,
		integer, intent(in), optional	newfile_intvalue,
		character(*), intent(in), optional	newfile_intunit,
		logical, intent(out), optional	err )

Add output information of a variable

Add output information of a variable.

In order to set default values, specify blank to name or do not specify name. When default values are specified, file is ignored. fileprefix is valid only when default values are specified.

When a variable identifier is specified to name and file is not specified or blanks are specified to file, "<em>string given to name</em>.nc" is specified to file.

If gthstnml is not initialized by HstNmlInfoCreate yet, error is occurred.

Parameters

[in,out]	gthstnml	gtool_history_nmlinfo_types::GTHST_NMLINFO 型変数
[in]	name	変数名 (optional). Variable identifier.
[in]	file	ファイル名 (optional). History data filename.
[in]	interval_value	出力間隔の数値 (optional). Numerical value for interval.
[in]	interval_unit	出力間隔の単位 (optional). Unit for interval.
[in]	precision	精度 (optional). Precision.
[in]	time_average	時間平均化フラグ (optional). Flag for time average.
[in]	average	time_average の旧版 (optional). Old version of time_average.
[in]	fileprefix	ファイル名の接頭詞 (optional). Prefixes of filenames.
[in]	origin_value	出力開始時刻 (optional). Start time of output.
[in]	origin_unit	出力開始時刻の単位 (optional). Unit of start time.
[in]	terminus_value	出力終了時刻 (optional). End time of output.
[in]	terminus_unit	出力終了時刻の単位 (optional). Unit of end time.
[in]	slice_start	空間方向の開始点 (optional). Start points of spaces.
[in]	slice_end	空間方向の終了点 (optional). End points of spaces.
[in]	slice_stride	空間方向の刻み幅 (optional). Strides of spaces.
[in]	space_average	平均化のフラグ (optional). Flag of average.
[in]	newfile_intvalue	ファイル分割時間間隔 (optional). Interval of file separation.
[in]	newfile_intunit	ファイル分割時間間隔の単位 (optional). Unit of file separation interval.
[out]	err	例外処理用フラグ. Exception handling flag.

Definition at line 71 of file hstnmlinfoadd.f90.

    use gtool_history_nmlinfo_types, only: gthst_nmlinfo, gthst_nmlinfo_entry
    use gtool_history_nmlinfo_generic, only: hstnmlinfodelete
    use gtool_history_nmlinfo_internal, only: listsearch, listlast
    use gtool_history_nmlinfo_internal, only: name_delimiter
    use dc_trace, only: beginsub, endsub, dbgmessage
    use dc_string, only: putline, printf, split, strinclude, stoa, joinchar, cprintf
    use dc_present, only: present_and_not_empty, present_and_true, present_select
    use dc_types, only: dp, string, token
    use dc_date_types, only: dc_difftime
    use dc_date, only: dcdifftimecreate, operator(>), operator(<)
    use dc_message, only: messagenotify
    use dc_error, only: storeerror, dc_noerr, dc_enotinit, &
      & usr_errno, hst_enotindefine, hst_ebadnewfileint
    use netcdf, only: nf90_max_dims
    implicit none
    type(GTHST_NMLINFO), intent(inout):: gthstnml
    character(*), intent(in), optional:: name
                              ! 変数名.
                              !
                              ! 先頭の空白は無視されます.
                              !
                              ! "Data1,Data2" のようにカンマで区切って複数
                              ! の変数を指定することも可能です.
                              !--
                              ! ただし,
                              ! その際には, *file* 引数で与えられる情報は
                              ! 無視されます. その他の情報はそれぞれの
                              ! 変数の情報として設定されます.
                              !++
                              !
                              ! Variable identifier.
                              !
                              ! Blanks at the head of the name are ignored.
                              !
                              ! Multiple variables can be specified
                              ! as "Data1,Data2" too. Delimiter is comma.
                              !--
                              ! In this case, *file* is ignored, and
                              ! other information is set to each variable.
                              !++
                              !
    character(*), intent(in), optional:: file
                              ! ヒストリデータのファイル名.
                              ! History data filenames
    real(DP), intent(in), optional:: interval_value
                              ! ヒストリデータの出力間隔の数値.
                              ! 負の値を与えると, 出力を抑止します.
                              !
                              ! Numerical value for interval of history data output.
                              ! Negative values suppresses output.
    character(*), intent(in), optional:: interval_unit
                              ! ヒストリデータの出力間隔の単位.
                              ! Unit for interval of history data output
    character(*), intent(in), optional:: precision
                              ! ヒストリデータの精度.
                              ! Precision of history data
    logical, intent(in), optional:: time_average
                              ! 出力データの時間平均化フラグ.
                              ! Flag for time average of output data.
    logical, intent(in), optional:: average
                              ! time_average の旧版.
                              ! Old version of "time_average"
    character(*), intent(in), optional:: fileprefix
                              ! ヒストリデータのファイル名の接頭詞.
                              ! Prefixes of history data filenames
    real(DP), intent(in), optional:: origin_value
                              ! 出力開始時刻.
                              ! Start time of output.
    character(*), intent(in), optional:: origin_unit
                              ! 出力開始時刻の単位.
                              ! Unit of start time of output.
    real(DP), intent(in), optional:: terminus_value
                              ! 出力終了時刻.
                              ! End time of output.
    character(*), intent(in), optional:: terminus_unit
                              ! 出力終了時刻の単位.
                              ! Unit of end time of output.
    integer, intent(in), optional:: slice_start(:)
                              ! 空間方向の開始点.
                              ! Start points of spaces.
    integer, intent(in), optional:: slice_end(:)
                              ! 空間方向の終了点.
                              ! End points of spaces.
    integer, intent(in), optional:: slice_stride(:)
                              ! 空間方向の刻み幅.
                              ! Strides of spaces.
    logical, intent(in), optional:: space_average(:)
                              ! 平均化のフラグ.
                              ! Flag of average.
    integer, intent(in), optional:: newfile_intvalue
                              ! ファイル分割時間間隔.
                              ! Interval of time of separation of a file.
    character(*), intent(in), optional:: newfile_intunit
                              ! ファイル分割時間間隔の単位.
                              ! Unit of interval of time of separation of a file.
    logical, intent(out), optional:: err
                              ! 例外処理用フラグ.
                              ! デフォルトでは, この手続き内でエラーが
                              ! 生じた場合, プログラムは強制終了します.
                              ! 引数 *err* が与えられる場合,
                              ! プログラムは強制終了せず, 代わりに
                              ! *err* に .true. が代入されます.
                              !
                              ! Exception handling flag.
                              ! By default, when error occur in
                              ! this procedure, the program aborts.
                              ! If this *err* argument is given,
                              ! .true. is substituted to *err* and
                              ! the program does not abort.
 
    !-----------------------------------
    !  作業変数
    !  Work variables
    type(GTHST_NMLINFO_ENTRY), pointer:: hptr =>null()
    type(GTHST_NMLINFO_ENTRY), pointer:: hptr_last =>null()
    type(DC_DIFFTIME):: interval_time, newfileint_time
    character(TOKEN), pointer:: varnames_array(:) =>null()
    integer:: i, vnmax, ary_size
    integer:: stat
    character(STRING):: cause_c
    character(*), parameter:: subname = 'HstNmlInfoAdd'
  continue
    call beginsub( subname, &
      & fmt = '@name=%a @file=%a @interval_value=%r @interval_unit=%a @precision=%a @time_average=%y @fileprefix=%a', &
      & d  = (/ present_select(.true., -1.0_dp, interval_value) /), &
      & l  = (/ present_and_true(time_average) /), &
      & ca = stoa( present_select(.true., '<no>', name), &
      &            present_select(.true., '<no>', file), &
      &            present_select(.true., '<no>', interval_unit), &
      &            present_select(.true., '<no>', precision), &
      &            present_select(.true., '<no>', fileprefix) ) &
      & )
 
    stat = dc_noerr
    cause_c = ''
 
    !-----------------------------------------------------------------
    !  初期設定のチェック
    !  Check initialization
    !-----------------------------------------------------------------
    if ( .not. gthstnml % initialized ) then
      stat = dc_enotinit
      cause_c = 'GTHST_NMLINFO'
      goto 999
    end if
 
    if ( .not. gthstnml % define_mode ) then
      stat = hst_enotindefine
      cause_c = 'Add'
      goto 999
    end if
 
    !-----------------------------------------------------------------
    !  複数の変数を設定する場合
    !  Configure multiple variables
    !-----------------------------------------------------------------
    if ( present_and_not_empty(name) ) then
      if ( index(name, name_delimiter) > 0 ) then
        call dbgmessage( 'multiple entries (%c) will be created', c1 = trim(name) )
!!$        if ( present(file) ) call DbgMessage( 'argument @file=%c is ignored', c1 = trim(file) )
 
        call split( str = name, sep = name_delimiter, & ! (in)
          & carray = varnames_array )                   ! (out)
        vnmax = size( varnames_array )
 
        do i = 1, vnmax
          call hstnmlinfoadd( &
            & gthstnml = gthstnml, &             ! (inout)
            & name = varnames_array(i), &        ! (in)
            & file = file, &                     ! (in)
            & interval_value = interval_value, & ! (in)
            & interval_unit = interval_unit, &   ! (in)
            & precision = precision, &           ! (in)
            & time_average = time_average, &     ! (in)
            & average = average, &               ! (in)
            & origin_value = origin_value, &         ! (in)
            & origin_unit = origin_unit, &           ! (in)
            & terminus_value = terminus_value, &     ! (in)
            & terminus_unit = terminus_unit, &       ! (in)
            & slice_start = slice_start, &           ! (in)
            & slice_end = slice_end, &               ! (in)
            & slice_stride = slice_stride, &         ! (in)
            & space_average = space_average, &       ! (in)
            & newfile_intvalue = newfile_intvalue, & ! (in)
            & newfile_intunit = newfile_intunit, &   ! (in)
            & err = err )                        ! (out)
          if ( present_and_true( err ) ) then
            deallocate( varnames_array )
            stat = usr_errno
            goto 999
          end if
        end do
        deallocate( varnames_array )
        goto 999
      end if
    end if
 
    !-----------------------------------------------------------------
    !  *gthstnml* へ情報を追加.
    !  Add information to *gthstnml*
    !-----------------------------------------------------------------
    if ( .not. present_and_not_empty(name) ) then
      if ( present(interval_value) ) gthstnml % gthstnml_list % interval_value = &
        & real(interval_value, kind=kind(gthstnml % gthstnml_list % interval_value))
      if ( present(interval_unit)  ) gthstnml % gthstnml_list % interval_unit  = interval_unit
      if ( present(precision)      ) gthstnml % gthstnml_list % precision      = precision
      if ( present(average)        ) gthstnml % gthstnml_list % time_average   = average
      if ( present(time_average)   ) gthstnml % gthstnml_list % time_average   = time_average
      if ( present(fileprefix)     ) gthstnml % gthstnml_list % fileprefix     = fileprefix
 
      if ( present(origin_value    ) ) gthstnml % gthstnml_list % origin_value     = &
        & real(origin_value, kind=kind(gthstnml % gthstnml_list % origin_value))
      if ( present(origin_unit     ) ) gthstnml % gthstnml_list % origin_unit      = origin_unit
      if ( present(terminus_value  ) ) gthstnml % gthstnml_list % terminus_value   = &
        & real(terminus_value, kind=kind(gthstnml % gthstnml_list % terminus_value))
      if ( present(terminus_unit   ) ) gthstnml % gthstnml_list % terminus_unit    = terminus_unit
      if ( present(slice_start     ) ) then
        ary_size = size(slice_start)
        gthstnml % gthstnml_list % slice_start(1:ary_size)  = slice_start
      end if
      if ( present(slice_end      ) ) then
        ary_size = size(slice_end)
        gthstnml % gthstnml_list % slice_end(1:ary_size)    = slice_end
      end if
      if ( present(slice_stride   ) ) then
        ary_size = size(slice_stride)
        gthstnml % gthstnml_list % slice_stride(1:ary_size) = slice_stride
      end if
      if ( present(space_average   ) ) then
        ary_size = size(space_average)
        gthstnml % gthstnml_list % space_average(1:ary_size) = space_average
      end if
      if ( present(newfile_intvalue) ) gthstnml % gthstnml_list % newfile_intvalue = newfile_intvalue
      if ( present(newfile_intunit ) ) gthstnml % gthstnml_list % newfile_intunit  = newfile_intunit
 
 
      hptr => gthstnml % gthstnml_list
 
    else
      hptr => gthstnml % gthstnml_list
      call listsearch( gthstnml_list = hptr, & ! (inout)
        &              name = name )           ! (in)
      if ( .not. associated(hptr) ) then
        call dbgmessage( 'new entry (%c) is created', c1 = trim( adjustl( name ) ) )
 
        hptr_last => gthstnml % gthstnml_list
        call listlast( gthstnml_list = hptr_last ) ! (inout)
        allocate( hptr )
 
        nullify( hptr % next )
 
        hptr % interval_value => gthstnml % gthstnml_list % interval_value
        hptr % interval_unit  => gthstnml % gthstnml_list % interval_unit
        hptr % precision      => gthstnml % gthstnml_list % precision
        hptr % time_average   => gthstnml % gthstnml_list % time_average
        hptr % fileprefix     => gthstnml % gthstnml_list % fileprefix
 
        hptr % origin_value     => gthstnml % gthstnml_list % origin_value
        hptr % origin_unit      => gthstnml % gthstnml_list % origin_unit
        hptr % terminus_value   => gthstnml % gthstnml_list % terminus_value
        hptr % terminus_unit    => gthstnml % gthstnml_list % terminus_unit
        hptr % slice_start      => gthstnml % gthstnml_list % slice_start
        hptr % slice_end        => gthstnml % gthstnml_list % slice_end
        hptr % slice_stride     => gthstnml % gthstnml_list % slice_stride
        hptr % space_average    => gthstnml % gthstnml_list % space_average
        hptr % newfile_intvalue => gthstnml % gthstnml_list % newfile_intvalue
        hptr % newfile_intunit  => gthstnml % gthstnml_list % newfile_intunit
 
        hptr_last % next => hptr
      else
        call dbgmessage( 'entry (%c) is overwritten', c1 = trim( adjustl( name ) ) )
      end if
 
      hptr % name  = adjustl( name )
      if ( present_and_not_empty(file) ) then
        hptr % file = file
        nullify(  hptr % fileprefix )
        allocate( hptr % fileprefix )
        hptr % fileprefix = ''
      else
        hptr % file = trim( adjustl(name) ) // '.nc'
      end if
 
      if ( present(interval_value) ) then
        nullify(  hptr % interval_value )
        allocate( hptr % interval_value )
        hptr % interval_value = real(interval_value, kind=kind(hptr % interval_value))
      end if
      if ( present(interval_unit)  ) then
        nullify(  hptr % interval_unit  )
        allocate( hptr % interval_unit  )
        hptr % interval_unit  = interval_unit
      end if
      if ( present(precision)      ) then
        nullify(  hptr % precision      )
        allocate( hptr % precision      )
        hptr % precision      = precision
      end if
      if ( present(average)        ) then
        nullify(  hptr % time_average        )
        allocate( hptr % time_average        )
        hptr % time_average   = average
      end if
      if ( present(time_average)   ) then
        nullify(  hptr % time_average   )
        allocate( hptr % time_average   )
        hptr % time_average   = time_average
      end if
 
      if ( present(origin_value)   ) then
        nullify(  hptr % origin_value   )
        allocate( hptr % origin_value   )
        hptr % origin_value   = real(origin_value, kind=kind(hptr % origin_value))
      end if
      if ( present(origin_unit)   ) then
        nullify(  hptr % origin_unit   )
        allocate( hptr % origin_unit   )
        hptr % origin_unit   = origin_unit
      end if
      if ( present(terminus_value)   ) then
        nullify(  hptr % terminus_value   )
        allocate( hptr % terminus_value   )
        hptr % terminus_value   = real(terminus_value, kind=kind(hptr % terminus_value))
      end if
      if ( present(terminus_unit)   ) then
        nullify(  hptr % terminus_unit   )
        allocate( hptr % terminus_unit   )
        hptr % terminus_unit   = terminus_unit
      end if
      if ( present(slice_start)   ) then
        ary_size = size( slice_start )
        nullify(  hptr % slice_start   )
        allocate( hptr % slice_start(1:nf90_max_dims)   )
        hptr % slice_start = 1
        hptr % slice_start(1:ary_size) = slice_start
      end if
      if ( present(slice_end)   ) then
        ary_size = size( slice_end )
        nullify(  hptr % slice_end   )
        allocate( hptr % slice_end(1:nf90_max_dims)   )
        hptr % slice_end = -1
        hptr % slice_end(1:ary_size) = slice_end
      end if
      if ( present(slice_stride)   ) then
        ary_size = size( slice_stride )
        nullify(  hptr % slice_stride   )
        allocate( hptr % slice_stride(1:nf90_max_dims)   )
        hptr % slice_stride = 1
        hptr % slice_stride(1:ary_size) = slice_stride
      end if
      if ( present(space_average)   ) then
        ary_size = size( space_average )
        nullify(  hptr % space_average   )
        allocate( hptr % space_average(1:nf90_max_dims)   )
        hptr % space_average = .false.
        hptr % space_average(1:ary_size) = space_average
      end if
      if ( present(newfile_intvalue)   ) then
        nullify(  hptr % newfile_intvalue   )
        allocate( hptr % newfile_intvalue   )
        hptr % newfile_intvalue   = newfile_intvalue
      end if
      if ( present(newfile_intunit)   ) then
        nullify(  hptr % newfile_intunit   )
        allocate( hptr % newfile_intunit   )
        hptr % newfile_intunit   = newfile_intunit
      end if
 
    end if
 
    !---------------------------------------------------------------
    !  時間の単位のチェック
    !  Check unit of time
    !---------------------------------------------------------------
    call dcdifftimecreate( &
      & diff = interval_time, &          ! (out)
      & value = hptr % interval_value, & ! (in)
      & unit = hptr % interval_unit, &   ! (in)
      & err = err )                      ! (out)
    if ( present_and_true( err ) ) then
      call hstnmlinfodelete( &
        & gthstnml = gthstnml, & ! (inout)
        & name = name )          ! (in)
      stat = usr_errno
      goto 999
    end if
 
    !---------------------------------------------------------------
    !  ファイル分割時間間隔のチェック
    !  Check interval of time of separation of a file
    !---------------------------------------------------------------
    call dcdifftimecreate( &
      & diff = newfileint_time, &                  ! (out)
      & value = real( hptr % newfile_intvalue ), & ! (in)
      & unit = hptr % newfile_intunit, &           ! (in)
      & err = err )                                ! (out)
    if ( present_and_true( err ) ) then
      call hstnmlinfodelete( &
        & gthstnml = gthstnml, & ! (inout)
        & name = name )          ! (in)
      stat = usr_errno
      goto 999
    end if
 
    if ( hptr % newfile_intvalue > 0 ) then
      if ( .not. ( newfileint_time > interval_time ) ) then
      call messagenotify( 'W', subname, &
        & 'newfile_int=%d [%c] must be greater than interval=%r [%c]', &
        & i = (/ hptr % newfile_intvalue /), &
        & r = (/ hptr % interval_value /), &
        & c1 = trim( hptr % newfile_intunit ), &
        & c2 = trim( hptr % interval_unit ) )
 
      call hstnmlinfodelete( &
        & gthstnml = gthstnml, & ! (inout)
        & name = name )          ! (in)
      stat = hst_ebadnewfileint
      cause_c = cprintf( '%d [%c]', &
        & i = (/ hptr % newfile_intvalue /), c1 = trim( hptr % newfile_intunit ) )
      goto 999
      end if
    end if
 
    nullify( hptr )
 
    !-----------------------------------------------------------------
    !  終了処理, 例外処理
    !  Termination and Exception handling
    !-----------------------------------------------------------------
999 continue
    call storeerror( stat, subname, err, cause_c )
    call endsub( subname )

References dc_trace::beginsub(), dc_trace::dbgmessage(), dc_error::dc_enotinit, dc_error::dc_noerr, dc_types::dp, dc_trace::endsub(), dc_error::hst_ebadnewfileint, dc_error::hst_enotindefine, dc_string::joinchar(), gtool_history_nmlinfo_internal::name_delimiter, dc_present::present_and_not_empty(), dc_present::present_and_true(), dc_error::storeerror(), dc_types::string, dc_types::token, and dc_error::usr_errno.

Here is the call graph for this function: