Data Types
interface	dimrange

Functions/Subroutines
subroutine, public	vartable_dump (vid)

subroutine, public	vartableadd (vid, class, cid)

subroutine, public	vartabledelete (vid, action, err)

subroutine, public	vartablelookup (vid, class, cid)

subroutine, public	vartablemore (vid, err)

integer function, public	ndims (vid)

subroutine, public	query_growable (vid, result)

Variables
integer, parameter, public	vid_invalid = -1

integer, parameter, public	vtb_class_unused = 0

integer, parameter, public	vtb_class_netcdf = 1

integer, parameter, public	classes_max = 2

type(gd_nc_variable_search), save, public	gdnc_search

Detailed Description

gtool variable table management

This module is not directly referenced from the gtool module, therefore naming conventions are quite flexible. Users must not call this.

A gtool variable is actually just a handle and multi-dimensional iterator, where the handle is a small integer value. To access the actual entity, first lookup the map table using the handle value, then lookup the variable table using the vid obtained there to get the class and class-specific variable number. This is at most pointer + offset reference cost. While gtool variables create as many iterators as needed from entity variables, this variable table creates only one entry per entity variable, so it has a reference count. This eliminates the need for entity variables to manage reference counts.

Function/Subroutine Documentation

◆ ndims()

integer function, public gtdata_internal_vartable::ndims ( integer, intent(in) vid )

Get number of dimensions of variable

Parameters

[in] vid Variable ID

Returns: Number of dimensions

Definition at line 356 of file gtdata_internal_vartable.f90.

    use gtdata_netcdf_types, only: gd_nc_variable
    use gtdata_netcdf_generic, only: gdncinquire => inquire
    use dc_error, only: storeerror, nf90_einval
    integer, intent(in):: vid
    integer:: class, cid
    call vartablelookup(vid, class, cid)
    select case(class)
    case(vtb_class_netcdf)
      call gdncinquire(gd_nc_variable(cid), ndims=result)
    case default
      call storeerror(nf90_einval, 'gtdata::ndims')
    end select

References ndims(), dc_error::storeerror(), vartablelookup(), and vtb_class_netcdf.

Here is the call graph for this function:

◆ query_growable()

subroutine, public gtdata_internal_vartable::query_growable	(	integer, intent(in)	vid,
		logical, intent(out)	result
	)

Query whether variable has unlimited dimension

Parameters

[in]	vid	Variable ID
[out]	result	.true. if variable has unlimited dimension

Definition at line 384 of file gtdata_internal_vartable.f90.

    use gtdata_netcdf_types, only: gd_nc_variable
    use gtdata_netcdf_generic, only: inquire
    use dc_error, only: storeerror, nf90_einval
    integer, intent(in):: vid
    logical, intent(out):: result
    integer:: class, cid
    call vartablelookup(vid, class, cid)
    select case(class)
    case(vtb_class_netcdf)
      call inquire(gd_nc_variable(cid), growable=result)
    case default
      call storeerror(nf90_einval, 'gtdata::ndims')
    end select

References dc_error::storeerror(), vartablelookup(), and vtb_class_netcdf.

Here is the call graph for this function:

◆ vartable_dump()

subroutine, public gtdata_internal_vartable::vartable_dump ( integer, intent(in) vid )

Dump variable table entry for debugging

Parameters

[in] vid Variable ID to dump

Definition at line 106 of file gtdata_internal_vartable.f90.

    use dc_trace, only: dbgmessage
    use gtdata_netcdf_generic, only: tostring
    use gtdata_netcdf_types, only: gd_nc_variable
    integer, intent(in):: vid
    character(10):: class
    if (.not. allocated(table)) return
    if (vid <= 0 .or. vid > size(table)) return
    select case(table(vid)%class)
    case(vtb_class_netcdf)
      class = 'netcdf'
    case default
      write(class, fmt="(i10)") table(vid)%class
    end select
    call dbgmessage('[vartable %d: class=%c cid=%d ref=%d]', &
      & i=(/vid, table(vid)%cid, table(vid)%refcount/), &
      & c1=trim(class))
    select case(table(vid)%class)
    case(vtb_class_netcdf)
      call dbgmessage('[%c]', c1=trim(tostring(gd_nc_variable(table(vid)%cid))))
    end select

References dc_trace::dbgmessage(), vtb_class_netcdf, and vtb_class_unused.

Here is the call graph for this function:

◆ vartableadd()

subroutine, public gtdata_internal_vartable::vartableadd	(	integer, intent(out)	vid,
		integer, intent(in)	class,
		integer, intent(in)	cid
	)

Add entry to variable table

If an entry with the same class and cid already exists, increments its reference count. Otherwise, creates a new entry.

Parameters

[out]	vid	Assigned variable ID
[in]	class	Variable class (VTB_CLASS_NETCDF, etc.)
[in]	cid	Class-specific ID

Definition at line 168 of file gtdata_internal_vartable.f90.

    use dc_trace, only: dbgmessage
    integer, intent(out):: vid
    integer, intent(in):: class, cid
    type(VAR_TABLE_ENTRY), allocatable:: tmp_table(:)
    integer:: n
  continue
    ! 必要ならば初期幅確保
    if (.not. allocated(table)) then
      allocate(table(table_ini_size))
      call entry_cleanup(table(:))
    endif
    ! 該当があれば参照数増加
    do, n = 1, size(table)
      if (table(n)%class == class .and. table(n)%cid == cid) then
        table(n)%refcount = table(n)%refcount + 1
        call dbgmessage('gtdata_vartable.add(class=%d cid=%d) found (ref=%d)', &
          & i=(/table(n)%class, table(n)%cid, table(n)%refcount/))
        vid = n
        return
      endif
    enddo
    ! もし空きが無ければ表を拡張
    if (all(table(:)%class /= vtb_class_unused)) then
      n = size(table)
      allocate(tmp_table(n))
      tmp_table(:) = table(:)
      deallocate(table)
      allocate(table(n * 2))
      table(1:n) = tmp_table(1:n)
      deallocate(tmp_table)
      table(n+1:n*2) = var_table_entry(vtb_class_unused, -1, 0)
    endif
    do, n = 1, size(table)
      if (table(n)%class == vtb_class_unused) then
        table(n)%class = class
        table(n)%cid = cid
        table(n)%refcount = 1
        vid = n
        return
      endif
    enddo
    vid = vid_invalid

References dc_trace::dbgmessage(), vid_invalid, and vtb_class_unused.

Here is the call graph for this function:

◆ vartabledelete()

subroutine, public gtdata_internal_vartable::vartabledelete	(	integer, intent(in)	vid,
		logical, intent(out)	action,
		logical, intent(out), optional	err
	)

Delete entry from variable table

Decrements the reference count. When it reaches zero, action is set to .true. indicating actual deletion should occur.

Parameters

[in]	vid	Variable ID to delete
[out]	action	.true. if actual deletion should be performed
[out]	err	Error flag (optional)

Definition at line 234 of file gtdata_internal_vartable.f90.

    integer, intent(in):: vid
    logical, intent(out):: action
    logical, intent(out), optional:: err
    if (.not. allocated(table)) goto 999
    if (vid <= 0 .or. vid > size(table)) goto 999
    if (table(vid)%class <= vtb_class_unused) goto 999
    if (table(vid)%class > classes_max) goto 999
    table(vid)%refcount = max(table(vid)%refcount - 1, 0)
    action = (table(vid)%refcount == 0)
    if (present(err)) err = .false.
    return
999 continue
    action = .false.
    if (present(err)) err = .true.

References classes_max, and vtb_class_unused.

◆ vartablelookup()

subroutine, public gtdata_internal_vartable::vartablelookup	(	integer, intent(in)	vid,
		integer, intent(out), optional	class,
		integer, intent(out), optional	cid
	)

Look up variable table entry

Returns the class and cid of the entry with the specified vid.

Parameters

[in]	vid	Variable ID to look up
[out]	class	Variable class (optional)
[out]	cid	Class-specific ID (optional)

Definition at line 270 of file gtdata_internal_vartable.f90.

    integer, intent(in):: vid
    integer, intent(out), optional:: class, cid
    if (.not. allocated(table)) goto 999
    if (vid <= 0 .or. vid > size(table)) goto 999
    if (table(vid)%class <= vtb_class_unused) goto 999
    if (table(vid)%class > classes_max) goto 999
    if (present(class)) class = table(vid)%class
    if (present(cid)) cid = table(vid)%cid
    return
999 continue
    if (present(class)) class = vtb_class_unused

References classes_max, and vtb_class_unused.

◆ vartablemore()

subroutine, public gtdata_internal_vartable::vartablemore	(	integer, intent(in)	vid,
		logical, intent(out), optional	err
	)

Increment reference count of variable table entry

Parameters

[in]	vid	Variable ID
[out]	err	Error flag (optional)

Definition at line 297 of file gtdata_internal_vartable.f90.

    integer, intent(in):: vid
    logical, intent(out), optional:: err
    if (.not. allocated(table)) goto 999
    if (vid <= 0 .or. vid > size(table)) goto 999
    if (table(vid)%class <= vtb_class_unused) goto 999
    if (table(vid)%class > classes_max) goto 999
    table(vid)%refcount = table(vid)%refcount + 1
    if (present(err)) err = .false.
    return
999 continue
    if (present(err)) err = .true.