gtvarslicenext.f90 File Reference

Move I/O range. More...

Go to the source code of this file.

Functions/Subroutines
subroutine	gtvarslicenext (var, dimord, err, stat)

Detailed Description

Move I/O range.

Author

Eizi TOYODA, Yasuhiro MORIKAWA

Copyright

Copyright (C) GFD Dennou Club, 2000-2026. All rights reserved.
License is BSD-2-Clause. See COPYRIGHT in detail

This subroutine is provided as gtdata_generic#Slice_Next through gtdata_generic.

Definition in file gtvarslicenext.f90.

Function/Subroutine Documentation

gtvarslicenext()

subroutine gtvarslicenext	(	type(gt_variable), intent(inout)	var,
		integer, intent(in), optional	dimord,
		logical, intent(out), optional	err,
		integer, intent(out), optional	stat )

Advance I/O range to next slice

Moves the dimension range by incrementing the start value of the dimord-th dimension of variable var by stride * count. If dimord is omitted, this operation is performed on any dimension. On success, stat becomes 0.

By setting a Slice with start and stride values of 1 for any dimension and sequentially calling Slice_Next, you can scan the entire variable.

If an error occurs while moving the I/O range, outputs a message and terminates the program. If err is provided, returns .true. and program does not terminate.

Parameters

[in,out]	var	Variable handle
[in]	dimord	Dimension order number (optional)
[out]	err	Error flag (optional)
[out]	stat	Status (0 on success) (optional)

Definition at line 63 of file gtvarslicenext.f90.

  use gtdata_types, only: gt_variable
  use dc_error, only: storeerror, dc_noerr, gt_enomoredims, &
    & nf90_einval, nf90_enotvar
  use gtdata_internal_map, only: map_lookup, gt_dimmap, map_set
  use dc_trace, only: beginsub, endsub, dbgmessage
  implicit none
  type(GT_VARIABLE), intent(in out):: var
  integer, intent(in), optional:: dimord
  logical, intent(out), optional:: err
  integer, intent(out), optional:: stat
  type(gt_dimmap), allocatable:: map(:)
  integer:: mystat, vid, id, nd, idim_lo, idim_hi, ilast
continue
  call beginsub('gtvarslicenext')
  if (present(dimord)) call dbgmessage('dimord=%d', i=(/dimord/))
 
  call map_lookup(var, vid=vid, ndims=nd)
  if (vid < 0) then
    mystat = nf90_enotvar
    goto 999
  endif
  if (nd <= 0) then
    call dbgmessage('dimension map not associated')
    mystat = gt_enomoredims
    goto 999
  endif
  allocate(map(nd))
  call map_lookup(var, map=map)
 
  if (present(dimord)) then
    if (dimord < 0 .or. dimord <= size(map)) then
      call dbgmessage('dimord=%d is out of 1..%d', i=(/dimord, size(map)/))
      mystat = nf90_einval
      goto 995
    endif
    idim_lo = dimord
    idim_hi = dimord
  else
    idim_lo = 1
    idim_hi = size(map)
  endif
  call dbgmessage('idim scan range=(%d:%d)', i=(/idim_lo, idim_hi/))
 
  mystat = gt_enomoredims
  do, id = idim_lo, idim_hi
    ilast = map(id)%start + (map(id)%count * 2 - 1) * map(id)%stride
    call dbgmessage('last_index=%d allcount=%d', &
      & i=(/ilast, map(id)%allcount/))
    if (ilast >= 1 .and. ilast <= map(id)%allcount) then
      map(id)%start = map(id)%start + map(id)%count * map(id)%stride
      mystat = dc_noerr
      exit
    endif
  enddo
  if (mystat /= dc_noerr) goto 995
  call map_set(var, map, mystat)
 
995 continue
  deallocate(map)
 
999 continue
  if (present(stat)) then
    stat = mystat
    if (present(err)) err = (mystat /= dc_noerr)
  else
    call storeerror(mystat, "GTVarSliceNext", err)
  endif
  call endsub('gtvarslicenext', 'stat=%d', i=(/mystat/))

References dc_trace::beginsub(), dc_trace::dbgmessage(), dc_error::dc_noerr, dc_trace::endsub(), dc_error::gt_enomoredims, gtdata_internal_map::map_lookup(), gtdata_internal_map::map_set(), and dc_error::storeerror().

Here is the call graph for this function: