Class gtool_history_types
In: gtool/gtool_history/gtool_history_types.f90

gtool_history より提供される構造データ型

Derived types provided from "gtool_history"

Note that Japanese and English are described in parallel.

モジュールの概要や使用方法については, gtool_history を参照ください.

See "gtool_history" for brief and usage of this module.

Derived types

GT_HISTORY :gtool4 データ出力用
GT_HISTORY_AXIS :gtool4 データ座標軸情報
GT_HISTORY_VARINFO :gtool4 データ変数情報


Included Modules

dc_types dc_date_types gtdata_types

Public Instance methods

Derived Type :
initialized = .false. :logical
: 初期設定フラグ. Initialization flag
unlimited_index = 0 :integer
: 無制限次元の ID. ID of unlimited dimension.
unlimited_units = ’’ :character(TOKEN)
: 無制限次元の単位. Units of unlimited dimension.
unlimited_units_symbol = UNIT_SYMBOL_ERR :integer
: 無制限次元の単位. Units of unlimited dimension.
dimvars(:) =>null() :type(GT_VARIABLE), pointer
: 次元変数 ID配列. it is index of dimvars(:), not that of vars(:).
dim_value_written(:) =>null() :logical, pointer
: 各次元が記述済みかどうか
origin :type(DC_DIFFTIME)
interval :type(DC_DIFFTIME)
newest :type(DC_DIFFTIME)
oldest :type(DC_DIFFTIME)
origin_setting = .false. :logical
: 時間の原点が明示的に設定されたか.
vars(:) =>null() :type(GT_VARIABLE), pointer
: 変数 ID 配列
growable_indices(:) =>null() :integer, pointer
: 無制限次元の添字 (無制限次元が無い時は 0)
count(:) =>null() :integer, pointer
: 各配列の無制限次元の配列長
var_avr_count(:) =>null() :integer, pointer
: 各変数の時間平均値出力の際の積算回数. -1 の場合は出力データを平均化しない.

Number of times of integral for time-averaged value output of each variable. -1 disables average value output

var_avr_data(:) =>null() :type(GT_HISTORY_AVRDATA), pointer
: 時間平均値を出力するためのデータ一時保管用配列.

Array for temporary keeping data for time-averaged value output

var_avr_firstput(:) =>null() :logical, pointer
: 一度目の出力を示すフラグ.

Flag for first output

var_avr_coefsum(:) =>null() :real(DP), pointer
: 各変数の時間平均値蓄積の際の係数の合計値.

Summation of coefficients for integral of time-averaged value of each variable

var_avr_baseint(:) =>null() :type(DC_DIFFTIME), pointer
: 各変数の時間平均値出力のための基本時間間隔.

Basic interval of time for output of time-averaged value of each variable

var_avr_prevtime(:) =>null() :type(DC_DIFFTIME), pointer
: 各変数の時間平均値出力のための前回の時刻保管.

Store keeping of previous time for output of time-averaged value of each variable

time_bnds(1:2) = 0.0_DP :real(DP)
: "time_bnds" 変数に出力されるデータ.

Data that is to be output in "time_bnds" variable

time_bnds_output_count = 0 :integer
: "time_bnds" 変数に出力された回数.

Number of output in "time_bnds" variable

time_nv_index = 0 :integer
: time_nv 次元の ID. ID of dimension "time_nv"
mpi_myrank = -1 :integer
: MPI におけるノード番号. Node number of MPI
mpi_nprocs = -1 :integer
: MPI における全ノード数. Number of all nodes of MPI
mpi_gather = .false. :logical
: ファイルを統合して出力するフラグ. Flag for integration of files
mpi_split = .false. :logical
: ファイルを分割して出力するフラグ. Flag for split of files
mpi_fileinfo =>null() :type(GT_HISTORY_MPIFILEINFO), pointer
: ファイルに関する情報 Information about file
mpi_dimdata_all(:) =>null() :type(GT_HISTORY_MPIAXISDATA), pointer
: 全体の軸データを保管するための配列. Array for keeping data of axes in whole area.
mpi_dimdata_each(:) =>null() :type(GT_HISTORY_MPIAXISDATA), pointer
: 個々のノードでの軸データを保管するための配列. Array for keeping data of axes on each node.
mpi_gthr_info(:) =>null() :type(GT_HISTORY_MPIAXISINFO), pointer
: データを一箇所に集約する際に必要な情報. Information for integration of data.
mpi_varinfo(:) =>null() :type(GT_HISTORY_VARINFO), pointer
: 変数情報. Information of variables
mpi_vars_index(:) =>null() :type(GT_HISTORY_MPIVARINDEX), pointer
: 各変数の配列添字情報. Indexes of array of each variable

gtool4 netCDF データの出力用構造体

この型の変数は HistoryCreate によって初期設定される必要があります。 初期設定後、データ出力用の複数のサブルーチンによって利用されます。 最終的には HistoryClose によって終了処理してください。

この構造体の内部の要素は非公開になっています。 問い合わせの際には HistoryInquire を利用してください。

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 . Note that the resultant file is undefined if you forget to finalize it.

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. However, it is not mandatory. When you are going to write ONLY one dataset, argument history of all subroutine calls can be omitted, and the history entity will be internally managed within this module.

Derived Type :
attrname :character(TOKEN)
: 属性の名前
attrtype :character(TOKEN)
: 属性の値の型
array = .false. :logical
: 属性の値が配列かどうか
Charvalue :character(STRING)
: 属性の値 (文字型変数)
Intvalue :integer
: 属性の値 (整数型変数)
Realvalue :real
: 属性の値 (単精度実数型変数)
Doublevalue :real(DP)
: 属性の値 (倍精度実数型変数)
Logicalvalue :logical
: 属性の値 (論理型変数)
Intarray(:) =>null() :integer ,pointer
: 属性の値 (整数型配列)
Realarray(:) =>null() :real ,pointer
: 属性の値 (単精度実数型配列)
Doublearray(:) =>null() :real(DP) ,pointer
: 属性の値 (倍精度実数型配列)

変数の属性情報の構造体. 外部参照はさせず, GT_HISTORY_VARINFO および GT_HISTORY_AXIS に内包されて利用されることを 想定している. 直接的にこの構造体を変数にとる サブルーチンは gtool_history_internal モジュール内の gtool_history_internal#append_attrs および gtool_history_internal#copy_attrs .

Derived Type :
a_DataAvr(:) =>null() :real(DP), pointer
length :integer


Array for temporary keeping data for time average value output.

Derived Type :
name = "" :character(TOKEN)
: 次元変数名
length = 0 :integer
: 次元長 (配列サイズ)
longname = "" :character(STRING)
: 次元変数の記述的名称
units = "" :character(STRING)
: 次元変数の単位
xtype = "" :character(TOKEN)
: 次元変数の型
attrs(:) =>null() :type(GT_HISTORY_ATTR), pointer
: 属性情報群


この型の変数は HistoryAxisCreate, HistoryAxisCopy, HistoryInquire によって初期設定される必要があります。 初期設定後、HistoryCreate の axes に与えます。

問い合わせは HistoryAxisInquire によって行います。 属性の付加は HistoryAxisAddAttr によって行います。 初期化は HistoryAxisClear によって行います。

This type may be used as a argument axes of HistoryCreate to define features of axes of a history dataset. Typically, a constant array of this type will be used for fixed specification.

Derived Type :
a_Axis(:) =>null() :real(DP), pointer
length = -1 :integer
attrs(:) =>null() :type(GT_HISTORY_ATTR), pointer
: 座標の属性 (HistoryCreate2 が呼ばれた場合に使用) Attributes of axes (this is used when HistoryCreate2 is used)

MPI 使用時に, 軸データを保管するための配列.

Array for keeping data of axes when MPI is used.

Derived Type :
index_all(:,:) =>null() :integer, pointer
length(:) =>null() :integer, pointer

MPI 使用時に, データを一箇所に集約する際に必要な情報.

Information for integration of data when MPI is used.

Derived Type :
already_output = .false. :logical
axes(:) =>null() :type(GT_HISTORY_AXIS), pointer
overwrite :logical
file :character(STRING)
title :character(STRING)
source :character(STRING)
institution :character(STRING)
conventions :character(STRING)
gt_version :character(TOKEN)
gtver_add :logical
quiet :logical
nc_history :character(STRING)

MPI 使用時に, ファイルに書き出す基本情報. (各ノード上のデータを統合して一つのファイルに出力する際に使用)

Basic information output to a file when MPI is used. (This is used when data on each node is integrated and output to one file )

Derived Type :
each2all(:,:) =>null() :integer, pointer
allcount(:) =>null() :integer, pointer
allcount_all = 0 :integer

MPI 使用時に, データを一箇所に集約する際に必要な情報.

Information for integration of data when MPI is used.

Derived Type :
name = "" :character(TOKEN)
: 変数名
dims(:) =>null() :character(TOKEN), pointer
: 依存する次元
longname = "" :character(STRING)
: 変数の記述的名称
units = "" :character(STRING)
: 変数の単位
xtype = "" :character(TOKEN)
: 変数の型
attrs(:) =>null() :type(GT_HISTORY_ATTR), pointer
: 属性情報群
time_average = .false. :logical
: 時間平均
initialized = .false. :logical
: 初期設定フラグ. Initialization flag


この型の変数は HistoryVarinfoCreate, HistoryVarinfoCopy, HistoryInquire によって初期設定される必要があります。 初期設定後、HistoryAddVariable の varinfo に与えます。

問い合わせは HistoryVarinfoInquire によって行います。 属性の付加は HistoryVarinfoAddAttr によって行います。 初期化は HistoryVarinfoClear によって行います。

This type may be used as a argument varinfo of HistoryAddVariable to define features of variable of a history dataset.