hstnmlinforedefine.f90

Go to the documentation of this file.

!> @file hstnmlinforedefine.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 Transit from output mode to define mode
!> @enden
!>
!> @ja
!> @brief 出力モードから定義モードに移行
!> @endja
 
  !> @en
  !> @brief Return from output mode to define mode
  !>
  !> Return from output mode to define mode,
  !> information can be configured again.
  !> Use HstNmlInfoEndDefine again and
  !> transit from define mode to output mode,
  !> before HstNmlInfoAssocGTHist is used.
  !> HstNmlInfoAdd, HstNmlInfoDelete, HstNmlInfoResetDefault
  !> can be used again after
  !> this subroutine is used.
  !>
  !> If @p gthstnml is not initialized by HstNmlInfoCreate yet,
  !> error is occurred.
  !> @enden
  !>
  !> @ja
  !> @brief 出力モードから定義モードに戻す
  !>
  !> 出力モードから定義モードに戻り,
  !> 再び情報を設定可能にします.
  !> HstNmlInfoAssocGTHist サブルーチンを呼び出す前には,
  !> 再度 HstNmlInfoEndDefine を呼び出して定義モードへと移行してください.
  !> このサブルーチンを呼んだ後でなら, 再度
  !> HstNmlInfoAdd, HstNmlInfoDelete, HstNmlInfoResetDefault
  !> を呼ぶことが可能です.
  !>
  !> なお, 与えられた @p gthstnml が HstNmlInfoCreate によって初期設定
  !> されていない場合にも, プログラムはエラーを発生させます.
  !> @endja
  !>
  !> @param[inout] gthstnml gtool_history_nmlinfo_types::GTHST_NMLINFO 型変数
  !> @param[out] err 例外処理用フラグ. Exception handling flag.
  subroutine hstnmlinforedefine( gthstnml, err )
    use gtool_history_nmlinfo_types, only: gthst_nmlinfo
    use dc_trace, only: beginsub, endsub
    use dc_types, only: string
    use dc_error, only: storeerror, dc_noerr, dc_enotinit, hst_eindefine
    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
    integer:: stat
    character(STRING):: cause_c
    character(*), parameter:: subname = 'HstNmlInfoReDefine'
  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
 
    if ( gthstnml % define_mode ) then
      stat = hst_eindefine
      cause_c = 'ReDefine'
      goto 999
    end if
 
    !-----------------------------------------------------------------
    !  定義モードへと戻る
    !  Return to define mode
    !-----------------------------------------------------------------
    gthstnml % define_mode = .true.
 
    !-----------------------------------------------------------------
    !  終了処理, 例外処理
    !  Termination and Exception handling
    !-----------------------------------------------------------------
999 continue
    call storeerror( stat, subname, err, cause_c )
    call endsub( subname )
  end subroutine hstnmlinforedefine