gdncvargetnum.f90

Go to the documentation of this file.

! -*- coding: utf-8; mode: f90 -*-
!-------------------------------------------------------------------------------------
! Copyright (c) 2000-2026 Gtool Development Group. All rights reserved.
!-------------------------------------------------------------------------------------
!> @file gdncvargetnum.erb
!>
!> @attention
!> This file is generated from ../../../../../src/gtdata/gtdata_netcdf/gdncvargetnum.erb by ERB included Ruby 3.3.8.
!> Please do not edit this file directly.
!>
!> @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 Get numeric data from netCDF variables
!>
!> These subroutines are provided as gtdata_generic#Get through
!> gtdata_netcdf_generic.
!> @enden
!>
!> @ja
!> @brief netCDF 変数から数値データを取得
!>
!> 以下のサブルーチンは gtdata_netcdf_generic を通じて
!> gtdata_generic#Get として提供されます。
!> @endja
!>
!>
!> @en
!> @brief Get variable data (real type)
!>
!> Reads data from a netCDF variable with array slicing support.
!> @enden
!>
!> @ja
!> @brief 変数データの取得 (real 型)
!>
!> netCDF 変数から配列スライシングをサポートしてデータを読み込みます。
!> @endja
!>
!> @param[in]  var    @en Variable handle @enden @ja 変数ハンドル @endja
!> @param[in]  start  @en Start indices for each dimension @enden @ja 各次元の開始インデックス @endja
!> @param[in]  cnt    @en Count of elements to read for each dimension @enden @ja 各次元の読み込み要素数 @endja
!> @param[in]  stride @en Stride (interval) for each dimension @enden @ja 各次元のストライド (間隔) @endja
!> @param[in]  imap   @en Memory mapping vector (see NetCDF manual NF_PUT_VARM_type) @enden
!>                    @ja メモリマッピングベクトル (NetCDF マニュアル NF_PUT_VARM_type 参照) @endja
!> @param[in]  siz    @en Size of val array @enden @ja val 配列のサイズ @endja
!> @param[out] val    @en Array to store read data @enden @ja 読み込んだデータを格納する配列 @endja
!> @param[out] iostat @en I/O status (NF90_NOERR on success) @enden @ja I/O ステータス (成功時 NF90_NOERR) @endja
!>
subroutine gdncvargetreal(var, start, cnt, stride, imap, siz, val, iostat)
  use gtdata_netcdf_types,    only: gd_nc_variable
  use gtdata_netcdf_internal, only: gd_nc_variable_entry, vtable_lookup
  use netcdf, only:   &
    & nf90_noerr,     &
    & nf90_einval,    &
    & nf90_eindefine, &
    & nf90_get_var,   &
    & nf90_redef,     &
    & nf90_enddef
  use dc_types,    only: sp
  implicit none
  type(gd_nc_variable), intent(in):: var
  integer, intent(in):: start(:)
  integer, intent(in):: cnt(:)
  integer, intent(in):: stride(:)
  integer, intent(in):: imap(:)
  ! NetCDF変数と内部データ配列のメモリ内構
  ! 造間のマッピングを指定する整数ベクトル.
  ! 詳しくは NetCDF マニュアル
  ! (NF_PUT_VARM_type 等 を参照のこと)
  integer, intent(in):: siz
  real(SP), intent(out):: val(siz)
  integer, intent(out):: iostat
  integer:: nd ! var が保持する変数が依存する次元変数の数
  type(gd_nc_variable_entry):: ent
  integer, allocatable:: istart(:), istride(:), iimap(:)
  continue
  iostat = vtable_lookup(var, ent)
  if (iostat /= nf90_noerr) goto 999
  ! --- nd check ---
  nd = 0
  if (associated(ent%dimids)) nd = size(ent%dimids)
  if (min(size(start), size(cnt), size(stride), size(imap)) < nd) then
    iostat = nf90_einval
    goto 999
  endif
  if (nd == 0) then
    iostat = nf90_get_var(ent%fileid, ent%varid, val(1), start)
    goto 999
  endif
  ! --- stride ovarwrite buffer ---
  allocate(istart(nd), istride(nd), iimap(nd))
  istart(1:nd) = start(1:nd)
  istride(1:nd) = stride(1:nd)
  iimap(1:nd) = imap(1:nd)
  ! --- do read ---
  iostat = nf90_get_var(ent%fileid, ent%varid, val, istart, cnt, istride, iimap)
  if (iostat == nf90_eindefine) then
    iostat = nf90_enddef(ent%fileid)
    if (iostat /= nf90_noerr) return
    iostat = nf90_get_var(ent%fileid, ent%varid, val, istart, cnt, istride, iimap)
    if (iostat /= nf90_noerr) return
    iostat = nf90_redef(ent%fileid)
    if (iostat /= nf90_noerr) return
  end if
  deallocate(istart, istride, iimap)
999 continue
end subroutine gdncvargetreal
 
!>
!> @en
!> @brief Get variable data (double type)
!>
!> Reads data from a netCDF variable with array slicing support.
!> @enden
!>
!> @ja
!> @brief 変数データの取得 (double 型)
!>
!> netCDF 変数から配列スライシングをサポートしてデータを読み込みます。
!> @endja
!>
!> @param[in]  var    @en Variable handle @enden @ja 変数ハンドル @endja
!> @param[in]  start  @en Start indices for each dimension @enden @ja 各次元の開始インデックス @endja
!> @param[in]  cnt    @en Count of elements to read for each dimension @enden @ja 各次元の読み込み要素数 @endja
!> @param[in]  stride @en Stride (interval) for each dimension @enden @ja 各次元のストライド (間隔) @endja
!> @param[in]  imap   @en Memory mapping vector (see NetCDF manual NF_PUT_VARM_type) @enden
!>                    @ja メモリマッピングベクトル (NetCDF マニュアル NF_PUT_VARM_type 参照) @endja
!> @param[in]  siz    @en Size of val array @enden @ja val 配列のサイズ @endja
!> @param[out] val    @en Array to store read data @enden @ja 読み込んだデータを格納する配列 @endja
!> @param[out] iostat @en I/O status (NF90_NOERR on success) @enden @ja I/O ステータス (成功時 NF90_NOERR) @endja
!>
subroutine gdncvargetdouble(var, start, cnt, stride, imap, siz, val, iostat)
  use gtdata_netcdf_types,    only: gd_nc_variable
  use gtdata_netcdf_internal, only: gd_nc_variable_entry, vtable_lookup
  use netcdf, only:   &
    & nf90_noerr,     &
    & nf90_einval,    &
    & nf90_eindefine, &
    & nf90_get_var,   &
    & nf90_redef,     &
    & nf90_enddef
  use dc_types,    only: dp
  implicit none
  type(gd_nc_variable), intent(in):: var
  integer, intent(in):: start(:)
  integer, intent(in):: cnt(:)
  integer, intent(in):: stride(:)
  integer, intent(in):: imap(:)
  ! NetCDF変数と内部データ配列のメモリ内構
  ! 造間のマッピングを指定する整数ベクトル.
  ! 詳しくは NetCDF マニュアル
  ! (NF_PUT_VARM_type 等 を参照のこと)
  integer, intent(in):: siz
  real(DP), intent(out):: val(siz)
  integer, intent(out):: iostat
  integer:: nd ! var が保持する変数が依存する次元変数の数
  type(gd_nc_variable_entry):: ent
  integer, allocatable:: istart(:), istride(:), iimap(:)
  continue
  iostat = vtable_lookup(var, ent)
  if (iostat /= nf90_noerr) goto 999
  ! --- nd check ---
  nd = 0
  if (associated(ent%dimids)) nd = size(ent%dimids)
  if (min(size(start), size(cnt), size(stride), size(imap)) < nd) then
    iostat = nf90_einval
    goto 999
  endif
  if (nd == 0) then
    iostat = nf90_get_var(ent%fileid, ent%varid, val(1), start)
    goto 999
  endif
  ! --- stride ovarwrite buffer ---
  allocate(istart(nd), istride(nd), iimap(nd))
  istart(1:nd) = start(1:nd)
  istride(1:nd) = stride(1:nd)
  iimap(1:nd) = imap(1:nd)
  ! --- do read ---
  iostat = nf90_get_var(ent%fileid, ent%varid, val, istart, cnt, istride, iimap)
  if (iostat == nf90_eindefine) then
    iostat = nf90_enddef(ent%fileid)
    if (iostat /= nf90_noerr) return
    iostat = nf90_get_var(ent%fileid, ent%varid, val, istart, cnt, istride, iimap)
    if (iostat /= nf90_noerr) return
    iostat = nf90_redef(ent%fileid)
    if (iostat /= nf90_noerr) return
  end if
  deallocate(istart, istride, iimap)
999 continue
end subroutine gdncvargetdouble
 
!>
!> @en
!> @brief Get variable data (int type)
!>
!> Reads data from a netCDF variable with array slicing support.
!> @enden
!>
!> @ja
!> @brief 変数データの取得 (int 型)
!>
!> netCDF 変数から配列スライシングをサポートしてデータを読み込みます。
!> @endja
!>
!> @param[in]  var    @en Variable handle @enden @ja 変数ハンドル @endja
!> @param[in]  start  @en Start indices for each dimension @enden @ja 各次元の開始インデックス @endja
!> @param[in]  cnt    @en Count of elements to read for each dimension @enden @ja 各次元の読み込み要素数 @endja
!> @param[in]  stride @en Stride (interval) for each dimension @enden @ja 各次元のストライド (間隔) @endja
!> @param[in]  imap   @en Memory mapping vector (see NetCDF manual NF_PUT_VARM_type) @enden
!>                    @ja メモリマッピングベクトル (NetCDF マニュアル NF_PUT_VARM_type 参照) @endja
!> @param[in]  siz    @en Size of val array @enden @ja val 配列のサイズ @endja
!> @param[out] val    @en Array to store read data @enden @ja 読み込んだデータを格納する配列 @endja
!> @param[out] iostat @en I/O status (NF90_NOERR on success) @enden @ja I/O ステータス (成功時 NF90_NOERR) @endja
!>
subroutine gdncvargetint(var, start, cnt, stride, imap, siz, val, iostat)
  use gtdata_netcdf_types,    only: gd_nc_variable
  use gtdata_netcdf_internal, only: gd_nc_variable_entry, vtable_lookup
  use netcdf, only:   &
    & nf90_noerr,     &
    & nf90_einval,    &
    & nf90_eindefine, &
    & nf90_get_var,   &
    & nf90_redef,     &
    & nf90_enddef
  implicit none
  type(gd_nc_variable), intent(in):: var
  integer, intent(in):: start(:)
  integer, intent(in):: cnt(:)
  integer, intent(in):: stride(:)
  integer, intent(in):: imap(:)
  ! NetCDF変数と内部データ配列のメモリ内構
  ! 造間のマッピングを指定する整数ベクトル.
  ! 詳しくは NetCDF マニュアル
  ! (NF_PUT_VARM_type 等 を参照のこと)
  integer, intent(in):: siz
  integer, intent(out):: val(siz)
  integer, intent(out):: iostat
  integer:: nd ! var が保持する変数が依存する次元変数の数
  type(gd_nc_variable_entry):: ent
  integer, allocatable:: istart(:), istride(:), iimap(:)
  continue
  iostat = vtable_lookup(var, ent)
  if (iostat /= nf90_noerr) goto 999
  ! --- nd check ---
  nd = 0
  if (associated(ent%dimids)) nd = size(ent%dimids)
  if (min(size(start), size(cnt), size(stride), size(imap)) < nd) then
    iostat = nf90_einval
    goto 999
  endif
  if (nd == 0) then
    iostat = nf90_get_var(ent%fileid, ent%varid, val(1), start)
    goto 999
  endif
  ! --- stride ovarwrite buffer ---
  allocate(istart(nd), istride(nd), iimap(nd))
  istart(1:nd) = start(1:nd)
  istride(1:nd) = stride(1:nd)
  iimap(1:nd) = imap(1:nd)
  ! --- do read ---
  iostat = nf90_get_var(ent%fileid, ent%varid, val, istart, cnt, istride, iimap)
  if (iostat == nf90_eindefine) then
    iostat = nf90_enddef(ent%fileid)
    if (iostat /= nf90_noerr) return
    iostat = nf90_get_var(ent%fileid, ent%varid, val, istart, cnt, istride, iimap)
    if (iostat /= nf90_noerr) return
    iostat = nf90_redef(ent%fileid)
    if (iostat /= nf90_noerr) return
  end if
  deallocate(istart, istride, iimap)
999 continue
end subroutine gdncvargetint