変数の出力設定の確認手続 More...

Functions/Subroutines
logical function	historyautochkoutput (varname)
logical function	historyautochkoutputtiming (time, varname)

Detailed Description

変数の出力設定の確認手続

Author: Yasuhiro MORIKAWA

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

Definition in file historyautochkoutput.f90.

Function/Subroutine Documentation

◆ historyautochkoutput()

logical function historyautochkoutput ( character(*), intent(in) varname )

変数の出力設定の確認

varname に指定された変数名が出力されるよう設定されている場合には .true. が, 出力されないよう設定されている場合は .false. が返ります.

HistoryAutoCreate による初期設定がなされていない場合や, varname に指定された変数名が HistoryAutoAddVariable によって登録されていない場合, 返り値に .false. が返ります.

Parameters

[in] varname 変数の名前. Variable name.

Returns: 出力設定が有効であれば .true.

Definition at line 39 of file historyautochkoutput.f90.

    use gtool_historyauto_internal, only: initialized, numvars, &
      & varname_vars, output_valid_vars
 
    implicit none
    logical:: result
    character(*), intent(in):: varname
                              ! 変数の名前. 
                              ! Variable name
 
    integer:: i, vnum
    integer, save:: svnum = 1
  continue
    ! 初期設定チェック
    ! Check initialization
    !
    if ( .not. initialized ) then
      result = .false.
      goto 999
    end if
 
    ! 変数 ID のサーチ
    ! Search variable ID
    !
    varsearch: do
      do i = svnum, numvars
        if ( trim( varname_vars(i) ) == trim(varname) ) then
          vnum = i
          exit varsearch
        end if
      end do
      do i = 1, svnum - 1
        if ( trim( varname_vars(i) ) == trim(varname) ) then
          vnum = i
          exit varsearch
        end if
      end do
 
      result = .false.
      goto 999
    end do varsearch
 
    svnum = vnum
 
    ! 出力設定の確認
    ! Check output setting
    !
    result = output_valid_vars( vnum )
 
999 continue

References gtool_historyauto_internal::initialized, gtool_historyauto_internal::numvars, gtool_historyauto_internal::output_valid_vars, and gtool_historyauto_internal::varname_vars.

◆ historyautochkoutputtiming()

logical function historyautochkoutputtiming	(	real(dp), intent(in)	time,
		character(*), intent(in)	varname )

変数の出力タイミングの確認

varname に指定された変数名が、time のタイミングで出力されるよう設定されている場合には .true. が, 出力されないよう設定されている場合は .false. が返ります.

なお, gtool_historyauto は時間ステップ可変に対応しているため, time のタイミングで出力されるかどうかについては, その前回に出力された時間に依存します. 従って, とある時間の出力設定の確認は下記のように HistoryAutoPut の前で使用して下さい.

if ( HistoryAutoChkOutputTiming( time, var ) ) then
  <some operation ...>
end if

call HistoryAutoPut( time, var, data )

以下のように使用した場合には, 期待するような返り値が得られないことにご留意下さい.

do i = 1, 10
  write(*,*) HistoryAutoChkOutputTiming( i * timestep, var )
end do