hstnmlinfoclose.f90

Go to the documentation of this file.

!> @file hstnmlinfoclose.f90
!>
!> @author Yasuhiro MORIKAWA
!> @copyright Copyright (C) GFD Dennou Club, 2007-2026. All rights reserved. <br/>
!>            License is BSD-2-Clause. See [COPYRIGHT](@ref COPYRIGHT) in detail
!>
!> @en
!> @brief Destructor of gtool_history_nmlinfo_types::GTHST_NMLINFO
!> @enden
!>
!> @ja
!> @brief gtool_history_nmlinfo_types::GTHST_NMLINFO 型の変数の終了処理
!> @endja
 
  !> @en
  !> @brief Destructor of gtool_history_nmlinfo_types::GTHST_NMLINFO
  !>
  !> Terminate all gtool_history_types::GT_HISTORY variables in @p gthstnml
  !> by gtool_history_generic::HistoryClose before this subroutine is used.
  !> If unterminated variables remain,
  !> error is occurred.
  !>
  !> Note that if @p gthstnml is not initialized by HstNmlInfoCreate yet,
  !> error is occurred.
  !> @enden
  !>
  !> @ja
  !> @brief gtool_history_nmlinfo_types::GTHST_NMLINFO 型の変数の終了処理
  !>
  !> このサブルーチンを使用する前に, @p gthstnml に格納されている
  !> gtool_history_types::GT_HISTORY 型の全ての変数に対して,
  !> gtool_history_generic::HistoryClose を用いて終了処理を行ってください.
  !> 終了処理されていないものがある場合,
  !> プログラムはエラーを発生させます.
  !>
  !> なお, 与えられた @p gthstnml が HstNmlInfoCreate によって初期設定
  !> されていない場合, プログラムはエラーを発生させます.
  !> @endja
  !>
  !> @param[inout] gthstnml gtool_history_nmlinfo_types::GTHST_NMLINFO 型変数
  !> @param[out] err 例外処理用フラグ. Exception handling flag.
  subroutine hstnmlinfoclose( gthstnml, err )
    use gtool_history_nmlinfo_types, only: gthst_nmlinfo, gthst_nmlinfo_entry
    use gtool_history_nmlinfo_internal, only: listlast
    use gtool_history, only: historyinitialized
    use dc_trace, only: beginsub, endsub, dbgmessage
    use dc_types, only: string
    use dc_error, only: storeerror, dc_noerr, dc_enotinit, hst_enottermgthist
    implicit none
    type(gthst_nmlinfo), intent(inout):: gthstnml
    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_prev =>null()
    integer:: stat
    character(STRING):: cause_c
    character(*), parameter:: subname = 'HstNmlInfoClose'
  continue
    call beginsub( subname )
    stat = dc_noerr
    cause_c = ''
 
    !-----------------------------------------------------------------
    !  初期設定のチェック
    !  Check initialization
    !-----------------------------------------------------------------
    if ( .not. gthstnml % initialized ) then
      stat = dc_enotinit
      cause_c = 'GTHST_NMLINFO'
      goto 999
    end if
 
    !-----------------------------------------------------------------
    !  "GTHST_NMLINFO" の設定の消去
    !  Clear the settings for "GTHST_NMLINFO"
    !-----------------------------------------------------------------
    do 
      hptr => gthstnml % gthstnml_list
      call listlast( gthstnml_list = hptr, & ! (inout)
        & previous = hptr_prev )             ! (out)
      call dbgmessage( 'remove entry (%c)', c1 = trim(hptr % name) )
      if ( trim( hptr % name ) == '' ) exit
      if ( .not. gthstnml % define_mode ) then
        if ( historyinitialized( hptr % history ) ) then
          stat = hst_enottermgthist
          cause_c = hptr % name
          goto 999
        end if
      end if
      deallocate( hptr )
      nullify( hptr_prev % next )
    end do
    deallocate( gthstnml % gthstnml_list )
 
    !-----------------------------------------------------------------
    !  終了処理, 例外処理
    !  Termination and Exception handling
    !-----------------------------------------------------------------
    gthstnml % initialized = .false.
    gthstnml % define_mode = .true.
999 continue
    nullify( hptr )
    call storeerror( stat, subname, err, cause_c )
    call endsub( subname )
  end subroutine hstnmlinfoclose