Skip to content

Commit

Permalink
Switch global ocean in init mode to E3SM shared constants
Browse files Browse the repository at this point in the history 
This merge also migrates the computation of the coriolis parameter
to using E3SM shared constants.

The unused constants module imports are removed from several
init mode utilities to ensure that they don't use constants
that are inconsistent with E3SM's versions.
  • Loading branch information
@xylar
xylar committed Jun 21, 2024
1 parent 254955c commit 2c73596
Show file tree
Hide file tree
Showing 7 changed files with 40 additions and 45 deletions.
4 changes: 3 additions & 1 deletion components/mpas-ocean/src/mode_init/Makefile
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,9 @@

OBJS = mpas_ocn_init_mode.o

UTILS = mpas_ocn_init_spherical_utils.o \
UTILS = shr_kind_mod.o \
shr_const_mod.o \
mpas_ocn_init_spherical_utils.o \
mpas_ocn_init_vertical_grids.o \
mpas_ocn_init_cell_markers.o \
mpas_ocn_init_interpolation.o \
Expand Down
3 changes: 0 additions & 3 deletions components/mpas-ocean/src/mode_init/mpas_ocn_init_cell_markers.F
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,8 @@ module ocn_init_cell_markers
use mpas_kind_types
use mpas_derived_types
use mpas_pool_routines
use mpas_constants
use mpas_timer

use ocn_constants

implicit none
private

Expand Down
61 changes: 31 additions & 30 deletions components/mpas-ocean/src/mode_init/mpas_ocn_init_global_ocean.F
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,18 +20,19 @@

module ocn_init_global_ocean

use shr_kind_mod, only: SHR_KIND_R8
use shr_const_mod

use mpas_kind_types
use mpas_io_units
use mpas_derived_types
use mpas_pool_routines
use mpas_constants
use mpas_io
use mpas_io_streams
use mpas_stream_manager
use mpas_timekeeping
use mpas_dmpar

use ocn_constants
use ocn_config
use ocn_diagnostics_variables
use ocn_init_cell_markers
Expand Down Expand Up @@ -632,8 +633,8 @@ subroutine ocn_init_setup_global_ocean_read_topo(domain, iErr)!{{{
call MPAS_closeStream(topographyStream)

if (config_global_ocean_topography_latlon_degrees) then
topoLat % array(:) = topoLat % array(:) * pii / 180.0_RKIND
topoLon % array(:) = topoLon % array(:) * pii / 180.0_RKIND
topoLat % array(:) = topoLat % array(:) * SHR_CONST_PI / 180.0_RKIND
topoLon % array(:) = topoLon % array(:) * SHR_CONST_PI / 180.0_RKIND
end if

end subroutine ocn_init_setup_global_ocean_read_topo!}}}
Expand Down Expand Up @@ -825,26 +826,26 @@ subroutine ocn_init_setup_global_ocean_create_model_topo(domain, iErr)!{{{
call ocn_init_interpolation_nearest_horiz(topoLon % array, topoLat % array, &
topoIC % array, nLonTopo, nLatTopo, &
lonCell, latCell, bottomDepthObserved, nCells, &
inXPeriod = 2.0_RKIND * pii)
inXPeriod = 2.0_RKIND * SHR_CONST_PI)

if (config_global_ocean_topography_has_ocean_frac) then
call ocn_init_interpolation_nearest_horiz(topoLon % array, topoLat % array, &
oceanFracIC % array, nLonTopo, nLatTopo, &
lonCell, latCell, oceanFracObserved, nCells, &
inXPeriod = 2.0_RKIND * pii)
inXPeriod = 2.0_RKIND * SHR_CONST_PI)
end if

elseif (config_global_ocean_topography_method == "bilinear_interpolation") then
call ocn_init_interpolation_bilinear_horiz(topoLon % array, topoLat % array, &
topoIC % array, nLonTopo, nLatTopo, &
lonCell, latCell, bottomDepthObserved, nCells, &
inXPeriod = 2.0_RKIND * pii)
inXPeriod = 2.0_RKIND * SHR_CONST_PI)

if (config_global_ocean_topography_has_ocean_frac) then
call ocn_init_interpolation_bilinear_horiz(topoLon % array, topoLat % array, &
oceanFracIC % array, nLonTopo, nLatTopo, &
lonCell, latCell, oceanFracObserved, nCells, &
inXPeriod = 2.0_RKIND * pii)
inXPeriod = 2.0_RKIND * SHR_CONST_PI)
end if

else
Expand Down Expand Up @@ -1642,11 +1643,11 @@ subroutine ocn_init_setup_global_ocean_read_tracer_lat_lon(domain, iErr)!{{{
if (config_global_ocean_tracer_latlon_degrees) then
do iLat = 1, nLatTracer
tracerLat % array(iLat) = tracerLat % array(iLat) * pii / 180.0_RKIND
tracerLat % array(iLat) = tracerLat % array(iLat) * SHR_CONST_PI / 180.0_RKIND
end do
do iLon = 1, nLonTracer
tracerLon % array(iLon) = tracerLon % array(iLon) * pii / 180.0_RKIND
tracerLon % array(iLon) = tracerLon % array(iLon) * SHR_CONST_PI / 180.0_RKIND
end do
end if
Expand Down Expand Up @@ -1714,11 +1715,11 @@ subroutine ocn_init_setup_global_ocean_read_swData_lat_lon(domain, iErr)!{{{
if (config_global_ocean_swData_latlon_degrees) then
do iLat = 1, nLatSW
swDataLat % array(iLat) = swDataLat % array(iLat) * pii / 180.0_RKIND
swDataLat % array(iLat) = swDataLat % array(iLat) * SHR_CONST_PI / 180.0_RKIND
end do
do iLon = 1, nLonSW
swDataLon % array(iLon) = swDataLon % array(iLon) * pii / 180.0_RKIND
swDataLon % array(iLon) = swDataLon % array(iLon) * SHR_CONST_PI / 180.0_RKIND
end do
end if
Expand Down Expand Up @@ -1801,11 +1802,11 @@ subroutine ocn_init_setup_global_ocean_read_ecosys_lat_lon(domain, iErr)!{{{
if (config_global_ocean_ecosys_latlon_degrees) then
do iLat = 1, nLatEcosys
tracerLat % array(iLat) = tracerLat % array(iLat) * pii / 180.0_RKIND
tracerLat % array(iLat) = tracerLat % array(iLat) * SHR_CONST_PI / 180.0_RKIND
end do
do iLon = 1, nLonEcosys
tracerLon % array(iLon) = tracerLon % array(iLon) * pii / 180.0_RKIND
tracerLon % array(iLon) = tracerLon % array(iLon) * SHR_CONST_PI / 180.0_RKIND
end do
end if
Expand Down Expand Up @@ -2072,13 +2073,13 @@ subroutine ocn_init_setup_global_ocean_interpolate_tracers(domain, tracerArray,
call ocn_init_interpolation_nearest_horiz(tracerLon % array, tracerLat % array, &
tracerIC % array, nLonTracer, nLatTracer, &
lonCell, latCell, interpTracer, nCells, &
inXPeriod = 2.0_RKIND * pii)
inXPeriod = 2.0_RKIND * SHR_CONST_PI)
elseif (config_global_ocean_tracer_method .eq. "bilinear_interpolation") then
call ocn_init_interpolation_bilinear_horiz(tracerLon % array, tracerLat % array, &
tracerIC % array, nLonTracer, nLatTracer, &
lonCell, latCell, interpTracer, nCells, &
inXPeriod = 2.0_RKIND * pii)
inXPeriod = 2.0_RKIND * SHR_CONST_PI)
else
call mpas_log_write( 'Invalid choice of config_global_ocean_tracer_method.', MPAS_LOG_CRIT)
Expand Down Expand Up @@ -2239,13 +2240,13 @@ subroutine ocn_init_setup_global_ocean_interpolate_ecosys_forcing(domain, fieldN
call ocn_init_interpolation_nearest_horiz(tracerLon % array, tracerLat % array, &
ecosysForcingIC % array(:,:,timeCounter), nLonEcosys, nLatEcosys, &
lonCell, latCell, ecosysForcingField, nCells, &
inXPeriod = 2.0_RKIND * pii)
inXPeriod = 2.0_RKIND * SHR_CONST_PI)
elseif (config_global_ocean_ecosys_method .eq. "bilinear_interpolation") then
call ocn_init_interpolation_bilinear_horiz(tracerLon % array, tracerLat % array, &
ecosysForcingIC % array(:,:,timeCounter), nLonEcosys, nLatEcosys, &
lonCell, latCell, ecosysForcingField, nCells, &
inXPeriod = 2.0_RKIND * pii)
inXPeriod = 2.0_RKIND * SHR_CONST_PI)
else
call mpas_log_write( 'Invalid choice of config_global_ocean_ecosys_method.', MPAS_LOG_CRIT)
iErr = 1
Expand Down Expand Up @@ -2449,33 +2450,33 @@ subroutine ocn_init_setup_global_ocean_interpolate_swData(domain, iErr)!{{{
call ocn_init_interpolation_nearest_horiz(swDataLon % array, swDataLat % array, &
chlorophyllIC % array, nLonSW, nLatSW, &
lonCell, latCell, chlorophyllData, nCells, &
inXPeriod = 2.0_RKIND * pii)
inXPeriod = 2.0_RKIND * SHR_CONST_PI)
call ocn_init_interpolation_nearest_horiz(swDataLon % array, swDataLat % array, &
zenithAngleIC % array, nLonSW, nLatSW, &
lonCell, latCell, zenithAngle, nCells, &
inXPeriod = 2.0_RKIND * pii)
inXPeriod = 2.0_RKIND * SHR_CONST_PI)
call ocn_init_interpolation_nearest_horiz(swDataLon % array, swDataLat % array, &
clearSKYIC % array, nLonSW, nLatSW, &
lonCell, latCell, clearSkyRadiation, nCells, &
inXPeriod = 2.0_RKIND * pii)
inXPeriod = 2.0_RKIND * SHR_CONST_PI)
elseif (config_global_ocean_swData_method .eq. "bilinear_interpolation") then
call ocn_init_interpolation_bilinear_horiz(swDataLon % array, swDataLat % array, &
chlorophyllIC % array, nLonSW, nLatSW, &
lonCell, latCell, chlorophyllData, nCells, &
inXPeriod = 2.0_RKIND * pii)
inXPeriod = 2.0_RKIND * SHR_CONST_PI)
call ocn_init_interpolation_bilinear_horiz(swDataLon % array, swDataLat % array, &
zenithAngleIC % array, nLonSW, nLatSW, &
lonCell, latCell, zenithAngle, nCells, &
inXPeriod = 2.0_RKIND * pii)
inXPeriod = 2.0_RKIND * SHR_CONST_PI)
call ocn_init_interpolation_bilinear_horiz(swDataLon % array, swDataLat % array, &
clearSKYIC % array, nLonSW, nLatSW, &
lonCell, latCell, clearSkyRadiation, nCells, &
inXPeriod = 2.0_RKIND * pii)
inXPeriod = 2.0_RKIND * SHR_CONST_PI)
else
call mpas_log_write( 'Invalid choice of config_global_ocean_swData_method.', MPAS_LOG_CRIT)
iErr = 1
Expand Down Expand Up @@ -2603,8 +2604,8 @@ subroutine ocn_init_setup_global_ocean_read_windstress(domain, iErr)!{{{
call MPAS_closeStream(windstressStream)
if (config_global_ocean_windstress_latlon_degrees) then
windLat % array(:) = windLat % array(:) * pii / 180.0_RKIND
windLon % array(:) = windLon % array(:) * pii / 180.0_RKIND
windLat % array(:) = windLat % array(:) * SHR_CONST_PI / 180.0_RKIND
windLon % array(:) = windLon % array(:) * SHR_CONST_PI / 180.0_RKIND
end if
end subroutine ocn_init_setup_global_ocean_read_windstress!}}}
Expand Down Expand Up @@ -2657,23 +2658,23 @@ subroutine ocn_init_setup_global_ocean_interpolate_windstress(domain, iErr)!{{{
call ocn_init_interpolation_nearest_horiz(windLon % array, windLat % array, &
zonalWindIC % array, nLonWind, nLatWind, &
lonCell, latCell, windStressZonal, nCells, &
inXPeriod = 2.0_RKIND * pii)
inXPeriod = 2.0_RKIND * SHR_CONST_PI)
call ocn_init_interpolation_nearest_horiz(windLon % array, windLat % array, &
meridionalWindIC % array, nLonWind, nLatWind, &
lonCell, latCell, windStressMeridional, nCells, &
inXPeriod = 2.0_RKIND * pii)
inXPeriod = 2.0_RKIND * SHR_CONST_PI)
elseif (config_global_ocean_windstress_method .eq. "bilinear_interpolation") then
call ocn_init_interpolation_bilinear_horiz(windLon % array, windLat % array, &
zonalWindIC % array, nLonWind, nLatWind, &
lonCell, latCell, windStressZonal, nCells, &
inXPeriod = 2.0_RKIND*pii)
inXPeriod = 2.0_RKIND*SHR_CONST_PI)
call ocn_init_interpolation_bilinear_horiz(windLon % array, windLat % array, &
meridionalWindIC % array, nLonWind, nLatWind, &
lonCell, latCell, windStressMeridional, nCells, &
inXPeriod = 2.0_RKIND*pii)
inXPeriod = 2.0_RKIND*SHR_CONST_PI)
else
call mpas_log_write( 'Invalid choice of config_global_ocean_windstress_method.', MPAS_LOG_CRIT)
Expand Down
3 changes: 0 additions & 3 deletions components/mpas-ocean/src/mode_init/mpas_ocn_init_interpolation.F
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,8 @@ module ocn_init_interpolation
use mpas_kind_types
use mpas_derived_types
use mpas_pool_routines
use mpas_constants
use mpas_timer

use ocn_constants

implicit none
private
save
Expand Down
10 changes: 6 additions & 4 deletions components/mpas-ocean/src/mode_init/mpas_ocn_init_spherical_utils.F
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,13 @@

module ocn_init_spherical_utils

use shr_kind_mod, only: SHR_KIND_R8
use shr_const_mod

use mpas_kind_types
use mpas_io_units
use mpas_derived_types
use mpas_pool_routines
use mpas_constants
use mpas_stream_manager

use ocn_config
Expand Down Expand Up @@ -293,15 +295,15 @@ subroutine ocn_init_realistic_coriolis_parameter(domain, err)!{{{
call mpas_pool_get_array(meshPool, 'fVertex', fVertex)

do iCell = 1, nCellsSolve
fCell(iCell) = 2.0_RKIND * omega * sin(latCell(iCell))
fCell(iCell) = 2.0_RKIND * SHR_CONST_OMEGA * sin(latCell(iCell))
end do

do iVertex = 1, nVerticesSolve
fVertex(iVertex) = 2.0_RKIND * omega * sin( latVertex(iVertex) )
fVertex(iVertex) = 2.0_RKIND * SHR_CONST_OMEGA * sin( latVertex(iVertex) )
end do

do iEdge = 1, nEdgesSolve
fEdge(iEdge) = 2.0_RKIND * omega * sin( latEdge(iEdge) )
fEdge(iEdge) = 2.0_RKIND * SHR_CONST_OMEGA * sin( latEdge(iEdge) )
end do

block_ptr => block_ptr % next
Expand Down
2 changes: 0 additions & 2 deletions components/mpas-ocean/src/mode_init/mpas_ocn_init_ssh_and_landIcePressure.F
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,7 @@ module ocn_init_ssh_and_landIcePressure
use mpas_io_units
use mpas_derived_types
use mpas_pool_routines
use mpas_constants

use ocn_constants
use ocn_config
use ocn_diagnostics_variables

Expand Down
2 changes: 0 additions & 2 deletions components/mpas-ocean/src/mode_init/mpas_ocn_init_vertical_grids.F
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,9 @@ module ocn_init_vertical_grids
use mpas_kind_types
use mpas_derived_types
use mpas_pool_routines
use mpas_constants
use mpas_timer
use mpas_io

use ocn_constants
use ocn_config
use ocn_diagnostics_variables

Expand Down

0 comments on commit 2c73596

Please sign in to comment.