Skip to content
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

Feature/mfmehari/export mom6 3 d fields #91

Draft
wants to merge 8 commits into
base: develop
Choose a base branch
from
Draft

Feature/mfmehari/export mom6 3 d fields #91

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
4f0c3ef
v2: Support for MOM6 as of 2024-Jul-29
mathomp4 Jul 29, 2024
5e1675c
Merge pull request #74 from GEOS-ESM/feature/mathomp4/mom6-2024Jul29-…
mathomp4 Jul 29, 2024
5b6e236
Remove DEFAULT_2018_ANSWERS as obsolete
mathomp4 Aug 15, 2024
493ad65
Update MOM6 Overrides to match current MOM6 results
mathomp4 Aug 20, 2024
e1793a4
Merge pull request #78 from GEOS-ESM/feature/mathomp4/remove-DEFAULT_…
mathomp4 Aug 21, 2024
8367afa
Merge pull request #81 from GEOS-ESM/feature/mathomp4/add-mom6-32-ove…
mathomp4 Aug 21, 2024
29625b1
Added export for MOM6 T, S and DH fields to be imported by NOBM
mfmehari Feb 28, 2025
c3a78f7
Merge branch 'develop' into feature/mfmehari/Export_MOM6_3D_fields
mfmehari Feb 28, 2025
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
90 changes: 74 additions & 16 deletions MOM6_GEOSPlug/MOM6_GEOSPlug.F90
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,16 +44,19 @@ module MOM6_GEOSPlugMod

use MOM_grid, only: ocean_grid_type

use ocean_model_mod, only: get_ocean_grid, &
ocean_model_init, &
ocean_model_init_sfc, &
update_ocean_model, &
ocean_model_end, &
ocean_model_restart, &
ocean_model_data_get, &
ocean_public_type, &
ocean_state_type, &
ocean_model_get_UV_surf
use ocean_model_mod, only: get_ocean_grid, &
ocean_model_init, &
ocean_model_init_sfc, &
update_ocean_model, &
ocean_model_end, &
ocean_model_restart, &
ocean_model_data_get, &
ocean_public_type, &
ocean_state_type, &
ocean_model_get_UV_surf, &
ocean_model_get_thickness, &
ocean_model_get_prog_tracer, &
ocean_model_get_prog_tracer_index

use MOM_surface_forcing_gfdl, only: ice_ocean_boundary_type

Expand Down Expand Up @@ -182,7 +185,7 @@ subroutine Initialize ( GC, IMPORT, EXPORT, CLOCK, RC )
integer :: Comm
integer :: isc,iec,jsc,jec
integer :: isd,ied,jsd,jed
integer :: IM, JM
integer :: IM, JM, LM
integer :: g_isc,g_iec,g_jsc,g_jec
integer :: g_isd,g_ied,g_jsd,g_jed
integer :: YEAR,MONTH,DAY,HR,MN,SC
Expand Down Expand Up @@ -216,11 +219,14 @@ subroutine Initialize ( GC, IMPORT, EXPORT, CLOCK, RC )
REAL_, pointer :: MOM_2D_MASK(:,:) => null()
REAL_, pointer :: SLV(:,:) => null()

real, allocatable :: Tmp2(:,:)
real, allocatable :: Tmp2(:,:), Tmp3(:,:,:)

REAL_, pointer, dimension(:, :, :) :: DH, TL, SL

integer :: DT_OCEAN
character(len=7) :: wind_stagger ! 'AGRID' or 'BGRID' or 'CGRID'
integer ::iwind_stagger ! AGRID or BGRID or CGRID
integer :: i

__Iam__('Initialize')

Expand Down Expand Up @@ -353,6 +359,9 @@ subroutine Initialize ( GC, IMPORT, EXPORT, CLOCK, RC )
ASSERT_(counts(1)==IM)
ASSERT_(counts(2)==JM)

call get_ocean_grid(Ocean_state, Ocean_grid)
LM=Ocean_grid%ke

! Check run time surface current stagger option set in MOM_input
! to make sure it matches what is expected here
!---------------------------------------------------------------
Expand Down Expand Up @@ -443,6 +452,24 @@ subroutine Initialize ( GC, IMPORT, EXPORT, CLOCK, RC )
call MAPL_GetPointer(EXPORT, SW, 'SW' , alloc=.true., _RC)
call MAPL_GetPointer(EXPORT, AREA, 'AREA', alloc=.true., _RC)
call MAPL_GetPointer(EXPORT, SLV, 'SLV', alloc=.true., _RC)
call MAPL_GetPointer(EXPORT, DH, 'DH' , alloc=.true., _RC)
call MAPL_GetPointer(EXPORT, TL, 'T', alloc=.true., _RC)
call MAPL_GetPointer(EXPORT, SL, 'S', alloc=.true., _RC)

! Get the 3-D MOM data
!---------------------
allocate(Tmp3(IM,JM,LM), __STAT__)

call ocean_model_get_thickness(Ocean_State, tmp3, isc, jsc)
DH = real(tmp3, kind=GeosKind)

call ocean_model_get_prog_tracer_index(Ocean_State,i,'temp')
call ocean_model_get_prog_tracer(Ocean_State,i, tmp3, isc, jsc)
TL = real(tmp3,kind=GeosKind) + MAPL_TICE

call ocean_model_get_prog_tracer_index(Ocean_State,i,'salt')
call ocean_model_get_prog_tracer(Ocean_State, i, tmp3, isc, jsc)
SL = real(tmp3,kind=GeosKind)

! Get the 2-D MOM data
!---------------------
Expand Down Expand Up @@ -471,6 +498,7 @@ subroutine Initialize ( GC, IMPORT, EXPORT, CLOCK, RC )
end if

deallocate(Tmp2, __STAT__)
deallocate(Tmp3, __STAT__)

RETURN_(ESMF_SUCCESS)
end subroutine Initialize
Expand Down Expand Up @@ -512,6 +540,7 @@ subroutine Run ( GC, IMPORT, EXPORT, CLOCK, RC )
type(ocean_public_type), pointer :: Ocean => null()
type(ocean_state_type), pointer :: Ocean_State => null()
type(MOM_MAPL_Type), pointer :: MOM_MAPL_internal_state => null()
type(ocean_grid_type), pointer :: Ocean_grid => null()
type(MOM_MAPLWrap_Type) :: wrap

!#include "MOM6_GEOSPlug_DeclarePointer___.h" ! Because these are "real(kind=GeosKind)" not using ACG.
Expand All @@ -531,6 +560,9 @@ subroutine Run ( GC, IMPORT, EXPORT, CLOCK, RC )
REAL_, pointer :: MOM_2D_MASK (:,:) => null()
REAL_, pointer :: AREA (:,:) => null()
REAL_, pointer :: T_Freeze (:,:) => null()
REAL_, pointer :: DH (:,:,:) => null()
REAL_, pointer :: TL (:,:,:) => null()
REAL_, pointer :: SL (:,:,:) => null()

! Imports
REAL_, pointer :: TAUX(:,:) => null()
Expand All @@ -555,11 +587,11 @@ subroutine Run ( GC, IMPORT, EXPORT, CLOCK, RC )
REAL_, pointer :: TAUYBOT(:,:) => null()

! Temporaries
real, allocatable :: U (:,:), V(:,:)
real, allocatable :: U(:,:), V(:,:), H(:,:,:)
real, allocatable :: cos_rot(:,:)
real, allocatable :: sin_rot(:,:)

integer :: IM, JM
integer :: IM, JM, LM

integer :: steady_state_ocean = 0 ! SA: Per Atanas T, "name" of this var is misleading
! We run ocean model only when it = 0
Expand All @@ -575,6 +607,7 @@ subroutine Run ( GC, IMPORT, EXPORT, CLOCK, RC )
real :: pice_scaling = 1.0
real :: dTf_dS
integer :: DT_OCEAN
integer :: tracer_index

REAL_, pointer, dimension(:,:) :: LATS => null()
REAL_, pointer, dimension(:,:) :: LONS => null()
Expand Down Expand Up @@ -626,11 +659,15 @@ subroutine Run ( GC, IMPORT, EXPORT, CLOCK, RC )
IM=iec-isc+1
JM=jec-jsc+1

call get_ocean_grid (Ocean_state, Ocean_grid)
LM=Ocean_grid%ke

! Temporaries with MOM default reals
!-----------------------------------

allocate(U(IM,JM ), __STAT__)
allocate(V(IM,JM ), __STAT__)
allocate(H(IM,JM,LM), __STAT__)
allocate(cos_rot(IM,JM), __STAT__)
allocate(sin_rot(IM,JM), __STAT__)

Expand Down Expand Up @@ -662,6 +699,10 @@ subroutine Run ( GC, IMPORT, EXPORT, CLOCK, RC )
! Get EXPORT pointers
!--------------------

call MAPL_GetPointer(EXPORT, DH, 'DH' , _RC)
call MAPL_GetPointer(EXPORT, TL, 'T' , _RC)
call MAPL_GetPointer(EXPORT, SL, 'S' , _RC)

call MAPL_GetPointer(EXPORT, UW, 'UW' , _RC)
call MAPL_GetPointer(EXPORT, VW, 'VW' , _RC)
call MAPL_GetPointer(EXPORT, UWB, 'UWB' , _RC)
Expand Down Expand Up @@ -765,7 +806,23 @@ subroutine Run ( GC, IMPORT, EXPORT, CLOCK, RC )
! Get required Exports at GEOS precision
!---------------------------------------

! mask
!MOM 3D fields
! Thickness
call ocean_model_get_thickness(Ocean_State, H, isc, jsc)
DH = real(H, kind=GeosKind)

! Temp
call ocean_model_get_prog_tracer_index(Ocean_State,tracer_index,'temp')
call ocean_model_get_prog_tracer(Ocean_State,tracer_index, H, isc, jsc)
TL = real(H,kind=GeosKind) + MAPL_TICE

! Salt
call ocean_model_get_prog_tracer_index(Ocean_State,tracer_index,'salt')
call ocean_model_get_prog_tracer(Ocean_State, tracer_index, H, isc, jsc)
SL = real(H,kind=GeosKind)

!MOM 2D fields
! 2D mask
U = 0.0
call ocean_model_data_get(Ocean_State, Ocean, 'mask', U, isc, jsc)
MOM_2D_MASK = real(U, kind=GeosKind)
Expand Down Expand Up @@ -908,11 +965,12 @@ subroutine Run ( GC, IMPORT, EXPORT, CLOCK, RC )
! Optional Exports at GEOS precision
!-----------------------------------
! none
! 3d exports with MOM6, such as depths, T, S, U, V, etc
! 3d exports with MOM6, other than depth, T, S (needed by NOBM), such as U, V, etc
! will not be exported. If needed, write them directly from MOM6

deallocate(U, V, __STAT__)
deallocate(cos_rot,sin_rot, __STAT__)
deallocate(H, __STAT__)

call MAPL_TimerOff(MAPL,"RUN" )
call MAPL_TimerOff(MAPL,"TOTAL" )
Expand Down
8 changes: 4 additions & 4 deletions MOM6_GEOSPlug/MOM6_GEOSPlug_StateSpecs.rc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,10 +49,10 @@ SLV | m | xy | N | sea_level_with_ice_loading_and_inv
FRAZIL | W m-2 | xy | N | heating_from_frazil_formation
MELT_POT | W m-2 | xy | N | heat_that_can_be_used_to_melt_sea_ice
FRZMLT | W m-2 | xy | N | freeze_melt_potential
T_Freeze | degC | xy | N | freezing_temperature_calculated_using_salinity
DH | m OR kg m-2 | xyz | C | DUMMY_EXPORT_layer_thickness
T | K | xyz | C | DUMMY_EXPORT_potential_temperature
S | PSU | xyz | C | DUMMY_EXPORT_salinity
T_Freeze | degC | xy | N | freezing_temperature_calculated_using_salinity
DH | m OR kg m-2 | xyz | C | layer_thickness
T | K | xyz | C | potential_temperature
S | PSU | xyz | C | salinity

category: INTERNAL
#----------------------------------------------------------------------------------------
Expand Down