gtvardimname2ord.f90

Go to the documentation of this file.

!> @file gtvardimname2ord.f90
!>
!> @author Eizi TOYODA, Yasuhiro MORIKAWA
!> @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 Query dimension order number from dimension relative name
!>
!> This function is provided as gtdata_generic#Dimname_to_Dimord
!> through gtdata_generic.
!> @enden
!>
!> @ja
!> @brief 次元相対名から次元順序番号の問い合わせ
!>
!> この関数は gtdata_generic から gtdata_generic#Dimname_to_Dimord
!> として提供されます。
!> @endja
!>
 
!>
!> @en
!> @brief Get dimension order from dimension relative name
!>
!> A variable belongs to multiple dimensions. Dimensions are identified
!> by order numbers, but since the order of dimensions in a variable
!> can be exchanged, it is sometimes convenient to identify them with
!> short names relative to the variable.
!> For example, for variable `filename?var`, used with comma notation
!> like `filename?var,dim=1` (see "5.4 Comma Notation" in gtool4 netCDF
!> Convention). (For netCDF variable `filename?varname`, dimension name
!> `dim` would indicate `filename?dim`, but such relationship does not
!> always hold.)
!>
!> The Dimname_to_Dimord procedure gives the dimension order number from
!> such relative dimension names. Valid numbers are 1 or greater;
!> numbers 0 or less indicate an error.
!> @param[in] var  Variable handle
!> @param[in] name Dimension relative name
!> @return Dimension order number (0 or less indicates error)
!> @enden
!>
!> @ja
!> @brief 次元相対名から次元順序番号を取得
!>
!> 変数には複数の次元が所属します。次元は順序番号で識別されますが、
!> 変数における次元の順序は入れ替えることもできるため、
!> 変数に相対的短い名前で識別することが便利な場合もあります。
!> たとえば変数 `filename?var` に対して `filename?var,dim=1` のような
!> コンマ記法 (gtool4 netCDF 規約の「5.4 コンマ記法」参照)
!> で用いられるものです。(NetCDF 変数 `filename?varname`
!> に対する次元名 `dim` は `filename?dim` を指示するでしょうが、
!> 必ずしもそのような関係が成り立つとは限りません)
!>
!> Dimname_to_Dimord 手続はこのような相対次元名から次元順序番号を与えます。
!> 正当な番号は1以上であり、0以下の番号はエラーを示します。
!> @param[in] var  変数ハンドル
!> @param[in] name 次元相対名
!> @return 次元順序番号 (0以下はエラーを示す)
!> @endja
!>
integer function gtvardimname2ord(var, name) result(result)
  use gtdata_types, only: gt_variable
  use dc_string, only: stoi
  use gtdata_netcdf_generic, only: search_dim
  use gtdata_netcdf_types, only: gd_nc_variable
  use gtdata_internal_map, only: var_class, vtb_class_netcdf
  implicit none
  type(gt_variable), intent(in):: var
  character(len = *), intent(in):: name
  integer:: class, cid
  result = -1
  if (name == ' ') return
  result = stoi(name)
  if (result /= 0) return
  ! 個別層に問い合わせて次元番号を得ようと試みる。
  call var_class(var, class, cid)
  if (class == vtb_class_netcdf) then
    result = search_dim(gd_nc_variable(cid), name)
  endif
  ! map 表から次元名を使って次元番号を得ようと試みる。
end function gtvardimname2ord