gtool_history.f90

Go to the documentation of this file.

!> @file gtool_history.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 for Input/Output of gtool4 netCDF data
!> @enden
!>
!> @ja
!> @brief gtool4 netCDF データの入出力インターフェース
!> @endja
 
!>
!> @en
!> @brief Interface for Input/Output of gtool4 netCDF data
!>
!> This module is designed for output to gtool4 netCDF dataset
!> sequentially along an axis (the "time" axis).
!>
!> For procedures, see gtool_history_generic.
!> For derived types, see gtool_history_types.
!> A Fortran 77 interface (HSPACK) is also available.
!>
!> @section usage Usage
!> @code
!> use gtool_history
!> @endcode
!> @enden
!>
!> @ja
!> @brief gtool4 netCDF データの入出力インターフェース
!>
!> gtool_history モジュールは、数値モデルの結果を
!> gtool4 netCDF 規約に基づくデータ形式
!> (以降、gtool4 データと呼びます) で出力するためのインターフェースです。
!> 主に時間積分の結果を等時間間隔で出力することを念頭においています。
!>
!> 手続き一覧は gtool_history_generic を参照してください。
!> 構造データ型は gtool_history_types を参照してください。
!> Fortran 77 用インターフェース (HSPACK) も用意しています。
!>
!> @section prepare 使用方法
!> @code
!> use gtool_history
!> @endcode
!>
!> @section conventions gtool4 netCDF 規約との対応
!>
!> バージョン gtool4_netCDF_version に対応しています。
!>
!> 出力データには以下の大域属性を必ず与えます:
!> - Conventions: gtool_history_internal の gtool4_netCDF_Conventions
!> - gt_version: gtool_history_internal の gtool4_netCDF_version
!> - title, source, institution: ユーザ指定
!> - history: 自動生成 (ユーザ名、時刻、HistoryCreate 呼び出し情報)
!>
!> 変数には以下の属性を与えます:
!> - long_name, units: ユーザ指定
!>
!> @note 現在の gtool_history は属性の解釈を行いません。
!> HistoryCopyVariable は変数コピー時に全属性を引き継ぎます。
!> @endja
!>
module gtool_history
  use gtool_history_types
  use gtool_history_generic
  implicit none
 
end module gtool_history