File: historyget.f90

HistoryGetDouble0( file, varname, array, [range], [quiet], [err] )

Subroutine :

file :

character(*), intent(in)

:	netCDF ファイル名. NetCDF filename.

varname :

character(*), intent(in)

:	変数名. Variable name

array :

real(DP), intent(out)

:

取得するデータを格納する配列

型は整数型, 単精度実数型, 倍精度実数型かのいづれかです. 取得するデータの空間次元のサイズと配列のサイズとが一致している必要があります. 入力するデータの型と array の型が異なる場合は, 自動的に array の型に変換されます.

Array in which input data is store

Type is integer or single precision real or double precision. Size of array must be identical to input data size. When type of input data is different from type of array, data is converted to type of array automatically.

range :

character(*), intent(in), optional

:	切り出し用オプション. gtool4 変数のコンマ記法で記述 {(例: time=100.0,x=10:20,y=^1:^5)} 詳しくは gtool4 netCDF 規約の「5.4 コンマ記法」を参照してください. Option for clipping. Give gtool4 comma-graphy {(ex. time=100.0,x=10:20,y=^1:^5)} For details, see "5.4 gtool4 comma-graphy" in gtool4 netCDF Convention

quiet : logical, intent(in), optional

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.

Note that Japanese and English are described in parallel.

netCDF データを入力します. gtool4 netCDF 規約に基づくデータを想定していますが, 大抵の netCDF データの入力は可能であると期待されます.

デフォルトでは, ファイル内の最新データ, すなわちデータを時刻最大で切り出したものを入力します. 別の時刻または別の次元で切り出したデータを入力したい場合には, 下記の time オプションもしくは range オプションを利用してください.

file にファイル名を, varname に変数名を与えます. array にはファイルから入力されたデータが返ります. ポインタの配列へデータを入力を行う場合は, HistoryGetPointer を利用してください.

ある時刻のデータを明示したい場合には, その時刻を time に与えます. 整数型, 単精度実数型, 倍精度実数型の数値を与えることが可能です.

range には gtool4 のコンマ記法 (gtool4 netCDF 規約の「5.4 コンマ記法」参照) を与えることで, 任意の次元で入力データを切り出すことが可能です. range に空文字を与えた場合は切り出しを行いません.

HistoryGet は複数のサブルーチンの総称名です. array には 0 ～ 7 次元の整数型, 単精度実数型, 倍精度実数型の配列を与えることが可能です.

デフォルトでは, データの入力時にどのファイルのどの変数がどの次元で切り出されて入力されたのかを表示します. メッセージ出力が不要な場合は quiet に .true. を与えてください.

Input netCDF data. NetCDF data with gtool4 conventions is assumed, but most netCDF data is expected to be input.

Give filename to file, variable name to varname. Input data is returned to array. If you want to use pointer array, use "HistoryGetPointer".

By default, recent data, that is to say, data clipped with maximum time is input. In order to input data clipped with other time or other dimension, use time option or range option as follows.

In order to get data at certain time, specify the time to time. Type is integer or single precision real or double precision.

Give gtool4 comma-graphy (See "5.4 gtool4 comma-graphy" in gtool4 netCDF Convention) to range, then input data can be clipped by an arbitrary dimension. If null character is given to range, data is not clipped.

HistoryGet is generic name of multiple subroutines. Integer, single precision real, and double precision real 0 — 7 rank array can be given to array.

By default, when data is input, filename and variable name and clipping information is printed. The message is suppressed when .true. is given to quiet

[Source]

subroutine HistoryGetDouble0(file, varname, array, range, quiet, err)
  !
  ! <b>Note that Japanese and English are described in parallel.</b>
  !
                                            !
  ! netCDF データを入力します. gtool4 netCDF 規約に基づくデータを想定
  ! していますが, 大抵の netCDF データの入力は可能であると期待されます.
  !
  ! デフォルトでは, ファイル内の最新データ, すなわちデータを
  ! 時刻最大で切り出したものを入力します. 別の時刻または
  ! 別の次元で切り出したデータを
  ! 入力したい場合には, 下記の *time* オプションもしくは 
  ! *range* オプションを利用してください. 
  !
  ! *file* にファイル名を, *varname* に変数名を与えます. 
  ! *array* にはファイルから入力されたデータが返ります. 
  ! ポインタの配列へデータを入力を行う場合は, 
  ! HistoryGetPointer を利用してください. 
  !
  ! ある時刻のデータを明示したい場合には, その時刻を 
  ! *time* に与えます. 
  ! 整数型, 単精度実数型, 倍精度実数型の数値を与えることが可能です. 
  !
  ! *range* には gtool4 のコンマ記法
  ! ({gtool4 netCDF 規約}[link:../xref.htm#label-6] の「5.4 コンマ記法」参照) 
  ! を与えることで, 任意の次元で入力データを切り出すことが可能です. 
  ! *range* に空文字を与えた場合は切り出しを行いません. 
  !
  ! *HistoryGet* は複数のサブルーチンの総称名です. *array* には
  ! 0 ～ 7 次元の整数型, 単精度実数型, 
  ! 倍精度実数型の配列を与えることが可能です.
  !
  ! デフォルトでは, データの入力時にどのファイルのどの変数が
  ! どの次元で切り出されて入力されたのかを表示します. 
  ! メッセージ出力が不要な場合は *quiet* に .true. を与えてください.
  !
  ! Input netCDF data. NetCDF data with gtool4 conventions is assumed,
  ! but most netCDF data is expected to be input.
  !
  ! Give filename to *file*, variable name to *varname*.
  ! Input data is returned to *array*.
  ! If you want to use pointer array, use "HistoryGetPointer".
  !
  ! By default, recent data, that is to say, data clipped with 
  ! maximum time is input. In order to input data clipped with
  ! other time or other dimension, 
  ! use *time* option or *range* option as follows.
  !
  ! In order to get data at certain time, specify the time to *time*. 
  ! Type is integer or single precision real or double precision.
  !
  ! Give gtool4 comma-graphy
  ! (See "5.4 gtool4 comma-graphy" in {gtool4 netCDF Convention}[link:../xref.htm#label-6]) 
  ! to *range*, then input data can be clipped by an arbitrary dimension.
  ! If null character is given to *range*, data is not clipped.
  !
  ! *HistoryGet* is generic name of multiple subroutines.
  ! Integer, single precision real, and double precision real
  ! 0 -- 7 rank array can be given to *array*.
  !
  ! By default, when data is input, filename and variable name and
  ! clipping information is printed. 
  ! The message is suppressed when .true. is given to *quiet*
  !
                      
                    
  !
  use gtdata_types, only: GT_VARIABLE
  use gtdata_generic, only: Open, Inquire, Close, Get
  use dc_string, only: toChar, Split, JoinChar, StoA
  use dc_url, only: GT_ATMARK, GT_COMMA, GT_EQUAL, UrlSplit, UrlMerge
  use dc_present, only: present_select, present_and_not_empty, present_and_true
  use regex,      only: match
  use dc_types, only: DP, STRING
  use dc_message, only: MessageNotify
  use dc_trace, only: Beginsub, Endsub, DbgMessage
  use dc_error, only: StoreError, DC_NOERR, GT_ENOTURL, GT_ERANKMISMATCH, GT_EARGSIZEMISMATCH
  character(*), intent(in):: file
                                                                        ! netCDF ファイル名. 
                              ! NetCDF filename.
                      
                    
  character(*), intent(in):: varname
                                                                        ! 変数名. 
                              ! Variable name
                      
                    
  character(*), intent(in), optional:: range
                                                                        ! 切り出し用オプション.
                              ! gtool4 変数のコンマ記法で記述
                              ! {(例: time=100.0,x=10:20,y=^1:^5)}
                              !
                              ! 詳しくは
                              ! {gtool4 netCDF 規約}[link:../xref.htm#label-6]
                              ! の「5.4 コンマ記法」を参照して
                              ! ください.
                              ! 
                              ! Option for clipping.
                              ! Give gtool4 comma-graphy 
                              ! {(ex. time=100.0,x=10:20,y=^1:^5)}
                              ! 
                              ! For details, see "5.4 gtool4
                              ! comma-graphy" in 
                              ! {gtool4 netCDF Convention}[link:../xref.htm#label-6]
                      
                    
  logical, intent(in), optional:: quiet
  real(DP), intent(out) :: array
                                                                        ! 取得するデータを格納する配列
                              !
                              ! 型は整数型, 単精度実数型, 倍精度実数型
                              ! かのいづれかです.  取得するデータの空
                              ! 間次元のサイズと配列のサイズとが一致し
                              ! ている必要があります.  入力するデータ
                              ! の型と *array* の型が異なる場合は, 自
                              ! 動的に *array* の型に変換されます.
                              ! 
                              ! Array in which input data is store
                              !
                              ! Type is integer or single precision
                              ! real or double precision.  Size of
                              ! array must be identical to input data
                              ! size.  When type of input data is
                              ! different from type of *array*, data
                              ! is converted to type of *array*
                              ! automatically.
                              ! 
                      
                    
  logical, intent(out), optional:: err
                                                                        ! 例外処理用フラグ.
                              ! デフォルトでは, この手続き内でエラーが
                              ! 生じた場合, プログラムは強制終了します.
                              ! 引数 *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. 
                      
                    

                      real(DP):: array_tmp(1)
                    
  type(GT_VARIABLE)             :: var
  character(STRING)             :: url, actual_url
  integer:: rank
  integer:: domain   ! 変数の入出力領域の大きさ
                     ! (= 変数が依存する各次元サイズの積)
  integer:: stat
  character(STRING):: cause_c
  character(*), parameter :: subname = "HistoryGetDouble0"

continue
  call BeginSub(subname, 'file=%c varname=%c range=%c', c1 = trim(file), c2 = trim(varname), c3 = trim(present_select('', 'no-range', range)))
  cause_c = ''
  stat = DC_NOERR

                                        


  !-------------------------------------
  !  最新時刻の URL 取得
  !  Get URL of latest time
  call lookup_growable_url(file, varname, url, range, err = err)
  if ( present_and_true(err) ) then
    stat = GT_ENOTURL
    cause_c = url
    goto 999
  end if

  !-------------------------------------
  !  ファイルオープン
  !  File open
  call Open( var, url, err = err )

  if ( present_and_true(err) ) then
    stat = GT_ENOTURL
    cause_c = url
    goto 999
  end if

  !-------------------------------------
  !  配列形状のチェック
  !  Check array shape
  call Inquire( var = var, rank = rank )          ! (out)

  if ( .not. 0 == rank ) then
    if ( .not. present_and_true(quiet) ) then
      call MessageNotify('W', subname, 'Rank of data (%c) is "%d", rank of argument is "%d"', i = (/rank, 0/), c1 = trim(url) )
    end if
    stat = GT_ERANKMISMATCH
    cause_c = 'array'
    goto 999
  end if
                                        

  !-------------------------------------
  !  データ取得
  !  Get data
  call Inquire( var = var, size = domain )        ! (out)

                    
  call Get( var = var, nvalue = domain, value = array_tmp) ! (out)
  array = array_tmp(1)

                    

  call Close( var )

  !-------------------------------------
  !  データファイル名と切り出し範囲の印字
  !  Print data filename and clipping range
  call actual_iorange_dump(url, actual_url, err = err)
  if ( .not. present_and_true(quiet) ) then
    call MessageNotify('M', subname, 'Input %c', c1=trim(actual_url))
  end if

999 continue
  call StoreError(stat, subname, err, cause_c)
  call EndSub(subname)
end subroutine HistoryGetDouble0

HistoryGetDouble0( file, varname, array, [range], [quiet], [err] )

Subroutine :

file :

character(*), intent(in)

:	netCDF ファイル名. NetCDF filename.

varname :

character(*), intent(in)

:	変数名. Variable name

array :

real(DP), intent(out)

:

取得するデータを格納する配列

型は整数型, 単精度実数型, 倍精度実数型かのいづれかです. 取得するデータの空間次元のサイズと配列のサイズとが一致している必要があります. 入力するデータの型と array の型が異なる場合は, 自動的に array の型に変換されます.

Array in which input data is store

Type is integer or single precision real or double precision. Size of array must be identical to input data size. When type of input data is different from type of array, data is converted to type of array automatically.

range :

character(*), intent(in), optional

:	切り出し用オプション. gtool4 変数のコンマ記法で記述 {(例: time=100.0,x=10:20,y=^1:^5)} 詳しくは gtool4 netCDF 規約の「5.4 コンマ記法」を参照してください. Option for clipping. Give gtool4 comma-graphy {(ex. time=100.0,x=10:20,y=^1:^5)} For details, see "5.4 gtool4 comma-graphy" in gtool4 netCDF Convention