gtvarsearch.f90

Go to the documentation of this file.

!> @file gtvarsearch.f90
!>
!> @author Yasuhiro MORIKAWA, Eizi TOYODA
!> @copyright Copyright (C) GFD Dennou Club, 2000-2026. All rights reserved. <br/>
!>            License is BSD-2-Clause. See [COPYRIGHT](@ref COPYRIGHT) in detail
!>
!> @en
!> @brief Variable search
!>
!> These subroutines are provided as gtdata_generic#GTVarSearch
!> through gtdata_generic.
!> @enden
!>
!> @ja
!> @brief 変数探査
!>
!> これらのサブルーチンは gtdata_generic から gtdata_generic#GTVarSearch
!> として提供されます。
!> @endja
!>
 
!>
!> @en
!> @brief Variable search subroutine (get next)
!>
!> To get all variables dependent on a filename urlBase,
!> first call GTVarSearch(urlBase) (see below), then call
!> GTVarSearch(url, end) in an infinite loop. This returns
!> variable names one by one in url. When end becomes true,
!> all variable names have been searched.
!>
!> Example:
!> @code
!> use gtool5
!> character(len = STRING) :: filename, varname
!> logical                 :: end
!>
!> write(*,*) "Enter file name: "
!> read(*,*) filename
!>
!> call GTVarSearch(filename)
!> do
!>   call GTVarSearch(varname, end)
!>   if (end) exit
!>   write(*, *) trim(varname)
!> enddo
!> @endcode
!> @param[out] url Variable URL
!> @param[out] end .true. when all variables have been searched
!> @enden
!>
!> @ja
!> @brief 変数探査サブルーチン (次を取得)
!>
!> あるファイル名 urlBase に依存する変数すべてを取得するには、
!> まず GTVarSearch(urlBase) (下記のサブルーチン) を呼び出し、
!> その後無限ループの中で GTVarSearch(url, end) を呼び出します。
!> そうすることで url に1つ1つの変数名が返ります。
!> end が真になったとき、すべての変数名を探索し終えたことになります。
!> @param[out] url 変数URL
!> @param[out] end すべての変数を探索し終えたとき .true.
!> @endja
!>
subroutine gtvarsearchnext(url, end)
  use gtdata_netcdf_generic, only: var_search
  use gtdata_internal_vartable, only: gdnc_search
  use dc_trace, only: beginsub, endsub
  implicit none
  character(len = *), intent(out):: url
  logical, intent(out):: end
continue
  call beginsub('gtvarsearchnext')
  call var_search(gdnc_search, &    ! (inout)
    &             url=url, end=end) ! (out)
  call endsub('gtvarsearchnext', 'url=%c end=%y', c1=trim(url), l=(/end/))
end subroutine gtvarsearchnext
 
!>
!> @en
!> @brief Variable search initialization subroutine
!>
!> See GTVarSearchNext above.
!> @param[in] urlBase Base URL for search
!> @enden
!>
!> @ja
!> @brief 変数探査初期化サブルーチン
!>
!> 上記の GTVarSearchNext を参照してください。
!> @param[in] urlBase 検索のベースURL
!> @endja
!>
subroutine gtvarsearchinit(urlBase)
  use gtdata_netcdf_generic, only: var_search
  use gtdata_internal_vartable, only: gdnc_search
  use dc_trace, only: beginsub, endsub
  implicit none
  character(len = *), intent(in):: urlBase
continue
  call beginsub('gtvarsearchinit', 'urlbase=<%c>', c1=trim(urlbase))
  call var_search(gdnc_search, &      ! (out)
    &             urlbase = urlbase ) ! (in)
  call endsub('gtvarsearchinit')
end subroutine gtvarsearchinit