Class gtool_historyauto_generic
In: gtool/gtool_historyauto/gtool_historyauto_generic.f90

gtool_historyauto より提供される手続の引用仕様宣言

Interface of procedures provided from gtool_historyauto

Note that Japanese and English are described in parallel.

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

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

Procedures list

HistoryAutoCreate :初期化
HistoryAutoAddVariable :変数追加
HistoryAutoPut :データ出力
HistoryAutoClose :終了処理
HistoryAutoPutAxis :座標データ追加
HistoryAutoAddWeight :座標重み追加
HistoryAutoAddAttr :属性追加
HistoryAutoAllVarFix :登録変数の確定
HistoryAutoPutAxisMPI :領域全体の座標データ指定 (MPI 使用時のみ有効)
——————— :———————
HistoryAutoCreate :Initialization
HistoryAutoAddVariable :Addition of variables
HistoryAutoPut :Output of data
HistoryAutoClose :Termination
HistoryAutoPutAxis :Addition of data of axes
HistoryAutoAddWeight :Addition of weights of axes
HistoryAutoAddAttr :Addition of attributes
HistoryAutoAllVarFix :Fix register of variables
HistoryAutoPutAxisMPI :Specify data of axes in whole area (This is valid when MPI is used)

Methods

HistoryAutoAddAttr   HistoryAutoAddAttr   HistoryAutoAddAttr   HistoryAutoAddAttr   HistoryAutoAddAttr   HistoryAutoAddAttr   HistoryAutoAddAttr   HistoryAutoAddAttr   HistoryAutoAddVariable   HistoryAutoAddVariable   HistoryAutoAddWeight   HistoryAutoAddWeight   HistoryAutoAddWeight   HistoryAutoAllVarFix   HistoryAutoClose   HistoryAutoCreate   HistoryAutoCreate   HistoryAutoPut   HistoryAutoPut   HistoryAutoPut   HistoryAutoPut   HistoryAutoPut   HistoryAutoPut   HistoryAutoPut   HistoryAutoPut   HistoryAutoPut   HistoryAutoPut   HistoryAutoPut   HistoryAutoPut   HistoryAutoPut   HistoryAutoPut   HistoryAutoPut   HistoryAutoPut   HistoryAutoPut   HistoryAutoPut   HistoryAutoPut   HistoryAutoPut   HistoryAutoPut   HistoryAutoPut   HistoryAutoPut   HistoryAutoPut   HistoryAutoPutAxis   HistoryAutoPutAxis   HistoryAutoPutAxis   HistoryAutoPutAxisMPI   HistoryAutoPutAxisMPI   HistoryAutoPutAxisMPI  

Included Modules

dc_date_types dc_types

Public Instance methods

HistoryAutoAddAttr( varname, attrname, value )
Subroutine :
varname :character(*), intent(in)
: 変数の名前.

ここで指定するものは, HistoryAutoCreate の dims , または HistoryAutoAddWeight の varname で既に指定されてい なければなりません.

Name of a variable.

This must be specified with dims in HistoryAutoCreate, or varname in "HistoryAutoAddWeight".

attrname :character(*), intent(in)
: 属性の名前. Name of an attribute.
value :character(*), intent(in)
: 属性の値. Value of an attribute.

座標変数および座標重み変数に属性を付加します. このサブルーチンを用いる前に, HistoryAutoCreate による初期設定が 必要です.

  • 座標変数については, HistoryAutoCreate の "dims" に与えられた もののみ指定可能です.
  • 座標重み変数については, HistoryAutoAddWeight で与えられた もののみ指定可能です.
  • HistoryAutoAddAttr は複数のサブルーチンの総称名です. value にはいくつかの型を与えることが可能です. 下記のサブルーチンを参照ください.

Add attributes axes or weights of axes. Initialization by "HistoryAutoCreate" is needed before use of this subroutine.

Original external subprogram is gtool/gtool_historyauto/historyautoaddattr.f90#HistoryAutoAddAttrChar0

HistoryAutoAddAttr( varname, attrname, value )
Subroutine :
varname :character(*), intent(in)
attrname :character(*), intent(in)
value :integer, intent(in)

Original external subprogram is gtool/gtool_historyauto/historyautoaddattr.f90#HistoryAutoAddAttrInt0

HistoryAutoAddAttr( varname, attrname, value )
Subroutine :
varname :character(*), intent(in)
attrname :character(*), intent(in)
value :logical, intent(in)

Original external subprogram is gtool/gtool_historyauto/historyautoaddattr.f90#HistoryAutoAddAttrLogical0

HistoryAutoAddAttr( varname, attrname, value )
Subroutine :
varname :character(*), intent(in)
attrname :character(*), intent(in)
value :real(DP), intent(in)

Original external subprogram is gtool/gtool_historyauto/historyautoaddattr.f90#HistoryAutoAddAttrDouble0

HistoryAutoAddAttr( varname, attrname, value )
Subroutine :
varname :character(*), intent(in)
attrname :character(*), intent(in)
value :real, intent(in)

Original external subprogram is gtool/gtool_historyauto/historyautoaddattr.f90#HistoryAutoAddAttrReal0

HistoryAutoAddAttr( varname, attrname, value )
Subroutine :
varname :character(*), intent(in)
attrname :character(*), intent(in)
value(:) :integer, intent(in)

Original external subprogram is gtool/gtool_historyauto/historyautoaddattr.f90#HistoryAutoAddAttrInt1

HistoryAutoAddAttr( varname, attrname, value )
Subroutine :
varname :character(*), intent(in)
attrname :character(*), intent(in)
value(:) :real(DP), intent(in)

Original external subprogram is gtool/gtool_historyauto/historyautoaddattr.f90#HistoryAutoAddAttrDouble1

HistoryAutoAddAttr( varname, attrname, value )
Subroutine :
varname :character(*), intent(in)
attrname :character(*), intent(in)
value(:) :real, intent(in)

Original external subprogram is gtool/gtool_historyauto/historyautoaddattr.f90#HistoryAutoAddAttrReal1

HistoryAutoAddVariable( varname, dims, longname, units, [xtype], [time_units], [time_average], [file], origin, terminus, [interval], [slice_start], [slice_end], [slice_stride], [space_average], [newfile_interval] )
Subroutine :
varname :character(*), intent(in)
: 変数名. Variable name
dims(:) :character(*), intent(in)
: 変数が依存する次元の名前. 時間の次元は配列の最後に指定すること.

Names of dependency dimensions of a variable. Dimension of time must be specified to last of an array.

longname :character(*), intent(in)
: 変数の記述的名称.

Descriptive name of a variable

units :character(*), intent(in)
: 変数の単位.

Units of a variable

xtype :character(*), intent(in), optional
: 変数のデータ型

デフォルトは float (単精度実数型) であ る. 有効なのは, double (倍精度実数型), int (整数型) である. 指定しない 場合や, 無効な型を指定した場合には, float (単 精度実数型) となる.

Data types of dimensions specified with "dims".

Default value is "float" (single precision). Other valid values are "double" (double precision), "int" (integer). If no value or invalid value is specified, "float" is applied.

time_units :character(*), intent(in), optional
: 時刻次元の単位. Units of time dimension.
time_average :logical, intent(in), optional
: 出力データを時間平均する場合には .true. を与えます. デフォルトは .false. です.

If output data is averaged, specify ".true.". Default is ".false.".

file :character(*), intent(in), optional
: 出力ファイル名. Output file name.
origin :type(DC_DIFFTIME), intent(in)
: 出力開始時刻.

Start time of output.

terminus :type(DC_DIFFTIME), intent(in)
: 出力終了時刻.

End time of output.

interval :type(DC_DIFFTIME), intent(in), optional
: 出力時間間隔.

省略した場合, 自動的に 1.0 [sec] が設定されます.

Interval of output time.

If this argument is omitted, a value of 1.0 [sec] is specified automatically.

slice_start(:) :integer, intent(in), optional
: 空間方向の開始点.

省略した場合, 座標データの開始点が設定されます.

Start points of spaces.

If this argument is omitted, start points of dimensions are set.

slice_end(:) :integer, intent(in), optional
: 空間方向の終了点.

省略した場合, 座標データの終了点が設定されます.

End points of spaces.

If this argument is omitted, End points of dimensions are set.

slice_stride(:) :integer, intent(in), optional
: 空間方向の刻み幅.

省略した場合, 1 が設定されます.

Strides of spaces

If this argument is omitted, 1 is set.

space_average(:) :logical, intent(in), optional
: 平均化のフラグ.

.true. が指定される座標に対して平均化を 行います. 省略した場合, .false. が設定されます.

Flag of average.

Axes specified .true. are averaged. If this argument is omitted, .false. is set.

newfile_interval :integer, intent(in), optional
: ファイル分割時間間隔.

省略した場合, 時間方向へのファイル分割を行いません.

Interval of time of separation of a file.

If this argument is omitted, a files is not separated in time direction.

データ出力するための変数登録を行います.

HistoryAutoAllVarFix を呼ぶ前にこのサブルーチンを使用してください.

Register variables for history data output

Use this subroutine before "HistoryAutoAllVarFix" is called.

Original external subprogram is gtool/gtool_historyauto/historyautoaddvariable.f90#HistoryAutoAddVariable2

HistoryAutoAddVariable( varname, dims, longname, units, [xtype], [time_units], [time_average], [file], [origin], [terminus], [interval], [slice_start], [slice_end], [slice_stride], [space_average], [newfile_interval] )
Subroutine :
varname :character(*), intent(in)
: 変数名. Variable name
dims(:) :character(*), intent(in)
: 変数が依存する次元の名前. 時間の次元は配列の最後に指定すること.

Names of dependency dimensions of a variable. Dimension of time must be specified to last of an array.

longname :character(*), intent(in)
: 変数の記述的名称.

Descriptive name of a variable

units :character(*), intent(in)
: 変数の単位.

Units of a variable

xtype :character(*), intent(in), optional
: 変数のデータ型

デフォルトは float (単精度実数型) であ る. 有効なのは, double (倍精度実数型), int (整数型) である. 指定しない 場合や, 無効な型を指定した場合には, float (単 精度実数型) となる.

Data types of dimensions specified with "dims".

Default value is "float" (single precision). Other valid values are "double" (double precision), "int" (integer). If no value or invalid value is specified, "float" is applied.

time_units :character(*), intent(in), optional
: 時刻次元の単位. Units of time dimension.
time_average :logical, intent(in), optional
: 出力データを時間平均する場合には .true. を与えます. デフォルトは .false. です.

If output data is averaged, specify ".true.". Default is ".false.".

file :character(*), intent(in), optional
: 出力ファイル名. Output file name.
origin :real, intent(in), optional
: 出力開始時刻.

省略した場合, 自動的に 0.0 [sec] が 設定されます.

Start time of output.

If this argument is omitted, 0.0 [sec] is specified automatically.

terminus :real, intent(in), optional
: 出力終了時刻.

省略した場合, 数値モデルの実行が終了するまで 出力を行います.

End time of output.

If this argument is omitted, output is continued until a numerical model is finished.

interval :real, intent(in), optional
: 出力時間間隔.

省略した場合, 自動的に 1.0 [sec] が設定されます.

Interval of output time.

If this argument is omitted, a value of 1.0 [sec] is specified automatically.

slice_start(:) :integer, intent(in), optional
: 空間方向の開始点.

省略した場合, 座標データの開始点が設定されます.

Start points of spaces.

If this argument is omitted, start points of dimensions are set.

slice_end(:) :integer, intent(in), optional
: 空間方向の終了点.

省略した場合, 座標データの終了点が設定されます.

End points of spaces.

If this argument is omitted, End points of dimensions are set.

slice_stride(:) :integer, intent(in), optional
: 空間方向の刻み幅.

省略した場合, 1 が設定されます.

Strides of spaces

If this argument is omitted, 1 is set.

space_average(:) :logical, intent(in), optional
: 平均化のフラグ.

.true. が指定される座標に対して平均化を 行います. 省略した場合, .false. が設定されます.

Flag of average.

Axes specified .true. are averaged. If this argument is omitted, .false. is set.

newfile_interval :integer, intent(in), optional
: ファイル分割時間間隔.

省略した場合, 時間方向へのファイル分割を行いません.

Interval of time of separation of a file.

If this argument is omitted, a files is not separated in time direction.

データ出力するための変数登録を行います.

HistoryAutoAllVarFix を呼ぶ前にこのサブルーチンを使用してください.

Register variables for history data output

Use this subroutine before "HistoryAutoAllVarFix" is called.

Original external subprogram is gtool/gtool_historyauto/historyautoaddvariable.f90#HistoryAutoAddVariable1

HistoryAutoAddWeight( dim, weight, [units], [xtype] )
Subroutine :
dim :character(*), intent(in)
: 座標重みを設定する座標の名称.

ただし, ここで指定するもの は, HistoryAutoCreate の dims 既に指定されていなければなりません.

Name of axis to which "weight" are set.

Note that this value must be set as "dims" of "HistoryAutoCreate".

weight(:) :integer, intent(in)
: 座標重みデータ.

データ型は整数, 単精度実数型, 倍精度実数型のどれでもかまいません. ただし, ファイルへ出力される際には, xtype もしくは座標データの型へと 変換されます.

Weight of axis.

Integer, single or double precision are acceptable as data type. Note that when this is output to a file, data type is converted into "xtype" or type of the axis.

units :character(*), intent(in), optional
: 座標重みの単位. 省略した場合には, 座標の単位が 使用されます.

Units of axis weight. If this argument is omitted, unit of the dimension is used.

xtype :character(*), intent(in), optional
: 座標重みのデータ型. 省略した場合には, 座標のデータ型が 使用されます.

Data type of weight of the dimension. If this argument is omitted, data type of the dimension is used.

座標の重みデータを設定します.

Set weights of axes.

Original external subprogram is gtool/gtool_historyauto/historyautoaddweight.f90#HistoryAutoAddWeightInt

HistoryAutoAddWeight( dim, weight, [units], [xtype] )
Subroutine :
dim :character(*), intent(in)
: 座標重みを設定する座標の名称.

ただし, ここで指定するもの は, HistoryAutoCreate の dims 既に指定されていなければなりません.

Name of axis to which "weight" are set.

Note that this value must be set as "dims" of "HistoryAutoCreate".

weight(:) :real(DP), intent(in)
: 座標重みデータ.

データ型は整数, 単精度実数型, 倍精度実数型のどれでもかまいません. ただし, ファイルへ出力される際には, xtype もしくは座標データの型へと 変換されます.

Weight of axis.

Integer, single or double precision are acceptable as data type. Note that when this is output to a file, data type is converted into "xtype" or type of the axis.

units :character(*), intent(in), optional
: 座標重みの単位. 省略した場合には, 座標の単位が 使用されます.

Units of axis weight. If this argument is omitted, unit of the dimension is used.

xtype :character(*), intent(in), optional
: 座標重みのデータ型. 省略した場合には, 座標のデータ型が 使用されます.

Data type of weight of the dimension. If this argument is omitted, data type of the dimension is used.

座標の重みデータを設定します.

Set weights of axes.

Original external subprogram is gtool/gtool_historyauto/historyautoaddweight.f90#HistoryAutoAddWeightDouble

HistoryAutoAddWeight( dim, weight, [units], [xtype] )
Subroutine :
dim :character(*), intent(in)
: 座標重みを設定する座標の名称.

ただし, ここで指定するもの は, HistoryAutoCreate の dims 既に指定されていなければなりません.

Name of axis to which "weight" are set.

Note that this value must be set as "dims" of "HistoryAutoCreate".

weight(:) :real, intent(in)
: 座標重みデータ.

データ型は整数, 単精度実数型, 倍精度実数型のどれでもかまいません. ただし, ファイルへ出力される際には, xtype もしくは座標データの型へと 変換されます.

Weight of axis.

Integer, single or double precision are acceptable as data type. Note that when this is output to a file, data type is converted into "xtype" or type of the axis.

units :character(*), intent(in), optional
: 座標重みの単位. 省略した場合には, 座標の単位が 使用されます.

Units of axis weight. If this argument is omitted, unit of the dimension is used.

xtype :character(*), intent(in), optional
: 座標重みのデータ型. 省略した場合には, 座標のデータ型が 使用されます.

Data type of weight of the dimension. If this argument is omitted, data type of the dimension is used.

座標の重みデータを設定します.

Set weights of axes.

Original external subprogram is gtool/gtool_historyauto/historyautoaddweight.f90#HistoryAutoAddWeightReal

HistoryAutoAllVarFix( )
Subroutine :

このサブルーチンは以下の動作を行います.

  • NAMELIST から読み込んだ変数名に無効なものが存在したかどうかをチェック.
  • HistoryAutoAddVariable で登録した変数名を印字.

このサブルーチンを呼んだ後に HistoryAutoAddVariable を呼ぶと エラーを生じます.

This subroutine performs following acts.

If "HistoryAutoAddVariable" is called after this subroutine is called, an error is occurred.

Original external subprogram is gtool/gtool_historyauto/historyautoallvarfix.f90#HistoryAutoAllVarFix

HistoryAutoClose( )
Subroutine :

HistoryAutoCreate で始まったデータ出力の終了処理を行います. プログラムを終了する前に必ずこのサブルーチンを呼んでください.

Terminates data output with "HistoryAutoCreate". Call this subroutine certainly before a progrem is finished.

Original external subprogram is gtool/gtool_historyauto/historyautoclose.f90#HistoryAutoClose1

HistoryAutoCreate( title, source, institution, dims, dimsizes, longnames, units, origin, terminus, [xtypes], [conventions], [gt_version], [all_output], [file_prefix], [namelist_filename], [interval], [slice_start], [slice_end], [slice_stride], [space_average], [time_average], [newfile_interval], [rank], [origin_date], [origin_date_invalid], [flag_mpi_gather], [flag_mpi_split] )
Subroutine :
title :character(*), intent(in)
: データ全体の表題. Title of entire data
source :character(*), intent(in)
: データを作成する際の手段. Source of data file
institution :character(*), intent(in)
: ファイルを最終的に変更した組織/個人. Institution or person that changes files for the last time
dims(:) :character(*), intent(in)
: 次元の名前.

配列の大きさに制限はありません. 個々の次元の文字数は dc_types#TOKEN まで. 配列内の文字数は 全て同じでなければなりません. 足りない文字分は空白で 補ってください.

Names of dimensions.

Length of array is unlimited. Limits of numbers of characters of each dimensions are "dc_types#TOKEN". Numbers of characters in this array must be same. Make up a deficit with blanks.

dimsizes(:) :integer, intent(in)
: dims で指定したそれぞれの次元大きさ.

配列の大きさは dims の大きさと等しい 必要があります. ‘0’ (数字のゼロ) を指定 するとその次元は 無制限次元 (unlimited dimension) となります. (gtool_history では時間の次元に対して無制限次元を 用いることを想定しています). ただし, 1 つの NetCDF ファイル (バージョン 3) は最大で 1 つの無制限次元しか持てないので, 2 ヶ所以上に ‘0’ を指定しないでください. その場合, 正しく gtool4 データが出力されません.

Lengths of dimensions specified with "dims".

Length of this array must be same as length of "dim". If ‘0’ (zero) is specified, the dimension is treated as unlimited dimension. (In "gtool_history", unlimited dimension is expected to be used as time). Note that one NetCDF file (version 3) can not have two or more unlimited dimensions, so that do not specify ‘0’ to two or more places. In that case, gtoo4 data is not output currently

longnames(:) :character(*), intent(in)
: dims で指定したそれぞれの次元の名前.

配列の大きさは dims の大きさ と等しい必要があります. 文字数 は dc_types#STRING まで. 配列内の文字数は 全て同じでなければなりません. 足りない文字分は空白で補います.

Names of dimensions specified with "dims".

Length of this array must be same as length of "dim". Limits of numbers of characters are "dc_types#STRING". Numbers of characters in this array must be same. Make up a deficit with blanks.

units(:) :character(*), intent(in)
: dims で指定したそれぞれの次元の単位.

配列の大きさは dims の大きさ と等しい必要があります. 文字数 は dc_types#STRING まで. 配列内の文字数は 全て同じでなければなりません. 足りない文字分は空白で補います.

Units of dimensions specified with "dims".

Length of this array must be same as length of "dim". Limits of numbers of characters are "dc_types#STRING". Numbers of characters in this array must be same. Make up a deficit with blanks.

origin :type(DC_DIFFTIME), intent(in)
: 出力開始時刻.

Start time of output.

terminus :type(DC_DIFFTIME), intent(in)
: 出力終了時刻.

End time of output.

xtypes(:) :character(*), intent(in), optional
: dims で指定したそれぞれの 次元のデータ型.

デフォルトは float (単精度実数型) です. 有効なのは, double (倍精度実数型), int (整数型) です. 指定しない 場合や, 無効な型を指定した場合には, float となります. なお, 配列の大きさ は dims の大きさと等しい必要が あります. 配列内の文字数は全て 同じでなければなりません. 足りない文字分は空白で補います.

Data types of dimensions specified with "dims".

Default value is "float" (single precision). Other valid values are "double" (double precision), "int" (integer). If no value or invalid value is specified, "float" is applied. Length of this array must be same as length of "dim". Numbers of characters in this array must be same. Make up a deficit with blanks.

conventions :character(*), intent(in), optional
: 出力するファイルの netCDF 規約

省略した場合, もしくは空文字を与えた場合, 出力する netCDF 規約の Conventions 属性に値 gtool4_netCDF_Conventions が自動的に与えられます.

NetCDF conventions of output file.

If this argument is omitted or, blanks are given, gtool4_netCDF_Conventions is given to attribute "Conventions" of an output file automatically.

gt_version :character(*), intent(in), optional
: gtool4 netCDF 規約のバージョン

省略した場合, gt_version 属性に 規約の最新版のバージョンナンバー gtool4_netCDF_version が与えられます. (ただし, 引数 conventions に gtool4_netCDF_Conventions 以外が与えられる場合は gt_version 属性を作成しません).

Version of gtool4 netCDF Conventions.

If this argument is omitted, latest version number of gtool4 netCDF Conventions is given to attribute "gt_version" of an output file (However, gtool4_netCDF_Conventions is not given to an argument "conventions", attribute "gt_version" is not created).

all_output :logical, intent(in), optional
: 登録変数を全て出力するためのフラグ.

.true. を指定すると, HistoryAutoAddVariable で登録された 変数が全て出力されるようになります.

namelist_filename が指定される場合 には, デフォルトは .false. となります. この場合には, namelist_filename に指定された NAMELIST ファイルから読み込まれる NAMELIST#gtool_historyauto_nml で指定された変数のみ出力されます.

namelist_filename が指定されない場合 には, .true. となります.

Flag for output all registered variables.

When .true. is specified, all variables registered by "HistoryAutoAddVariable" are output.

If namelist_filename is specified, default value becomes .false. . In this case, only variables specified in "NAMELIST#gtool_historyauto_nml" loaded from a NAMELIST file namelist_filename.

If namelist_filename is not specified, this value becomes .true. .

file_prefix :character(*), intent(in), optional
: データのファイル名の接頭詞. Prefixes of history data filenames
namelist_filename :character(*), intent(in), optional
: NAMELIST ファイルの名称.

省略した場合, もしくは空白文字を与えた場合, NAMELIST ファイルは読み込みません.

Name of NAMELIST file.

If this argument is omitted, or blanks are specified, no NAMELIST file is loaded.

interval :type(DC_DIFFTIME), intent(in), optional
: 出力時間間隔.

省略した場合, 自動的に 1.0 [sec] が設定されます.

Interval of output time.

If this argument is omitted, 1.0 [sec] is specified automatically.

slice_start(:) :integer, intent(in), optional
: 空間方向の開始点.

省略した場合, 座標データの開始点が設定されます.

Start points of spaces.

If this argument is omitted, start points of dimensions are set.

slice_end(:) :integer, intent(in), optional
: 空間方向の終了点.

省略した場合, もしくは負の値が与えら得た場合, 座標データの終了点が設定されます.

End points of spaces.

If this argument is omitted or negative value is specified, end points of dimensions are set.

slice_stride(:) :integer, intent(in), optional
: 空間方向の刻み幅.

省略した場合, 1 が設定されます.

Strides of spaces

If this argument is omitted, 1 is set.

space_average(:) :logical, intent(in), optional
: 平均化のフラグ.

.true. が指定される座標に対して平均化を 行います. 省略した場合, .false. が設定されます.

Flag of average.

Axes specified .true. are averaged. If this argument is omitted, .false. is set.

time_average :logical, intent(in), optional
: 出力データの時間平均フラグ. デフォルトは .false. Flag for time average of output data Default value is .false.
newfile_interval :integer, intent(in), optional
: ファイル分割時間間隔.

省略した場合, 時間方向へのファイル分割を行いません.

Interval of time of separation of a file.

If this argument is omitted, a files is not separated in time direction.

rank :character(*), intent(in), optional
: ランクの名称.

Name of a rank.

origin_date :type(DC_DATETIME), intent(in), optional
: 出力開始日時.

Start date of output.

origin_date_invalid :logical, intent(in), optional
: .true. を与えると, origin_date を無効にします.

If ".true." is given, "origin_date" is ignored.

flag_mpi_gather :logical, intent(in), optional
: MPI 使用時に, 各ノードで HistoryPut に与えたデータを一つのファイルに統合して出力 する場合には .true. を与えてください. デフォルトは .false. です.

.true. を与えた場合, HistoryPutAxisMPI に全体の軸データを与えてください.

When MPI is used, if ".true." is given, data given to "HistoryPut" on each node is integrated and output to one file. Default value is ".false.".

If .true. is given, give data of axes in whole area to "HistoryPutAxisMPI"

flag_mpi_split :logical, intent(in), optional
: MPI 使用時に, 各ノードで HistoryPut に与えたデータをそれぞれ別名のファイルに 出力する場合には .true. を与えてください. デフォルトは .false. です.

When MPI is used, if ".true." is given, data given to "HistoryPut" on each node is split into discrete files. Default value is ".false.".

複数のデータ出力を行うための初期化を行います.

この HistoryAutoCreate には, モデル内で出力する 変数が依存する座標や座標重みなどを全てを設定してください.

all_output に .true. を与えた場合や, namelist_filename を与えない (空文字を与える) 場合には, HistoryAutoAddVariable で登録される全ての変数が出力されます. 一方で namelist_filename に NAMELIST ファイル名を与える場合には, その NAMELIST ファイルから出力のオンオフや, 出力ファイル名, 出力間隔などを変更可能です. 変更可能な項目に関しては NAMELIST#gtool_historyauto_nml を参照して下さい.

interval, origin, terminus, slice_start, slice_end, slice_stride, space_average, time_average, newfile_interval などの設定はデフォルト値として使用されます. これらの設定値は HistoryAutoAddVariable および NAMELIST#gtool_historyauto_nml で上書きされます. (優先度が高いのは NAMELIST#gtool_historyauto_nml , HistoryAutoAddVariable の引数, HistoryAutoCreate の引数 の順です).

Initialization for multiple history data output

Set all axes and their weights depended by variables output from numerical models to this "HistoryAutoCreate".

All variables registered by "HistoryAutoAddVariable" are output if .true. is given to "all_output" or "namelist_filename" is not given (or blanks are given) On the other hand, if a filename of NAMELIST file is given to "namelist_filename", on/off of output, output filename and output interval, etc. can be changed from the NAMELIST file. For available items, see "NAMELIST#gtool_historyauto_nml".

Settings about "interval", "origin", "terminus", "slice_start", "slice_end", "slice_stride", "space_average", "time_average", "newfile_interval" etc. are used as default values. Their set values are overwritten by "HistoryAutoAddVariable" or "NAMELIST#gtool_historyauto_nml". ("NAMELIST#gtool_historyauto_nml" is high priority, arguments of "HistoryAutoAddVariable" are medium, arguments of "HistoryAutoCreate" are low).

This procedure input/output NAMELIST#gtool_historyauto_nml .

Original external subprogram is gtool/gtool_historyauto/historyautocreate.f90#HistoryAutoCreate1

HistoryAutoCreate( title, source, institution, dims, dimsizes, longnames, units, [xtypes], [conventions], [gt_version], [all_output], [file_prefix], [namelist_filename], [interval], [origin], [terminus], [slice_start], [slice_end], [slice_stride], [space_average], [time_average], [newfile_interval], [rank], [origin_date], [origin_date_invalid], [flag_mpi_gather], [flag_mpi_split] )
Subroutine :
title :character(*), intent(in)
: データ全体の表題. Title of entire data
source :character(*), intent(in)
: データを作成する際の手段. Source of data file
institution :character(*), intent(in)
: ファイルを最終的に変更した組織/個人. Institution or person that changes files for the last time
dims(:) :character(*), intent(in)
: 次元の名前.

配列の大きさに制限はありません. 個々の次元の文字数は dc_types#TOKEN まで. 配列内の文字数は 全て同じでなければなりません. 足りない文字分は空白で 補ってください.

Names of dimensions.

Length of array is unlimited. Limits of numbers of characters of each dimensions are "dc_types#TOKEN". Numbers of characters in this array must be same. Make up a deficit with blanks.

dimsizes(:) :integer, intent(in)
: dims で指定したそれぞれの次元大きさ.

配列の大きさは dims の大きさと等しい 必要があります. ‘0’ (数字のゼロ) を指定 するとその次元は 無制限次元 (unlimited dimension) となります. (gtool_history では時間の次元に対して無制限次元を 用いることを想定しています). ただし, 1 つの NetCDF ファイル (バージョン 3) は最大で 1 つの無制限次元しか持てないので, 2 ヶ所以上に ‘0’ を指定しないでください. その場合, 正しく gtool4 データが出力されません.

Lengths of dimensions specified with "dims".

Length of this array must be same as length of "dim". If ‘0’ (zero) is specified, the dimension is treated as unlimited dimension. (In "gtool_history", unlimited dimension is expected to be used as time). Note that one NetCDF file (version 3) can not have two or more unlimited dimensions, so that do not specify ‘0’ to two or more places. In that case, gtoo4 data is not output currently

longnames(:) :character(*), intent(in)
: dims で指定したそれぞれの次元の名前.

配列の大きさは dims の大きさ と等しい必要があります. 文字数 は dc_types#STRING まで. 配列内の文字数は 全て同じでなければなりません. 足りない文字分は空白で補います.

Names of dimensions specified with "dims".

Length of this array must be same as length of "dim". Limits of numbers of characters are "dc_types#STRING". Numbers of characters in this array must be same. Make up a deficit with blanks.

units(:) :character(*), intent(in)
: dims で指定したそれぞれの次元の単位.

配列の大きさは dims の大きさ と等しい必要があります. 文字数 は dc_types#STRING まで. 配列内の文字数は 全て同じでなければなりません. 足りない文字分は空白で補います.

Units of dimensions specified with "dims".

Length of this array must be same as length of "dim". Limits of numbers of characters are "dc_types#STRING". Numbers of characters in this array must be same. Make up a deficit with blanks.

xtypes(:) :character(*), intent(in), optional
: dims で指定したそれぞれの 次元のデータ型.

デフォルトは float (単精度実数型) です. 有効なのは, double (倍精度実数型), int (整数型) です. 指定しない 場合や, 無効な型を指定した場合には, float となります. なお, 配列の大きさ は dims の大きさと等しい必要が あります. 配列内の文字数は全て 同じでなければなりません. 足りない文字分は空白で補います.

Data types of dimensions specified with "dims".

Default value is "float" (single precision). Other valid values are "double" (double precision), "int" (integer). If no value or invalid value is specified, "float" is applied. Length of this array must be same as length of "dim". Numbers of characters in this array must be same. Make up a deficit with blanks.

conventions :character(*), intent(in), optional
: 出力するファイルの netCDF 規約

省略した場合, もしくは空文字を与えた場合, 出力する netCDF 規約の Conventions 属性に値 gtool4_netCDF_Conventions が自動的に与えられます.

NetCDF conventions of output file.

If this argument is omitted or, blanks are given, gtool4_netCDF_Conventions is given to attribute "Conventions" of an output file automatically.

gt_version :character(*), intent(in), optional
: gtool4 netCDF 規約のバージョン

省略した場合, gt_version 属性に 規約の最新版のバージョンナンバー gtool4_netCDF_version が与えられます. (ただし, 引数 conventions に gtool4_netCDF_Conventions 以外が与えられる場合は gt_version 属性を作成しません).

Version of gtool4 netCDF Conventions.

If this argument is omitted, latest version number of gtool4 netCDF Conventions is given to attribute "gt_version" of an output file (However, gtool4_netCDF_Conventions is not given to an argument "conventions", attribute "gt_version" is not created).

all_output :logical, intent(in), optional
: 登録変数を全て出力するためのフラグ.

.true. を指定すると, HistoryAutoAddVariable で登録された 変数が全て出力されるようになります.

namelist_filename が指定される場合 には, デフォルトは .false. となります. この場合には, namelist_filename に指定された NAMELIST ファイルから読み込まれる NAMELIST#gtool_historyauto_nml で指定された変数のみ出力されます.

namelist_filename が指定されない場合 には, .true. となります.

Flag for output all registered variables.

When .true. is specified, all variables registered by "HistoryAutoAddVariable" are output.

If namelist_filename is specified, default value becomes .false. . In this case, only variables specified in "NAMELIST#gtool_historyauto_nml" loaded from a NAMELIST file namelist_filename.

If namelist_filename is not specified, this value becomes .true. .

file_prefix :character(*), intent(in), optional
: ヒストリデータのファイル名の接頭詞. Prefixes of history data filenames
namelist_filename :character(*), intent(in), optional
: NAMELIST ファイルの名称.

省略した場合, もしくは空白文字を与えた場合, NAMELIST ファイルは読み込みません.

Name of NAMELIST file.

If this argument is omitted, or blanks are specified, no NAMELIST file is loaded.

interval :real, intent(in), optional
: 出力時間間隔.

省略した場合, 自動的に 1.0 [sec] が設定されます.

Interval of output time.

If this argument is omitted, 1.0 [sec] is specified automatically.

origin :real, intent(in), optional
: 出力開始時刻.

省略した場合, 自動的に 0.0 [sec] が 設定されます.

Start time of output.

If this argument is omitted, 0.0 [sec] is specified automatically.

terminus :real, intent(in), optional
: 出力終了時刻.

省略した場合, 数値モデルの実行が終了するまで 出力を行います.

End time of output.

If this argument is omitted, output is continued until a numerical model is finished.

slice_start(:) :integer, intent(in), optional
: 空間方向の開始点.

省略した場合, 座標データの開始点が設定されます.

Start points of spaces.

If this argument is omitted, start points of dimensions are set.

slice_end(:) :integer, intent(in), optional
: 空間方向の終了点.

省略した場合, 座標データの終了点が設定されます.

End points of spaces.

If this argument is omitted, End points of dimensions are set.

slice_stride(:) :integer, intent(in), optional
: 空間方向の刻み幅.

省略した場合, 1 が設定されます.

Strides of spaces

If this argument is omitted, 1 is set.

space_average(:) :logical, intent(in), optional
: 平均化のフラグ.

.true. が指定される座標に対して平均化を 行います. 省略した場合, .false. が設定されます.

Flag of average.

Axes specified .true. are averaged. If this argument is omitted, .false. is set.

time_average :logical, intent(in), optional
: 出力データの時間平均フラグ. デフォルトは .false. Flag for time average of output data Default value is .false.
newfile_interval :integer, intent(in), optional
: ファイル分割時間間隔.

省略した場合, 時間方向へのファイル分割を行いません.

Interval of time of separation of a file.

If this argument is omitted, a files is not separated in time direction.

rank :character(*), intent(in), optional
: ランクの名称. 空文字を与えた場合には無視されます.

Name of a rank. If blank is given, this argument is ignored.

origin_date :type(DC_DATETIME), intent(in), optional
: 出力開始日時.

Start date of output.

origin_date_invalid :logical, intent(in), optional
: .true. を与えると, origin_date を無効にします.

If ".true." is given, "origin_date" is ignored.

flag_mpi_gather :logical, intent(in), optional
: MPI 使用時に, 各ノードで HistoryPut に与えたデータを一つのファイルに統合して出力 する場合には .true. を与えてください. デフォルトは .false. です.

.true. を与えた場合, HistoryPutAxisMPI に全体の軸データを与えてください.

When MPI is used, if ".true." is given, data given to "HistoryPut" on each node is integrated and output to one file. Default value is ".false.".

If .true. is given, give data of axes in whole area to "HistoryPutAxisMPI"

flag_mpi_split :logical, intent(in), optional
: MPI 使用時に, 各ノードで HistoryPut に与えたデータをそれぞれ別名のファイルに 出力する場合には .true. を与えてください. デフォルトは .false. です.

When MPI is used, if ".true." is given, data given to "HistoryPut" on each node is split into discrete files. Default value is ".false.".

複数のヒストリデータ出力を行うための初期化を行います.

この HistoryAutoCreate には, モデル内で出力する 変数が依存する座標や座標重みなどを全てを設定してください.

all_output に .true. を与えた場合や, namelist_filename を与えない (空文字を与える) 場合には, HistoryAutoAddVariable で登録される全ての変数が出力されます. 一方で namelist_filename に NAMELIST ファイル名を与える場合には, その NAMELIST ファイルから出力のオンオフや, 出力ファイル名, 出力間隔などを変更可能です. 変更可能な項目に関しては NAMELIST#gtool_historyauto_nml を参照して下さい.

interval, origin, terminus, slice_start, slice_end, slice_stride, space_average, time_average, newfile_interval などの設定はデフォルト値として使用されます. これらの設定値は HistoryAutoAddVariable および NAMELIST#gtool_historyauto_nml で上書きされます. (優先度が高いのは NAMELIST#gtool_historyauto_nml , HistoryAutoAddVariable の引数, HistoryAutoCreate の引数 の順です).

Initialization for multiple history data output

Set all axes and their weights depended by variables output from numerical models to this "HistoryAutoCreate".

All variables registered by "HistoryAutoAddVariable" are output if .true. is given to "all_output" or "namelist_filename" is not given (or blanks are given) On the other hand, if a filename of NAMELIST file is given to "namelist_filename", on/off of output, output filename and output interval, etc. can be changed from the NAMELIST file. For available items, see "NAMELIST#gtool_historyauto_nml".

Settings about "interval", "origin", "terminus", "slice_start", "slice_end", "slice_stride", "space_average", "time_average", "newfile_interval" etc. are used as default values. Their set values are overwritten by "HistoryAutoAddVariable" or "NAMELIST#gtool_historyauto_nml". ("NAMELIST#gtool_historyauto_nml" is high priority, arguments of "HistoryAutoAddVariable" are medium, arguments of "HistoryAutoCreate" are low).

Original external subprogram is gtool/gtool_historyauto/historyautocreate.f90#HistoryAutoCreate2

HistoryAutoPut( time, varname, array, [err] )
Subroutine :
time :type(DC_DIFFTIME), intent(in)
: データの時刻. Time of data
varname :character(*), intent(in)
: 変数の名前.

ただし, ここで指定するものは, HistoryAutoAddVariable の varname で既に指定されてい なければなりません.

Name of a variable.

This must be specified varname in "HistoryAutoAddVariable".

array(:) :real(DP), intent(in), target
: 出力データ.

データ型は整数, 単精度実数型, 倍精度実数型のどれでもかまいません. ただし, ファイルへ出力される際には, HistoryAutoAddVariable の xtypes で指定した データ型へ変換されます.

Output data.

Integer, single or double precision are acceptable as data type. Note that when this is output to a file, data type is converted into "xtype" specified in "HistoryAutoAddVariable"

err :logical, intent(out), optional
: 例外処理用フラグ. デフォルトでは, この手続き内でエラーが 生じた場合, プログラムは強制終了します. 引数 err が与えられる場合, プログラムは強制終了せず, 代わりに err に .true. が代入されます.

Exception handling flag. By default, when error occur in this procedure, the program aborts. If this err argument is given, .true. is substituted to err and the program does not abort.

データの出力を行います. このサブルーチンを用いる前に, "HistoryAutoCreate" による初期設定が必要です.

varname は HistoryAutoAddVariable で指定されている必要があります.

HistoryAutoPut は複数のサブルーチンの総称名です. array には 0 〜 7 次元のデータを与えることが可能です. (下記のサブルーチンを参照ください). また, 整数, 単精度実数, 倍精度実数を与えることが可能です. ただし, 0 次元のデータを与える際の引数キーワードは value を用いてください.

Output data. Initialization by "HistoryAutoCreate" is needed before use of this subroutine.

"varname" must be specified by "HistoryAutoAddVariable".

"HistoryAutoPut" is a generic name of multiple subroutines. Then 0 — 7 dimensional data can be given to "array". (See bellow subroutines). And, integer, sinble or double precision can be given. However, if 0 dimensional data is given, use "value" as a keyword argument.

Original external subprogram is gtool/gtool_historyauto/historyautoput.f90#HistoryAutoPutDouble1

HistoryAutoPut( time, varname, array, [err] )
Subroutine :
time :type(DC_DIFFTIME), intent(in)
varname :character(*), intent(in)
array(:) :integer, intent(in), target
err :logical, intent(out), optional
: 例外処理用フラグ. デフォルトでは, この手続き内でエラーが 生じた場合, プログラムは強制終了します. 引数 err が与えられる場合, プログラムは強制終了せず, 代わりに err に .true. が代入されます.

Exception handling flag. By default, when error occur in this procedure, the program aborts. If this err argument is given, .true. is substituted to err and the program does not abort.

Original external subprogram is gtool/gtool_historyauto/historyautoput.f90#HistoryAutoPutInt1

HistoryAutoPut( time, varname, array, [err] )
Subroutine :
time :type(DC_DIFFTIME), intent(in)
varname :character(*), intent(in)
array(:) :real, intent(in), target
err :logical, intent(out), optional
: 例外処理用フラグ. デフォルトでは, この手続き内でエラーが 生じた場合, プログラムは強制終了します. 引数 err が与えられる場合, プログラムは強制終了せず, 代わりに err に .true. が代入されます.

Exception handling flag. By default, when error occur in this procedure, the program aborts. If this err argument is given, .true. is substituted to err and the program does not abort.

Original external subprogram is gtool/gtool_historyauto/historyautoput.f90#HistoryAutoPutReal1

HistoryAutoPut( time, varname, array, [err] )
Subroutine :
time :type(DC_DIFFTIME), intent(in)
varname :character(*), intent(in)
array(:,:) :integer, intent(in), target
err :logical, intent(out), optional
: 例外処理用フラグ. デフォルトでは, この手続き内でエラーが 生じた場合, プログラムは強制終了します. 引数 err が与えられる場合, プログラムは強制終了せず, 代わりに err に .true. が代入されます.

Exception handling flag. By default, when error occur in this procedure, the program aborts. If this err argument is given, .true. is substituted to err and the program does not abort.

Original external subprogram is gtool/gtool_historyauto/historyautoput.f90#HistoryAutoPutInt2

HistoryAutoPut( time, varname, array, [err] )
Subroutine :
time :type(DC_DIFFTIME), intent(in)
varname :character(*), intent(in)
array(:,:) :real(DP), intent(in), target
err :logical, intent(out), optional
: 例外処理用フラグ. デフォルトでは, この手続き内でエラーが 生じた場合, プログラムは強制終了します. 引数 err が与えられる場合, プログラムは強制終了せず, 代わりに err に .true. が代入されます.

Exception handling flag. By default, when error occur in this procedure, the program aborts. If this err argument is given, .true. is substituted to err and the program does not abort.

Original external subprogram is gtool/gtool_historyauto/historyautoput.f90#HistoryAutoPutDouble2

HistoryAutoPut( time, varname, array, [err] )
Subroutine :
time :type(DC_DIFFTIME), intent(in)
varname :character(*), intent(in)
array(:,:) :real, intent(in), target
err :logical, intent(out), optional
: 例外処理用フラグ. デフォルトでは, この手続き内でエラーが 生じた場合, プログラムは強制終了します. 引数 err が与えられる場合, プログラムは強制終了せず, 代わりに err に .true. が代入されます.

Exception handling flag. By default, when error occur in this procedure, the program aborts. If this err argument is given, .true. is substituted to err and the program does not abort.

Original external subprogram is gtool/gtool_historyauto/historyautoput.f90#HistoryAutoPutReal2

HistoryAutoPut( time, varname, array, [err] )
Subroutine :
time :type(DC_DIFFTIME), intent(in)
varname :character(*), intent(in)
array(:,:,:) :integer, intent(in), target
err :logical, intent(out), optional
: 例外処理用フラグ. デフォルトでは, この手続き内でエラーが 生じた場合, プログラムは強制終了します. 引数 err が与えられる場合, プログラムは強制終了せず, 代わりに err に .true. が代入されます.

Exception handling flag. By default, when error occur in this procedure, the program aborts. If this err argument is given, .true. is substituted to err and the program does not abort.

Original external subprogram is gtool/gtool_historyauto/historyautoput.f90#HistoryAutoPutInt3

HistoryAutoPut( time, varname, array, [err] )
Subroutine :
time :type(DC_DIFFTIME), intent(in)
varname :character(*), intent(in)
array(:,:,:) :real(DP), intent(in), target
err :logical, intent(out), optional
: 例外処理用フラグ. デフォルトでは, この手続き内でエラーが 生じた場合, プログラムは強制終了します. 引数 err が与えられる場合, プログラムは強制終了せず, 代わりに err に .true. が代入されます.

Exception handling flag. By default, when error occur in this procedure, the program aborts. If this err argument is given, .true. is substituted to err and the program does not abort.

Original external subprogram is gtool/gtool_historyauto/historyautoput.f90#HistoryAutoPutDouble3

HistoryAutoPut( time, varname, array, [err] )
Subroutine :
time :type(DC_DIFFTIME), intent(in)
varname :character(*), intent(in)
array(:,:,:) :real, intent(in), target
err :logical, intent(out), optional
: 例外処理用フラグ. デフォルトでは, この手続き内でエラーが 生じた場合, プログラムは強制終了します. 引数 err が与えられる場合, プログラムは強制終了せず, 代わりに err に .true. が代入されます.

Exception handling flag. By default, when error occur in this procedure, the program aborts. If this err argument is given, .true. is substituted to err and the program does not abort.

Original external subprogram is gtool/gtool_historyauto/historyautoput.f90#HistoryAutoPutReal3

HistoryAutoPut( time, varname, array, [err] )
Subroutine :
time :type(DC_DIFFTIME), intent(in)
varname :character(*), intent(in)
array(:,:,:,:) :integer, intent(in), target
err :logical, intent(out), optional
: 例外処理用フラグ. デフォルトでは, この手続き内でエラーが 生じた場合, プログラムは強制終了します. 引数 err が与えられる場合, プログラムは強制終了せず, 代わりに err に .true. が代入されます.

Exception handling flag. By default, when error occur in this procedure, the program aborts. If this err argument is given, .true. is substituted to err and the program does not abort.

Original external subprogram is gtool/gtool_historyauto/historyautoput.f90#HistoryAutoPutInt4

HistoryAutoPut( time, varname, array, [err] )
Subroutine :
time :type(DC_DIFFTIME), intent(in)
varname :character(*), intent(in)
array(:,:,:,:) :real(DP), intent(in), target
err :logical, intent(out), optional
: 例外処理用フラグ. デフォルトでは, この手続き内でエラーが 生じた場合, プログラムは強制終了します. 引数 err が与えられる場合, プログラムは強制終了せず, 代わりに err に .true. が代入されます.

Exception handling flag. By default, when error occur in this procedure, the program aborts. If this err argument is given, .true. is substituted to err and the program does not abort.

Original external subprogram is gtool/gtool_historyauto/historyautoput.f90#HistoryAutoPutDouble4

HistoryAutoPut( time, varname, array, [err] )
Subroutine :
time :type(DC_DIFFTIME), intent(in)
varname :character(*), intent(in)
array(:,:,:,:) :real, intent(in), target
err :logical, intent(out), optional
: 例外処理用フラグ. デフォルトでは, この手続き内でエラーが 生じた場合, プログラムは強制終了します. 引数 err が与えられる場合, プログラムは強制終了せず, 代わりに err に .true. が代入されます.

Exception handling flag. By default, when error occur in this procedure, the program aborts. If this err argument is given, .true. is substituted to err and the program does not abort.

Original external subprogram is gtool/gtool_historyauto/historyautoput.f90#HistoryAutoPutReal4

HistoryAutoPut( time, varname, array, [err] )
Subroutine :
time :type(DC_DIFFTIME), intent(in)
varname :character(*), intent(in)
array(:,:,:,:,:) :integer, intent(in), target
err :logical, intent(out), optional
: 例外処理用フラグ. デフォルトでは, この手続き内でエラーが 生じた場合, プログラムは強制終了します. 引数 err が与えられる場合, プログラムは強制終了せず, 代わりに err に .true. が代入されます.

Exception handling flag. By default, when error occur in this procedure, the program aborts. If this err argument is given, .true. is substituted to err and the program does not abort.

Original external subprogram is gtool/gtool_historyauto/historyautoput.f90#HistoryAutoPutInt5

HistoryAutoPut( time, varname, array, [err] )
Subroutine :
time :type(DC_DIFFTIME), intent(in)
varname :character(*), intent(in)
array(:,:,:,:,:) :real(DP), intent(in), target
err :logical, intent(out), optional
: 例外処理用フラグ. デフォルトでは, この手続き内でエラーが 生じた場合, プログラムは強制終了します. 引数 err が与えられる場合, プログラムは強制終了せず, 代わりに err に .true. が代入されます.

Exception handling flag. By default, when error occur in this procedure, the program aborts. If this err argument is given, .true. is substituted to err and the program does not abort.

Original external subprogram is gtool/gtool_historyauto/historyautoput.f90#HistoryAutoPutDouble5

HistoryAutoPut( time, varname, array, [err] )
Subroutine :
time :type(DC_DIFFTIME), intent(in)
varname :character(*), intent(in)
array(:,:,:,:,:) :real, intent(in), target
err :logical, intent(out), optional
: 例外処理用フラグ. デフォルトでは, この手続き内でエラーが 生じた場合, プログラムは強制終了します. 引数 err が与えられる場合, プログラムは強制終了せず, 代わりに err に .true. が代入されます.

Exception handling flag. By default, when error occur in this procedure, the program aborts. If this err argument is given, .true. is substituted to err and the program does not abort.

Original external subprogram is gtool/gtool_historyauto/historyautoput.f90#HistoryAutoPutReal5

HistoryAutoPut( time, varname, array, [err] )
Subroutine :
time :type(DC_DIFFTIME), intent(in)
varname :character(*), intent(in)
array(:,:,:,:,:,:) :integer, intent(in), target
err :logical, intent(out), optional
: 例外処理用フラグ. デフォルトでは, この手続き内でエラーが 生じた場合, プログラムは強制終了します. 引数 err が与えられる場合, プログラムは強制終了せず, 代わりに err に .true. が代入されます.

Exception handling flag. By default, when error occur in this procedure, the program aborts. If this err argument is given, .true. is substituted to err and the program does not abort.

Original external subprogram is gtool/gtool_historyauto/historyautoput.f90#HistoryAutoPutInt6

HistoryAutoPut( time, varname, array, [err] )
Subroutine :
time :type(DC_DIFFTIME), intent(in)
varname :character(*), intent(in)
array(:,:,:,:,:,:) :real(DP), intent(in), target
err :logical, intent(out), optional
: 例外処理用フラグ. デフォルトでは, この手続き内でエラーが 生じた場合, プログラムは強制終了します. 引数 err が与えられる場合, プログラムは強制終了せず, 代わりに err に .true. が代入されます.

Exception handling flag. By default, when error occur in this procedure, the program aborts. If this err argument is given, .true. is substituted to err and the program does not abort.

Original external subprogram is gtool/gtool_historyauto/historyautoput.f90#HistoryAutoPutDouble6

HistoryAutoPut( time, varname, array, [err] )
Subroutine :
time :type(DC_DIFFTIME), intent(in)
varname :character(*), intent(in)
array(:,:,:,:,:,:) :real, intent(in), target
err :logical, intent(out), optional
: 例外処理用フラグ. デフォルトでは, この手続き内でエラーが 生じた場合, プログラムは強制終了します. 引数 err が与えられる場合, プログラムは強制終了せず, 代わりに err に .true. が代入されます.

Exception handling flag. By default, when error occur in this procedure, the program aborts. If this err argument is given, .true. is substituted to err and the program does not abort.

Original external subprogram is gtool/gtool_historyauto/historyautoput.f90#HistoryAutoPutReal6

HistoryAutoPut( time, varname, array, [err] )
Subroutine :
time :type(DC_DIFFTIME), intent(in)
varname :character(*), intent(in)
array(:,:,:,:,:,:,:) :integer, intent(in), target
err :logical, intent(out), optional
: 例外処理用フラグ. デフォルトでは, この手続き内でエラーが 生じた場合, プログラムは強制終了します. 引数 err が与えられる場合, プログラムは強制終了せず, 代わりに err に .true. が代入されます.

Exception handling flag. By default, when error occur in this procedure, the program aborts. If this err argument is given, .true. is substituted to err and the program does not abort.

Original external subprogram is gtool/gtool_historyauto/historyautoput.f90#HistoryAutoPutInt7

HistoryAutoPut( time, varname, array, [err] )
Subroutine :
time :type(DC_DIFFTIME), intent(in)
varname :character(*), intent(in)
array(:,:,:,:,:,:,:) :real(DP), intent(in), target
err :logical, intent(out), optional
: 例外処理用フラグ. デフォルトでは, この手続き内でエラーが 生じた場合, プログラムは強制終了します. 引数 err が与えられる場合, プログラムは強制終了せず, 代わりに err に .true. が代入されます.

Exception handling flag. By default, when error occur in this procedure, the program aborts. If this err argument is given, .true. is substituted to err and the program does not abort.

Original external subprogram is gtool/gtool_historyauto/historyautoput.f90#HistoryAutoPutDouble7

HistoryAutoPut( time, varname, array, [err] )
Subroutine :
time :type(DC_DIFFTIME), intent(in)
varname :character(*), intent(in)
array(:,:,:,:,:,:,:) :real, intent(in), target
err :logical, intent(out), optional
: 例外処理用フラグ. デフォルトでは, この手続き内でエラーが 生じた場合, プログラムは強制終了します. 引数 err が与えられる場合, プログラムは強制終了せず, 代わりに err に .true. が代入されます.

Exception handling flag. By default, when error occur in this procedure, the program aborts. If this err argument is given, .true. is substituted to err and the program does not abort.

Original external subprogram is gtool/gtool_historyauto/historyautoput.f90#HistoryAutoPutReal7

HistoryAutoPut( time, varname, value, [err] )
Subroutine :
time :type(DC_DIFFTIME), intent(in)
varname :character(*), intent(in)
value :integer, intent(in), target
err :logical, intent(out), optional
: 例外処理用フラグ. デフォルトでは, この手続き内でエラーが 生じた場合, プログラムは強制終了します. 引数 err が与えられる場合, プログラムは強制終了せず, 代わりに err に .true. が代入されます.

Exception handling flag. By default, when error occur in this procedure, the program aborts. If this err argument is given, .true. is substituted to err and the program does not abort.

Original external subprogram is gtool/gtool_historyauto/historyautoput.f90#HistoryAutoPutInt0

HistoryAutoPut( time, varname, value, [err] )
Subroutine :
time :type(DC_DIFFTIME), intent(in)
varname :character(*), intent(in)
value :real(DP), intent(in), target
err :logical, intent(out), optional
: 例外処理用フラグ. デフォルトでは, この手続き内でエラーが 生じた場合, プログラムは強制終了します. 引数 err が与えられる場合, プログラムは強制終了せず, 代わりに err に .true. が代入されます.

Exception handling flag. By default, when error occur in this procedure, the program aborts. If this err argument is given, .true. is substituted to err and the program does not abort.

Original external subprogram is gtool/gtool_historyauto/historyautoput.f90#HistoryAutoPutDouble0

HistoryAutoPut( time, varname, value, [err] )
Subroutine :
time :type(DC_DIFFTIME), intent(in)
varname :character(*), intent(in)
value :real, intent(in), target
err :logical, intent(out), optional
: 例外処理用フラグ. デフォルトでは, この手続き内でエラーが 生じた場合, プログラムは強制終了します. 引数 err が与えられる場合, プログラムは強制終了せず, 代わりに err に .true. が代入されます.

Exception handling flag. By default, when error occur in this procedure, the program aborts. If this err argument is given, .true. is substituted to err and the program does not abort.

Original external subprogram is gtool/gtool_historyauto/historyautoput.f90#HistoryAutoPutReal0

HistoryAutoPutAxis( dim, array )
Subroutine :
dim :character(*), intent(in)
: 座標の名称.

ただし, ここで指定するもの は, HistoryAutoCreate の dims 既に指定されていなければなりません.

Name of axis.

Note that this value must be set as "dims" of "HistoryAutoCreate".

array(:) :integer, intent(in)
: 座標データ

データ型は整数, 単精度実数型, 倍精度実数型のどれでもかまいません. ただし, ファイルへ出力される際には, HistoryAutoCreate の xtypes で指定した データ型へ変換されます.

Data of axis

Integer, single or double precision are acceptable as data type. Note that when this is output to a file, data type is converted into "xtypes" specified in "HistoryAutoCreate"

座標データを設定します.

Set data of an axis.

Original external subprogram is gtool/gtool_historyauto/historyautoputaxis.f90#HistoryAutoPutAxisInt

HistoryAutoPutAxis( dim, array )
Subroutine :
dim :character(*), intent(in)
: 座標の名称.

ただし, ここで指定するもの は, HistoryAutoCreate の dims 既に指定されていなければなりません.

Name of axis.

Note that this value must be set as "dims" of "HistoryAutoCreate".

array(:) :real(DP), intent(in)
: 座標データ

データ型は整数, 単精度実数型, 倍精度実数型のどれでもかまいません. ただし, ファイルへ出力される際には, HistoryAutoCreate の xtypes で指定した データ型へ変換されます.

Data of axis

Integer, single or double precision are acceptable as data type. Note that when this is output to a file, data type is converted into "xtypes" specified in "HistoryAutoCreate"

座標データを設定します.

Set data of an axis.

Original external subprogram is gtool/gtool_historyauto/historyautoputaxis.f90#HistoryAutoPutAxisDouble

HistoryAutoPutAxis( dim, array )
Subroutine :
dim :character(*), intent(in)
: 座標の名称.

ただし, ここで指定するもの は, HistoryAutoCreate の dims 既に指定されていなければなりません.

Name of axis.

Note that this value must be set as "dims" of "HistoryAutoCreate".

array(:) :real, intent(in)
: 座標データ

データ型は整数, 単精度実数型, 倍精度実数型のどれでもかまいません. ただし, ファイルへ出力される際には, HistoryAutoCreate の xtypes で指定した データ型へ変換されます.

Data of axis

Integer, single or double precision are acceptable as data type. Note that when this is output to a file, data type is converted into "xtypes" specified in "HistoryAutoCreate"

座標データを設定します.

Set data of an axis.

Original external subprogram is gtool/gtool_historyauto/historyautoputaxis.f90#HistoryAutoPutAxisReal

HistoryAutoPutAxisMPI( dim, array )
Subroutine :
dim :character(*), intent(in)
: 座標変数の名称.

ここで指定するものは, HistoryAutoCreate の 引数 dims で既に指定されてい なければなりません.

Name of dimensional variable.

This name must be specified by an argument dims in "HistoryAutoCreate".

array(:) :real(DP), intent(in)
: 座標データ.

Data of axes.

MPI 使用時に, 各々のノード上のデータを単一ファイルに 集約して出力する場合には, このサブルーチンに領域全体の座標データを与えてください. また, HistoryAutoCreate のオプショナル論理型引数 flag_mpi_gather に .true. を与えてください.

When MPI is used, if data on each node is integrated and output to one file, give data of axes in whole area to this subroutine. And give .true. to optional logical argument flag_mpi_gather in "HistoryAutoCreate".

Original external subprogram is gtool/gtool_historyauto/historyautoputaxismpi.f90#HistoryAutoPutAxisMPIDouble

HistoryAutoPutAxisMPI( dim, array )
Subroutine :
dim :character(*), intent(in)
array(:) :integer, intent(in)

MPI 使用時に, 各々のノード上のデータを単一ファイルに 集約して出力する場合には, このサブルーチンに領域全体の座標データを与えてください. また, HistoryAutoCreate のオプショナル論理型引数 flag_mpi_gather に .true. を与えてください.

When MPI is used, if data on each node is integrated and output to one file, give data of axes in whole area to this subroutine. And give .true. to optional logical argument flag_mpi_gather in "HistoryAutoCreate".

Original external subprogram is gtool/gtool_historyauto/historyautoputaxismpi.f90#HistoryAutoPutAxisMPIInt

HistoryAutoPutAxisMPI( dim, array )
Subroutine :
dim :character(*), intent(in)
array(:) :real, intent(in)

MPI 使用時に, 各々のノード上のデータを単一ファイルに 集約して出力する場合には, このサブルーチンに領域全体の座標データを与えてください. また, HistoryAutoCreate のオプショナル論理型引数 flag_mpi_gather に .true. を与えてください.

When MPI is used, if data on each node is integrated and output to one file, give data of axes in whole area to this subroutine. And give .true. to optional logical argument flag_mpi_gather in "HistoryAutoCreate".

Original external subprogram is gtool/gtool_historyauto/historyautoputaxismpi.f90#HistoryAutoPutAxisMPIReal

[Validate]