gtool_historyauto.f90

Go to the documentation of this file.

!> @file gtool_historyauto.f90
!>
!> @author Yasuhiro MORIKAWA
!> @copyright Copyright (C) GFD Dennou Club, 2008-2026. All rights reserved. <br/>
!>            License is BSD-2-Clause. See [COPYRIGHT](@ref COPYRIGHT) in detail
!>
!> @en
!> @brief Interface of Output of gtool4 netCDF data (For large models)
!> @enden
!>
!> @ja
!> @brief gtool4 netCDF データの出力インターフェース (大規模モデル用)
!> @endja
 
module gtool_historyauto
  !>
  !> @en
  !> @brief Interface of Input/Output of gtool4 netCDF data (For large models)
  !>
  !> <b>Note that Japanese and English are described in parallel.</b>
  !>
  !> "gtool_historyauto" module is an application of "gtool_history" module,
  !> and provides data output easy-to-use interfaces
  !> for large numerical models that output many variables.
  !> This module has following features.
  !>
  !> - In case that multiple files are output,
  !>   gtool_history_generic::HistoryCreate must be called many times at each file
  !>   using "gtool_history" module, while
  !>   gtool_historyauto_generic::HistoryAutoCreate has to be called once in a numerical model
  !>   using this module.
  !> - Output filename or output interval, etc can be changed easily.
  !>   In practice, their settings are changed by arguments of
  !>   gtool_historyauto_generic::HistoryAutoAddVariable or NAMELIST gtool_historyauto_nml.
  !> - gtool_history_types::GT_HISTORY need not be used.
  !>
  !> ### Tutorial
  !>
  !> - Gtool5 official tutorial:
  !>   - Data output for models that output many files (JAPANESE only)
  !>   - Descriptions of used subroutines (JAPANESE only)
  !>
  !> ### Procedures list
  !>
  !> See gtool_historyauto_generic.
  !>
  !> ### NAMELIST
  !>
  !> NAMELIST gtool_historyauto_nml
  !>
  !> ### Acknowledgment
  !>
  !> - gt4_historyauto
  !>   (document is written by Japanese)
  !>   that is an application of "gt4_history"
  !>   by Horinouchi is referred when this module is created.
  !> @enden
  !>
  !> @ja
  !> @brief gtool4 netCDF データの入出力インターフェース (大規模モデル用)
  !>
  !> gtool_historyauto モジュールは gtool_history モジュールの応用版であり,
  !> 多数の変数を出力する大規模な数値モデルを想定した,
  !> データ出力のための簡便なインターフェースを提供します.
  !> このモジュールは以下のような特徴を持ちます.
  !>
  !> - 複数のファイルへの出力を行う場合,
  !>   gtool_history モジュールではファイルごとに
  !>   gtool_history_generic::HistoryCreate を何度も
  !>   呼び出す必要がありましたが, このモジュールでは
  !>   gtool_historyauto_generic::HistoryAutoCreate をモデル内で一度呼び出すだけで済みます.
  !> - 個別の変数について, 出力ファイルや出力間隔を手軽に変更可能です.
  !>   実際には, gtool_historyauto_generic::HistoryAutoAddVariable の引数もしくは,
  !>   NAMELIST gtool_historyauto_nml によって変更することが可能です.
  !> - gtool_history_types::GT_HISTORY 構造体を直接使用することなく
  !>   出力を行うことが可能となっています.
  !>
  !> ### チュートリアル
  !>
  !> - gtool5 オフィシャルチュートリアル:
  !>   - 多数のファイル出力を行うモデルでのデータ出力
  !>   - 使われているサブルーチンの説明
  !>
  !> ### 手続リスト
  !>
  !> gtool_historyauto_generic を参照ください.
  !>
  !> ### NAMELIST
  !>
  !> NAMELIST gtool_historyauto_nml
  !>
  !> ### 謝辞
  !>
  !> - このモジュールは, 堀之内氏による gt4_history の
  !>   アプリケーション gt4_historyauto を参考にして作成しました.
  !> @endja
  !>
 
  use gtool_historyauto_generic
 
end module gtool_historyauto