historyautochkoutput.f90 File Reference

Check output setting of a variable . More...

Go to the source code of this file.

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

Detailed Description

Check output setting of a variable

.

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

)

Check output setting of a variable

If output setting of varname is valid, .true. is returned. If output setting of varname is invalid, .false. is returned.

If initialization with HistoryAutoCreate is not done yet, .false. is returned. If varname is invalid, .false. is returned.

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
	)

Check output timing of a variable

If varname is output on time, .true. is returned.

Please use this function as follows.

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

call HistoryAutoPut( time, var, data )

Following usage does not return correct values.

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

If initialization with HistoryAutoCreate is not done yet, .false. is returned. If varname is invalid, .false. is returned.

Parameters

[in]	time	データの時刻. Time of data.
[in]	varname	変数の名前. Variable name.

Returns

出力タイミングであれば .true.

Definition at line 149 of file historyautochkoutput.f90.

    use gtool_historyauto_internal, only: initialized, numvars, &
      & varname_vars, output_valid_vars, origin_time_vars, histaddvar_vars, &
      & newfile_inttime_vars, newfile_createtime_vars, prev_outtime_vars, &
      & interval_time_vars, terminus_time_vars
    use dc_types, only: dp
 
    implicit none
    logical:: result
    real(DP), intent(in):: time
                              ! データの時刻. 
                              ! Time of data
    character(*), intent(in):: varname
                              ! 変数の名前. 
                              ! Variable name
 
    real(DP), parameter:: zero_time = 0.0_dp
    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 )
 
    if ( .not. result ) goto 999
 
    if ( origin_time_vars(vnum) > time ) then
      result = .false. 
      goto 999
    end if
 
    if (             origin_time_vars(vnum) <= time &
      &  .and.       (      terminus_time_vars(vnum) < zero_time &
      &                .or. terminus_time_vars(vnum) >= time      ) &
      &  .and. .not. histaddvar_vars(vnum)            ) then
 
      result = .true.
      goto 999
    end if
 
    if ( terminus_time_vars(vnum) > zero_time .and. terminus_time_vars(vnum) < time ) then
      result = .false.
      goto 999
    end if
 
    if ( newfile_inttime_vars(vnum) > zero_time ) then
      if ( time - newfile_createtime_vars(vnum) >= newfile_inttime_vars(vnum) ) then
        result = .true.
        goto 999
      end if
    end if
 
    if ( time - prev_outtime_vars(vnum) >= interval_time_vars(vnum) ) then
      result = .true.
      goto 999
    end if
 
    result = .false.
 
999 continue

References dc_types::dp, gtool_historyauto_internal::histaddvar_vars, gtool_historyauto_internal::initialized, gtool_historyauto_internal::interval_time_vars, gtool_historyauto_internal::newfile_createtime_vars, gtool_historyauto_internal::newfile_inttime_vars, gtool_historyauto_internal::numvars, gtool_historyauto_internal::origin_time_vars, gtool_historyauto_internal::output_valid_vars, gtool_historyauto_internal::prev_outtime_vars, gtool_historyauto_internal::terminus_time_vars, gtool_historyauto_internal::varname_vars, and gtool_historyauto_internal::zero_time.