Subroutine: HistoryGet

【変数入力 (固定長配列用)】

2004年11月22日森川靖大

概要

サブルーチン HistoryGet は、既存の gtool4 データ内の変数のデータを取得します。 (このサブルーチンを用いる前に、 HistoryCreate による初期設定は必要ありません)。

配列サイズをプログラム中で変更できるポインタ配列へデータを入力したい場合には、 HistoryGetPointer を利用してください。

書式

call HistoryGet(file, varname, array, [time])

引数

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

file
   [変数] [文字型]    取得しようとするデータが格納された netCDF ファイルの名前。

varname
   [変数] [文字型]    取得しようとするデータの変数の名前。 ここで指定する変数は、 fileで指定されるファイル内に含まれていなければならない。

array
   [変数]
[配列(1)]
[配列(2)]
[配列(3)] [実数型(単)]
[実数型(倍)]    取得するデータを格納する配列。 0次元 (変数) から3次元までの配列が許容される。型は単精度実数型か倍精度実数型かのどちらかである。取得するデータの空間次元のサイズと配列のサイズとが一致している必要がある。 varname のデータ型と array の型が異なる場合は、自動的に array の型に変換される。

time
   [変数] [文字型]
[実数型(単)]
[実数型(倍)]    取得するデータの時刻。 (ここで言う時間とは、 無制限次元 (unlimited dimension)を想定している)。指定しない場合は一番最後の時刻のデータが取得される。型は文字型、単精度実数型、倍精度実数型のいずれかである。なお、文字型の場合に限り、「^」を頭に付けることで、時間のステップ数で指定することも可能である。 (例えば「^10」ならば 10 ステップ目を取得する)。

※ 以下には、1) 引数、2) 変数か配列か、3) データ型、4)引数の説明が記してある。なお、[配列*()]の括弧内は配列の次元を表しており、 [配列(2)]ならば2次元の配列を意味する。また、[実数型(単)]は単精度実数型を、 [実数型(倍)**]は倍精度実数型を表す。
`file`	[変数]	[文字型]	取得しようとするデータが格納された netCDF ファイルの名前。
`varname`	[変数]	[文字型]	取得しようとするデータの変数の名前。ここで指定する変数は、 `file`で指定されるファイル内に含まれていなければならない。
`array`	[変数] [配列(1)] [配列(2)] [配列(3)]	[実数型(単)] [実数型(倍)]	取得するデータを格納する配列。 0次元 (変数) から3次元までの配列が許容される。型は単精度実数型か倍精度実数型かのどちらかである。取得するデータの空間次元のサイズと配列のサイズとが一致している必要がある。 `varname` のデータ型と `array` の型が異なる場合は、自動的に `array` の型に変換される。
`time`	[変数]	[文字型] [実数型(単)] [実数型(倍)]	取得するデータの時刻。 (ここで言う時間とは、無制限次元 (unlimited dimension)を想定している)。指定しない場合は一番最後の時刻のデータが取得される。型は文字型、単精度実数型、倍精度実数型のいずれかである。なお、文字型の場合に限り、「`^`」を頭に付けることで、時間のステップ数で指定することも可能である。 (例えば「`^10`」ならば 10 ステップ目を取得する)。