historyvarinfoinquire.f90 File Reference

Inquire a GT_HISTORY_VARINFO variable . More...

Go to the source code of this file.

Functions/Subroutines
subroutine	historyvarinfoinquire1 (varinfo, name, dims, longname, units, xtype, time_average, average, err)
subroutine	historyvarinfoinquire2 (varinfo, name, dims, longname, units, xtype, time_average, average, err)

Detailed Description

Inquire a GT_HISTORY_VARINFO variable

.

Author

Yasuhiro MORIKAWA

Copyright

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

Definition in file historyvarinfoinquire.f90.

Function/Subroutine Documentation

historyvarinfoinquire1()

subroutine historyvarinfoinquire1	(	type(gt_history_varinfo), intent(in)	varinfo,
		character(*), intent(out), optional	name,
		character(*), dimension(:), optional, pointer	dims,
		character(*), intent(out), optional	longname,
		character(*), intent(out), optional	units,
		character(*), intent(out), optional	xtype,
		logical, intent(out), optional	time_average,
		logical, intent(out), optional	average,
		logical, intent(out), optional	err
	)

Inquire a GT_HISTORY_VARINFO variable

Retrieves each piece of information from a GT_HISTORY_VARINFO variable. dims is a pointer array; pass it in a null state.

Parameters

[in]	varinfo	GT_HISTORY_VARINFO variable
[out]	name	Variable name (optional)
[out]	dims	Dependent dimensions, pointer (optional)
[out]	longname	Descriptive name of the variable (optional)
[out]	units	Units of the variable (optional)
[out]	xtype	Type of the variable (optional)
[out]	time_average	Time average flag (optional)
[out]	average	Time average flag for backward compatibility (optional)
[out]	err	Exception handling flag (optional)

Definition at line 48 of file historyvarinfoinquire.f90.

    use dc_types, only: string
    use dc_trace, only: beginsub, endsub
    use dc_error, only: storeerror, dc_noerr, dc_enotinit
    use gtool_history_types, only: gt_history_varinfo
    implicit none
    type(GT_HISTORY_VARINFO),intent(in) :: varinfo
    character(*), intent(out), optional:: name     ! 変数名
    character(*), pointer,     optional:: dims(:)  !(out) 依存する次元
    character(*), intent(out), optional:: longname ! 変数の記述的名称
    character(*), intent(out), optional:: units    ! 変数の単位
    character(*), intent(out), optional:: xtype    ! 変数の型
    logical, intent(out), optional:: time_average  ! 時間平均
    logical, intent(out), optional:: average       ! 時間平均 (後方互換用)
    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. 
 
    ! Internal Work
    integer:: i, numdims, stat
    character(STRING):: cause_c
    character(*), parameter:: subname = "HistoryVarinfoInquire1"
  continue
    call beginsub(subname)
    stat = dc_noerr
    cause_c = ''
 
    if ( .not. varinfo % initialized ) then
      stat = dc_enotinit
      cause_c = 'GT_HISTORY_VARINFO'
      goto 999
    end if
    if (present(name)) name = varinfo % name
    if (present(dims)) then
      numdims = size(varinfo % dims)
      allocate(dims(numdims))
      do i = 1, numdims
        dims(i) = varinfo % dims(i)
      end do
    end if
    if ( present(longname) ) longname = varinfo % longname
    if ( present(units)    ) units    = varinfo % units
    if ( present(xtype)    ) xtype    = varinfo % xtype
    if ( present(time_average)  ) time_average  = varinfo % time_average
    if ( present(average)  )           average  = varinfo % time_average
 
999 continue
    call storeerror(stat, subname, err, cause_c=cause_c)
    call endsub(subname)

References dc_trace::beginsub(), dc_error::dc_enotinit, dc_error::dc_noerr, dc_trace::endsub(), dc_error::storeerror(), and dc_types::string.

Here is the call graph for this function:

historyvarinfoinquire2()

subroutine historyvarinfoinquire2	(	type(gt_history_varinfo), intent(in)	varinfo,
		character(*), intent(out), optional	name,
		character(*), dimension(:), optional, pointer	dims,
		character(*), intent(out), optional	longname,
		character(*), intent(out), optional	units,
		character(*), intent(out), optional	xtype,
		logical, intent(out), optional	time_average,
		logical, intent(out), optional	average,
		logical, intent(out), optional	err
	)

Inquire a GT_HISTORY_VARINFO variable (generic interface)

Usage is same as HistoryVarinfoInquire.

Definition at line 123 of file historyvarinfoinquire.f90.

    use gtool_history_types, only: gt_history_varinfo
    use gtool_history_generic, only: historyvarinfoinquire
    use dc_trace, only: beginsub, endsub
    implicit none
    type(GT_HISTORY_VARINFO),intent(in) :: varinfo
    character(*), intent(out), optional:: name     ! 変数名
    character(*), pointer,     optional:: dims(:)  !(out) 依存する次元
    character(*), intent(out), optional:: longname ! 変数の記述的名称
    character(*), intent(out), optional:: units    ! 変数の単位
    character(*), intent(out), optional:: xtype    ! 変数の型
    logical, intent(out), optional:: time_average  ! 時間平均
    logical, intent(out), optional:: average       ! 時間平均 (後方互換用)
    logical, intent(out), optional:: err
    character(*), parameter:: subname = "HistoryVarinfoInquire2"
  continue
    call beginsub(subname)
    call historyvarinfoinquire( varinfo, &
      & name, dims, longname, units, xtype, &
      & time_average, average, err )
    call endsub(subname)

References dc_trace::beginsub(), and dc_trace::endsub().

Here is the call graph for this function: