gtdata_netcdf_file_generic.f90

Go to the documentation of this file.

!>
!> @file gtdata_netcdf_file_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 Interface specifications for netCDF file open/close procedures
!> @enden
!>
!> @ja
!> @brief netCDF ファイルのオープンクローズに関する手続きの引用仕様
!> @endja
!>
 
!>
!> @en
!> @brief Interface specifications for netCDF file open/close procedures
!>
!> This module provides interface declarations for procedures that handle
!> opening, closing, and managing netCDF files.
!>
!> | Procedure | Description |
!> |-----------|-------------|
!> | GDNcFileOpen | Open a netCDF file |
!> | GDNcFileClose | Close a netCDF file |
!> | GDNcFileReopen | Increment reference count of an open file |
!> | GDNcFileDataMode | Switch to data mode |
!> | GDNcFileDefineMode | Switch to define mode |
!> | GDNcFileSync | Synchronize file to disk |
!> | GDNcFileInquire | Inquire file properties |
!>
!> @enden
!>
!> @ja
!> @brief netCDF ファイルのオープンクローズに関する手続きの引用仕様
!>
!> このモジュールは netCDF ファイルのオープン、クローズ、管理を行う
!> 手続きのインターフェース宣言を提供します。
!>
!> | 手続き | 説明 |
!> |--------|------|
!> | GDNcFileOpen | netCDF ファイルを開く |
!> | GDNcFileClose | netCDF ファイルを閉じる |
!> | GDNcFileReopen | オープン中ファイルの参照カウントを増加 |
!> | GDNcFileDataMode | データモードに切り替え |
!> | GDNcFileDefineMode | 定義モードに切り替え |
!> | GDNcFileSync | ファイルをディスクに同期 |
!> | GDNcFileInquire | ファイル属性を取得 |
!>
!> @endja
!>
module gtdata_netcdf_file_generic
  !
  use dc_types, only: string
  use dc_trace, only: beginsub, endsub, dbgmessage
 
  implicit none
  private
 
  public:: gdncfileopen, gdncfileclose, gdncfilereopen
  public:: gdncfiledatamode, gdncfiledefinemode, gdncfilesync
  public:: gdncfileinquire
 
  interface
    !>
    !> @en
    !> @brief Open a netCDF file
    !> @enden
    !> @ja
    !> @brief netCDF ファイルを開く
    !> @endja
    !>
    !> @param[out] fileid   @en File ID @enden @ja ファイル ID @endja
    !> @param[in]  filename @en File name @enden @ja ファイル名 @endja
    !> @param[in]  writable @en Writable flag (optional) @enden @ja 書込可能フラグ (省略可能) @endja
    !> @param[in]  overwrite @en Overwrite existing file (optional) @enden @ja 既存ファイル上書きフラグ (省略可能) @endja
    !> @param[out] stat     @en Status code (optional) @enden @ja ステータスコード (省略可能) @endja
    !> @param[out] err      @en Error flag (optional) @enden @ja エラーフラグ (省略可能) @endja
    !>
    subroutine gdncfileopen(fileid, filename, writable, overwrite, stat, err)
      integer, intent(out):: fileid
      character(len = *), intent(in):: filename
      logical, intent(in), optional:: writable
      logical, intent(in), optional:: overwrite
      logical, intent(out), optional:: err
      integer, intent(out), optional:: stat
    end subroutine gdncfileopen
  end interface
 
  interface
    !>
    !> @en
    !> @brief Close a netCDF file
    !> @enden
    !> @ja
    !> @brief netCDF ファイルを閉じる
    !> @endja
    !>
    !> @param[in]  fileid @en File ID @enden @ja ファイル ID @endja
    !> @param[out] err    @en Error flag (optional) @enden @ja エラーフラグ (省略可能) @endja
    !>
    subroutine gdncfileclose(fileid, err)
      integer, intent(in):: fileid
      logical, intent(out), optional:: err
    end subroutine gdncfileclose
  end interface
 
  interface
    !>
    !> @en
    !> @brief Increment reference count of an open netCDF file
    !> @enden
    !> @ja
    !> @brief オープン中の netCDF ファイルの参照カウントを増加
    !> @endja
    !>
    !> @param[in]  fileid @en File ID @enden @ja ファイル ID @endja
    !> @param[out] err    @en Error flag (optional) @enden @ja エラーフラグ (省略可能) @endja
    !>
    subroutine gdncfilereopen(fileid, err)
      integer, intent(in):: fileid
      logical, intent(out), optional:: err
    end subroutine gdncfilereopen
  end interface
 
  interface
    !>
    !> @en
    !> @brief Switch netCDF file to data mode
    !> @enden
    !> @ja
    !> @brief netCDF ファイルをデータモードに切り替え
    !> @endja
    !>
    !> @param[in] fileid @en File ID @enden @ja ファイル ID @endja
    !> @return           @en Status code from nf90_enddef @enden @ja nf90_enddef のステータスコード @endja
    !>
    integer function gdncfiledatamode(fileid) result(result)
      integer, intent(in):: fileid
    end function gdncfiledatamode
  end interface
 
  interface
    !>
    !> @en
    !> @brief Switch netCDF file to define mode
    !> @enden
    !> @ja
    !> @brief netCDF ファイルを定義モードに切り替え
    !> @endja
    !>
    !> @param[in] fileid @en File ID @enden @ja ファイル ID @endja
    !> @return           @en Status code from nf90_redef @enden @ja nf90_redef のステータスコード @endja
    !>
    integer function gdncfiledefinemode(fileid) result(result)
      integer, intent(in):: fileid
    end function gdncfiledefinemode
  end interface
 
  interface
    !>
    !> @en
    !> @brief Synchronize netCDF file to disk
    !> @enden
    !> @ja
    !> @brief netCDF ファイルをディスクに同期
    !> @endja
    !>
    !> @param[in]  fileid @en File ID (optional, sync all if omitted) @enden @ja ファイル ID (省略時は全ファイルを同期) @endja
    !> @param[out] stat   @en Status code (optional) @enden @ja ステータスコード (省略可能) @endja
    !>
    subroutine gdncfilesync(fileid, stat)
      integer, intent(in), optional:: fileid
      integer, intent(out), optional:: stat
    end subroutine gdncfilesync
  end interface
 
  !> @private
  !> @en Not public, so not placed in gtdata_netcdf_generic @enden
  !> @ja 非公開なので gtdata_netcdf_generic には置かない @endja
  interface gdncfileinquire
    !>
    !> @en
    !> @brief Inquire the file name of an open netCDF file
    !> @enden
    !> @ja
    !> @brief オープン中の netCDF ファイルのファイル名を取得
    !> @endja
    !>
    !> @param[in]  fileid @en File ID @enden @ja ファイル ID @endja
    !> @param[out] name   @en File name @enden @ja ファイル名 @endja
    !>
    subroutine gdncfileinquirename(fileid, name)
      integer, intent(in):: fileid
      character(len = *), intent(out):: name
    end subroutine gdncfileinquirename
  end interface
 
end module gtdata_netcdf_file_generic