historyvarinfoclear.f90

Go to the documentation of this file.

!> @file historyvarinfoclear.f90
!>
!> @author Yasuhiro MORIKAWA
!> @copyright Copyright (C) GFD Dennou Club, 2000-2026. All rights reserved. <br/>
!>            License is BSD-2-Clause. See [COPYRIGHT](@ref COPYRIGHT) in detail
!>
!> @en
!> @brief Destructor of GT_HISTORY_VARINFO
!> @enden
!>
!> @ja
!> @brief GT_HISTORY_VARINFO 変数のクリア
!> @endja
 
!>
!> @en
!> @brief Clear GT_HISTORY_VARINFO variable
!>
!> Initializes the variable varinfo to the state before
!> HistoryVarinfoCreate initialization.
!> @param[inout] varinfo Variable information
!> @param[out]   err     Error flag (optional)
!> @enden
!>
!> @ja
!> @brief GT_HISTORY_VARINFO 型変数初期化
!>
!> varinfo で与えられた変数を HistoryVarinfoCreate による初期設定よりも
!> さらに前の状態に初期化します。
!> @param[inout] varinfo 変数情報
!> @param[out]   err     エラーフラグ (省略可能)
!> @endja
!>
  subroutine historyvarinfoclear0(varinfo, err)
    use dc_error, only: storeerror, dc_noerr, dc_enotinit
    use gtool_history_types, only: gt_history_varinfo
    use dc_trace, only: beginsub, endsub
    use dc_types, only: string
    implicit none
    type(gt_history_varinfo),intent(inout) :: varinfo
    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. 
 
    integer:: stat
    character(STRING):: cause_c
    character(len = *), parameter:: subname = "HistoryVarinfoClear1"
  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
 
    varinfo % name     = ""
    varinfo % longname = ""
    varinfo % units    = ""
    varinfo % xtype    = ""
    if (associated(varinfo % attrs)) then
      deallocate(varinfo % attrs)
    end if
 
    varinfo % initialized = .false.
999 continue
    call storeerror( stat, subname, err, cause_c )
    call endsub(subname)
  end subroutine historyvarinfoclear0