gtool_history_types.f90

Go to the documentation of this file.

!> @file gtool_history_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 types provided from gtool_history
!> @enden
!>
!> @ja
!> @brief gtool_history より提供される構造データ型
!> @endja
 
!>
!> @en
!> @brief Derived types provided from gtool_history
!>
!> See gtool_history for overview and usage of this module.
!>
!> Derived types:
!> - GT_HISTORY: gtool4 data output structure
!> - GT_HISTORY_AXIS: gtool4 axis information
!> - GT_HISTORY_VARINFO: gtool4 variable information
!> @enden
!>
!> @ja
!> @brief gtool_history より提供される構造データ型
!>
!> モジュールの概要や使用方法については gtool_history を参照してください。
!>
!> 構造データ型:
!> - GT_HISTORY: gtool4 データ出力用
!> - GT_HISTORY_AXIS: gtool4 データ座標軸情報
!> - GT_HISTORY_VARINFO: gtool4 データ変数情報
!> @endja
!>
module gtool_history_types
 
  use dc_types, only: string, token, dp, sp
  use dc_date_types, only: dc_difftime, unit_symbol_err
  use gtdata_types, only: gt_variable
  implicit none
  private
 
  public:: gt_history, gt_history_axis, gt_history_varinfo
  public:: gt_history_attr, gt_history_avrdata
  public:: gt_history_mpifileinfo, gt_history_mpiaxisdata
  public:: gt_history_mpiaxisinfo, gt_history_mpivarindex
 
  !>
  !> @en
  !> @brief Structure for gtool4 netCDF data output
  !>
  !> Data entity of this type represents a netCDF dataset
  !> controlled by gtool5 library.
  !> It must be initialized by HistoryCreate,
  !> then used in many subroutines, and must be finalized by
  !> HistoryClose.
  !>
  !> Users are recommended to retain the object of this type
  !> returned by HistoryCreate, to use it as the last argument
  !> called history for all following subroutine calls.
  !> When writing only one dataset, the history argument can be omitted.
  !> @enden
  !>
  !> @ja
  !> @brief gtool4 netCDF データの出力用構造体
  !>
  !> この型の変数は HistoryCreate によって初期設定される必要があります。
  !> 初期設定後、データ出力用の複数のサブルーチンによって利用されます。
  !> 最終的には HistoryClose によって終了処理してください。
  !>
  !> この構造体の内部の要素は非公開になっています。
  !> 問い合わせの際には HistoryInquire を利用してください。
  !> @endja
  !>
  type gt_history
 
    logical:: initialized = .false.
    ! 初期設定フラグ.
    ! Initialization flag
    integer:: unlimited_index = 0
    ! 無制限次元の ID.
    ! ID of unlimited dimension.
    character(TOKEN):: unlimited_units = ''
    ! 無制限次元の単位.
    ! Units of unlimited dimension.
    integer:: unlimited_units_symbol = unit_symbol_err
    ! 無制限次元の単位.
    ! Units of unlimited dimension.
    type(gt_variable), pointer:: dimvars(:) =>null()
    ! 次元変数 ID配列.
    ! it is index of dimvars(:),
    ! not that of vars(:).
    logical, pointer:: dim_value_written(:) =>null()
    ! 各次元が記述済みかどうか
    real(dp):: origin, interval, newest, oldest
    ! 単位は HistoryCreate の units 中で無制限次元
    ! に対応するものになる.
    logical:: origin_setting = .false.
    ! 時間の原点が明示的に設定されたか.
    type(gt_variable), pointer:: vars(:) =>null()
    ! 変数 ID 配列
    integer, pointer:: growable_indices(:) =>null()
    ! 無制限次元の添字
    ! (無制限次元が無い時は 0)
    integer, pointer:: count(:) =>null()
    ! 各配列の無制限次元の配列長
    integer, pointer:: var_avr_count(:) =>null()
    ! 各変数の時間平均値出力の際の積算回数.
    ! -1 の場合は出力データを平均化しない.
    !
    ! Number of times of integral
    ! for time-averaged value output of each variable.
    ! -1 disables average value output
    type(gt_history_avrdata), pointer:: var_avr_data(:) =>null()
    ! 時間平均値を出力するためのデータ一時保管用配列.
    !
    ! Array for temporary keeping data for
    ! time-averaged value output
    logical, pointer:: var_avr_firstput(:) =>null()
    ! 一度目の出力を示すフラグ.
    !
    ! Flag for first output
    real(dp), pointer:: var_avr_coefsum(:) =>null()
    ! 各変数の時間平均値蓄積の際の係数の合計値.
    !
    ! Summation of coefficients for integral
    ! of time-averaged value of each variable
    real(dp), pointer:: var_avr_baseint(:) =>null()
    ! 各変数の時間平均値出力のための基本時間間隔.
    !
    ! Basic interval of time for output
    ! of time-averaged value of each variable
    real(dp), pointer:: var_avr_prevtime(:) =>null()
    ! 各変数の時間平均値出力のための前回の時刻保管.
    !
    ! Store keeping of previous time for output
    ! of time-averaged value of each variable
    real(dp):: time_bnds(1:2) = 0.0_dp
    ! "time_bnds" 変数に出力されるデータ.
    !
    ! Data that is to be output in "time_bnds"
    ! variable
    integer:: time_bnds_output_count = 0
    ! "time_bnds" 変数に出力された回数.
    !
    ! Number of output in "time_bnds" variable
    integer:: time_nv_index = 0
    ! time_nv 次元の ID.
    ! ID of dimension "time_nv"
 
    ! MPI 関連の変数
    ! Variables for MPI
    !
    integer:: mpi_myrank = -1
    ! MPI におけるノード番号. Node number of MPI
    integer:: mpi_nprocs = -1
    ! MPI における全ノード数. Number of all nodes of MPI
    logical:: mpi_gather = .false.
    ! ファイルを統合して出力するフラグ.
    ! Flag for integration of files
    logical:: mpi_split = .false.
    ! ファイルを分割して出力するフラグ.
    ! Flag for split of files
    type(gt_history_mpifileinfo), pointer:: mpi_fileinfo =>null()
    ! ファイルに関する情報
    ! Information about file
    type(gt_history_mpiaxisdata), pointer:: mpi_dimdata_all(:) =>null()
    ! 全体の軸データを保管するための配列.
    ! Array for keeping data of axes in whole area.
    type(gt_history_mpiaxisdata), pointer:: mpi_dimdata_each(:) =>null()
    ! 個々のノードでの軸データを保管するための配列.
    ! Array for keeping data of axes on each node.
    type(gt_history_mpiaxisinfo), pointer:: mpi_gthr_info(:) =>null()
    ! データを一箇所に集約する際に必要な情報.
    ! Information for integration of data.
    type(gt_history_varinfo), pointer:: mpi_varinfo(:) =>null()
    ! 変数情報.
    ! Information of variables
    type(gt_history_mpivarindex), pointer:: mpi_vars_index(:) =>null()
    ! 各変数の配列添字情報.
    ! Indexes of array of each variable
  end type gt_history
 
  !> @en
  !> @brief Array for temporary keeping data for time average value output
  !> @enden
  !> @ja
  !> @brief 時間方向の平均値を出力するためのデータ一時保管用配列
  !> @endja
  type gt_history_avrdata
    real(dp), pointer:: a_dataavr(:) =>null()
    integer:: length
  end type gt_history_avrdata
 
  !>
  !> @en
  !> @brief Structure for axis information
  !>
  !> This type may be used as the argument axes of HistoryCreate
  !> to define features of axes of a history dataset.
  !> Initialize with HistoryAxisCreate, HistoryAxisCopy, or HistoryInquire.
  !> Query with HistoryAxisInquire. Add attributes with HistoryAxisAddAttr.
  !> Clear with HistoryAxisClear.
  !> @enden
  !>
  !> @ja
  !> @brief 座標軸情報を格納する構造体
  !>
  !> この型の変数は HistoryAxisCreate, HistoryAxisCopy, HistoryInquire
  !> によって初期設定される必要があります。
  !> 初期設定後、HistoryCreate の axes に与えます。
  !> 問い合わせは HistoryAxisInquire、属性付加は HistoryAxisAddAttr、
  !> 初期化は HistoryAxisClear によって行います。
  !> @endja
  !>
  type gt_history_axis
    character(TOKEN) :: name     = "" ! 次元変数名
    integer          :: length   = 0  ! 次元長 (配列サイズ)
    character(STRING):: longname = "" ! 次元変数の記述的名称
    character(STRING):: units    = "" ! 次元変数の単位
    character(TOKEN) :: xtype    = "" ! 次元変数の型
    type(gt_history_attr), pointer:: attrs(:) =>null() ! 属性情報群
  end type gt_history_axis
 
 
  !>
  !> @en
  !> @brief Structure for variable information
  !>
  !> This type may be used as the argument varinfo of HistoryAddVariable
  !> to define features of a variable of a history dataset.
  !> Initialize with HistoryVarinfoCreate, HistoryVarinfoCopy, or HistoryInquire.
  !> Query with HistoryVarinfoInquire. Add attributes with HistoryVarinfoAddAttr.
  !> Clear with HistoryVarinfoClear.
  !> @enden
  !>
  !> @ja
  !> @brief 変数情報を格納する構造体
  !>
  !> この型の変数は HistoryVarinfoCreate, HistoryVarinfoCopy,
  !> HistoryInquire によって初期設定される必要があります。
  !> 初期設定後、HistoryAddVariable の varinfo に与えます。
  !> 問い合わせは HistoryVarinfoInquire、属性付加は HistoryVarinfoAddAttr、
  !> 初期化は HistoryVarinfoClear によって行います。
  !> @endja
  !>
  type gt_history_varinfo
    character(TOKEN)          :: name     = ""     ! 変数名
    character(TOKEN), pointer :: dims(:)  =>null() ! 依存する次元
    character(STRING)         :: longname = ""     ! 変数の記述的名称
    character(STRING)         :: units    = ""     ! 変数の単位
    character(TOKEN)          :: xtype    = ""     ! 変数の型
    type(gt_history_attr), pointer:: attrs(:) =>null() ! 属性情報群
    logical:: time_average = .false.               ! 時間平均
    logical:: initialized = .false.
    ! 初期設定フラグ.
    ! Initialization flag
  end type gt_history_varinfo
 
  !> @en
  !> @brief Structure for attribute information
  !>
  !> @private
  !> Intended to be contained within GT_HISTORY_VARINFO and GT_HISTORY_AXIS.
  !> Directly used by gtool_history_internal#append_attrs and
  !> gtool_history_internal#copy_attrs.
  !> @enden
  !> @ja
  !> @brief 変数の属性情報の構造体
  !>
  !> @private
  !> GT_HISTORY_VARINFO および GT_HISTORY_AXIS に内包されて利用されます。
  !> 直接この構造体を扱うサブルーチンは gtool_history_internal の
  !> append_attrs および copy_attrs です。
  !> @endja
  type gt_history_attr
    character(TOKEN)    :: attrname                ! 属性の名前
    character(TOKEN)    :: attrtype                ! 属性の値の型
    logical             :: array = .false.         ! 属性の値が配列かどうか
    character(STRING)   :: charvalue               ! 属性の値 (文字型変数)
    integer             :: intvalue                ! 属性の値 (整数型変数)
    real(sp)            :: realvalue               ! 属性の値 (単精度実数型変数)
    real(dp)            :: doublevalue             ! 属性の値 (倍精度実数型変数)
    logical             :: logicalvalue            ! 属性の値 (論理型変数)
    integer,  pointer   :: intarray(:) =>null()    ! 属性の値 (整数型配列)
    real(sp), pointer   :: realarray(:) =>null()   ! 属性の値 (単精度実数型配列)
    real(dp), pointer   :: doublearray(:) =>null() ! 属性の値 (倍精度実数型配列)
  end type gt_history_attr
 
  !> @en
  !> @brief Basic file information for MPI output
  !>
  !> Used when data on each node is integrated and output to one file.
  !> @enden
  !> @ja
  !> @brief MPI 使用時のファイル書き出し基本情報
  !>
  !> 各ノード上のデータを統合して一つのファイルに出力する際に使用します。
  !> @endja
  type gt_history_mpifileinfo
    logical:: already_output = .false.
    type(gt_history_axis), pointer:: axes(:) =>null()
    logical:: overwrite
    character(STRING):: file
    character(STRING):: title
    character(STRING):: source
    character(STRING):: institution
    character(STRING):: conventions
    character(TOKEN):: gt_version
    logical:: gtver_add
    logical:: quiet
    character(STRING):: nc_history
  end type gt_history_mpifileinfo
 
  !> @en
  !> @brief Array for keeping axis data when MPI is used
  !> @enden
  !> @ja
  !> @brief MPI 使用時の軸データ保管用配列
  !> @endja
  type gt_history_mpiaxisdata
    real(dp), pointer:: a_axis(:) =>null()
    integer:: length = -1
    type(gt_history_attr), pointer:: attrs(:) =>null()
    ! 座標の属性 (HistoryCreate2 が呼ばれた場合に使用)
    ! Attributes of axes (this is used when HistoryCreate2 is used)
  end type gt_history_mpiaxisdata
 
  !> @en
  !> @brief Information for data integration when MPI is used
  !> @enden
  !> @ja
  !> @brief MPI 使用時のデータ集約情報
  !> @endja
  type gt_history_mpiaxisinfo
    integer, pointer:: index_all(:,:) =>null()
    integer, pointer:: length(:) =>null()
  end type gt_history_mpiaxisinfo
 
  !> @en
  !> @brief Variable index information for MPI data integration
  !> @enden
  !> @ja
  !> @brief MPI 使用時の変数配列添字情報
  !> @endja
  type gt_history_mpivarindex
    integer, pointer:: each2all(:,:) =>null()
    integer, pointer:: allcount(:) =>null()
    integer:: allcount_all = 0
  end type gt_history_mpivarindex
 
end module gtool_history_types