Subroutine: HistoryCreate

【gtool4 データ出力用初期設定】

2004/12/16 森川靖大

概要

サブルーチン HistoryCreate は、 gtool4 データ出力の初期設定を行います。 HistoryAddVariable、 HistoryCopyVariable、 HistoryPut、 HistoryAddAttr、 HistoryClose、 HistorySetTime を用いるためには、HistoryCreate による初期設定が必要です。

なお、プログラム内で HistoryCreate を呼び出した場合、プログラムを終了する前に必ず、 HistoryClose を呼び出して終了処理を行なって下さい。

書式

call HistoryCreate(file, title, source, institution, &
                 & dims, dimsizes, longnames, units, origin, interval, &
                 & [xtypes], [history], [conventions], [gt_version])

call HistoryCreate(file, title, source, institution, &
                 & axes, origin, interval, &
                 & [xtypes], [history], [conventions], [gt_version])

引数

※ 以下には、1) 引数、2) 変数か配列か、3) データ型、4)引数の説明が記してある。なお、[配列(*)]の括弧内は配列の次元を表しており、 [配列(2)]ならば2次元の配列を意味する。また、[実数型(単)]は単精度実数型を、 [実数型(倍)]は倍精度実数型を表す。

file
[変数] [文字型] 出力するファイルの名前。

title
[変数] [文字型] データ全体の表題。

source
[変数] [文字型] データを作成する際の手段。

institution
[変数] [文字型] ファイルを最終的に変更した人/組織。

axes
[配列(1)] [GT_HISTORY_AXIS型] 次元情報を格納した構造型変数。 構造型の詳細や設定の例は GT_HISTORY_AXIS を参照のこと。配列の大きさに制限は無い。

dims
[配列(1)] [文字型] 次元の名前。 配列の大きさに制限は無い。文字数は32まで。配列内の文字数は全て同じでなければならない。足りない文字分は空白で補う。

dimsizes
[配列(1)] [整数型] dimsで指定したそれぞれの次元大きさ。 配列の大きさはdimsの大きさと等しい必要がある。 '0' (数字のゼロ) を指定するとその次元は 無制限次元 (unlimited dimension) となる。 (gt4_history では時間の次元に対して無制限次元を用いることを想定している)。ただし、1つの NetCDF ファイルは最大で1つの無制限次元しか持てないので、 2ヶ所以上に'0' を指定しないこと。 正しく gtool4 データが出力されない。

longname
[配列(1)] [文字型] dimsで指定したそれぞれの次元の名前。 配列の大きさはdimsの大きさと等しい必要がある。文字数は500まで。配列内の文字数は全て同じでなければならない。足りない文字分は空白で補う。

units
[配列(1)] [文字型] dimsで指定したそれぞれの次元の単位。 配列の大きさはdimsの大きさと等しい必要がある。文字数は500まで。配列内の文字数は全て同じでなければならない。足りない文字分は空白で補う。

origin
[変数] [実数型(単)] 時間の原点。これはHistoryPut により変数を最初に出力するときの時間と一致する。

interval
[変数] [実数型(単)] 出力時間間隔。同じ変数に対して HistoryPut を再度呼んだときに自動的に時間変数がこの値だけ増やされて出力される。なお、各々の出力ファイルにつき HistorySetTimeを一度でも用いた場合、この値は無効になるので注意すること。

[xtypes]
[配列(1)] [文字型] dimsで指定したそれぞれの次元のデータ型。
デフォルトはfloat (単精度実数型)である。有効なのは、double (倍精度実数型)、 int (整数型)である。指定しない場合や、無効な型を指定した場合には、 float (単精度実数型)となる。なお、配列の大きさはdimsの大きさと等しい必要がある。配列内の文字数は全て同じでなければならない。足りない文字分は空白で補う。

[history]
[変数] [GT_HISTORY型] 出力ファイルの設定。 主に出力ファイルを複数に分割する場合に指定する。 (単独のファイルに書き出す場合は指定する必要は無い)。なお、このGT_HISTORY型変数は HistoryCreate より前に Fortran 90 プログラム内で定義されている必要がある。定義の方法に関してはGT_HISTORYを参照のこと。

[conventions]
[変数] [文字型] 出力するファイルの netCDF 規約 (省略可能)。 省略した場合、もしくは空文字を与えた場合、Conventions 属性に属性値 "http://www.gfd-dennou.org/arch/gtool4/conventions/" が自動的に与えられる。

[gt_version]
[変数] [文字型] gtool4 netCDF 規約のバージョン (省略可能)。 省略した場合、gt_version 属性に規約の最新版が与えられる。 (ただし、conventions に "http://www.gfd-dennou.org/arch/gtool4/conventions/" 以外が与えられる場合は gt_version 属性を作成しない)。

※ 以下には、1) 引数、2) 変数か配列か、3) データ型、4)引数の説明が記してある。なお、[配列*()]の括弧内は配列の次元を表しており、 [配列(2)]ならば2次元の配列を意味する。また、[実数型(単)]は単精度実数型を、 [実数型(倍)**]は倍精度実数型を表す。
`file`	[変数]	[文字型]	出力するファイルの名前。
`title`	[変数]	[文字型]	データ全体の表題。
`source`	[変数]	[文字型]	データを作成する際の手段。
`institution`	[変数]	[文字型]	ファイルを最終的に変更した人/組織。
`axes`	[配列(1)]	[GT_HISTORY_AXIS型]	次元情報を格納した構造型変数。構造型の詳細や設定の例は GT_HISTORY_AXIS を参照のこと。配列の大きさに制限は無い。
`dims`	[配列(1)]	[文字型]	次元の名前。配列の大きさに制限は無い。文字数は32まで。配列内の文字数は全て同じでなければならない。足りない文字分は空白で補う。
`dimsizes`	[配列(1)]	[整数型]	`dims`で指定したそれぞれの次元大きさ。配列の大きさは`dims`の大きさと等しい必要がある。 `'0'` (数字のゼロ) を指定するとその次元は無制限次元 (unlimited dimension) となる。 (gt4_history では時間の次元に対して無制限次元を用いることを想定している)。ただし、1つの NetCDF ファイルは最大で1つの無制限次元しか持てないので、 2ヶ所以上に`'0'` を指定しないこと。正しく gtool4 データが出力されない。
`longname`	[配列(1)]	[文字型]	`dims`で指定したそれぞれの次元の名前。配列の大きさは`dims`の大きさと等しい必要がある。文字数は500まで。配列内の文字数は全て同じでなければならない。足りない文字分は空白で補う。
`units`	[配列(1)]	[文字型]	`dims`で指定したそれぞれの次元の単位。配列の大きさは`dims`の大きさと等しい必要がある。文字数は500まで。配列内の文字数は全て同じでなければならない。足りない文字分は空白で補う。
`origin`	[変数]	[実数型(単)]	時間の原点。これはHistoryPut により変数を最初に出力するときの時間と一致する。
`interval`	[変数]	[実数型(単)]	出力時間間隔。同じ変数に対して HistoryPut を再度呼んだときに自動的に時間変数がこの値だけ増やされて出力される。なお、各々の出力ファイルにつき HistorySetTimeを一度でも用いた場合、この値は無効になるので注意すること。
`[xtypes]`	[配列(1)]	[文字型]	`dims`で指定したそれぞれの次元のデータ型。デフォルトは`float` (単精度実数型)である。有効なのは、`double` (倍精度実数型)、 `int` (整数型)である。指定しない場合や、無効な型を指定した場合には、 `float` (単精度実数型)となる。なお、配列の大きさは`dims`の大きさと等しい必要がある。配列内の文字数は全て同じでなければならない。足りない文字分は空白で補う。
`[history]`	[変数]	[GT_HISTORY型]	出力ファイルの設定。主に出力ファイルを複数に分割する場合に指定する。 (単独のファイルに書き出す場合は指定する必要は無い)。なお、このGT_HISTORY型変数は HistoryCreate より前に Fortran 90 プログラム内で定義されている必要がある。定義の方法に関してはGT_HISTORYを参照のこと。
`[conventions]`	[変数]	[文字型]	出力するファイルの netCDF 規約 (省略可能)。省略した場合、もしくは空文字を与えた場合、Conventions 属性に属性値 `"`http://www.gfd-dennou.org/arch/gtool4/conventions/`"` が自動的に与えられる。
`[gt_version]`	[変数]	[文字型]	gtool4 netCDF 規約のバージョン (省略可能)。省略した場合、gt_version 属性に規約の最新版が与えられる。 (ただし、conventions に `"`http://www.gfd-dennou.org/arch/gtool4/conventions/`"` 以外が与えられる場合は gt_version 属性を作成しない)。