Skip to content

Commit 9ca1ea4

Browse files
brian-eatonbrian-eaton
authored
Merge pull request #1054 from PeterHjortLauritzen/clubb_intr_bug_fix
cam6_4_006: fix CLUBB interface bug
2 parents 08d0326 + 7a3a23c commit 9ca1ea4

14 files changed

+196
-24
lines changed

‎.gitmodules

+1-1
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@
4444
path = src/dynamics/fv3
4545
url = https://github.com/ESCOMP/CAM_FV3_interface.git
4646
fxrequired = AlwaysRequired
47-
fxtag = fv3int_053124
47+
fxtag = fv3int_061924
4848
fxDONOTUSEurl = https://github.com/ESCOMP/CAM_FV3_interface.git
4949

5050
[submodule "geoschem"]

‎doc/ChangeLog

+141
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,146 @@
11
===============================================================
22

3+
Tag name: cam6_4_006
4+
Originator(s): pel, eaton
5+
Date: 3 July 2024
6+
One-line Summary: fix clubb interface bug (dry/moist mixing ratio conversion)
7+
Github PR URL: https://github.com/ESCOMP/CAM/pull/1054
8+
9+
Purpose of changes (include the issue number and title text for each relevant GitHub issue):
10+
- fix issue described in https://github.com/ESCOMP/CAM/issues/1053
11+
. refactor set_wet_to_dry and set_dry_to_wet to require specifying which
12+
constituent type the mixing ratio conversion is applied to
13+
14+
Describe any changes made to build system: N/A
15+
16+
Describe any changes made to the namelist: N/A
17+
18+
List any changes to the defaults for the boundary datasets: N/A
19+
20+
Describe any substantial timing or memory changes: N/A
21+
22+
Code reviewed by: nusbaume
23+
24+
List all files eliminated: N/A
25+
26+
List all files added and what they do: N/A
27+
28+
List all existing files that have been modified, and describe the changes:
29+
30+
.gitmodules
31+
- update fv3 from fv3int_053124 to fv3int_061924
32+
33+
src/physics/cam/clubb_intr.F90
34+
- add convert_cnst_type='wet' to arg list for set_wet_to_dry
35+
36+
src/physics/cam/physics_types.F90
37+
- refactor set_wet_to_dry and set_dry_to_wet to require specifying which
38+
constituent mixing ratios are being converted.
39+
40+
src/dynamics/fv3/dp_coupling.F90
41+
src/dynamics/fv/dp_coupling.F90
42+
- add convert_cnst_type='dry' to arg list for set_wet_to_dry
43+
44+
src/physics/cam/gw_drag.F90
45+
src/physics/cam/physpkg.F90
46+
src/physics/carma/cam/carma_intr.F90
47+
src/physics/simple/physpkg.F90
48+
- add convert_cnst_type='dry' to arg list for set_dry_to_wet
49+
50+
src/physics/cam/vertical_diffusion.F90
51+
- add convert_cnst_type='dry' to arg list for set_dry_to_wet
52+
and set_wet_to_dry
53+
54+
src/physics/carma/models/cirrus/carma_cloudfraction.F90
55+
src/physics/carma/models/cirrus_dust/carma_cloudfraction.F90
56+
- remove unused association of set_dry_to_wet and set_wet_to_dry
57+
58+
If there were any failures reported from running test_driver.sh on any test
59+
platform, and checkin with these failures has been OK'd by the gatekeeper,
60+
then copy the lines from the td.*.status files for the failed tests to the
61+
appropriate machine below. All failed tests must be justified.
62+
63+
derecho/intel/aux_cam:
64+
65+
ERP_Ln9.f09_f09_mg17.FCSD_HCO.derecho_intel.cam-outfrq9s (Overall: FAIL)
66+
SMS_D_Ln9_P1280x1.ne0ARCTICne30x4_ne0ARCTICne30x4_mt12.FHIST.derecho_intel.cam-outfrq9s (Overall: PEND)
67+
SMS_D_Ln9_P1280x1.ne0CONUSne30x8_ne0CONUSne30x8_mt12.FCHIST.derecho_intel.cam-outfrq9s (Overall: PEND)
68+
SMS_D_Ln9.T42_T42.FSCAM.derecho_intel.cam-outfrq9s (Overall: FAIL)
69+
- pre-existing failures
70+
71+
ERC_D_Ln9.f19_f19_mg17.QPC6.derecho_intel.cam-outfrq3s_cosp (Overall: DIFF)
72+
ERC_D_Ln9_P144x1.ne16pg3_ne16pg3_mg17.QPC6HIST.derecho_intel.cam-outfrq3s_ttrac_usecase (Overall: DIFF)
73+
ERP_D_Ln9.f19_f19_mg17.QPC6.derecho_intel.cam-outfrq9s (Overall: DIFF)
74+
ERP_D_Ln9.ne30pg3_ne30pg3_mg17.FLTHIST.derecho_intel.cam-outfrq9s (Overall: DIFF)
75+
ERP_D_Ln9.ne30pg3_ne30pg3_mg17.FLTHIST.derecho_intel.cam-outfrq9s_rrtmgp (Overall: DIFF)
76+
ERP_D_Ln9_P64x2.f09_f09_mg17.QSC6.derecho_intel.cam-outfrq9s (Overall: DIFF)
77+
ERP_Ld3.f09_f09_mg17.FWHIST.derecho_intel.cam-reduced_hist1d (Overall: DIFF)
78+
ERP_Ln9.C96_C96_mg17.F2000climo.derecho_intel.cam-outfrq9s_mg3 (Overall: DIFF)
79+
ERP_Ln9.f09_f09_mg17.F1850.derecho_intel.cam-outfrq9s (Overall: DIFF)
80+
ERP_Ln9.f09_f09_mg17.F2000climo.derecho_intel.cam-outfrq9s (Overall: DIFF)
81+
ERP_Ln9.f09_f09_mg17.F2010climo.derecho_intel.cam-outfrq9s (Overall: DIFF)
82+
ERP_Ln9.f09_f09_mg17.FHIST_BDRD.derecho_intel.cam-outfrq9s (Overall: DIFF)
83+
ERP_Ln9.f19_f19_mg17.FWsc1850.derecho_intel.cam-outfrq9s (Overall: DIFF)
84+
ERP_Ln9.ne30pg3_ne30pg3_mg17.FCnudged.derecho_intel.cam-outfrq9s (Overall: DIFF)
85+
ERP_Ln9.ne30pg3_ne30pg3_mg17.FW2000climo.derecho_intel.cam-outfrq9s (Overall: DIFF)
86+
ERP_Ln9_P24x3.f45_f45_mg37.QPWmaC6.derecho_intel.cam-outfrq9s_mee_fluxes (Overall: DIFF)
87+
ERS_Ld3.f10_f10_mg37.F1850.derecho_intel.cam-outfrq1d_14dec_ghg_cam7 (Overall: DIFF)
88+
ERS_Ln9.f09_f09_mg17.FX2000.derecho_intel.cam-outfrq9s (Overall: DIFF)
89+
ERS_Ln9.f19_f19_mg17.FXSD.derecho_intel.cam-outfrq9s (Overall: DIFF)
90+
ERS_Ln9_P288x1.mpasa120_mpasa120.F2000climo.derecho_intel.cam-outfrq9s_mpasa120 (Overall: DIFF)
91+
ERS_Ln9_P36x1.mpasa480_mpasa480.F2000climo.derecho_intel.cam-outfrq9s_mpasa480 (Overall: DIFF)
92+
SMS_D_Ln9.f09_f09_mg17.FCts2nudged.derecho_intel.cam-outfrq9s_leapday (Overall: DIFF)
93+
SMS_D_Ln9.f09_f09_mg17.FCvbsxHIST.derecho_intel.cam-outfrq9s (Overall: DIFF)
94+
SMS_D_Ln9.f09_f09_mg17.FSD.derecho_intel.cam-outfrq9s (Overall: DIFF)
95+
SMS_D_Ln9.f19_f19_mg17.FWma2000climo.derecho_intel.cam-outfrq9s (Overall: DIFF)
96+
SMS_D_Ln9.f19_f19_mg17.FWma2000climo.derecho_intel.cam-outfrq9s_waccm_ma_mam4 (Overall: DIFF)
97+
SMS_D_Ln9.f19_f19_mg17.FXHIST.derecho_intel.cam-outfrq9s_amie (Overall: DIFF)
98+
SMS_D_Ln9.f19_f19_mg17.QPC2000climo.derecho_intel.cam-outfrq3s_usecase (Overall: DIFF)
99+
SMS_D_Ln9.ne16pg3_ne16pg3_mg17.FX2000.derecho_intel.cam-outfrq9s (Overall: DIFF)
100+
SMS_D_Ln9.ne30pg3_ne30pg3_mg17.FMTHIST.derecho_intel.cam-outfrq9s (Overall: DIFF)
101+
SMS_D_Ln9_P1280x1.ne30pg3_ne30pg3_mg17.FCLTHIST.derecho_intel.cam-outfrq9s (Overall: DIFF)
102+
SMS_Ld1.f09_f09_mg17.FCHIST_GC.derecho_intel.cam-outfrq1d (Overall: DIFF)
103+
SMS_Ld1.f09_f09_mg17.FW2000climo.derecho_intel.cam-outfrq1d (Overall: DIFF)
104+
SMS_Ld1.ne30pg3_ne30pg3_mg17.FC2010climo.derecho_intel.cam-outfrq1d (Overall: DIFF)
105+
SMS_Lh12.f09_f09_mg17.FCSD_HCO.derecho_intel.cam-outfrq3h (Overall: DIFF)
106+
SMS_Lm13.f10_f10_mg37.F2000climo.derecho_intel.cam-outfrq1m (Overall: DIFF)
107+
SMS_Ln9.f09_f09_mg17.F2010climo.derecho_intel.cam-nudging (Overall: DIFF)
108+
SMS_Ln9.f09_f09_mg17.FW1850.derecho_intel.cam-reduced_hist3s (Overall: DIFF)
109+
SMS_Ln9.f19_f19.F2000climo.derecho_intel.cam-silhs (Overall: DIFF)
110+
SMS_Ln9.f19_f19_mg17.FHIST.derecho_intel.cam-outfrq9s_nochem (Overall: DIFF)
111+
SMS_Ln9.ne30pg3_ne30pg3_mg17.FW2000climo.derecho_intel.cam-outfrq9s_rrtmgp (Overall: DIFF)
112+
- expected baseline differences for cam6/cam7 physics
113+
114+
izumi/nag/aux_cam:
115+
116+
DAE.f45_f45_mg37.FHS94.izumi_nag.cam-dae (Overall: FAIL)
117+
- pre-existing failure
118+
119+
ERC_D_Ln9.f10_f10_mg37.QPC6.izumi_nag.cam-outfrq3s_am (Overall: DIFF)
120+
ERC_D_Ln9.f10_f10_mg37.QPC6.izumi_nag.cam-outfrq3s_cospsathist (Overall: DIFF)
121+
ERC_D_Ln9.f10_f10_mg37.QPC6.izumi_nag.cam-outfrq3s (Overall: DIFF)
122+
ERC_D_Ln9.f10_f10_mg37.QPWmaC6.izumi_nag.cam-outfrq3s (Overall: DIFF)
123+
ERI_D_Ln18.f19_f19_mg17.QPC6.izumi_nag.cam-ghgrmp_e8 (Overall: DIFF)
124+
ERP_Ln9.ne5pg3_ne5pg3_mg37.QPC6.izumi_nag.cam-outfrq9s_clubbmf (Overall: DIFF)
125+
SMS_D_Ln9.f10_f10_mg37.QPC6.izumi_nag.cam-outfrq3s_ba (Overall: DIFF)
126+
SMS_P48x1_D_Ln3.f09_f09_mg17.QPC6HIST.izumi_nag.cam-outfrq3s_co2cycle_usecase (Overall: DIFF)
127+
- expected baseline differences for cam6 physics
128+
129+
izumi/gnu/aux_cam:
130+
131+
ERP_D_Ln9.C48_C48_mg17.QPC6.izumi_gnu.cam-outfrq9s (Overall: DIFF)
132+
ERP_D_Ln9.ne3pg3_ne3pg3_mg37.QPC6.izumi_gnu.cam-outfrq9s_rrtmgp (Overall: DIFF)
133+
- expected baseline differences for cam6 physics
134+
135+
CAM tag used for the baseline comparison tests if different than previous
136+
tag:
137+
138+
Summarize any changes to answers: BFB except all tests using CLUBB (i.e.,
139+
cam6 and cam7 physics) will have baseline comparison failures.
140+
141+
===============================================================
142+
===============================================================
143+
3144
Tag name: cam6_4_005
4145
Originator(s): eaton
5146
Date: 1 July 2024

‎src/dynamics/fv/dp_coupling.F90

+1-1
Original file line numberDiff line numberDiff line change
@@ -576,7 +576,7 @@ subroutine d_p_coupling(grid, phys_state, phys_tend, pbuf2d, dyn_out)
576576
! (note: cam_thermo_dry_air_update assumes dry unless optional conversion factor provided)
577577
!
578578
call set_state_pdry(phys_state(lchnk)) ! First get dry pressure to use for this timestep
579-
call set_wet_to_dry(phys_state(lchnk)) ! Dynamics had moist, physics wants dry
579+
call set_wet_to_dry(phys_state(lchnk), convert_cnst_type='dry') ! Dynamics had moist, physics wants dry
580580
if (dry_air_species_num>0) then
581581
!------------------------------------------------------------
582582
! Apply limiters to mixing ratios of major species

‎src/dynamics/fv3

Submodule fv3 updated 1 file

‎src/physics/cam/clubb_intr.F90

+3-2
Original file line numberDiff line numberDiff line change
@@ -2549,8 +2549,9 @@ subroutine clubb_tend_cam( state, ptend_all, pbuf, hdtime, &
25492549
! Copy the state to state1 array to use in this routine
25502550
call physics_state_copy(state, state1)
25512551

2552-
! constituents are all treated as dry mmr by clubb
2553-
call set_wet_to_dry(state1)
2552+
! Constituents are all treated as dry mmr by clubb. Convert the water species to
2553+
! a dry basis.
2554+
call set_wet_to_dry(state1, convert_cnst_type='wet')
25542555

25552556
if (clubb_do_liqsupersat) then
25562557
call pbuf_get_field(pbuf, npccn_idx, npccn)

‎src/physics/cam/gw_drag.F90

+1-1
Original file line numberDiff line numberDiff line change
@@ -1396,7 +1396,7 @@ subroutine gw_tend(state, pbuf, dt, ptend, cam_in, flx_heat)
13961396
call physics_state_copy(state, state1)
13971397

13981398
! constituents are all treated as wet mmr
1399-
call set_dry_to_wet(state1)
1399+
call set_dry_to_wet(state1, convert_cnst_type='dry')
14001400

14011401
lchnk = state1%lchnk
14021402
ncol = state1%ncol

‎src/physics/cam/physics_types.F90

+40-8
Original file line numberDiff line numberDiff line change
@@ -1481,40 +1481,72 @@ end subroutine set_state_pdry
14811481

14821482
!===============================================================================
14831483

1484-
subroutine set_wet_to_dry (state)
1484+
subroutine set_wet_to_dry(state, convert_cnst_type)
1485+
1486+
! Convert mixing ratios from a wet to dry basis for constituents of type
1487+
! convert_cnst_type. Constituents are given a type when they are added
1488+
! to the constituent array by a call to cnst_add during the register
1489+
! phase of initialization. There are two constituent types: 'wet' for
1490+
! water species and 'dry' for non-water species.
14851491

14861492
use constituents, only: pcnst, cnst_type
14871493

14881494
type(physics_state), intent(inout) :: state
1495+
character(len=3), intent(in) :: convert_cnst_type
14891496

1497+
! local variables
14901498
integer m, ncol
1499+
character(len=*), parameter :: sub = 'set_wet_to_dry'
1500+
!-----------------------------------------------------------------------------
1501+
1502+
! check input
1503+
if (.not.(convert_cnst_type == 'wet' .or. convert_cnst_type == 'dry')) then
1504+
write(iulog,*) sub//': FATAL: convert_cnst_type not recognized: '//convert_cnst_type
1505+
call endrun(sub//': FATAL: convert_cnst_type not recognized: '//convert_cnst_type)
1506+
end if
14911507

14921508
ncol = state%ncol
14931509

1494-
do m = 1,pcnst
1495-
if (cnst_type(m).eq.'dry') then
1510+
do m = 1, pcnst
1511+
if (cnst_type(m) == convert_cnst_type) then
14961512
state%q(:ncol,:,m) = state%q(:ncol,:,m)*state%pdel(:ncol,:)/state%pdeldry(:ncol,:)
1497-
endif
1513+
end if
14981514
end do
14991515

15001516
end subroutine set_wet_to_dry
15011517

15021518
!===============================================================================
15031519

1504-
subroutine set_dry_to_wet (state)
1520+
subroutine set_dry_to_wet(state, convert_cnst_type)
1521+
1522+
! Convert mixing ratios from a dry to wet basis for constituents of type
1523+
! convert_cnst_type. Constituents are given a type when they are added
1524+
! to the constituent array by a call to cnst_add during the register
1525+
! phase of initialization. There are two constituent types: 'wet' for
1526+
! water species and 'dry' for non-water species.
15051527

15061528
use constituents, only: pcnst, cnst_type
15071529

15081530
type(physics_state), intent(inout) :: state
1531+
character(len=3), intent(in) :: convert_cnst_type
15091532

1533+
! local variables
15101534
integer m, ncol
1535+
character(len=*), parameter :: sub = 'set_dry_to_wet'
1536+
!-----------------------------------------------------------------------------
1537+
1538+
! check input
1539+
if (.not.(convert_cnst_type == 'wet' .or. convert_cnst_type == 'dry')) then
1540+
write(iulog,*) sub//': FATAL: convert_cnst_type not recognized: '//convert_cnst_type
1541+
call endrun(sub//': FATAL: convert_cnst_type not recognized: '//convert_cnst_type)
1542+
end if
15111543

15121544
ncol = state%ncol
15131545

1514-
do m = 1,pcnst
1515-
if (cnst_type(m).eq.'dry') then
1546+
do m = 1, pcnst
1547+
if (cnst_type(m) == convert_cnst_type) then
15161548
state%q(:ncol,:,m) = state%q(:ncol,:,m)*state%pdeldry(:ncol,:)/state%pdel(:ncol,:)
1517-
endif
1549+
end if
15181550
end do
15191551

15201552
end subroutine set_dry_to_wet

‎src/physics/cam/physpkg.F90

+1-1
Original file line numberDiff line numberDiff line change
@@ -1948,7 +1948,7 @@ subroutine tphysac (ztodt, cam_in, &
19481948
!
19491949
! Note: this operation will NOT be reverted with set_wet_to_dry after set_dry_to_wet call
19501950
!
1951-
call set_dry_to_wet(state)
1951+
call set_dry_to_wet(state, convert_cnst_type='dry')
19521952

19531953
if (trim(cam_take_snapshot_before) == "physics_dme_adjust") then
19541954
call cam_snapshot_all_outfld_tphysac(cam_snapshot_after_num, state, tend, cam_in, cam_out, pbuf,&

‎src/physics/cam/vertical_diffusion.F90

+2-2
Original file line numberDiff line numberDiff line change
@@ -911,7 +911,7 @@ subroutine vertical_diffusion_tend( &
911911
! ----------------------- !
912912

913913
! Assume 'wet' mixing ratios in diffusion code.
914-
call set_dry_to_wet(state)
914+
call set_dry_to_wet(state, convert_cnst_type='dry')
915915

916916
rztodt = 1._r8 / ztodt
917917
lchnk = state%lchnk
@@ -1384,7 +1384,7 @@ subroutine vertical_diffusion_tend( &
13841384
endif
13851385
end do
13861386
! convert wet mmr back to dry before conservation check
1387-
call set_wet_to_dry(state)
1387+
call set_wet_to_dry(state, convert_cnst_type='dry')
13881388

13891389
if (.not. do_pbl_diags) then
13901390
slten(:ncol,:) = ( sl(:ncol,:) - sl_prePBL(:ncol,:) ) * rztodt

‎src/physics/cam7/physpkg.F90

+1-1
Original file line numberDiff line numberDiff line change
@@ -2395,7 +2395,7 @@ subroutine tphysac (ztodt, cam_in, &
23952395
!
23962396
! Note: this operation will NOT be reverted with set_wet_to_dry after set_dry_to_wet call
23972397
!
2398-
call set_dry_to_wet(state)
2398+
call set_dry_to_wet(state, convert_cnst_type='dry')
23992399

24002400
if (trim(cam_take_snapshot_before) == "physics_dme_adjust") then
24012401
call cam_snapshot_all_outfld_tphysac(cam_snapshot_before_num, state, tend, cam_in, cam_out, pbuf,&

‎src/physics/carma/cam/carma_intr.F90

+1-1
Original file line numberDiff line numberDiff line change
@@ -1036,7 +1036,7 @@ subroutine carma_timestep_tend(state, cam_in, cam_out, ptend, dt, pbuf, dlf, rli
10361036
! The CARMA interface assumes that mass mixing ratios are relative to a
10371037
! wet atmosphere, so convert any dry mass mixing ratios to wet.
10381038
call physics_state_copy(state, state_loc)
1039-
call set_dry_to_wet(state_loc)
1039+
call set_dry_to_wet(state_loc, convert_cnst_type='dry')
10401040

10411041
spdiags(:, :, :) = 0.0_r8
10421042
gpdiags(:, :, :, :) = 0.0_r8

‎src/physics/carma/models/cirrus/carma_cloudfraction.F90

+1-2
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,7 @@ subroutine CARMA_CloudFraction(carma, cstate, cam_in, state, icol, cldfrc, rhcri
2424
use carma_mod
2525

2626
use shr_kind_mod, only: r8 => shr_kind_r8
27-
use physics_types, only: physics_state, physics_ptend, set_wet_to_dry, &
28-
set_dry_to_wet
27+
use physics_types, only: physics_state, physics_ptend
2928
use constituents, only: cnst_get_ind
3029
use cam_abortutils, only: endrun
3130

‎src/physics/carma/models/cirrus_dust/carma_cloudfraction.F90

+1-2
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,7 @@ subroutine CARMA_CloudFraction(carma, cstate, cam_in, state, icol, cldfrc, rhcri
2424
use carma_mod
2525

2626
use shr_kind_mod, only: r8 => shr_kind_r8
27-
use physics_types, only: physics_state, physics_ptend, set_wet_to_dry, &
28-
set_dry_to_wet
27+
use physics_types, only: physics_state, physics_ptend
2928
use constituents, only: cnst_get_ind
3029
use cam_abortutils, only: endrun
3130

‎src/physics/simple/physpkg.F90

+1-1
Original file line numberDiff line numberDiff line change
@@ -654,7 +654,7 @@ subroutine tphysac (ztodt, cam_in, cam_out, state, tend, pbuf)
654654
!
655655
! Note: this operation will NOT be reverted with set_wet_to_dry after set_dry_to_wet call
656656
!
657-
call set_dry_to_wet(state)
657+
call set_dry_to_wet(state, convert_cnst_type='dry')
658658
call physics_dme_adjust(state, tend, qini, totliqini, toticeini, ztodt)
659659
call tot_energy_phys(state, 'phAM')
660660
call tot_energy_phys(state, 'dyAM', vc=vc_dycore)

0 commit comments

Comments
 (0)