historyvarinfocreate.f90 File Reference

Constructor of GT_HISTORY_VARINFO . More...

Go to the source code of this file.

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

Detailed Description

Constructor of GT_HISTORY_VARINFO

.

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 historyvarinfocreate.f90.

Function/Subroutine Documentation

historyvarinfocreate1()

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

Create a GT_HISTORY_VARINFO variable

Creates a GT_HISTORY_VARINFO variable. After setting with this subroutine, pass it to the varinfo argument of HistoryAddVariable. To add attributes, use HistoryVarinfoAddAttr.

Parameters

[in,out]	varinfo	Variable information
[in]	name	Variable name
[in]	dims	Dependent dimensions
[in]	longname	Descriptive name
[in]	units	Units
[in]	xtype	Variable type (optional)
[in]	time_average	Time average flag (optional)
[in]	average	Time average flag (optional, backward compatibility)
[out]	err	Error flag (optional)

Definition at line 53 of file historyvarinfocreate.f90.

    !
    use gtool_history_types, only: gt_history_varinfo
    use dc_types, only: string, token
    use dc_trace, only: beginsub, endsub
    use dc_message, only: messagenotify
    use dc_error, only: storeerror, dc_noerr, dc_ealreadyinit
    implicit none
    type(GT_HISTORY_VARINFO),intent(inout) :: varinfo
    character(*), intent(in):: name     ! 変数名
    character(*), intent(in):: dims(:)  ! 依存する次元
    character(*), intent(in):: longname ! 変数の記述的名称
    character(*), intent(in):: units    ! 変数の単位
    character(*), intent(in), optional:: xtype
                                         ! 変数の型
    logical, intent(in), optional:: time_average
                                         ! 時間平均
    logical, intent(in), 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 = "HistoryVarinfoCreate1"
  continue
    call beginsub(subname)
    stat = dc_noerr
    cause_c = ''
 
    if ( varinfo % initialized ) then
      stat = dc_ealreadyinit
      cause_c = 'GT_HISTORY_VARINFO'
      goto 999
    end if
 
    varinfo % name = name
    varinfo % longname = longname
    varinfo % units = units
    if ( present(xtype) )        varinfo % xtype = xtype
    if ( present(time_average) ) varinfo % time_average = time_average
    if ( present(average) )      varinfo % time_average = average
    numdims = size(dims)
    allocate(varinfo % dims(numdims))
    do i = 1, numdims
      varinfo % dims(i) = dims(i)
      if (len(trim(dims(i))) > token) then
        call messagenotify('W', subname, &
          & 'dimension name <%c> is trancated to <%c>', &
          & c1=trim(dims(i)), c2=trim(varinfo % dims(i)))
      end if
    end do
    varinfo % initialized = .true.
 
999 continue
    call storeerror( stat, subname, err, cause_c )
    call endsub(subname)

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

Here is the call graph for this function:

historyvarinfocreate2()

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

Create a GT_HISTORY_VARINFO variable (generic interface)

Usage is same as HistoryVarinfoCreate.

Definition at line 140 of file historyvarinfocreate.f90.

    use gtool_history_types, only: gt_history_varinfo
    use gtool_history_generic, only: historyvarinfocreate
    use dc_trace, only: beginsub, endsub
    implicit none
    type(GT_HISTORY_VARINFO),intent(inout) :: varinfo
    character(*), intent(in):: name     ! 変数名
    character(*), intent(in):: dims(:)  ! 依存する次元
    character(*), intent(in):: longname ! 変数の記述的名称
    character(*), intent(in):: units    ! 変数の単位
    character(*), intent(in), optional:: xtype
                                         ! 変数の型
    logical, intent(in), optional:: time_average
                                         ! 時間平均
    logical, intent(in), 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
    character(*), parameter:: subname = "HistoryVarinfoCreate2"
  continue
    call beginsub(subname)
    call historyvarinfocreate( varinfo, & ! (out)
      & name, dims, longname, units, xtype, &    ! (in)
      & time_average, average, err &            ! (in) optional
      & ) 
    call endsub(subname)

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

Here is the call graph for this function: