gtdata_netcdf_types.f90

Go to the documentation of this file.

!>
!> @file gtdata_netcdf_types.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 Derived type definitions for abstract netCDF variable interface
!> @enden
!>
!> @ja
!> @brief 抽象 netCDF 変数インターフェイス用の派生型定義
!> @endja
!>
 
!>
!> @en
!> @brief Derived type definitions for abstract netCDF variable interface
!>
!> This module provides type definitions for managing netCDF variables
!> at the gtdata abstraction layer.
!>
!> | Type | Description |
!> |------|-------------|
!> | GD_NC_VARIABLE | User handle for netCDF variables |
!> | GD_NC_VARIABLE_ENTRY | Internal table entry for variable management |
!> | GD_NC_VARIABLE_SEARCH | Iterator for variable list search |
!>
!> @enden
!>
!> @ja
!> @brief 抽象 netCDF 変数インターフェイス用の派生型定義
!>
!> このモジュールは gtdata 抽象化層で netCDF 変数を管理するための
!> 型定義を提供します。
!>
!> | 型 | 説明 |
!> |----|------|
!> | GD_NC_VARIABLE | netCDF 変数用のユーザハンドル |
!> | GD_NC_VARIABLE_ENTRY | 変数管理用の内部テーブルエントリ |
!> | GD_NC_VARIABLE_SEARCH | 変数リスト検索用イテレータ |
!>
!> @endja
!>
module gtdata_netcdf_types
 
  implicit none
 
  !>
  !> @en
  !> @brief User handle for netCDF variables
  !>
  !> This is the handle that users (gtdata layer) should use.
  !> The id member is an index into the gdnctab table in the
  !> gtdata_netcdf_internal module.
  !> @enden
  !>
  !> @ja
  !> @brief netCDF 変数用のユーザハンドル
  !>
  !> ユーザ (gtdata 層) が使うべきハンドルです。
  !> id メンバは gtdata_netcdf_internal モジュールの gdnctab 表の
  !> インデックスとなります。
  !> @endja
  !>
  type gd_nc_variable
    integer:: id  !< @en Index into gdnctab table @enden @ja gdnctab 表へのインデックス @endja
  end type gd_nc_variable
 
  !>
  !> @en
  !> @brief Internal table entry for variable management
  !>
  !> Element of the gdnctab table in gtdata_netcdf_internal module.
  !>
  !> A variable (gtdata_netcdf_variable entity) is identified by
  !> (fileid, varid, dimid). A valid variable always has a positive fileid.
  !>
  !> For dimension variables, dimids contains the dimension itself.
  !> For non-dimension variables, dimids contains the list of dimids
  !> for that variable's dimensions.
  !> @enden
  !>
  !> @ja
  !> @brief 変数管理用の内部テーブルエントリ
  !>
  !> gtdata_netcdf_internal モジュールの gdnctab 表の要素です。
  !>
  !> 変数 (gtdata_netcdf_variable 実体) は (fileid, varid, dimid) で
  !> 同定されます。正当な変数の fileid は必ず正です。
  !>
  !> 次元変数については自次元が、非次元変数については
  !> 自分にとっての次元の dimid の一覧が dimids に保存されます。
  !> @endja
  !>
  type gd_nc_variable_entry
    integer:: fileid             !< @en File ID @enden @ja ファイル ID @endja
    integer:: varid              !< @en Variable ID @enden @ja 変数 ID @endja
    integer:: dimid              !< @en Dimension ID @enden @ja 次元 ID @endja
    integer, pointer:: dimids(:) !< @en Dimension ID table @enden @ja 次元 ID 表 @endja
    integer:: attrid             !< @en Attribute search iterator @enden @ja 属性サーチ用イテレータ @endja
  end type gd_nc_variable_entry
 
  !>
  !> @en
  !> @brief Iterator for variable list search
  !> @enden
  !>
  !> @ja
  !> @brief 変数リスト検索用イテレータ
  !> @endja
  !>
  type gd_nc_variable_search
    integer:: fileid  !< @en File ID @enden @ja ファイル ID @endja
    integer:: varid   !< @en Variable ID @enden @ja 変数 ID @endja
    integer:: dimid   !< @en Dimension ID @enden @ja 次元 ID @endja
  end type gd_nc_variable_search
 
end module gtdata_netcdf_types