Bring in cam_in/cam_out variables to the registry (#402)

Tag name (required for release branches):
Originator(s): cacraigucar nusbaume

Description (include the issue title, and the keyword ['closes',
'fixes', 'resolves'] followed by the issue number):
Closes #23 

Describe any changes made to build system: N/A

Describe any changes made to the namelist: N/A

List any changes to the defaults for the input datasets (e.g. boundary
datasets): N/A

List all files eliminated and why: 
D       src/control/camsrfexch.F90
D       src/control/camsrfexch.meta
- camsrfexch is not needed in CAM-SIMA and was just a temporary routine
until cam_in/cam_out were fully implemented

List all files added and what they do: 
A       test/unit/python/sample_files/physics_types_ddt_mf.F90
A       test/unit/python/sample_files/physics_types_ddt_mf.meta
            - test new functionality

List all existing files that have been modified, and describe the
changes:
(Helpful git command: `git diff --name-status
development...<your_branch_name>`)
M       .gitmodules
             - Update atmospheric_physics external

M       src/control/cam_comp.F90
M       src/cpl/nuopc/atm_comp_nuopc.F90
M       src/dynamics/mpas/stepon.F90
M       src/dynamics/none/stepon.F90
M       src/dynamics/se/stepon.F90
             - Use cam_in/cam_out from the registry now (physics_types)
                         
M       src/cpl/nuopc/atm_import_export.F90 
M       src/cpl/nuopc/atm_stream_ndep.F90     
              - Use cam_in/cam_out from the registry now (physics_types)
              - Fix bugs in code which was previously #if def'd out
             
M       src/physics/utils/phys_comp.F90
               - New interface for allocate_physics_types_fields
              
M       src/data/generate_registry_data.py 
- Grab dimensions via 'use' statements instead of input arguments in the
generated 'allocate_physics_types_fields' subroutine to allow for
arbitrary registry variable order
             
M       test/unit/python/sample_files/physics_types_complete.F90
M       test/unit/python/sample_files/physics_types_complete.meta
M       test/unit/python/sample_files/physics_types_ddt2.F90
M       test/unit/python/sample_files/physics_types_ddt_array.F90
M       test/unit/python/sample_files/physics_types_ddt_eul.F90
M       test/unit/python/sample_files/physics_types_ddt_eul.meta
M       test/unit/python/sample_files/physics_types_ddt_fv.F90
M       test/unit/python/sample_files/physics_types_ddt_fv.meta
M       test/unit/python/sample_files/physics_types_ddt_se.F90
M       test/unit/python/sample_files/physics_types_ddt_se.meta
M       test/unit/python/sample_files/physics_types_parameter.F90
M       test/unit/python/sample_files/physics_types_simple.F90
M       test/unit/python/sample_files/reg_good_complete.xml
M       test/unit/python/sample_files/reg_good_ddt.xml
M       test/unit/python/sample_files/reg_good_mf.xml
M       test/unit/python/test_registry.py
             - update tests as needed with the new code
             
M       src/data/registry.xml
             - Fully implement cam_in/cam_out

If there are new failures (compared to the
`test/existing-test-failures.txt` file),
have them OK'd by the gatekeeper, note them here, and add them to the
file.
If there are baseline differences, include the test and the reason for
the
diff. What is the nature of the change? Roundoff?

derecho/intel/aux_sima:  All BFB

derecho/gnu/aux_sima:  All BFB

---------

Co-authored-by: Jesse Nusbaumer <nusbaume@ucar.edu>
Co-authored-by: Haipeng Lin <myself@jimmielin.me>

Author: 3 people

.gitmodules

@@ -20,7 +20,7 @@
 [submodule "ncar-physics"]
         path          = src/physics/ncar_ccpp
 	url           = https://github.com/ESCOMP/atmospheric_physics
-	fxtag         = e92f76351e7f7703fb6d91cb5e76dcbbc6dcb3f2
+	fxtag         = 754a0c28631655289765e99f747c1d96a6d882f4
         fxrequired    = AlwaysRequired
         fxDONOTUSEurl = https://github.com/ESCOMP/atmospheric_physics
 [submodule "rrtmgp-data"]

src/control/cam_comp.F90

@@ -25,7 +25,7 @@ module cam_comp
    use time_manager,              only: is_first_step, is_first_restart_step
    use time_manager,              only: get_curr_calday
 
-   use camsrfexch,                only: cam_out_t, cam_in_t
+   use physics_types,             only: cam_out_t, cam_in_t
    use physics_types,             only: phys_state, phys_tend
    use physics_types,             only: dtime_phys
    use physics_types,             only: calday
@@ -90,7 +90,6 @@ subroutine cam_init(caseid, ctitle, model_doi_url,                         &
       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
       use cam_history,               only: history_init_files
 !      use history_scam,              only: scm_intht
       use cam_pio_utils,             only: init_pio_subsystem
@@ -232,10 +231,6 @@ subroutine cam_init(caseid, ctitle, model_doi_url,                         &
 
          call dyn_init(cam_runtime_opts, dyn_in, dyn_out)
 
-         ! Allocate and setup surface exchange data
-         call atm2hub_alloc(cam_out)
-         call hub2atm_alloc(cam_in)
-
       else
 
 !!XXgoldyXX: v need to import this
@@ -563,7 +558,6 @@ subroutine cam_final(cam_out, cam_in)
       use stepon,               only: stepon_final
       use phys_comp,            only: phys_final
       use cam_initfiles,        only: cam_initfiles_close
-      use camsrfexch,           only: atm2hub_deallocate, hub2atm_deallocate
 !      use ionosphere_interface, only: ionosphere_final
       use cam_control_mod,      only: initial_run
 
@@ -583,9 +577,6 @@ subroutine cam_final(cam_out, cam_in)
          call cam_initfiles_close()
       end if
 
-      call hub2atm_deallocate(cam_in)
-      call atm2hub_deallocate(cam_out)
-
       ! This flush attempts to ensure that asynchronous diagnostic prints
       !   from all processes do not get mixed up with the "END OF MODEL RUN"
       !   message printed by masterproc below.  The test-model script

src/control/camsrfexch.F90

@@ -43,7 +43,7 @@ module atm_comp_nuopc
    use cam_instance        , only : cam_instance_init, inst_suffix, inst_index
    use cam_comp            , only : cam_init, cam_run1, cam_run2, cam_run3, cam_run4, cam_final
    use cam_comp            , only : cam_timestep_init, cam_timestep_final
-   use camsrfexch          , only : cam_out_t, cam_in_t
+   use physics_types       , only : cam_out_t, cam_in_t
 !   use radiation           , only : nextsw_cday  !uncomment once radiation has been CCPP-ized -JN
    use cam_logfile         , only : cam_set_log_unit, iulog
    use cam_abortutils      , only : check_allocate

src/control/camsrfexch.meta

@@ -458,7 +458,7 @@ subroutine import_fields( gcomp, cam_in, restart_init, rc)
     ! copy from field pointer to CAM-SIMA array data structure
     ! -----------------------------------------------------
 
-    use camsrfexch        , only : cam_in_t
+    use physics_types     , only : cam_in_t
     use shr_const_mod     , only : shr_const_stebol
     use shr_sys_mod       , only : shr_sys_abort
     use nuopc_shr_methods , only : chkerr
@@ -526,9 +526,6 @@ subroutine import_fields( gcomp, cam_in, restart_init, rc)
     ! Required atmosphere input fields
     !--------------------------
 
-!Remove once the "cam_in" object has been fully implemented. -JN
-#if 0
-
     if (overwrite_flds) then
        call state_getfldptr(importState, 'Faxx_taux', fldptr=fldptr_taux, rc=rc)
        if (ChkErr(rc,__LINE__,u_FILE_u)) return
@@ -540,7 +537,7 @@ subroutine import_fields( gcomp, cam_in, restart_init, rc)
        if (ChkErr(rc,__LINE__,u_FILE_u)) return
        do i = 1, columns_on_task
           cam_in%wsx(i)    = -fldptr_taux(i) * med2mod_areacor(i)
-          cam_in%wsy(i)    = -fldptr_tauy(g) * med2mod_areacor(i)
+          cam_in%wsy(i)    = -fldptr_tauy(i) * med2mod_areacor(i)
           cam_in%shf(i)    = -fldptr_sen(i)  * med2mod_areacor(i)
           cam_in%cflx(i,1) = -fldptr_evap(i) * med2mod_areacor(i)
        end do
@@ -599,6 +596,8 @@ subroutine import_fields( gcomp, cam_in, restart_init, rc)
        cam_in%landfrac(i)  =  fldptr_lfrac(i)
     end do
 
+! Commented out until dimensions and usage are figured out
+#if 0
     ! Optional fields
 
     call state_getfldptr(importState, 'Sl_ram1', fldptr=fldptr1d, exists=exists, rc=rc)
@@ -676,7 +675,11 @@ subroutine import_fields( gcomp, cam_in, restart_init, rc)
           cam_in%fireztop(i) = fldptr1d(i)
        end do
     end if
+#endif
 
+#if 0
+! Ignoring depvel for now as it has a problematic second dimension (number of dry deposited species) 
+! and it was determined that it probably will not be used in CAM-SIMA for some time
     ! dry dep velocities
     call state_getfldptr(importState, 'Sl_ddvel', fldptr2d=fldptr2d, exists=exists, rc=rc)
     if (ChkErr(rc,__LINE__,u_FILE_u)) return
@@ -687,7 +690,10 @@ subroutine import_fields( gcomp, cam_in, restart_init, rc)
           end do
        end do
     end if
+#endif
 
+#if 0
+! Commented out until water isotopes or carbon ccle fluxe are implemented in CAM-SIMA
     ! fields needed to calculate water isotopes to ocean evaporation processes
     call state_getfldptr(importState,  'So_ustar', fldptr=fldptr1d, exists=exists, rc=rc)
     if (ChkErr(rc,__LINE__,u_FILE_u)) return
@@ -806,7 +812,9 @@ subroutine import_fields( gcomp, cam_in, restart_init, rc)
              cam_in%cflx(i,c_i(4)) = cam_in%cflx(i,c_i(1)) + cam_in%cflx(i,c_i(2)) + cam_in%cflx(i,c_i(3))
           end do
        end do
+
     end if
+#endif
 
     ! if first step, determine longwave up flux from the surface temperature
     if (first_time) then
@@ -818,9 +826,6 @@ subroutine import_fields( gcomp, cam_in, restart_init, rc)
        first_time = .false.
     end if
 
-!Remove once the "cam_in" object has been fully implemented. -JN
-#endif
-
   end subroutine import_fields
 
   !===============================================================================
@@ -835,7 +840,7 @@ subroutine export_fields( gcomp, model_mesh, model_clock, cam_out, rc)
     use ESMF              , only : ESMF_Clock
     use nuopc_shr_methods , only : chkerr
     use srf_field_check   , only : active_Faxa_nhx, active_Faxa_noy
-    use camsrfexch        , only : cam_out_t
+    use physics_types     , only : cam_out_t
     use time_manager      , only : is_first_step, get_nstep
     use physics_grid      , only : columns_on_task
     use atm_stream_ndep   , only : stream_ndep_init, stream_ndep_interp
@@ -884,9 +889,6 @@ subroutine export_fields( gcomp, model_mesh, model_clock, cam_out, rc)
     call NUOPC_ModelGet(gcomp, exportState=exportState, rc=rc)
     if (ChkErr(rc,__LINE__,u_FILE_u)) return
 
-!Remove once the "cam_in" object has been fully implemented. -JN
-#if 0
-
     ! required export state variables
     call state_getfldptr(exportState, 'Sa_topo', fldptr=fldptr_topo, rc=rc)
     if (ChkErr(rc,__LINE__,u_FILE_u)) return
@@ -947,8 +949,8 @@ subroutine export_fields( gcomp, model_mesh, model_clock, cam_out, rc)
        fldptr_swnet(i) = cam_out%netsw(i) * mod2med_areacor(i)
        fldptr_snowc(i) = cam_out%precsc(i)*1000._r8 * mod2med_areacor(i)
        fldptr_snowl(i) = cam_out%precsl(i)*1000._r8 * mod2med_areacor(i)
-       fldptr_rainc(i) = (cam_out%precc(i) - cam_out(c)%precsc(i))*1000._r8 * mod2med_areacor(i)
-       fldptr_rainl(i) = (cam_out%precl(i) - cam_out(c)%precsl(i))*1000._r8 * mod2med_areacor(i)
+       fldptr_rainc(i) = (cam_out%precc(i) - cam_out%precsc(i))*1000._r8 * mod2med_areacor(i)
+       fldptr_rainl(i) = (cam_out%precl(i) - cam_out%precsl(i))*1000._r8 * mod2med_areacor(i)
        fldptr_soll(i)  = cam_out%soll(i)  * mod2med_areacor(i)
        fldptr_sols(i)  = cam_out%sols(i)  * mod2med_areacor(i)
        fldptr_solld(i) = cam_out%solld(i) * mod2med_areacor(i)
@@ -1035,13 +1037,10 @@ subroutine export_fields( gcomp, model_mesh, model_clock, cam_out, rc)
        scale_ndep = 1._r8
     end if
     do i = 1, columns_on_task
-       fldptr_ndep(1,i) = cam_out(c)%nhx_nitrogen_flx(i) * scale_ndep * mod2med_areacor(i)
-       fldptr_ndep(2,i) = cam_out(c)%noy_nitrogen_flx(i) * scale_ndep * mod2med_areacor(i)
+       fldptr_ndep(1,i) = cam_out%nhx_nitrogen_flx(i) * scale_ndep * mod2med_areacor(i)
+       fldptr_ndep(2,i) = cam_out%noy_nitrogen_flx(i) * scale_ndep * mod2med_areacor(i)
     end do
 
-!Remove once the "cam_in" object has been fully implemented. -JN
-#endif
-
   end subroutine export_fields
 
   !===============================================================================