Complete Zhang McFarlane conversion to CCPP #186

cacraigucar · 2024-12-24T20:19:20Z

Originator(s): Cheryl Craig

Tag: atmos_phys0_08_000

Summary (include the keyword ['closes', 'fixes', 'resolves'] and issue number):
Add ccpp'ized ZM - closes #66

Describe any changes made to the namelist:
A schemes/zhang_mcfarlane/zm_convr_namelist.xml
- namelist template for ZM

List all files eliminated and why: N/A

List all files added and what they do:
A schemes/cloud_fraction/cloud_fraction_fice.F90
A schemes/cloud_fraction/cloud_fraction_fice.meta
- Bring in the cloud_fraction_fice portion of the cloud_fraction CAM code and CCPP'ize it

A schemes/sima_diagnostics/zm_diagnostics.F90
A schemes/sima_diagnostics/zm_diagnostics.meta
- Add the main ZM diagnostics

A schemes/sima_diagnostics/zm_convr_tendency_diagnostics.F90
A schemes/sima_diagnostics/zm_convr_tendency_diagnostics.meta
A schemes/sima_diagnostics/zm_evap_tendency_diagnostics.F90
A schemes/sima_diagnostics/zm_evap_tendency_diagnostics.meta
A schemes/sima_diagnostics/zm_momtran_tendency_diagnostics.F90
A schemes/sima_diagnostics/zm_momtran_tendency_diagnostics.meta
A schemes/sima_diagnostics/zm_tendency_diagnostics.F90
A schemes/sima_diagnostics/zm_tendency_diagnostics.meta
- Add ZM tendency diagnostics for each ZM component

A schemes/utilities/to_be_ccppized_temporary.F90
A schemes/utilities/to_be_ccppized_temporary.meta
- Add a temporary routine to house init methods which aren't being run with to_be_ccppized code.
- Add a call to wv_sat_init

A schemes/zhang_mcfarlane/set_deep_conv_fluxes_to_general.F90
A schemes/zhang_mcfarlane/set_deep_conv_fluxes_to_general.meta
A schemes/zhang_mcfarlane/set_general_conv_fluxes_to_deep.F90
A schemes/zhang_mcfarlane/set_general_conv_fluxes_to_deep.meta
- Add interstitials to move variables back and forth from the ZM deep variables to general variables for the ZM routine which is used in shallow convection as well

A test/test_suites/suite_zhang_mcfarlane.xml
- Suite to test ZM

A to_be_ccppized/error_messages.F90
A to_be_ccppized/namelist_utils.F90
A to_be_ccppized/wv_sat_methods.F90
A to_be_ccppized/wv_saturation.F90
- Add methods which ZM requires, but are not being CCPP-ized at this point in time

List all existing files that have been modified, and describe the changes:
(Helpful git command: git diff --name-status development...<your_branch_name>)
M doc/ChangeLog
M doc/NamesNotInDictionary.txt
- updated with ZM names

M schemes/zhang_mcfarlane/zm_conv_convtran.F90
M schemes/zhang_mcfarlane/zm_conv_convtran.meta
M schemes/zhang_mcfarlane/zm_conv_evap.F90
M schemes/zhang_mcfarlane/zm_conv_evap.meta
M schemes/zhang_mcfarlane/zm_conv_momtran.F90
M schemes/zhang_mcfarlane/zm_conv_momtran.meta
M schemes/zhang_mcfarlane/zm_convr.F90
M schemes/zhang_mcfarlane/zm_convr.meta
- Further refinements needed to CCPP'ize ZM

M suites/suite_cam7.xml
- Add ZM routines to CAM7

List any test failures:

Is this a science-changing update? New physics package, algorithm change, tuning changes, etc?
- CCPP'ized ZM which was a package which already existed in CAM

…mpilation

…eanup3

Pull ZM 0.5 timestep removal into main

Remove 0.5*timestop logic from all to zm Register species from MICM

Replace original, locally-developed license with Apache 2.0 license.

Bring in development ESCOMP#108 (TUV-x) ESCOMP#112 (tropopause_find) to main

Bring in new directory structure from development

…stics

cacraigucar

I believe I have addressed all of @peverwhee's comments, but I may have missed one

schemes/utilities/to_be_ccppized_temporary.meta

schemes/zhang_mcfarlane/zm_convr.F90

schemes/zhang_mcfarlane/zm_conv_momtran.F90

schemes/zhang_mcfarlane/zm_conv_evap.F90

schemes/sima_diagnostics/zm_diagnostics.F90

schemes/zhang_mcfarlane/zm_conv_evap.meta

cacraigucar · 2025-01-14T20:41:04Z

schemes/zhang_mcfarlane/zm_conv_evap.F90


          work2 = max(fsnow_conv(i,k), work1)
          if (snowmlt(i).gt.0._kind_phys) work2 = 0._kind_phys
-          ntsnprd(i,k) = prdprec(i,k)*work2 - evpsnow(i) - snowmlt(i)
-          tend_s_snwprd  (i,k) = prdprec(i,k)*work2*latice
+          ntsnprd(i,k) = prdprec_gen(i,k)*work2 - evpsnow(i) - snowmlt(i)
+          tend_s_snwprd  (i,k) = prdprec_gen(i,k)*work2*latice
          tend_s_snwevmlt(i,k) = - ( evpsnow(i) + snowmlt(i) )*latice
-      else
-          ntsnprd(i,k) = prdsnow(i,k) - min(flxsnow(i,k)*gravit/pdel(i,k), evpsnow(i)+snowmlt(i))
-          tend_s_snwprd  (i,k) = prdsnow(i,k)*latice
-          tend_s_snwevmlt(i,k) = -min(flxsnow(i,k)*gravit/pdel(i,k), evpsnow(i)+snowmlt(i) )*latice
      end if


I asked Rich Neale about this, but he has not responded. Since this could fit under "code cleanup", I am inclined to leave it. Also, ZM may be having some science changes coming in, so we could bring that up when that PR comes along.

cacraigucar · 2025-01-14T20:41:42Z

schemes/zhang_mcfarlane/zm_conv_evap.F90

@@ -192,7 +176,7 @@ subroutine zm_conv_evap_run(ncol, pver, pverp, &
          evplimit   = min(evplimit, flxprec(i,k) * gravit / pdel(i,k))

 ! Total evaporation cannot exceed input precipitation
-          evplimit   = min(evplimit, (prec(i) - evpvint(i)) * gravit / pdel(i,k))
+          evplimit   = min(evplimit, (prec_gen(i) - evpvint(i)) * gravit / pdel(i,k))

          evpprec(i) = min(evplimit, evpprec(i))
          if( .not.old_snow ) then


See response on other old_snow comment

schemes/zhang_mcfarlane/zm_conv_convtran.meta

peverwhee · 2025-01-16T17:21:25Z

schemes/zhang_mcfarlane/zm_conv_evap.F90


          work2 = max(fsnow_conv(i,k), work1)
          if (snowmlt(i).gt.0._kind_phys) work2 = 0._kind_phys
-          ntsnprd(i,k) = prdprec(i,k)*work2 - evpsnow(i) - snowmlt(i)
-          tend_s_snwprd  (i,k) = prdprec(i,k)*work2*latice
+          ntsnprd(i,k) = prdprec_gen(i,k)*work2 - evpsnow(i) - snowmlt(i)
+          tend_s_snwprd  (i,k) = prdprec_gen(i,k)*work2*latice
          tend_s_snwevmlt(i,k) = - ( evpsnow(i) + snowmlt(i) )*latice
-      else
-          ntsnprd(i,k) = prdsnow(i,k) - min(flxsnow(i,k)*gravit/pdel(i,k), evpsnow(i)+snowmlt(i))
-          tend_s_snwprd  (i,k) = prdsnow(i,k)*latice
-          tend_s_snwevmlt(i,k) = -min(flxsnow(i,k)*gravit/pdel(i,k), evpsnow(i)+snowmlt(i) )*latice
      end if


ok! I guess I'd like to be sure we haven't lost functionality in CAM with this PR? since there used to be a way to make old_snow=.false. (by passing in prdsnow)

peverwhee

a couple lingering things

schemes/zhang_mcfarlane/zm_convr.meta

schemes/sima_diagnostics/zm_diagnostics.meta

…mcleanup4

nusbaume

Great work @cacraigucar! I do have some change requests, but hopefully they are all minor (and of course please let me know if you have any concerns with anything I suggested). Thanks!

schemes/cloud_fraction/cloud_fraction_fice.F90

schemes/cloud_fraction/cloud_fraction_fice.meta

schemes/sima_diagnostics/zm_convr_tendency_diagnostics.F90

schemes/sima_diagnostics/zm_diagnostics.F90

to_be_ccppized/units.F90

to_be_ccppized/wv_saturation.F90

suites/suite_zhang_mcfarlane.xml

nusbaume · 2025-01-17T23:08:09Z

suites/suite_cam7.xml

+    <scheme>qneg</scheme>
+    <scheme>geopotential_temp</scheme>
+    <scheme>zm_diagnostics</scheme>
+


I believe we need to add another set of check_energy calls after the ZM block here:

Suggested change



<scheme>check_energy_scaling</scheme>

<scheme>check_energy_chng</scheme>

Thanks @nusbaume, also wanted to add that before running the ZM scheme, the following should be called to zero the inputs to check_energy_chng:

<scheme>check_energy_zero_fluxes</scheme>

Some inputs need to be provided to check_energy_chng to actually check the energy changes match the boundary fluxes.

Based on physpkg.F90 calls to check_energy_chng after convect_deep_tend:

! Check energy integrals, including "reserved liquid" flx_cnd(:ncol) = prec_dp(:ncol) + rliq(:ncol) snow_dp(:ncol) = snow_dp(:ncol) + rice(:ncol) call check_energy_cam_chng(state, tend, "convect_deep", nstep, ztodt, zero, flx_cnd, snow_dp, zero) snow_dp(:ncol) = snow_dp(:ncol) - rice(:ncol)

the following inputs need to be provided (as an output from the ZM scheme):

scheme_name = "convect_deep"

net_liquid_and_lwe_ice_fluxes_through_top_and_bottom_of_atmosphere_column ("flx_cnd" in check_energy_chng) = prec_dp(:ncol) + rliq(:ncol)

net_lwe_ice_fluxes_through_top_and_bottom_of_atmosphere_column ("flx_ice" in check_energy_chng; I don't like how the above code is recycling snow_dp there simply for calling check_energy_cam_chng) = snow_dp(:ncol) + rice(:ncol)

I realized I have to make the same changes for the shallow convection. Here is how I added these fluxes for my scheme: jimmielin@8c9b103

It looks like snow_dp comes from zm_conv_evap, so that needs to be provided in the interstitial that renames general to deep. But in the case of ZM, rice has to be added on top of it. Maybe pass net_lwe_ice_fluxes_through_top_and_bottom_of_atmosphere_column into both the scheme that computes rice then add snow_dp on top of it in the interstitial.

Or if this is too much work feel free to open an issue? I can add this since I made check_energy_chng so I am the person to blame 😃

@jimmielin - can we open this as a new issue? I have converted ZM, and we can make convect_deep with its additional features a new PR? I'm literally on my last edits and I want to avoid feature creep (and missing deadlines)

@cacraigucar agreed, I am happy to defer this to the future - I can work on this as an example of how check_energy_chng is called as I didn't have a good example to work with when I converted it.

Added issue #192

This all sounds like a good plan to me! I'm keeping this open so we can find it if need be, but feel free to consider it "resolved" for this PR. Thanks!

nusbaume · 2025-01-17T23:25:05Z

doc/ChangeLog

+Originator(s): cacraig
+Date: Dec 24, 2024
+One-line Summary: Complete Zhang McFarlane conversion to CCPP
+Github PR URL:


Just adding a reminder to finish the ChangeLog or add the same info to the PR description before merging.

…p4' into atmos_phys_zmcleanup4

cacraigucar

@nusbaume - Let me know what you think about the few areas where I made some compromises and have questions for you.

schemes/cloud_fraction/cloud_fraction_fice.F90

schemes/sima_diagnostics/zm_convr_tendency_diagnostics.F90

schemes/sima_diagnostics/zm_diagnostics.F90

schemes/cloud_fraction/cloud_fraction_fice.meta

cacraigucar · 2025-01-22T23:31:43Z

suites/suite_cam7.xml

+    <scheme>qneg</scheme>
+    <scheme>geopotential_temp</scheme>
+    <scheme>zm_diagnostics</scheme>
+


suites/suite_zhang_mcfarlane.xml

cacraigucar · 2025-01-23T00:19:14Z

suites/suite_cam7.xml

+    <scheme>qneg</scheme>
+    <scheme>geopotential_temp</scheme>
+    <scheme>zm_diagnostics</scheme>
+


@jimmielin - can we open this as a new issue? I have converted ZM, and we can make convect_deep with its additional features a new PR? I'm literally on my last edits and I want to avoid feature creep (and missing deadlines)

to_be_ccppized/units.F90

peverwhee

thanks @cacraigucar !

schemes/zhang_mcfarlane/zm_conv_evap.F90

to_be_ccppized/units.F90

nusbaume

Getting much closer! Just some missed changes from the previous review along with one comment change request. Thanks!

cacraigucar

I'd forgotten to push my last set of changes last night... sigh. Could you please resolve the issues that were in that push, so I can see what is left? Also, I am still looking into the to_be_ccppized_temporary

schemes/zhang_mcfarlane/zm_conv_evap.F90

nusbaume

Almost there! Just two missed requests from earlier.

schemes/zhang_mcfarlane/zm_conv_evap.F90

schemes/sima_diagnostics/zm_diagnostics.F90

cacraigucar

Next try - there are still some unresolved conversations, but they are for things I remember doing, so I think they are in there.

cacraigucar · 2025-01-23T18:21:05Z

schemes/utilities/to_be_ccppized_temporary.F90

@@ -0,0 +1,29 @@
+module to_be_ccppized_temporary


Well, it turns out that it is at the top of both the suite_zhang_mcfarlane.xml as well as the top of the ZM section in the CAM7 suite. So it is being tested - I just missed seeing it in my scanning of the files.

schemes/sima_diagnostics/zm_diagnostics.F90

schemes/zhang_mcfarlane/zm_conv_evap.F90

nusbaume

Looks great to me now, thanks @cacraigucar!

Tag: atmos_phys0_08_000 Use new constituent tendency updater in cam7 SDF #188 MUSICA TUVX scheme: create aerosol radiator, set_aerosol_optics_values #182 Set gas-species profiles in TUV-x and map indices between constituents and MICM #184 Complete Zhang McFarlane conversion to CCPP #186

cacraigucar and others added 30 commits May 17, 2024 11:52

Metadata completed and partial namelist

c6f2699

Remove unused variables

c6ddcb4

Cleanup3 updates and namelist xml file added

2e96710

put back in dif inside zm_convr_run

3c6447a

Remove dif from calling list

2abb58d

Bring limcnv calculation into init

2d7b589

Update ZM metadata, add namelist and preliminary mods for CAM-SIMA co…

5b89cb5

…mpilation

Remove prdsnow completely

2208d45

Add missing declaration for standard_name

70c0450

hook up constituents

2252688

Updates to get ZM to compile in CAM-SIMA

c8076de

Merge tag 'atmos_phys0_03_000' into atmos_phys_zmcleanup3

102cd40

Fixes for cleanup3

755a07b

additional changes to get ZM running in CAM-SIMA

e8dc85f

Merge remote-tracking branch 'court/diagnostics' into atmos_phys_zmcl…

6cf8164

…eanup3

Preliminary zm_diagnostics

c790696

preliminary diagnostics for ZM

00c566d

Merge pull request ESCOMP#110 from ESCOMP/development

d9d0e5d

Pull ZM 0.5 timestep removal into main

Merge tag 'atmos_phys_0_04_001' into atmos_phys_zmcleanup3

721142e

Remove 0.5*timestop logic from all to zm Register species from MICM

Remove zm_org logic per Rich Neale's advice

34e609b

Changes to get ZM to run in CAM-SIMA

aba6bee

Changes to fix answers - now roundoff

094d677

Change Liceense to Apache 2.0

fd27d14

Replace original, locally-developed license with Apache 2.0 license.

Remove old license file.

592fe83

cleanup and fix a couple of bugs

bff9925

add some ZM diagnostics

752c550

Merge pull request ESCOMP#121 from ESCOMP/development

93a1dbf

Bring in development ESCOMP#108 (TUV-x) ESCOMP#112 (tropopause_find) to main

Merge pull request ESCOMP#130 from ESCOMP/development

f8ce60b

Bring in new directory structure from development

Next phase of updates to ZM, including introducing zm_tendency_diagno…

d17b4ed

…stics

preliminary diagnostics

307d8bc

cacraigucar commented Jan 14, 2025

View reviewed changes

cacraigucar requested a review from peverwhee January 14, 2025 23:26

Update CAM7 SDF

4eaff0d

peverwhee reviewed Jan 16, 2025

View reviewed changes

peverwhee requested changes Jan 16, 2025

View reviewed changes

schemes/zhang_mcfarlane/zm_convr.meta Show resolved Hide resolved

schemes/sima_diagnostics/zm_diagnostics.meta Outdated Show resolved Hide resolved

cacraigucar added 2 commits January 16, 2025 10:42

Merge remote-tracking branch 'upstream/development' into atmos_phys_z…

582a284

…mcleanup4

Address more reviewer comments

508f8df

cacraigucar requested a review from peverwhee January 17, 2025 19:44

nusbaume requested changes Jan 17, 2025

View reviewed changes

cacraigucar added 3 commits January 22, 2025 14:09

address more reviewer comments

be92b76

Merge remote-tracking branch 'refs/remotes/origin/atmos_phys_zmcleanu…

9834767

…p4' into atmos_phys_zmcleanup4

further reviewer comment cleanup

3cf1473

cacraigucar commented Jan 23, 2025

View reviewed changes

jimmielin mentioned this pull request Jan 23, 2025

Add check_energy_chng calls (and inputs) for ZM scheme / CAM7 suite #192

Open

peverwhee approved these changes Jan 23, 2025

View reviewed changes

nusbaume reviewed Jan 23, 2025

View reviewed changes

schemes/zhang_mcfarlane/zm_conv_evap.F90 Outdated Show resolved Hide resolved

to_be_ccppized/units.F90 Outdated Show resolved Hide resolved

nusbaume requested changes Jan 23, 2025

View reviewed changes

cacraigucar added 2 commits January 23, 2025 10:02

More reviewer comments

c5b16f7

One more change

1ef9358

cacraigucar commented Jan 23, 2025

View reviewed changes

schemes/zhang_mcfarlane/zm_conv_evap.F90 Outdated Show resolved Hide resolved

cacraigucar requested a review from nusbaume January 23, 2025 17:22

nusbaume requested changes Jan 23, 2025

View reviewed changes

schemes/zhang_mcfarlane/zm_conv_evap.F90 Show resolved Hide resolved

schemes/sima_diagnostics/zm_diagnostics.F90 Outdated Show resolved Hide resolved

Address more reviewer comments

27e410b

cacraigucar commented Jan 23, 2025

View reviewed changes

cacraigucar requested a review from nusbaume January 23, 2025 18:44

nusbaume approved these changes Jan 23, 2025

View reviewed changes

Update NamesNotInDictionary.txt

7d1ab92

cacraigucar merged commit fb23338 into ESCOMP:development Jan 24, 2025
3 checks passed

cacraigucar mentioned this pull request Jan 24, 2025

Merge development into main for ZM #194

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Complete Zhang McFarlane conversion to CCPP #186

Complete Zhang McFarlane conversion to CCPP #186

cacraigucar commented Dec 24, 2024 •

edited

Loading

cacraigucar left a comment

cacraigucar Jan 14, 2025

cacraigucar Jan 14, 2025

peverwhee Jan 16, 2025 •

edited

Loading

peverwhee left a comment

nusbaume left a comment

nusbaume Jan 17, 2025

cacraigucar Jan 22, 2025

jimmielin Jan 22, 2025 •

edited

Loading

cacraigucar Jan 23, 2025

jimmielin Jan 23, 2025

nusbaume Jan 23, 2025

nusbaume Jan 17, 2025

cacraigucar left a comment

cacraigucar Jan 22, 2025

cacraigucar Jan 23, 2025

peverwhee left a comment

nusbaume left a comment

cacraigucar left a comment

nusbaume left a comment

cacraigucar left a comment

cacraigucar Jan 23, 2025

nusbaume left a comment

+    <!-- Check that energy and water changes match the boundary fluxes -->
+    <scheme>check_energy_scaling</scheme>
+    <scheme>check_energy_chng</scheme>

Complete Zhang McFarlane conversion to CCPP #186

Complete Zhang McFarlane conversion to CCPP #186

Conversation

cacraigucar commented Dec 24, 2024 • edited Loading

cacraigucar left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

peverwhee Jan 16, 2025 • edited Loading

Choose a reason for hiding this comment

peverwhee left a comment

Choose a reason for hiding this comment

nusbaume left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jimmielin Jan 22, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cacraigucar left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

peverwhee left a comment

Choose a reason for hiding this comment

nusbaume left a comment

Choose a reason for hiding this comment

cacraigucar left a comment

Choose a reason for hiding this comment

nusbaume left a comment

Choose a reason for hiding this comment

cacraigucar left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nusbaume left a comment

Choose a reason for hiding this comment

cacraigucar commented Dec 24, 2024 •

edited

Loading

peverwhee Jan 16, 2025 •

edited

Loading

jimmielin Jan 22, 2025 •

edited

Loading