hstnmlinfooutputvalid.f90 File Reference

出力の有効性のチェック More...

Go to the source code of this file.

Functions/Subroutines
logical function	hstnmlinfooutputvalid (gthstnml, name)

Detailed Description

出力の有効性のチェック

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

Function/Subroutine Documentation

hstnmlinfooutputvalid()

logical function hstnmlinfooutputvalid	(	type(gthst_nmlinfo), intent(in)	gthstnml,
		character(*), intent(in)	name
	)

出力の有効性のチェック

変数 name の出力が有効であれば, .true. を, そうでなければ .false. を返します. 出力が有効であるかどうかは, 出力間隔 interval_value の 正負によって判定されます. 正の場合が有効, 負の場合が無効です. gthstnml が初期設定されていない場合にも .false. が返ります. name に関するデータが存在しない場合にも .false. が返ります.

なお, 与えられた gthstnml が HstNmlInfoCreate によって初期設定 されていない場合, プログラムはエラーを発生させます.

Parameters

[in]	gthstnml	gtool_history_nmlinfo_types::GTHST_NMLINFO 型変数
[in]	name	変数名. 先頭の空白は無視されます. Variable identifier. Blanks at the head of the name are ignored.

Returns

出力が有効であれば .true.

Definition at line 47 of file hstnmlinfooutputvalid.f90.

    use gtool_history_nmlinfo_types, only: gthst_nmlinfo, gthst_nmlinfo_entry
    use gtool_history_nmlinfo_internal, only: listsearch
    implicit none
    type(GTHST_NMLINFO), intent(in):: gthstnml
    character(*), intent(in):: name
                              ! 変数名. 
                              ! 先頭の空白は無視されます. 
                              ! 
                              ! Variable identifier. 
                              ! Blanks at the head of the name are ignored. 
 
    !-----------------------------------
    !  作業変数
    !  Work variables
    type(GTHST_NMLINFO_ENTRY), pointer:: hptr =>null()
!!$    character(*), parameter:: subname = 'HstNmlInfoOutputValid'
  continue
 
    result = .false.
 
    !-----------------------------------------------------------------
    !  初期設定のチェック
    !  Check initialization
    !-----------------------------------------------------------------
    if ( .not. gthstnml % initialized ) goto 999
 
    !-----------------------------------------------------------------
    !  情報格納変数への結合
    !  Associate a variable storing information
    !-----------------------------------------------------------------
    hptr => gthstnml % gthstnml_list
    call listsearch( gthstnml_list = hptr, & ! (inout)
      &              name = name )           ! (in)
 
    if ( .not. associated( hptr ) ) goto 999
 
    !-----------------------------------------------------------------
    !  出力の有効性のチェック
    !  Check validity of output
    !-----------------------------------------------------------------
    if ( hptr % interval_value > 0.0 ) then
      result = .true.
      goto 999
    end if
 
    !-----------------------------------------------------------------
    !  終了処理, 例外処理
    !  Termination and Exception handling
    !-----------------------------------------------------------------
999 continue
    nullify( hptr )