Skip to content

Commit

Permalink
Merge pull request #1628 from GEOS-ESM/feature/mathomp4/1564-remove-l…
Browse files Browse the repository at this point in the history 
…atlon-basic-factory

Fixes #1564. Remove latlon basic constructor
  • Loading branch information
@mathomp4
mathomp4 committed Aug 9, 2022
2 parents d49b9cb + 116cd30 commit 1c4aeab
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 96 deletions.
2 changes: 2 additions & 0 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

### Removed

- Removed `LatLonGridFactory_basic` factory constructor (dead code)

### Deprecated

## [2.24.0] - 2022-08-08
Expand Down
130 changes: 34 additions & 96 deletions base/MAPL_LatLonGridFactory.F90
View file
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ module MAPL_LatLonGridFactoryMod
real(kind=REAL64), allocatable :: lon_corners(:)
real(kind=REAL64), allocatable :: lat_corners(:)
logical :: force_decomposition = .false.

! Domain decomposition:
integer :: nx = MAPL_UNDEFINED_INTEGER
integer :: ny = MAPL_UNDEFINED_INTEGER
Expand Down Expand Up @@ -101,7 +101,6 @@ module MAPL_LatLonGridFactoryMod
character(len=*), parameter :: MOD_NAME = 'MAPL_LatLonGridFactory::'

interface LatLonGridFactory
module procedure LatLonGridFactory_basic
module procedure LatLonGridFactory_from_parameters
end interface LatLonGridFactory

Expand All @@ -116,67 +115,6 @@ module MAPL_LatLonGridFactoryMod

contains

! Note: lats and lons must be in _radians_, as the ESMF_Grid
! constructor is currently assuming that choice.
function Latlongridfactory_basic(grid_name, &
& lon_centers, lat_centers, lon_corners, lat_corners, &
& ims, jms, lm, unusable, rc) result(factory)
type (LatLonGridFactory) :: factory
character(len=*), intent(in) :: grid_name
real(kind=REAL64), intent(in) :: lon_centers(:)
real(kind=REAL64), intent(in) :: lat_centers(:)
real(kind=REAL64), intent(in) :: lon_corners(:)
real(kind=REAL64), intent(in) :: lat_corners(:)
integer, intent(in) :: ims(:)
integer, intent(in) :: jms(:)
integer, intent(in) :: lm
class (KeywordEnforcer), optional, intent(in) :: unusable
integer, optional, intent(out) :: rc

type (ESMF_VM) :: vm
integer :: nPet

integer :: status
character(*), parameter :: IAM = __FILE__

_UNUSED_DUMMY(unusable)

factory%is_regular = .false.

factory%grid_name = grid_name
factory%lon_centers = lon_centers
factory%lat_centers = lat_centers
factory%lon_corners = lon_corners
factory%lat_corners = lat_corners

factory%im_world = size(lon_centers)
factory%jm_world = size(lon_centers)
factory%lm = lm

! Decomposition
factory%ims = ims
factory%jms = jms
factory%nx = size(ims)
factory%ny = size(jms)

! Check consistency

_ASSERT(size(lon_corners) == size(lon_centers)+1, 'inconsistent shape')
_ASSERT(size(lat_corners) == size(lat_centers)+1, 'inconsistent shape')

_ASSERT(sum(ims) == size(lon_centers),'inconcistent decomposition')
_ASSERT(sum(jms) == size(lat_centers),'inconcistent decomposition')

call ESMF_VMGetCurrent(vm, rc=status)
_VERIFY(status)
call ESMF_VMGet(vm, PETcount=nPet, rc=status)
_VERIFY(status)
_ASSERT(factory%nx*factory%ny == nPet,'inconsistent process topology')

_RETURN(_SUCCESS)

end function LatLonGridFactory_basic


function LatLonGridFactory_from_parameters(unusable, grid_name, &
& im_world, jm_world, lm, nx, ny, ims, jms, &
Expand All @@ -199,7 +137,7 @@ function LatLonGridFactory_from_parameters(unusable, grid_name, &
integer, optional, intent(in) :: ny
integer, optional, intent(in) :: ims(:)
integer, optional, intent(in) :: jms(:)
logical, optional, intent(in) :: force_decomposition
logical, optional, intent(in) :: force_decomposition

integer, optional, intent(out) :: rc

Expand Down Expand Up @@ -467,7 +405,7 @@ function compute_lon_corners(this, dateline, unusable, rc) result(lon_corners)
regional = (dateline == 'XY')
if (regional) then
delta = (this%lon_range%max - this%lon_range%min) / this%im_world
min_coord = this%lon_range%min
min_coord = this%lon_range%min
max_coord = this%lon_range%max
else
delta = 360.d0 / this%im_world
Expand Down Expand Up @@ -732,11 +670,11 @@ subroutine initialize_from_file_metadata(this, file_metadata, unusable, force_fi
integer :: i
logical :: hasLon, hasLat, hasLongitude, hasLatitude, hasLev,hasLevel,regLat,regLon
real(kind=REAL64) :: del12,delij

integer :: i_min, i_max
real(kind=REAL64) :: d_lat, d_lat_temp, extrap_lat
logical :: is_valid, use_file_coords, compute_lons, compute_lats

_UNUSED_DUMMY(unusable)

if (present(force_file_coordinates)) then
Expand All @@ -747,7 +685,7 @@ subroutine initialize_from_file_metadata(this, file_metadata, unusable, force_fi

! Cannot assume that lats and lons are evenly spaced
this%is_regular = .false.

associate (im => this%im_world, jm => this%jm_world, lm => this%lm)
lon_name = 'lon'
hasLon = file_metadata%has_dimension(lon_name)
Expand All @@ -757,7 +695,7 @@ subroutine initialize_from_file_metadata(this, file_metadata, unusable, force_fi
else
lon_name = 'longitude'
hasLongitude = file_metadata%has_dimension(lon_name)
if (hasLongitude) then
if (hasLongitude) then
im = file_metadata%get_dimension(lon_name, rc=status)
_VERIFY(status)
else
Expand All @@ -772,7 +710,7 @@ subroutine initialize_from_file_metadata(this, file_metadata, unusable, force_fi
else
lat_name = 'latitude'
hasLatitude = file_metadata%has_dimension(lat_name)
if (hasLatitude) then
if (hasLatitude) then
jm = file_metadata%get_dimension(lat_name, rc=status)
_VERIFY(status)
else
Expand All @@ -793,11 +731,11 @@ subroutine initialize_from_file_metadata(this, file_metadata, unusable, force_fi
lm = file_metadata%get_dimension(lev_name,rc=status)
_VERIFY(status)
end if
end if
end if

! TODO: if 'lat' and 'lon' are not present then
! assume ... pole/dateline are ?

! TODO: check radians vs degrees. Assume degrees for now.


Expand Down Expand Up @@ -865,12 +803,12 @@ subroutine initialize_from_file_metadata(this, file_metadata, unusable, force_fi
end if
end if
end if


! Corners are the midpoints of centers (and extrapolated at the
! poles for lats.)
allocate(this%lon_corners(im+1), this%lat_corners(jm+1))

this%lon_corners(1) = (this%lon_centers(im) + this%lon_centers(1))/2 - 180
this%lon_corners(2:im) = (this%lon_centers(1:im-1) + this%lon_centers(2:im))/2
this%lon_corners(im+1) = (this%lon_centers(im) + this%lon_centers(1))/2 + 180
Expand All @@ -892,7 +830,7 @@ subroutine initialize_from_file_metadata(this, file_metadata, unusable, force_fi
this%lat_corners(1) = this%lat_centers(1) - (this%lat_centers(2)-this%lat_centers(1))/2
this%lat_corners(2:jm) = (this%lat_centers(1:jm-1) + this%lat_centers(2:jm))/2
this%lat_corners(jm+1) = this%lat_centers(jm) - (this%lat_centers(jm-1)-this%lat_centers(jm))/2

if (abs(this%lat_centers(1) + 90) < 1000*epsilon(1.0)) then
this%pole = 'PC'
else if (abs(this%lat_corners(1) + 90) < 1000*epsilon(1.0)) then
Expand Down Expand Up @@ -928,10 +866,10 @@ subroutine initialize_from_file_metadata(this, file_metadata, unusable, force_fi
else
compute_lons=.false.
compute_lats=.false.
if (regLon .and. (this%dateline.ne.'XY')) then
if (regLon .and. (this%dateline.ne.'XY')) then
compute_lons=.true.
end if
if (regLat .and. (this%pole.ne.'XY')) then
if (regLat .and. (this%pole.ne.'XY')) then
compute_lats=.true.
end if
if (compute_lons .and. compute_lats) then
Expand Down Expand Up @@ -959,7 +897,7 @@ subroutine initialize_from_file_metadata(this, file_metadata, unusable, force_fi
end if

end associate

call this%make_arbitrary_decomposition(this%nx, this%ny, rc=status)
_VERIFY(status)

Expand All @@ -969,7 +907,7 @@ subroutine initialize_from_file_metadata(this, file_metadata, unusable, force_fi
allocate(this%jms(0:this%ny-1))
call MAPL_DecomposeDim(this%im_world, this%ims, this%nx, min_DE_extent=2)
call MAPL_DecomposeDim(this%jm_world, this%jms, this%ny, min_DE_extent=2)

call this%check_and_fill_consistency(rc=status)
_VERIFY(status)

Expand All @@ -995,7 +933,7 @@ subroutine initialize_from_config_with_prefix(this, config, prefix, unusable, rc

call ESMF_VmGetCurrent(VM, rc=status)
_VERIFY(status)

this%is_regular = .true.
call ESMF_ConfigGetAttribute(config, tmp, label=prefix//'GRIDNAME:', default=MAPL_GRID_NAME_DEFAULT)
this%grid_name = trim(tmp)
Expand Down Expand Up @@ -1404,7 +1342,7 @@ subroutine initialize_from_esmf_distGrid(this, dist_grid, lon_array, lat_array,

! the code below is kluge to return DE/DC wheither or not the file lons are -180 to 180 or 0 360
! it detects whether the first longitudes which are cell centers
! If first longitude is 0 or -180 (DC) it is dateline center in that 0 or -180 is
! If first longitude is 0 or -180 (DC) it is dateline center in that 0 or -180 is
! in the center of a grid cell.
! or shifted by half a grid box (DE) so 0 or -180 is the edge of a cell
! really should have 4 options dateline edge (DE), dateline center(DC)
Expand Down Expand Up @@ -1439,7 +1377,7 @@ subroutine initialize_from_esmf_distGrid(this, dist_grid, lon_array, lat_array,

nx_guess = nint(sqrt(real(nPet)))
do nx = nx_guess,1,-1
ny=nPet/nx
ny=nPet/nx
if (nx*ny==nPet) then
call MAPL_ConfigSetAttribute(config, nx, 'NX:')
call MAPL_ConfigSetAttribute(config, ny, 'NY:')
Expand Down Expand Up @@ -1514,7 +1452,7 @@ function physical_params_are_equal(this, a) result(equal)
end if
else
equal = &
& all(a%lon_centers == this%lon_centers) .and. &
& all(a%lon_centers == this%lon_centers) .and. &
& all(a%lon_corners == this%lon_corners) .and. &
& all(a%lat_centers == this%lat_centers) .and. &
& all(a%lat_corners == this%lat_corners)
Expand Down Expand Up @@ -1612,7 +1550,7 @@ function generate_new_decomp(im,nd) result(n)
integer, intent(in) :: im, nd
integer :: n
logical :: canNotDecomp

canNotDecomp = .true.
n = nd
do while(canNotDecomp)
Expand All @@ -1623,7 +1561,7 @@ function generate_new_decomp(im,nd) result(n)
end if
enddo
end function generate_new_decomp

subroutine init_halo(this, unusable, rc)
class (LatLonGridFactory), target, intent(inout) :: this
class (KeywordEnforcer), optional, intent(in) :: unusable
Expand Down Expand Up @@ -1659,7 +1597,7 @@ subroutine init_halo(this, unusable, rc)
this%py = pet / this%nx

this%is_halo_initialized = .true.

_RETURN(_SUCCESS)

end subroutine init_halo
Expand Down Expand Up @@ -1688,7 +1626,7 @@ subroutine halo(this, array, unusable, halo_width, rc)
call this%init_halo(rc=status)
_VERIFY(status)
end if

associate (nx => this%nx, ny => this% ny, px => this%px, py => this%py)
! Nearest neighbors processor' ids
pet_north = get_pet(px, py+1, nx, ny)
Expand Down Expand Up @@ -1729,7 +1667,7 @@ subroutine fill_north(array, rc)

integer :: len, last

last = size(array,2)-1
last = size(array,2)-1
len = size(array,1)

call MAPL_CommsSendRecv(this%layout, &
Expand All @@ -1754,7 +1692,7 @@ subroutine fill_south(array, rc)

integer :: len, last

last = size(array,2)-1
last = size(array,2)-1
len = size(array,1)

call MAPL_CommsSendRecv(this%layout, &
Expand All @@ -1780,7 +1718,7 @@ subroutine fill_east(array, rc)

integer :: len, last

last = size(array,2)-1
last = size(array,2)-1
len = size(array,1)

call MAPL_CommsSendRecv(this%layout, &
Expand Down Expand Up @@ -1826,7 +1764,7 @@ subroutine append_metadata(this, metadata)

type (Variable) :: v
real(kind=REAL64), allocatable :: temp_coords(:)

! Horizontal grid dimensions
call metadata%add_dimension('lon', this%im_world)
call metadata%add_dimension('lat', this%jm_world)
Expand Down Expand Up @@ -1897,8 +1835,8 @@ subroutine generate_file_bounds(this,grid,local_start,global_start,global_count,
allocate(local_start,source=[i1,j1])
allocate(global_start,source=[1,1])
allocate(global_count,source=[global_dim(1),global_dim(2)])
_RETURN(_SUCCESS)

_RETURN(_SUCCESS)

end subroutine generate_file_bounds

Expand Down Expand Up @@ -1929,7 +1867,7 @@ function generate_file_reference2D(this,fpointer) result(ref)
_UNUSED_DUMMY(this)
ref = ArrayReference(fpointer)
end function generate_file_reference2D

function generate_file_reference3D(this,fpointer,metaData) result(ref)
use pFIO
type(ArrayReference) :: ref
Expand All @@ -1939,6 +1877,6 @@ function generate_file_reference3D(this,fpointer,metaData) result(ref)
_UNUSED_DUMMY(this)
ref = ArrayReference(fpointer)
end function generate_file_reference3D


end module MAPL_LatLonGridFactoryMod

0 comments on commit 1c4aeab

Please sign in to comment.