hstnmlinfooutputstep.f90 File Reference

Checker of output timing . More...

Go to the source code of this file.

Functions/Subroutines
logical function	hstnmlinfooutputstep (gthstnml, name, time)

Detailed Description

Checker of output timing

.

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

Function/Subroutine Documentation

hstnmlinfooutputstep()

logical function hstnmlinfooutputstep	(	type(gthst_nmlinfo), intent(in)	gthstnml,
		character(*), intent(in)	name,
		type(dc_difftime), intent(in)	time
	)

Check output timing of a variable

If time is the time that a variable name is output, .true. is returned, otherwise .false. is returned. When gthstnml is not initialized, .false. is returned too. When data corresponding to name is not found, .false. is returned too.

If gthstnml is not initialized by HstNmlInfoCreate yet, error is occurred.

Parameters

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

Returns

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

Definition at line 44 of file hstnmlinfooutputstep.f90.

    use gtool_history_nmlinfo_types, only: gthst_nmlinfo, gthst_nmlinfo_entry
    use gtool_history_nmlinfo_internal, only: listsearch
    use dc_date_types, only: dc_difftime
    use dc_date_generic, only: dcdifftimecreate, mod, operator(==)
    use dc_types, only: dp
    implicit none
    type(GTHST_NMLINFO), intent(in):: gthstnml
    character(*), intent(in):: name
                              ! 変数名. 
                              ! 先頭の空白は無視されます. 
                              ! 
                              ! Variable identifier. 
                              ! Blanks at the head of the name are ignored. 
    type(DC_DIFFTIME), intent(in):: time
                              ! 現在時刻. Current time
 
    !-----------------------------------
    !  作業変数
    !  Work variables
    type(GTHST_NMLINFO_ENTRY), pointer:: hptr =>null()
    type(DC_DIFFTIME):: interval_time
!!$    character(*), parameter:: subname = 'HstNmlInfoOutputStep'
  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
    if ( hptr % output_step_disable ) goto 999
 
    !-----------------------------------------------------------------
    !  時刻のチェック
    !  Check time
    !-----------------------------------------------------------------
    if ( .not. hptr % interval_value > 0.0 ) goto 999
 
    call dcdifftimecreate( &
      & diff = interval_time, &                      ! (out)
      & value = real( hptr % interval_value, dp ), & ! (in)
      & unit = hptr % interval_unit )                ! (in)
 
    if ( mod( time, interval_time ) == 0 ) then
      result = .true.
    end if
 
    !-----------------------------------------------------------------
    !  終了処理, 例外処理
    !  Termination and Exception handling
    !-----------------------------------------------------------------
999 continue
    nullify( hptr )

References dc_types::dp.