hstnmlinfoclose.f90 File Reference

Destructor of gtool_history_nmlinfo_types::GTHST_NMLINFO . More...

Go to the source code of this file.

Functions/Subroutines
subroutine	hstnmlinfoclose (gthstnml, err)

Detailed Description

Destructor of gtool_history_nmlinfo_types::GTHST_NMLINFO

.

Author

Yasuhiro MORIKAWA

Copyright

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

Definition in file hstnmlinfoclose.f90.

Function/Subroutine Documentation

hstnmlinfoclose()

subroutine hstnmlinfoclose	(	type(gthst_nmlinfo), intent(inout)	gthstnml,
		logical, intent(out), optional	err
	)

Destructor of gtool_history_nmlinfo_types::GTHST_NMLINFO

Terminate all gtool_history_types::GT_HISTORY variables in gthstnml by gtool_history_generic::HistoryClose before this subroutine is used. If unterminated variables remain, error is occurred.

Note that if gthstnml is not initialized by HstNmlInfoCreate yet, error is occurred.

Parameters

[in,out]	gthstnml	gtool_history_nmlinfo_types::GTHST_NMLINFO 型変数
[out]	err	例外処理用フラグ. Exception handling flag.

Definition at line 42 of file hstnmlinfoclose.f90.

    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 )

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

Here is the call graph for this function: