Add new register phase

.gitmodules

@@ -1,7 +1,7 @@
 [submodule "ccpp-framework"]
         path          = ccpp_framework
         url           = https://github.com/NCAR/ccpp-framework
-        fxtag         = 2024-07-19-dev
+        fxtag         = 2024-10-31-dev
         fxrequired    = AlwaysRequired
 	fxDONOTUSEurl = https://github.com/NCAR/ccpp-framework
 [submodule "history"]

src/control/cam_comp.F90

@@ -86,6 +86,7 @@ subroutine cam_init(caseid, ctitle, model_doi_url,                         &
       use cam_initfiles,        only: cam_initfiles_open
       use dyn_grid,             only: model_grid_init
       use phys_comp,            only: phys_init
+      use phys_comp,            only: phys_register
       use dyn_comp,             only: dyn_init
 !      use cam_restart,          only: cam_read_restart
       use camsrfexch,           only: hub2atm_alloc, atm2hub_alloc
@@ -186,6 +187,10 @@ subroutine cam_init(caseid, ctitle, model_doi_url,                         &
       ! Open initial or restart file, and topo file if specified.
       call cam_initfiles_open()
 
+      ! Call CCPP physics register phase (must happen before
+      !   cam_register_constituents)
+      call phys_register()
+
       ! Initialize constituent information
       !    This will set the total number of constituents and the
       !    number of advected constituents.

src/data/generate_registry_data.py

@@ -1783,16 +1783,7 @@ def gen_registry(registry_file, dycore, outdir, indent,
                                     logger, schema_path=schema_dir,
                                     error_on_noxmllint=error_on_no_validate)
     except CCPPError as ccpperr:
-        cemsg = f"{ccpperr}".split('\n', maxsplit=1)[0]
-        if cemsg[0:12] == 'Execution of':
-            xstart = cemsg.find("'")
-            if xstart >= 0:
-                xend = cemsg[xstart + 1:].find("'") + xstart + 1
-                emsg += '\n' + cemsg[xstart + 1:xend]
-            # end if (else, just keep original message)
-        elif cemsg[0:18] == 'validate_xml_file:':
-            emsg += "\n" + cemsg
-        # end if
+        emsg += f"\n{ccpperr}"
         file_ok = False
     # end try
     if not file_ok:

src/data/registry.xml

@@ -154,7 +154,7 @@
               allocatable="pointer">
       <long_name>inverse exner function w.r.t. surface pressure (ps/p)^(R/cp)</long_name>
       <dimensions>horizontal_dimension vertical_layer_dimension</dimensions>
-      <ic_file_input_names>exner state_exner</ic_file_input_names>
+      <ic_file_input_names>exner state_exner inverse_exner_function_wrt_surface_pressure</ic_file_input_names>
     </variable>
     <variable local_name="zm"
               standard_name="geopotential_height_wrt_surface"

src/physics/utils/phys_comp.F90

@@ -10,6 +10,7 @@ module phys_comp
    private
 
    public :: phys_readnl
+   public :: phys_register
    public :: phys_init
    public :: phys_timestep_init
    public :: phys_run1
@@ -129,25 +130,17 @@ subroutine phys_readnl(nlfilename)
 
    end subroutine phys_readnl
 
-   subroutine phys_init()
-      use cam_abortutils,       only: endrun
-      use physics_grid,         only: columns_on_task
-      use vert_coord,           only: pver, pverp
-      use cam_thermo,           only: cam_thermo_init
-      use physics_types,        only: allocate_physics_types_fields
-      use cam_ccpp_cap,         only: cam_ccpp_physics_initialize
+   subroutine phys_register()
+      use cam_ccpp_cap,         only: cam_ccpp_physics_register
       use cam_ccpp_cap,         only: ccpp_physics_suite_part_list
+      use cam_abortutils,       only: endrun
 
       ! Local variables
       integer                    :: i_group
 
-      call cam_thermo_init(columns_on_task, pver, pverp)
-
-      call allocate_physics_types_fields(columns_on_task, pver, pverp,        &
-           set_init_val_in=.true., reallocate_in=.false.)
-      call cam_ccpp_physics_initialize(phys_suite_name)
+      call cam_ccpp_physics_register(phys_suite_name)
       if (errcode /= 0) then
-         call endrun('cam_ccpp_physics_initialize: '//trim(errmsg))
+         call endrun('cam_ccpp_physics_register: '//trim(errmsg))
       end if
       call ccpp_physics_suite_part_list(phys_suite_name, suite_parts,         &
            errmsg, errcode)
@@ -158,12 +151,31 @@ subroutine phys_init()
       ! Confirm that the suite parts are as expected
       do i_group = 1, size(suite_parts)
          if (.not. any(suite_parts(i_group) == suite_parts_expect)) then
-            write(errmsg, *) 'phys_init: SDF suite groups MUST be ',             &
+            write(errmsg, *) 'phys_register: SDF suite groups MUST be ',      &
                 'ONLY `physics_before_coupler` and/or `physics_after_coupler`'
             call endrun(errmsg)
          end if
       end do
 
+   end subroutine phys_register
+
+   subroutine phys_init()
+      use cam_abortutils,       only: endrun
+      use physics_grid,         only: columns_on_task
+      use vert_coord,           only: pver, pverp
+      use cam_thermo,           only: cam_thermo_init
+      use physics_types,        only: allocate_physics_types_fields
+      use cam_ccpp_cap,         only: cam_ccpp_physics_initialize
+
+      call cam_thermo_init(columns_on_task, pver, pverp)
+
+      call allocate_physics_types_fields(columns_on_task, pver, pverp,        &
+           set_init_val_in=.true., reallocate_in=.false.)
+      call cam_ccpp_physics_initialize(phys_suite_name)
+      if (errcode /= 0) then
+         call endrun('cam_ccpp_physics_initialize: '//trim(errmsg))
+      end if
+
    end subroutine phys_init
 
    subroutine phys_timestep_init()