gtvarexchdim.f90 File Reference

Exchange dimension order numbers. More...

Go to the source code of this file.

Functions/Subroutines
subroutine	gtvarexchdim (var, dimord1, dimord2, count_compact, err)

Detailed Description

Exchange dimension order numbers.

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

Definition in file gtvarexchdim.f90.

Function/Subroutine Documentation

gtvarexchdim()

subroutine gtvarexchdim	(	type(gt_variable), intent(in)	var,
		integer, intent(in)	dimord1,
		integer, intent(in)	dimord2,
		logical, intent(in), optional	count_compact,
		logical, intent(out)	err
	)

Exchange dimensions at specified order numbers

Exchanges dimensions at dimension order numbers dimord1 and dimord2 in variable var.

If count_compact is .true., operates including degenerate dimensions.

If an error occurs, outputs a message and terminates the program. If err is provided, returns .true. and program does not terminate.

Parameters

[in]	var	Variable handle
[in]	dimord1	First dimension order number
[in]	dimord2	Second dimension order number
[in]	count_compact	Include degenerate dimensions (optional)
[out]	err	Error flag

Definition at line 56 of file gtvarexchdim.f90.

  use gtdata_types, only: gt_variable
  use gtdata_internal_map, only: map_lookup, gt_dimmap, map_set_ndims, map_set, &
    & dimord_skip_compact
  use dc_trace, only: beginsub, endsub, dbgmessage
  implicit none
  type(GT_VARIABLE), intent(in):: var
  integer, intent(in):: dimord1, dimord2
  logical, intent(in), optional:: count_compact
  logical, intent(out):: err
  type(gt_dimmap), allocatable:: map(:)
  type(gt_dimmap):: tmpmap
  integer:: ndimsp, stat, idim1, idim2
  logical:: direct_mode
  character(*), parameter:: subname = 'GTVarExchDim'
continue
  err = .true.
  direct_mode = .false.
  if (present(count_compact)) then
    direct_mode = count_compact
  endif
  call beginsub(subname)
  if (dimord1 < 1 .or. dimord2 < 1) then
    call endsub(subname, "negative dimord=%d %d invalid", i=(/dimord1, dimord2/))
    return
  endif
  call map_lookup(var, ndims=ndimsp)
  if (ndimsp <= 0) then
    call endsub(subname, "variable invalid")
    return
  else if (dimord1 > ndimsp .or. dimord2 > ndimsp) then
    call endsub(subname, "dimord=%d %d not exist", i=(/dimord1, dimord2/))
    return
  endif
 
  allocate(map(ndimsp))
  call map_lookup(var, map=map)
 
  if (.not. direct_mode) then
    idim1 = dimord_skip_compact(dimord1, map)
    idim2 = dimord_skip_compact(dimord2, map)
    if (idim1 < 0 .or. idim2 < 0) then
      call endsub(subname, "dimord=%d %d not found after compaction", &
        & i=(/dimord1, dimord2/))
      deallocate(map)
      return
    endif
  else
    idim1 = dimord1
    idim2 = dimord2
  endif
 
  tmpmap = map(idim1)
  map(idim1) = map(idim2)
  map(idim2) = tmpmap
  call map_set(var, map, stat)
  deallocate(map)
 
  err = stat /= 0
  call endsub(subname)

References dc_trace::beginsub(), dc_trace::dbgmessage(), gtdata_internal_map::dimord_skip_compact(), dc_trace::endsub(), gtdata_internal_map::map_lookup(), gtdata_internal_map::map_set(), and gtdata_internal_map::map_set_ndims().

Here is the call graph for this function: