gtdata_generic.f90

Go to the documentation of this file.

! -*- coding: utf-8; mode: f90 -*-
!-------------------------------------------------------------------------------------
! Copyright (c) 2000-2026 Gtool Development Group. All rights reserved.
!-------------------------------------------------------------------------------------
! ** Important**
!
! This file is generated from ../../../../src/gtdata/gtdata_generic.erb by ERB included Ruby 3.3.8.
! Please do not edit this file directly. @see "../../../../src/gtdata/gtdata_generic.erb"
!-------------------------------------------------------------------------------------
!> @file gtdata_generic.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 Generic procedure declarations for gtool variables
!>
!> All procedures for operations on GT_VARIABLE type variables
!> (file format independent multi-dimensional data) are declared
!> and exported here as generic interfaces.
!> @enden
!>
!> @ja
!> @brief gtool 変数の総称手続き宣言
!>
!> ファイルの形式に依存しない多次元データである GT_VARIABLE 型変数
!> の操作に関する手続きの全てはここで総称宣言されて公開されます。
!> @endja
!>
!>
!> @en
!> @brief GT_VARIABLE type variable generic procedure declarations
!>
!> All procedures for operations on GT_VARIABLE type variables
!> (file format independent multi-dimensional data) are declared
!> and exported here as generic interfaces.
!>
!> The procedures listed below are designed so that the first argument
!> is the main target of operations. Since the first argument identifies
!> these as gtool4 procedures, names are not prefixed with GT.
!>
!> ## Procedure List by Category
!>
!> ### Variable Creation/Initialization/Termination
!> | Procedure | Description |
!> |-----------|-------------|
!> | Create | Create variable |
!> | Open | Initialize variable |
!> | Close | Finalize variable |
!>
!> ### Inquiry
!> | Procedure | Description |
!> |-----------|-------------|
!> | Inquire | Query variable or attribute information |
!>
!> ### Data I/O
!> | Procedure | Description |
!> |-----------|-------------|
!> | Get | File input |
!> | Put, PutLine | File output |
!>
!> ### Dimension Order Query/Modification
!> | Procedure | Description |
!> |-----------|-------------|
!> | Dimname_To_Dimord | Query dimension order from dimension relative name |
!> | Exch_dim | Exchange dimension order numbers |
!>
!> ### Variable Composition Mapping (Limit, Dimension Add/Remove)
!> | Procedure | Description |
!> |-----------|-------------|
!> | Limit | Constrain I/O range |
!> | Add_Dim | Add dimension to variable |
!> | Del_Dim | Hide dimension from variable |
!> | Transform | Unify dimension arrangement of two variables |
!>
!> ### I/O Range Restriction (Slice)
!> | Procedure | Description |
!> |-----------|-------------|
!> | Slice | Restrict I/O range |
!> | Slice_Next | Move I/O range |
!> | Get_Slice | Query variable I/O range restriction information |
!>
!> ### Attribute Operations
!> | Procedure | Description |
!> |-----------|-------------|
!> | Attr_Rewind | Initialize variable attribute enumeration |
!> | Attr_Next | Enumerate variable attributes |
!> | Attr_True | Read variable attribute as logical |
!> | Get_Attr | Read variable attribute |
!> | Put_Attr | Write variable attribute |
!> | Copy_Attr | Copy attribute |
!> | Del_Attr | Delete variable attribute |
!>
!> ### Others
!> | Procedure | Description |
!> |-----------|-------------|
!> | GTVarSearch | Enumerate variable names in file |
!> | GTVarSync | Synchronize file I/O |
!> | GTDataTmpNam | Auto-create variable name |
!> | operator(.equivalent.) | Equivalence check |
!> @enden
!>
!> @ja
!> @brief GT_VARIABLE 型変数の手続総称宣言
!>
!> ファイルの形式に依存しない多次元データである GT_VARIABLE 型変数
!> の操作に関する手続きの全てはここで総称宣言されて公開されます。
!>
!> 以降に一覧される手続は、第 1 引数が主な操作対象になるようなスタイルで
!> 設計されています。 第 1 引数から gtool4 の手続であることがわかるので、
!> 名前にわざわざ GT とはつけていません。
!>
!> ## 種類別手続き一覧
!>
!> ### 変数の作成・初期化・終了
!> | 手続き | 説明 |
!> |--------|------|
!> | Create | 変数の作成 |
!> | Open | 変数の初期化 |
!> | Close | 変数の終了処理 |
!>
!> ### 問い合わせ
!> | 手続き | 説明 |
!> |--------|------|
!> | Inquire | 変数または属性に関する問い合わせ |
!>
!> ### データの入出力
!> | 手続き | 説明 |
!> |--------|------|
!> | Get | ファイル入力 |
!> | Put, PutLine | ファイル出力 |
!>
!> ### 次元順序番号の問い合わせ・変更
!> | 手続き | 説明 |
!> |--------|------|
!> | Dimname_To_Dimord | 次元相対名から次元順序番号の問い合わせ |
!> | Exch_dim | 次元順序番号の交換 |
!>
!> ### 変数構成写像機能（リミット、次元の加除）
!>
!> 変数 (GT_VARIABLE 型) は順序の決まった次元集合をもちます。それぞれ
!> の次元には決まった長さがあり、1から長さまでの番号で識別される格子から
!> なっています。しかしながら、必要に応じて変数がもつ次元の順序を入れ替え
!> たり、次元が存在しないようにみせかけたり、各々の次元の長さを変えたり格
!> 子番号を付け替えたりできます。
!>
!> | 手続き | 説明 |
!> |--------|------|
!> | Limit | 入出力範囲を拘束 |
!> | Add_Dim | 変数に次元を追加 |
!> | Del_Dim | 変数から次元を隠蔽 |
!> | Transform | 2 つの変数の次元配置の共通化 |
!>
!> ### 入出力範囲限定機能（スライス）
!> | 手続き | 説明 |
!> |--------|------|
!> | Slice | 入出力範囲を限定 |
!> | Slice_Next | 入出力範囲を移動 |
!> | Get_Slice | 変数入出力範囲限定情報を問い合わせ |
!>
!> ### 属性関係
!>
!> 属性名は英字、数字、下線から構成されます。先頭の文字は英字または
!> "+" でなければなりません。"+" から始まる属性名は内部的に使用されるもの
!> で、netCDF 実装では大域変数に対応します。
!>
!> | 手続き | 説明 |
!> |--------|------|
!> | Attr_Rewind | 変数属性列挙の初期化 |
!> | Attr_Next | 変数属性の列挙 |
!> | Attr_True | 変数属性を論理型として読み取り |
!> | Get_Attr | 変数属性の読み取り |
!> | Put_Attr | 変数属性の書き出し |
!> | Copy_Attr | 属性のコピー |
!> | Del_Attr | 変数属性の削除 |
!>
!> ### その他
!> | 手続き | 説明 |
!> |--------|------|
!> | GTVarSearch | ファイルの中の変数名の列挙 |
!> | GTVarSync | ファイル入出力の同期 |
!> | GTDataTmpNam | 変数名の自動作成 |
!> | operator(.equivalent.) | 同値判定 |
!> @endja
!>
module gtdata_generic
  implicit none
  !> @en
  !> @brief Open variable interface
  !> @enden
  !> @ja
  !> @brief 変数オープンインターフェース
  !> @endja
  interface open
    subroutine gtvaropenbydimord(var, source_var, dimord, &
      count_compact, inherit_slice, err)
      use gtdata_types, only: gt_variable
      type(gt_variable), intent(out):: var
      type(gt_variable), intent(in):: source_var
      integer, intent(in):: dimord
      logical, intent(in), optional:: count_compact
      logical, intent(in), optional:: inherit_slice
      logical, intent(out), optional:: err
    end subroutine gtvaropenbydimord
    subroutine gtvaropen(var, url, writable, err)
      use gtdata_types, only: gt_variable
      type(gt_variable), intent(out):: var
      character(*), intent(in):: url
      logical, intent(in), optional:: writable
      logical, intent(out), optional:: err
    end subroutine gtvaropen
  end interface
  !> @en
  !> @brief Create variable interface
  !> @enden
  !> @ja
  !> @brief 変数作成インターフェース
  !> @endja
  interface create
    subroutine gtvarcreate(var, url, dims, xtype, long_name, overwrite, err)
      use gtdata_types, only: gt_variable
      type(gt_variable), intent(out):: var
      character(len = *), intent(in):: url
      type(gt_variable), intent(in), optional:: dims(:)
      character(len = *), intent(in), optional:: xtype
      character(len = *), intent(in), optional:: long_name
      logical, intent(in), optional:: overwrite
      logical, intent(out), optional:: err
    end subroutine gtvarcreate
    subroutine gtvarcreated(var, url, length, xtype, long_name, overwrite, err)
      use gtdata_types, only: gt_variable
      type(gt_variable), intent(out):: var
      character(len = *), intent(in):: url
      integer, intent(in):: length
      character(len = *), intent(in), optional:: xtype
      character(len = *), intent(in), optional:: long_name
      logical, intent(in), optional:: overwrite
      logical, intent(out), optional:: err
    end subroutine gtvarcreated
  end interface create
  !> @en
  !> @brief Close variable interface
  !> @enden
  !> @ja
  !> @brief 変数クローズインターフェース
  !> @endja
  interface close
    subroutine gtvarclose(var, err)
      use gtdata_types, only: gt_variable
      type(gt_variable), intent(in):: var
      logical, intent(out), optional:: err
    end subroutine gtvarclose
  end interface close
  !> @en
  !> @brief Rewind attribute enumeration interface
  !> @enden
  !> @ja
  !> @brief 属性列挙巻き戻しインターフェース
  !> @endja
  interface attr_rewind
    subroutine gtvarattrrewind(var)
      use gtdata_types, only: gt_variable
      type(gt_variable), intent(inout):: var
    end subroutine gtvarattrrewind
  end interface attr_rewind
  !> @en
  !> @brief Get next attribute interface
  !> @enden
  !> @ja
  !> @brief 次の属性取得インターフェース
  !> @endja
  interface attr_next
    subroutine gtvarattrnext(var, name, end)
      use gtdata_types, only: gt_variable
      type(gt_variable), intent(inout):: var
      character(*), intent(out):: name
      logical, intent(out), optional:: end
    end subroutine gtvarattrnext
  end interface attr_next
  !> @en
  !> @brief Read attribute as logical interface
  !> @enden
  !> @ja
  !> @brief 属性を論理値として読み取りインターフェース
  !> @endja
  interface attr_true
    logical function gtvarattrtrue(var, name, default)
      use gtdata_types, only: gt_variable
      type(gt_variable), intent(in):: var
      character(len = *), intent(in):: name
      logical, intent(in), optional:: default
    end function gtvarattrtrue
  end interface attr_true
  !> @en
  !> @brief Get attribute interface
  !>
  !> Multiple interfaces for scalar, array, and pointer reception.
  !> - Scalar: simplest, takes interpretable value, rest discarded
  !> - Pointer array: allocates as many entities as interpretable
  !> - Array: truncates excess, fills with default if short
  !> - Character: truncates/pads like normal character assignment
  !> @enden
  !> @ja
  !> @brief 属性取得インターフェース
  !>
  !> スカラ、配列、ポインタでの受け取り用の複数インターフェース。
  !> - スカラ: 最も簡単、解釈可能な値がとられ残りは捨てられる
  !> - ポインタ配列: 解釈可能な数だけ実体が割り付けられる
  !> - 配列: 余れば切り捨て、足りなければdefault値で埋める
  !> - 文字: 通常の文字型代入と同様切り捨て・空白埋め
  !> @endja
  interface get_attr
    subroutine gtvargetattri(var, name, value, default)
      use gtdata_types, only: gt_variable
      type(gt_variable), intent(in):: var
      character(len = *), intent(in):: name
      integer, intent(out):: value
      integer, intent(in), optional:: default
    end subroutine gtvargetattri
    subroutine gtvargetattrr(var, name, value, default)
      use gtdata_types, only: gt_variable
      type(gt_variable), intent(in):: var
      character(len = *), intent(in):: name
      real, intent(out):: value
      real, intent(in), optional:: default
    end subroutine gtvargetattrr
    subroutine gtvargetattrd(var, name, value, default)
      use gtdata_types, only: gt_variable
      use dc_types, only: dp
      type(gt_variable), intent(in):: var
      character(len = *), intent(in):: name
      real(DP), intent(out):: value
      real(DP), intent(in), optional:: default
    end subroutine gtvargetattrd
    ! ポインタ配列を使って受け取る場合は解釈可能な数だけ実体が割り付けられる。
    subroutine gtvargetattrip(var, name, value)
      use gtdata_types, only: gt_variable
      type(gt_variable), intent(in):: var
      character(len = *), intent(in):: name
      integer, pointer:: value(:)
    end subroutine gtvargetattrip
    subroutine gtvargetattrrp(var, name, value)
      use gtdata_types, only: gt_variable
      type(gt_variable), intent(in):: var
      character(len = *), intent(in):: name
      real, pointer:: value(:)
    end subroutine gtvargetattrrp
    subroutine gtvargetattrdp(var, name, value)
      use gtdata_types, only: gt_variable
      use dc_types, only: dp
      type(gt_variable), intent(in):: var
      character(len = *), intent(in):: name
      real(DP), pointer:: value(:)
    end subroutine gtvargetattrdp
    ! integer 配列, real 配列として受け取る
    ! 場合は属性長があまっている場合には切り捨てられ、
    ! 属性長が足りない場合は default 値 (ポインタと違い必須) を埋める。
    subroutine gtvargetattria(var, name, value, default)
      use gtdata_types, only: gt_variable
      type(gt_variable), intent(in):: var
      character(len = *), intent(in):: name
      integer, intent(out):: value(:)
      integer, intent(in):: default
    end subroutine gtvargetattria
    subroutine gtvargetattrra(var, name, value, default)
      use gtdata_types, only: gt_variable
      type(gt_variable), intent(in):: var
      character(len = *), intent(in):: name
      real, intent(out):: value(:)
      real, intent(in):: default
    end subroutine gtvargetattrra
    subroutine gtvargetattrda(var, name, value, default)
      use gtdata_types, only: gt_variable
      use dc_types, only: dp
      type(gt_variable), intent(in):: var
      character(len = *), intent(in):: name
      real(DP), intent(out):: value(:)
      real(DP), intent(in):: default
    end subroutine gtvargetattrda
    ! character 型で受け取る場合は通常の文字型代入と同様、
    ! 受け側変数の長さに合わせて切り捨て・空白埋めを行う。
    ! 属性が存在しない場合 default 値を使う。
    subroutine gtvargetattrcc(var, name, value, default)
      use gtdata_types, only: gt_variable
      type(gt_variable), intent(in):: var
      character(len = *), intent(in):: name
      character(len = *), intent(out):: value
      character(len = *), intent(in), optional:: default
    end subroutine gtvargetattrcc
    ! 文字列として読み取る場合は元の長さは正確に受け取られる。
    ! 属性が存在しない場合 default 値を使う。
!    subroutine GTVarGetAttrSC(var, name, value, default)
!      use dc_string, only: VSTRING
!      use gtdata_types, only: GT_VARIABLE
!      type(GT_VARIABLE), intent(in):: var
!      character(len = *), intent(in):: name
!      type(VSTRING), intent(out):: value
!      character(len = *), intent(in), optional:: default
!    end subroutine GTVarGetAttrSC
  end interface get_attr
  !> @en
  !> @brief Put attribute interface
  !> @enden
  !> @ja
  !> @brief 属性設定インターフェース
  !> @endja
  interface put_attr
    subroutine gtvarputattrdouble(var, name, value, err)
      use gtdata_types, only: gt_variable
      use dc_types, only: dp
      real(DP),           intent(in)            :: value(:)
      real,               intent(out), optional :: err
      type(gt_variable), intent(inout):: var
      character(len = *), intent(in):: name
    end subroutine gtvarputattrdouble
    subroutine gtvarputattrreal(var, name, value, err)
      use gtdata_types, only: gt_variable
      use dc_types, only: sp
      real(SP),           intent(in)            :: value(:)
      real(SP),           intent(out), optional :: err
      type(gt_variable), intent(inout):: var
      character(len = *), intent(in):: name
    end subroutine gtvarputattrreal
    subroutine gtvarputattrint(var, name, value, err)
      use gtdata_types, only: gt_variable
      integer,            intent(in)            :: value(:)
      real,               intent(out), optional :: err
      type(gt_variable), intent(inout):: var
      character(len = *), intent(in):: name
    end subroutine gtvarputattrint
    subroutine gtvarputattrchar(var, name, value, xtype, err)
      use gtdata_types, only: gt_variable
      character(len = *), intent(in)            :: value
      logical,            intent(out), optional :: err
      character(len = *), intent(in),  optional :: xtype
      type(gt_variable), intent(inout):: var
      character(len = *), intent(in):: name
    end subroutine gtvarputattrchar
    subroutine gtvarputattrlogical(var, name, value, err)
      use gtdata_types, only: gt_variable
      logical,            intent(in)            :: value
      real,               intent(out), optional :: err
      type(gt_variable), intent(inout):: var
      character(len = *), intent(in):: name
    end subroutine gtvarputattrlogical
  end interface put_attr
  !> @en
  !> @brief Delete attribute interface
  !> @enden
  !> @ja
  !> @brief 属性削除インターフェース
  !> @endja
  interface del_attr
    subroutine gtvardelattr(var, name, err)
      use gtdata_types, only: gt_variable
      type(gt_variable), intent(inout):: var
      character(len = *), intent(in):: name
      logical, intent(out), optional:: err
    end subroutine gtvardelattr
  end interface del_attr
  !> @en
  !> @brief Copy attribute interface
  !> @enden
  !> @ja
  !> @brief 属性コピーインターフェース
  !> @endja
  interface copy_attr
    subroutine gtvarcopyattr(to, attrname, from, err)
      use gtdata_types, only: gt_variable
      type(gt_variable), intent(inout):: to
      character(len = *), intent(in):: attrname
      type(gt_variable), intent(in):: from
      logical, intent(out), optional:: err
    end subroutine gtvarcopyattr
    subroutine gtvarcopyattrall(to, from, err, global)
      use gtdata_types, only: gt_variable
      type(gt_variable), intent(inout):: to
      type(gt_variable), intent(inout):: from
      logical, intent(out), optional:: err
      logical, intent(in), optional:: global
    end subroutine gtvarcopyattrall
  end interface copy_attr
  !> @en
  !> @brief Slice (I/O range restriction) interface
  !>
  !> Current I/O range size can be obtained with inquire(var, size=).
  !> - Auto specification: specify compatible for identical settings
  !> - Dimension-specified: specify dimension number
  !> - String: specify by character string
  !> @enden
  !> @ja
  !> @brief スライス (入出力範囲限定) インターフェース
  !>
  !> 現在の入出力範囲の大きさは inquire(var, size=) で取得できる。
  !> - おまかせ指示: compatible を指定するとまったく同じに指定
  !> - 次元指定: 次元番号を指定
  !> - 文字列: 文字列による指示
  !> @endja
  interface slice
    subroutine gtvarsliceauto(var, compatible)
      use gtdata_types, only: gt_variable
      type(gt_variable), intent(inout):: var
      type(gt_variable), intent(in), optional:: compatible
    end subroutine gtvarsliceauto
    ! 次元を指定した指示
    subroutine gtvarslice(var, dimord, start, count, stride)
      use gtdata_types, only: gt_variable
      type(gt_variable), intent(in):: var
      integer, intent(in):: dimord
      integer, intent(in), optional:: start
      integer, intent(in), optional:: count
      integer, intent(in), optional:: stride
    end subroutine gtvarslice
    ! 文字列による指示
    subroutine gtvarslicec(var, string, err)
      use gtdata_types, only: gt_variable
      type(gt_variable), intent(inout):: var
      character(len = *), intent(in):: string
      logical, intent(out):: err
    end subroutine gtvarslicec
  end interface slice
  !> @en
  !> @brief Get slice information interface
  !>
  !> - Specify dimension order to get
  !> - Bulk get for all dimensions (pre-allocate array with inquire(var, alldims))
  !> @enden
  !> @ja
  !> @brief スライス情報取得インターフェース
  !>
  !> - 次元順番を指定して取得
  !> - 全次元について一括取得 (あらかじめ inquire(var, alldims) して配列を確保)
  !> @endja
  interface get_slice
    subroutine gtvargetslice(var, dimord, start, count, stride, count_compact)
      use gtdata_types, only: gt_variable
      type(gt_variable), intent(in):: var
      integer, intent(in):: dimord
      integer, intent(out), optional:: start
      integer, intent(out), optional:: count
      integer, intent(out), optional:: stride
      logical, intent(in), optional:: count_compact
    end subroutine gtvargetslice
    ! 全次元について一括取得
    ! あらかじめ inquire(var, alldims) して配列を確保する。
    subroutine gtvargetsliceall(var, start, count, stride)
      use gtdata_types, only: gt_variable
      type(gt_variable), intent(in):: var
      integer, intent(out), optional:: start(:), count(:), stride(:)
    end subroutine gtvargetsliceall
  end interface get_slice
  !> @en
  !> @brief Dimension name to dimension order interface
  !> @enden
  !> @ja
  !> @brief 次元名から次元順序番号への変換インターフェース
  !> @endja
  interface dimname_to_dimord
    integer function gtvardimname2ord(var, name)
      use gtdata_types, only: gt_variable
      type(gt_variable), intent(in):: var
      character(len = *), intent(in):: name
    end function gtvardimname2ord
  end interface dimname_to_dimord
  !> @en
  !> @brief Limit (spatial transformer setup) interface
  !> @enden
  !> @ja
  !> @brief リミット (空間変換器機能セットアップ) インターフェース
  !> @endja
  interface limit
    subroutine gtvarlimit(var, string, err)
      use gtdata_types, only: gt_variable
      type(gt_variable), intent(inout) :: var
      character(len = *), intent(in)   :: string
      logical, intent(out), optional   :: err
    end subroutine gtvarlimit
    subroutine gtvarlimit_iiii(var, dimord, start, count, stride, err)
      use gtdata_types, only: gt_variable
      type(gt_variable), intent(inout):: var
      integer, intent(in)             :: dimord
      integer, intent(in) , optional  :: start, count, stride
      logical, intent(out), optional  :: err
    end subroutine gtvarlimit_iiii
  end interface limit
  !> @en
  !> @brief Transform (unify dimension arrangement) interface
  !> @enden
  !> @ja
  !> @brief トランスフォーム (次元配置の共通化) インターフェース
  !> @endja
  interface transform
    subroutine gtvarxformbinary(var1, var2, err)
      use gtdata_types, only: gt_variable
      type(gt_variable), intent(inout):: var1, var2
      logical, intent(out), optional:: err
    end subroutine gtvarxformbinary
  end interface transform
  !> @en
  !> @brief Add dimension interface
  !>
  !> Adds dimension dimvar at position dimord in variable handle var.
  !> Dimensions from dimord onwards shift one position back.
  !> If dimord > number of valid dimensions, treated as (valid dims + 1).
  !> @enden
  !> @ja
  !> @brief 次元追加インターフェース
  !>
  !> 変数ハンドル var の dimord 番目の位置に次元 dimvar を追加する。
  !> dimord 番目以降の次元は一つ後ろにずれる。
  !> もし dimord が var の有効次元数より大きければ (有効次元数 + 1)
  !> が与えられたものとみなされる。
  !> @endja
  interface add_dim
    subroutine gtvaradddim(var, dimord, dimvar, err)
      use gtdata_types, only: gt_variable
      type(gt_variable), intent(in):: var
      type(gt_variable), intent(in):: dimvar
      integer, intent(in):: dimord
      logical, intent(out):: err
    end subroutine gtvaradddim
  end interface add_dim
  !> @en
  !> @brief Delete dimension interface
  !>
  !> "Removes" dimension from variable handle. Actually just lowers
  !> the rank in dimension correspondence table and decrements valid
  !> dimension count, so I/O is unaffected.
  !> @enden
  !> @ja
  !> @brief 次元削除インターフェース
  !>
  !> 変数ハンドルから次元を「除去」する。実際には、
  !> 次元対応表の順位を下げ有効次元数をデクリメントするだけなので、
  !> 入出力に支障はない。
  !> @endja
  interface del_dim
    subroutine gtvardeldim(var, dimord, err)
      use gtdata_types, only: gt_variable
      type(gt_variable), intent(in):: var
      integer, intent(in):: dimord
      logical, intent(out):: err
    end subroutine gtvardeldim
  end interface del_dim
  !> @en
  !> @brief Exchange dimension order interface
  !> @enden
  !> @ja
  !> @brief 次元順序交換インターフェース
  !> @endja
  interface exch_dim
    subroutine gtvarexchdim(var, dimord1, dimord2, count_compact, err)
      use gtdata_types, only: gt_variable
      type(gt_variable), intent(in):: var
      integer, intent(in):: dimord1, dimord2
      logical, intent(in), optional:: count_compact
      logical, intent(out):: err
    end subroutine gtvarexchdim
  end interface exch_dim
  !> @en
  !> @brief Inquire variable information interface
  !> @enden
  !> @ja
  !> @brief 変数情報問い合わせインターフェース
  !> @endja
  interface inquire
    subroutine gtvarinquire(var, growable, &
      & rank, alldims, allcount, size, &
      & xtype, name, url, err)
      use gtdata_types, only: gt_variable
      type(gt_variable), intent(in):: var
      character(len=*), intent(out), optional:: xtype
      character(len=*), intent(out), optional:: name
      character(len=*), intent(out), optional:: url
      integer, intent(out), optional:: rank
      integer, intent(out), optional:: alldims
      integer, intent(out), optional:: allcount
      integer, intent(out), optional:: size
      logical, intent(out), optional:: growable
      logical, intent(out), optional:: err
    end subroutine gtvarinquire
    subroutine gtvarinquire2(var, allcount)
      use gtdata_types, only: gt_variable
      type(gt_variable), intent(in):: var
      integer, intent(out):: allcount(:)
    end subroutine gtvarinquire2
    subroutine gtvarinquired(var, dimord, url, allcount, err)
      use gtdata_types, only: gt_variable
      type(gt_variable), intent(in):: var
      integer, intent(in):: dimord
      character(len=*), intent(out), optional:: url
      integer, intent(out), optional:: allcount
      logical, intent(out), optional:: err
    end subroutine gtvarinquired
    subroutine gtvarinquirea(var, attrname, xtype)
      use gtdata_types, only: gt_variable
      type(gt_variable), intent(in):: var
      character(len=*), intent(in):: attrname
      character(len=*), intent(out), optional:: xtype
    end subroutine gtvarinquirea
  end interface inquire
  !> @en
  !> @brief Slice next (iterator for traversal) interface
  !> @enden
  !> @ja
  !> @brief 次スライス (総なめ用イテレータ) インターフェース
  !> @endja
  interface slice_next
    subroutine gtvarslicenext(var, dimord, err, stat)
      use gtdata_types, only: gt_variable
      type(gt_variable), intent(in out):: var
      integer, intent(in), optional:: dimord
      logical, intent(out), optional:: err
      integer, intent(out), optional:: stat
    end subroutine gtvarslicenext
  end interface slice_next
  !> @en
  !> @brief Equivalence check operator interface
  !> @enden
  !> @ja
  !> @brief 同値判定演算子インターフェース
  !> @endja
  interface operator(.equivalent.)
    logical function gtvarequivalent(var1, var2)
      use gtdata_types, only: gt_variable
      type(gt_variable), intent(in):: var1, var2
    end function gtvarequivalent
  end interface operator(.equivalent.)
  !> @en
  !> @brief Get (file input) interface
  !>
  !> Get(var, value, nvalue, [err]):
  !> Gets current I/O range to 1D array. nvalue must store array length.
  !> Using specific name GTVarGetReal allows input to multi-dimensional
  !> array, but note the relationship with I/O range.
  !>
  !> Get(var, value, [err]) takes 1-7 dimensional pointers.
  !> Limits I/O range to pointer dimensions, allocates array,
  !> fills values and returns.
  !> @enden
  !> @ja
  !> @brief Get (ファイル入力) インターフェース
  !>
  !> Get(var, value, nvalue, [err]):
  !> 1次元配列に現在の入出力範囲を取得する。
  !> nvalue は利用者が配列長を格納しなければならない。
  !> 個別名 GTVarGetReal を用いると多次元配列に入力
  !> することもできるが、入出力範囲との関係に注意が必要。
  !>
  !> Get(var, value, [err]) は 1〜7 次元のポインタをとる。
  !> 入出力範囲をポインタ次元数に限定し、配列を確保し、
  !> 値を入れて返す。
  !> @endja
  interface get
    subroutine gtvargetdouble(var, value, nvalue, err)
      use gtdata_types, only: gt_variable
      use dc_types, only: dp
      real(DP), intent(out):: value(*)
      type(gt_variable), intent(in):: var
      integer, intent(in):: nvalue
      logical, intent(out), optional:: err
    end subroutine gtvargetdouble
    subroutine gtvargetpointerdouble1(var, value, err)
      use gtdata_types, only: gt_variable
      use dc_types,     only: dp
      real(DP),          pointer               :: value(:)
      type(gt_variable), intent(in)            :: var
      logical,           intent(out), optional :: err
    end subroutine gtvargetpointerdouble1
    subroutine gtvargetpointerdouble2(var, value, err)
      use gtdata_types, only: gt_variable
      use dc_types,     only: dp
      real(DP),          pointer               :: value(:,:)
      type(gt_variable), intent(in)            :: var
      logical,           intent(out), optional :: err
    end subroutine gtvargetpointerdouble2
    subroutine gtvargetpointerdouble3(var, value, err)
      use gtdata_types, only: gt_variable
      use dc_types,     only: dp
      real(DP),          pointer               :: value(:,:,:)
      type(gt_variable), intent(in)            :: var
      logical,           intent(out), optional :: err
    end subroutine gtvargetpointerdouble3
    subroutine gtvargetpointerdouble4(var, value, err)
      use gtdata_types, only: gt_variable
      use dc_types,     only: dp
      real(DP),          pointer               :: value(:,:,:,:)
      type(gt_variable), intent(in)            :: var
      logical,           intent(out), optional :: err
    end subroutine gtvargetpointerdouble4
    subroutine gtvargetpointerdouble5(var, value, err)
      use gtdata_types, only: gt_variable
      use dc_types,     only: dp
      real(DP),          pointer               :: value(:,:,:,:,:)
      type(gt_variable), intent(in)            :: var
      logical,           intent(out), optional :: err
    end subroutine gtvargetpointerdouble5
    subroutine gtvargetpointerdouble6(var, value, err)
      use gtdata_types, only: gt_variable
      use dc_types,     only: dp
      real(DP),          pointer               :: value(:,:,:,:,:,:)
      type(gt_variable), intent(in)            :: var
      logical,           intent(out), optional :: err
    end subroutine gtvargetpointerdouble6
    subroutine gtvargetpointerdouble7(var, value, err)
      use gtdata_types, only: gt_variable
      use dc_types,     only: dp
      real(DP),          pointer               :: value(:,:,:,:,:,:,:)
      type(gt_variable), intent(in)            :: var
      logical,           intent(out), optional :: err
    end subroutine gtvargetpointerdouble7
    subroutine gtvargetreal(var, value, nvalue, err)
      use gtdata_types, only: gt_variable
      use dc_types, only: sp
      real(SP), intent(out):: value(*)
      type(gt_variable), intent(in):: var
      integer, intent(in):: nvalue
      logical, intent(out), optional:: err
    end subroutine gtvargetreal
    subroutine gtvargetpointerreal1(var, value, err)
      use gtdata_types, only: gt_variable
      use dc_types,     only: sp
      real(SP),          pointer               :: value(:)
      type(gt_variable), intent(in)            :: var
      logical,           intent(out), optional :: err
    end subroutine gtvargetpointerreal1
    subroutine gtvargetpointerreal2(var, value, err)
      use gtdata_types, only: gt_variable
      use dc_types,     only: sp
      real(SP),          pointer               :: value(:,:)
      type(gt_variable), intent(in)            :: var
      logical,           intent(out), optional :: err
    end subroutine gtvargetpointerreal2
    subroutine gtvargetpointerreal3(var, value, err)
      use gtdata_types, only: gt_variable
      use dc_types,     only: sp
      real(SP),          pointer               :: value(:,:,:)
      type(gt_variable), intent(in)            :: var
      logical,           intent(out), optional :: err
    end subroutine gtvargetpointerreal3
    subroutine gtvargetpointerreal4(var, value, err)
      use gtdata_types, only: gt_variable
      use dc_types,     only: sp
      real(SP),          pointer               :: value(:,:,:,:)
      type(gt_variable), intent(in)            :: var
      logical,           intent(out), optional :: err
    end subroutine gtvargetpointerreal4
    subroutine gtvargetpointerreal5(var, value, err)
      use gtdata_types, only: gt_variable
      use dc_types,     only: sp
      real(SP),          pointer               :: value(:,:,:,:,:)
      type(gt_variable), intent(in)            :: var
      logical,           intent(out), optional :: err
    end subroutine gtvargetpointerreal5
    subroutine gtvargetpointerreal6(var, value, err)
      use gtdata_types, only: gt_variable
      use dc_types,     only: sp
      real(SP),          pointer               :: value(:,:,:,:,:,:)
      type(gt_variable), intent(in)            :: var
      logical,           intent(out), optional :: err
    end subroutine gtvargetpointerreal6
    subroutine gtvargetpointerreal7(var, value, err)
      use gtdata_types, only: gt_variable
      use dc_types,     only: sp
      real(SP),          pointer               :: value(:,:,:,:,:,:,:)
      type(gt_variable), intent(in)            :: var
      logical,           intent(out), optional :: err
    end subroutine gtvargetpointerreal7
    subroutine gtvargetint(var, value, nvalue, err)
      use gtdata_types, only: gt_variable
      integer,  intent(out):: value(*)
      type(gt_variable), intent(in):: var
      integer, intent(in):: nvalue
      logical, intent(out), optional:: err
    end subroutine gtvargetint
    subroutine gtvargetpointerint1(var, value, err)
      use gtdata_types, only: gt_variable
      integer,           pointer               :: value(:)
      type(gt_variable), intent(in)            :: var
      logical,           intent(out), optional :: err
    end subroutine gtvargetpointerint1
    subroutine gtvargetpointerint2(var, value, err)
      use gtdata_types, only: gt_variable
      integer,           pointer               :: value(:,:)
      type(gt_variable), intent(in)            :: var
      logical,           intent(out), optional :: err
    end subroutine gtvargetpointerint2
    subroutine gtvargetpointerint3(var, value, err)
      use gtdata_types, only: gt_variable
      integer,           pointer               :: value(:,:,:)
      type(gt_variable), intent(in)            :: var
      logical,           intent(out), optional :: err
    end subroutine gtvargetpointerint3
    subroutine gtvargetpointerint4(var, value, err)
      use gtdata_types, only: gt_variable
      integer,           pointer               :: value(:,:,:,:)
      type(gt_variable), intent(in)            :: var
      logical,           intent(out), optional :: err
    end subroutine gtvargetpointerint4
    subroutine gtvargetpointerint5(var, value, err)
      use gtdata_types, only: gt_variable
      integer,           pointer               :: value(:,:,:,:,:)
      type(gt_variable), intent(in)            :: var
      logical,           intent(out), optional :: err
    end subroutine gtvargetpointerint5
    subroutine gtvargetpointerint6(var, value, err)
      use gtdata_types, only: gt_variable
      integer,           pointer               :: value(:,:,:,:,:,:)
      type(gt_variable), intent(in)            :: var
      logical,           intent(out), optional :: err
    end subroutine gtvargetpointerint6
    subroutine gtvargetpointerint7(var, value, err)
      use gtdata_types, only: gt_variable
      integer,           pointer               :: value(:,:,:,:,:,:,:)
      type(gt_variable), intent(in)            :: var
      logical,           intent(out), optional :: err
    end subroutine gtvargetpointerint7
  end interface get
  !> @en
  !> @brief PutLine (print) interface
  !>
  !> "Printing" is input from the variable's perspective and output
  !> from the file's perspective. So it somewhat straddles put and get,
  !> but we inherit the procedure name from dc_string as put_line.
  !> @enden
  !> @ja
  !> @brief PutLine (印字) インターフェース
  !>
  !> 印字というのは変数にしてみれば入力だしファイルにしてみれば出力だ。
  !> だから put と get を兼営しているようなものでまことにあやしいのだが、
  !> いちおう dc_string の手続名を継承して put_line にしておく。
  !> @endja
  interface putline
    subroutine gtvarputline( var, unit, indent, err )
      use gtdata_types, only: gt_variable
      type(gt_variable), intent(in):: var
      integer, intent(in), optional:: unit
      character(*), intent(in), optional:: indent
      logical, intent(out), optional:: err
    end subroutine gtvarputline
  end interface
  !> @en
  !> @brief Put (file output) interface
  !> @enden
  !> @ja
  !> @brief Put (ファイル出力) インターフェース
  !> @endja
  interface put
    subroutine gtvarputdouble(var, value, nvalue, err)
      use gtdata_types, only: gt_variable
      use dc_types, only: dp
      real(DP), intent(in):: value(nvalue)
      type(gt_variable), intent(in):: var
      integer, intent(in):: nvalue
      logical, intent(out), optional:: err
    end subroutine gtvarputdouble
    subroutine gtvarputdouble1(var, value, err)
      use gtdata_types,   only: gt_variable
      use dc_types,       only: dp
      real(DP), intent(in) :: value(:)
      type(gt_variable),intent(in):: var
      logical  ,intent(out), optional:: err
    end subroutine gtvarputdouble1
    subroutine gtvarputdouble2(var, value, err)
      use gtdata_types,   only: gt_variable
      use dc_types,       only: dp
      real(DP), intent(in) :: value(:,:)
      type(gt_variable),intent(in):: var
      logical  ,intent(out), optional:: err
    end subroutine gtvarputdouble2
    subroutine gtvarputdouble3(var, value, err)
      use gtdata_types,   only: gt_variable
      use dc_types,       only: dp
      real(DP), intent(in) :: value(:,:,:)
      type(gt_variable),intent(in):: var
      logical  ,intent(out), optional:: err
    end subroutine gtvarputdouble3
    subroutine gtvarputdouble4(var, value, err)
      use gtdata_types,   only: gt_variable
      use dc_types,       only: dp
      real(DP), intent(in) :: value(:,:,:,:)
      type(gt_variable),intent(in):: var
      logical  ,intent(out), optional:: err
    end subroutine gtvarputdouble4
    subroutine gtvarputdouble5(var, value, err)
      use gtdata_types,   only: gt_variable
      use dc_types,       only: dp
      real(DP), intent(in) :: value(:,:,:,:,:)
      type(gt_variable),intent(in):: var
      logical  ,intent(out), optional:: err
    end subroutine gtvarputdouble5
    subroutine gtvarputdouble6(var, value, err)
      use gtdata_types,   only: gt_variable
      use dc_types,       only: dp
      real(DP), intent(in) :: value(:,:,:,:,:,:)
      type(gt_variable),intent(in):: var
      logical  ,intent(out), optional:: err
    end subroutine gtvarputdouble6
    subroutine gtvarputdouble7(var, value, err)
      use gtdata_types,   only: gt_variable
      use dc_types,       only: dp
      real(DP), intent(in) :: value(:,:,:,:,:,:,:)
      type(gt_variable),intent(in):: var
      logical  ,intent(out), optional:: err
    end subroutine gtvarputdouble7
    subroutine gtvarputreal(var, value, nvalue, err)
      use gtdata_types, only: gt_variable
      use dc_types, only: sp
      real(SP), intent(in):: value(nvalue)
      type(gt_variable), intent(in):: var
      integer, intent(in):: nvalue
      logical, intent(out), optional:: err
    end subroutine gtvarputreal
    subroutine gtvarputreal1(var, value, err)
      use gtdata_types,   only: gt_variable
      use dc_types,       only: sp
      real(SP), intent(in) :: value(:)
      type(gt_variable),intent(in):: var
      logical  ,intent(out), optional:: err
    end subroutine gtvarputreal1
    subroutine gtvarputreal2(var, value, err)
      use gtdata_types,   only: gt_variable
      use dc_types,       only: sp
      real(SP), intent(in) :: value(:,:)
      type(gt_variable),intent(in):: var
      logical  ,intent(out), optional:: err
    end subroutine gtvarputreal2
    subroutine gtvarputreal3(var, value, err)
      use gtdata_types,   only: gt_variable
      use dc_types,       only: sp
      real(SP), intent(in) :: value(:,:,:)
      type(gt_variable),intent(in):: var
      logical  ,intent(out), optional:: err
    end subroutine gtvarputreal3
    subroutine gtvarputreal4(var, value, err)
      use gtdata_types,   only: gt_variable
      use dc_types,       only: sp
      real(SP), intent(in) :: value(:,:,:,:)
      type(gt_variable),intent(in):: var
      logical  ,intent(out), optional:: err
    end subroutine gtvarputreal4
    subroutine gtvarputreal5(var, value, err)
      use gtdata_types,   only: gt_variable
      use dc_types,       only: sp
      real(SP), intent(in) :: value(:,:,:,:,:)
      type(gt_variable),intent(in):: var
      logical  ,intent(out), optional:: err
    end subroutine gtvarputreal5
    subroutine gtvarputreal6(var, value, err)
      use gtdata_types,   only: gt_variable
      use dc_types,       only: sp
      real(SP), intent(in) :: value(:,:,:,:,:,:)
      type(gt_variable),intent(in):: var
      logical  ,intent(out), optional:: err
    end subroutine gtvarputreal6
    subroutine gtvarputreal7(var, value, err)
      use gtdata_types,   only: gt_variable
      use dc_types,       only: sp
      real(SP), intent(in) :: value(:,:,:,:,:,:,:)
      type(gt_variable),intent(in):: var
      logical  ,intent(out), optional:: err
    end subroutine gtvarputreal7
    subroutine gtvarputint(var, value, nvalue, err)
      use gtdata_types, only: gt_variable
      integer, intent(in):: value(nvalue)
      type(gt_variable), intent(in):: var
      integer, intent(in):: nvalue
      logical, intent(out), optional:: err
    end subroutine gtvarputint
    subroutine gtvarputint1(var, value, err)
      use gtdata_types,   only: gt_variable
      integer,  intent(in) :: value(:)
      type(gt_variable),intent(in):: var
      logical  ,intent(out), optional:: err
    end subroutine gtvarputint1
    subroutine gtvarputint2(var, value, err)
      use gtdata_types,   only: gt_variable
      integer,  intent(in) :: value(:,:)
      type(gt_variable),intent(in):: var
      logical  ,intent(out), optional:: err
    end subroutine gtvarputint2
    subroutine gtvarputint3(var, value, err)
      use gtdata_types,   only: gt_variable
      integer,  intent(in) :: value(:,:,:)
      type(gt_variable),intent(in):: var
      logical  ,intent(out), optional:: err
    end subroutine gtvarputint3
    subroutine gtvarputint4(var, value, err)
      use gtdata_types,   only: gt_variable
      integer,  intent(in) :: value(:,:,:,:)
      type(gt_variable),intent(in):: var
      logical  ,intent(out), optional:: err
    end subroutine gtvarputint4
    subroutine gtvarputint5(var, value, err)
      use gtdata_types,   only: gt_variable
      integer,  intent(in) :: value(:,:,:,:,:)
      type(gt_variable),intent(in):: var
      logical  ,intent(out), optional:: err
    end subroutine gtvarputint5
    subroutine gtvarputint6(var, value, err)
      use gtdata_types,   only: gt_variable
      integer,  intent(in) :: value(:,:,:,:,:,:)
      type(gt_variable),intent(in):: var
      logical  ,intent(out), optional:: err
    end subroutine gtvarputint6
    subroutine gtvarputint7(var, value, err)
      use gtdata_types,   only: gt_variable
      integer,  intent(in) :: value(:,:,:,:,:,:,:)
      type(gt_variable),intent(in):: var
      logical  ,intent(out), optional:: err
    end subroutine gtvarputint7
    subroutine gtvarputchar(var, value, nvalue, err)
      use gtdata_types, only: gt_variable
      type(gt_variable), intent(in):: var
      integer, intent(in):: nvalue
      character(*), intent(in):: value(nvalue)
      logical, intent(out), optional:: err
    end subroutine gtvarputchar
  end interface put
  !> @en
  !> @brief Search variables in file interface
  !> @enden
  !> @ja
  !> @brief ファイル内変数検索インターフェース
  !> @endja
  interface gtvarsearch
    subroutine gtvarsearchnext(url, end)
      character(len = *), intent(out):: url
      logical, intent(out):: end
    end subroutine gtvarsearchnext
    subroutine gtvarsearchinit(urlBase)
      character(len = *), intent(in):: urlBase
    end subroutine gtvarsearchinit
  end interface gtvarsearch
  !> @en
  !> @brief Sync file I/O interface
  !>
  !> Safety exit point. Since SysDepAbort calls this, must not call StoreError.
  !> @enden
  !> @ja
  !> @brief ファイル入出力同期インターフェース
  !>
  !> 安全のための脱出口。SysDepAbort が呼び出すので、StoreError を呼んではならない。
  !> @endja
  interface
    subroutine gtvarsync(var, stat)
      use gtdata_types, only: gt_variable
      type(gt_variable), intent(inout), optional:: var
      integer, intent(out), optional:: stat
    end subroutine gtvarsync
  end interface
  !> @en
  !> @brief Create copy interface (utility)
  !>
  !> Library written using only gtdata layer.
  !> @enden
  !> @ja
  !> @brief コピー作成インターフェース (ユーティリティ)
  !>
  !> gtdata 層だけで書かれたライブラリ。
  !> @endja
  interface create
    subroutine gtvarcreatecopyc(var, url, copyfrom, copyvalue, &
      & overwrite, err)
      use gtdata_types, only: gt_variable
      implicit none
      type(gt_variable), intent(out):: var
      character(len = *), intent(in):: url
      type(gt_variable), intent(inout):: copyfrom
      logical, intent(in), optional:: copyvalue
      logical, intent(in), optional:: overwrite
      logical, intent(out), optional:: err
    end subroutine gtvarcreatecopyc
  end interface
  !> @en
  !> @brief Delete variable interface (work in progress)
  !> @enden
  !> @ja
  !> @brief 変数削除インターフェース (作成中)
  !> @endja
  interface gtvardel
    subroutine gtvardel1(varname, err)
      character(len = *), intent(in):: varname
      logical, intent(out):: err
    end subroutine gtvardel1
  end interface
  !> @en
  !> @brief Add member (structure related) interface
  !> @enden
  !> @ja
  !> @brief メンバ追加 (構造体関係) インターフェース
  !> @endja
  interface add_member
    subroutine gtvaraddmember(var, url, link_name)
      use gtdata_types, only: gt_variable
      type(gt_variable), intent(inout):: var
      character(len = *), intent(in):: url
      character(len = *), intent(in), optional:: link_name
    end subroutine gtvaraddmember
  end interface
  !> @en
  !> @brief Auto-create unique variable name interface
  !> @enden
  !> @ja
  !> @brief 一意な変数名の自動作成インターフェース
  !> @endja
  interface gtdatatmpnam
    subroutine gtvartmpnam(file, base, result)
      character(len = *), intent(in):: file
      character(len = *), intent(in):: base
      character(len = *), intent(out):: result
    end subroutine gtvartmpnam
  end interface
end module gtdata_generic