Skip to content

Generalized indices support in fms2_io #1871

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
vithikashah001 merged 3 commits into from
May 28, 2026
Merged

Generalized indices support in fms2_io #1871

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5ab34e6
Generalized indices support in fms2_io
May 14, 2026
f7d4658
Add `zdim_index` variable
May 15, 2026
4198e30
Allocate buffers with correct shape
May 15, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 25 additions & 28 deletions fms2_io/include/domain_read.inc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,7 @@ subroutine domain_read_2d(fileobj, variable_name, vdata, unlim_dim_level, &
integer :: xgsize !< Size of global x io domain
integer :: ygbegin !< Starting y index of global io domain
integer :: ygsize !< Size of global y io domain
integer :: dim_order(2) !< Order of the dimensions
type(domain2d), pointer :: io_domain !< pointer to the io_domain

!< The global data is only allocated by the io root PEs
Expand Down Expand Up @@ -164,14 +165,6 @@ subroutine domain_read_2d(fileobj, variable_name, vdata, unlim_dim_level, &
return
endif

if (xdim_index .ne. 1 .or. ydim_index .ne. 2) then
! This is a KLUDGE
! mpp_scatter assumes that the variable is (x,y), if that is not the case it remaps the data
! to a 4D array and calls domain_read_4d which does not use mpp_scatter yet
vdata_dummy(1:size(vdata,1),1:size(vdata,2), 1:1, 1:1) => vdata(:,:)
call domain_read_4d(fileobj, variable_name, vdata_dummy, unlim_dim_level)
return
endif
io_domain => mpp_get_io_domain(fileobj%domain)
c(:) = 1
e(:) = shape(vdata)
Expand Down Expand Up @@ -240,29 +233,32 @@ subroutine domain_read_2d(fileobj, variable_name, vdata, unlim_dim_level, &
e(xdim_index) = xc_size
e(ydim_index) = yc_size

dim_order(xdim_index) = 1
dim_order(ydim_index) = 2

select type(vdata)
type is (integer(kind=i4_kind))
call allocate_array(buf_i4_kind_pe, e)
call mpp_scatter(isc-xgbegin+1, isc+xc_size-xgbegin, jsc-ygbegin+1, jsc+yc_size-ygbegin, fileobj%pelist, &
buf_i4_kind_pe, buf_i4_kind, fileobj%is_root)
buf_i4_kind_pe, buf_i4_kind, dim_order, fileobj%is_root)
call put_array_section(buf_i4_kind_pe, vdata, c, e)
deallocate(buf_i4_kind_pe)
type is (integer(kind=i8_kind))
call allocate_array(buf_i8_kind_pe, e)
call mpp_scatter(isc-xgbegin+1, isc+xc_size-xgbegin, jsc-ygbegin+1, jsc+yc_size-ygbegin, fileobj%pelist, &
buf_i8_kind_pe, buf_i8_kind, fileobj%is_root)
buf_i8_kind_pe, buf_i8_kind, dim_order, fileobj%is_root)
call put_array_section(buf_i8_kind_pe, vdata, c, e)
deallocate(buf_i8_kind_pe)
type is (real(kind=r4_kind))
call allocate_array(buf_r4_kind_pe, e)
call mpp_scatter(isc-xgbegin+1, isc+xc_size-xgbegin, jsc-ygbegin+1, jsc+yc_size-ygbegin, fileobj%pelist, &
buf_r4_kind_pe, buf_r4_kind, fileobj%is_root)
buf_r4_kind_pe, buf_r4_kind, dim_order, fileobj%is_root)
call put_array_section(buf_r4_kind_pe, vdata, c, e)
deallocate(buf_r4_kind_pe)
type is (real(kind=r8_kind))
call allocate_array(buf_r8_kind_pe, e)
call mpp_scatter(isc-xgbegin+1, isc+xc_size-xgbegin, jsc-ygbegin+1, jsc+yc_size-ygbegin, fileobj%pelist, &
buf_r8_kind_pe, buf_r8_kind, fileobj%is_root)
buf_r8_kind_pe, buf_r8_kind, dim_order, fileobj%is_root)
call put_array_section(buf_r8_kind_pe, vdata, c, e)
deallocate(buf_r8_kind_pe)
class default
Expand Down Expand Up @@ -304,6 +300,7 @@ subroutine domain_read_3d(fileobj, variable_name, vdata, unlim_dim_level, &

integer :: xdim_index !< The index of the variable that is the x dimension
integer :: ydim_index !< The index of the variable that is the y dimension
integer :: zdim_index !< The index of the variable that is the z dimension
integer :: xpos !< The position of the x axis
integer :: ypos !< The position of the y axis
integer :: i !< For do loops
Expand All @@ -320,6 +317,7 @@ subroutine domain_read_3d(fileobj, variable_name, vdata, unlim_dim_level, &
integer :: xgsize !< Size of global x io domain
integer :: ygbegin !< Starting y index of global io domain
integer :: ygsize !< Size of global y io domain
integer :: dim_order(3) !< Order of the dimensions
type(domain2d), pointer :: io_domain !< pointer to the io_domain

!< The global data is only allocated by the io root PEs
Expand Down Expand Up @@ -365,14 +363,6 @@ subroutine domain_read_3d(fileobj, variable_name, vdata, unlim_dim_level, &
return
endif

if (xdim_index .ne. 1 .or. ydim_index .ne. 2) then
! This is a KLUDGE
! mpp_scatter assumes that the variable is (x,y), if that is not the case it remaps the data
! to a 4D array and calls domain_read_4d which does not use mpp_scatter yet
vdata_dummy(1:size(vdata,1),1:size(vdata,2), 1:size(vdata,3), 1:1) => vdata(:,:,:)
call domain_read_4d(fileobj, variable_name, vdata_dummy, unlim_dim_level)
return
endif
io_domain => mpp_get_io_domain(fileobj%domain)
c(:) = 1
if (present(corner)) c = corner
Expand Down Expand Up @@ -444,29 +434,36 @@ subroutine domain_read_3d(fileobj, variable_name, vdata, unlim_dim_level, &
e(xdim_index) = xc_size
e(ydim_index) = yc_size

! Calculate the index of the z dimension
zdim_index = 6 - xdim_index - ydim_index

dim_order(xdim_index) = 1
dim_order(ydim_index) = 2
dim_order(zdim_index) = 3

select type(vdata)
type is (integer(kind=i4_kind))
call allocate_array(buf_i4_kind_pe, e)
call mpp_scatter(isc-xgbegin+1, isc+xc_size-xgbegin, jsc-ygbegin+1, jsc+yc_size-ygbegin, e(3), fileobj%pelist, &
buf_i4_kind_pe, buf_i4_kind, fileobj%is_root)
call mpp_scatter(isc-xgbegin+1, isc+xc_size-xgbegin, jsc-ygbegin+1, jsc+yc_size-ygbegin, e(zdim_index), &
fileobj%pelist, buf_i4_kind_pe, buf_i4_kind, dim_order, fileobj%is_root)
call put_array_section(buf_i4_kind_pe, vdata, c, e)
deallocate(buf_i4_kind_pe)
type is (integer(kind=i8_kind))
call allocate_array(buf_i8_kind_pe, e)
call mpp_scatter(isc-xgbegin+1, isc+xc_size-xgbegin, jsc-ygbegin+1, jsc+yc_size-ygbegin, e(3), fileobj%pelist, &
buf_i8_kind_pe, buf_i8_kind, fileobj%is_root)
call mpp_scatter(isc-xgbegin+1, isc+xc_size-xgbegin, jsc-ygbegin+1, jsc+yc_size-ygbegin, e(zdim_index), &
fileobj%pelist, buf_i8_kind_pe, buf_i8_kind, dim_order, fileobj%is_root)
call put_array_section(buf_i8_kind_pe, vdata, c, e)
deallocate(buf_i8_kind_pe)
type is (real(kind=r4_kind))
call allocate_array(buf_r4_kind_pe, e)
call mpp_scatter(isc-xgbegin+1, isc+xc_size-xgbegin, jsc-ygbegin+1, jsc+yc_size-ygbegin, e(3), fileobj%pelist, &
buf_r4_kind_pe, buf_r4_kind, fileobj%is_root)
call mpp_scatter(isc-xgbegin+1, isc+xc_size-xgbegin, jsc-ygbegin+1, jsc+yc_size-ygbegin, e(zdim_index), &
fileobj%pelist, buf_r4_kind_pe, buf_r4_kind, dim_order, fileobj%is_root)
call put_array_section(buf_r4_kind_pe, vdata, c, e)
deallocate(buf_r4_kind_pe)
type is (real(kind=r8_kind))
call allocate_array(buf_r8_kind_pe, e)
call mpp_scatter(isc-xgbegin+1, isc+xc_size-xgbegin, jsc-ygbegin+1, jsc+yc_size-ygbegin, e(3), fileobj%pelist, &
buf_r8_kind_pe, buf_r8_kind, fileobj%is_root)
call mpp_scatter(isc-xgbegin+1, isc+xc_size-xgbegin, jsc-ygbegin+1, jsc+yc_size-ygbegin, e(zdim_index), &
fileobj%pelist, buf_r8_kind_pe, buf_r8_kind, dim_order, fileobj%is_root)
call put_array_section(buf_r8_kind_pe, vdata, c, e)
deallocate(buf_r8_kind_pe)
class default
Expand Down
Loading
Loading