reconcile with dev-access-esm1.6 - interface code (#551)

# CABLE

## Description
Reconcile developments in ESM1.6 with CABLE:main

There are changes across utilities since directories as well BUT here it
is only those in coupled/ that are considered.

Post shuffling these files around to facilitate building a library. What
happens to them is irrelevant really.

These modified and added files are from dev-access-esm1.6. 

## Testing

- [x] Are the changes bitwise-compatible with the main branch? If
working on an optional feature, are the results bitwise-compatible when
this feature is off? If yes, copy benchcab output showing successful
completion of the bitwise compatibility tests or equivalent results
below this line.

So - I haven't actually done the testing BUT considering none of these
fits are even in the build they cant impact anything

<!-- readthedocs-preview cable start -->
----
📚 Documentation preview 📚:
https://cable--551.org.readthedocs.build/en/551/

<!-- readthedocs-preview cable end -->

Author: JhanSrbinovsky

src/coupled/ESM1.5/CABLEfilesFromESM1.5/allocate_soil_params_cbl.F90

@@ -12,7 +12,7 @@ MODULE allocate_soil_params_mod
 
 SUBROUTINE allocate_soil_parameter_type(var, mp)
 
-USE cable_params_mod,           ONLY: soil_parameter_type
+USE cable_soil_type_mod,        ONLY: soil_parameter_type
 USE cable_other_constants_mod,  ONLY: nrb
 
 !-----------------------------------------------------------------------------

src/coupled/ESM1.5/CABLEfilesFromESM1.5/allocate_veg_params_cbl.F90

@@ -12,7 +12,7 @@ MODULE allocate_veg_params_mod
 
 SUBROUTINE allocate_veg_parameter_type(var, mp)
 
-USE cable_params_mod,           ONLY: veg_parameter_type
+USE cable_veg_type_mod,         ONLY: veg_parameter_type
 USE cable_other_constants_mod,  ONLY: nrb !used as ambiguosly AND inconsistently as # rad. bands
 USE cable_other_constants_mod,  ONLY: nscs ! number of soil carbon stores
 USE cable_other_constants_mod,  ONLY: nvcs ! number of vegetation carbon stores

src/coupled/ESM1.5/CABLEfilesFromESM1.5/cable_cbm.F90

@@ -1,66 +1,82 @@
 MODULE cable_cbm_module
 
-   USE cable_canopy_module
+USE cable_canopy_module
 
-   IMPLICIT NONE
+IMPLICIT NONE
 
-   PRIVATE
-   PUBLIC cbm 
+PRIVATE
+PUBLIC cbm 
 
 CONTAINS
 
-   SUBROUTINE cbm( dels, air, bgc, canopy, met,                                &
-                   bal, rad, rough, soil,                                      &
-                   ssnow, sum_flux, veg, climate )
+SUBROUTINE cbm( dels, air, bgc, canopy, met, bal, rad, rough, soil,            &
+                ssnow, sum_flux, veg, climate )
 
+!subrs:
+USE cbl_albedo_mod,            ONLY: albedo
 USE cbl_init_radiation_module, ONLY: init_radiation
-USE cbl_albedo_mod, ONLY: albedo
-USE cbl_masks_mod, ONLY: fveg_mask,  fsunlit_mask,  fsunlit_veg_mask
+USE cbl_masks_mod,             ONLY: fveg_mask, fsunlit_mask,  fsunlit_veg_mask
 USE cbl_soil_snow_main_module, ONLY: soil_snow
-USE snow_aging_mod, ONLY : snow_aging 
-
-!jhan:pass these !data
+USE snow_aging_mod,            ONLY: snow_aging
+USE cable_roughness_module,    ONLY: ruff_resist
+USE cable_air_module,          ONLY: define_air
+USE cable_canopy_module,       ONLY: define_canopy
+
+!data
+USE casadimension,             ONLY: icycle 
+USE cable_phys_constants_mod,  ONLY: GRAV, CAPP 
+  USE cable_common_module
+  USE cable_carbon_module
+
+!jhan:mp must come from here until revise the mp that is also set
+USE cable_def_types_mod, ONLY: met_type, radiation_type, veg_parameter_type,  &
+                               soil_parameter_type, roughness_type,           &
+                               canopy_type, soil_snow_type, balances_type,    &
+                               air_type, bgc_pool_type, sum_flux_type,        &
+                               climate_type, mp, nrb  
+                                   
+! data: scalars
 USE cable_other_constants_mod, ONLY: Ccoszen_tols => coszen_tols
-USE cable_other_constants_mod,  ONLY : Crad_thresh => rad_thresh
+USE cable_other_constants_mod, ONLY: Crad_thresh => rad_thresh
 USE cable_other_constants_mod, ONLY: clai_thresh => lai_thresh
 USE cable_other_constants_mod, ONLY: cgauss_w => gauss_w
 USE cable_math_constants_mod,  ONLY: cpi => pi
 USE cable_math_constants_mod,  ONLY: cpi180 => pi180
+USE cable_phys_constants_mod,  ONLY: tfrz            
+USE grid_constants_mod_cbl,    ONLY: ICE_SoilType!
 USE cable_surface_types_mod,   ONLY: lakes_cable
-USE grid_constants_mod_cbl,    ONLY: ICE_SoilType
-
-
-   USE cable_common_module
-   USE cable_carbon_module
-   USE cable_def_types_mod
-   USE cable_roughness_module
-   USE cable_air_module
-   USE casadimension,            ONLY: icycle 
-   USE cable_phys_constants_mod, ONLY: GRAV, CAPP 
-
-   
-   ! CABLE model variables
-   TYPE (air_type),       INTENT(INOUT) :: air
-   TYPE (bgc_pool_type),  INTENT(INOUT) :: bgc
-   TYPE (canopy_type),    INTENT(INOUT) :: canopy
-   TYPE (met_type),       INTENT(INOUT) :: met
-   TYPE (balances_type),  INTENT(INOUT) :: bal
-   TYPE (radiation_type), INTENT(INOUT) :: rad
-   TYPE (roughness_type), INTENT(INOUT) :: rough
-   TYPE (soil_snow_type), INTENT(INOUT) :: ssnow
-   TYPE (sum_flux_type),  INTENT(INOUT) :: sum_flux
-   TYPE(climate_type),    INTENT(INOUT) :: climate
-    
-   TYPE (soil_parameter_type), INTENT(INOUT)   :: soil 
-   TYPE (veg_parameter_type),  INTENT(INOUT)    :: veg  
+USE cable_phys_constants_mod,  ONLY: cEMLEAF=> EMLEAF
+USE cable_phys_constants_mod,  ONLY: cEMSOIL=> EMSOIL
+USE cable_phys_constants_mod,  ONLY: cSBOLTZ=> SBOLTZ
+
+! CABLE model variables
+TYPE (air_type),       INTENT(INOUT) :: air
+TYPE (bgc_pool_type),  INTENT(INOUT) :: bgc
+TYPE (canopy_type),    INTENT(INOUT) :: canopy
+TYPE (met_type),       INTENT(INOUT) :: met
+TYPE (balances_type),  INTENT(INOUT) :: bal
+TYPE (radiation_type), INTENT(INOUT) :: rad
+TYPE (roughness_type), INTENT(INOUT) :: rough
+TYPE (soil_snow_type), INTENT(INOUT) :: ssnow
+TYPE (sum_flux_type),  INTENT(INOUT) :: sum_flux
+TYPE(climate_type),    INTENT(INOUT) :: climate
+ 
+TYPE (soil_parameter_type), INTENT(INOUT)   :: soil 
+TYPE (veg_parameter_type),  INTENT(INOUT)    :: veg  
 
-   REAL, INTENT(IN)               :: dels ! time setp size (s)
+REAL, INTENT(IN)               :: dels ! time setp size (s)
 
 !co-efficients usoughout init_radiation ` called from _albedo as well
 REAL :: c1(mp,nrb)
 REAL :: rhoch(mp,nrb)
 REAL :: xk(mp,nrb)
+REAL :: veg_wt(mp)    
+REAL :: veg_trad(mp)      
+REAL :: soil_wt(mp)       
+REAL :: soil_trad(mp)     
+REAL :: trad_corr(mp)     
 
+! local vars
 LOGICAL :: veg_mask(mp), sunlit_mask(mp), sunlit_veg_mask(mp)
 LOGICAL :: jls_standalone = .FALSE.
 LOGICAL :: jls_radiation  = .FALSE.
@@ -75,7 +91,7 @@ SUBROUTINE cbm( dels, air, bgc, canopy, met,                                &
 ENDIF
 
 CALL define_air (met, air)
-   
+
 CALL fveg_mask( veg_mask, mp, Clai_thresh, canopy%vlaiw )
 CALL fsunlit_mask( sunlit_mask, mp, CRAD_THRESH,( met%fsd(:,1)+met%fsd(:,2) ) )
 CALL fsunlit_veg_mask( sunlit_veg_mask, veg_mask, sunlit_mask, mp )
@@ -99,12 +115,7 @@ SUBROUTINE cbm( dels, air, bgc, canopy, met,                                &
 
 IF( cable_runtime%um_explicit ) THEN
 
- !Ticket 331 refactored albedo code for JAC
- !#539 move of snow_Aging routine  
- !CALL snow_aging(ssnow%snage,mp,dels,ssnow%snowd,ssnow%osnowd,ssnow%tggsn(:,1),&
- !        ssnow%tgg(:,1),ssnow%isflag,veg%iveg,soil%isoilm) 
-         
-call Albedo( ssnow%AlbSoilsn, soil%AlbSoil,                                &
+  CALL Albedo( ssnow%AlbSoilsn, soil%AlbSoil,                                &
              mp, nrb, ICE_SoilType, lakes_cable, jls_radiation, veg_mask,       &
              Ccoszen_tols, cgauss_w,                                        & 
              veg%iveg, soil%isoilm, veg%refl, veg%taul,                     & 
@@ -126,67 +137,112 @@ SUBROUTINE cbm( dels, air, bgc, canopy, met,                                &
              !CanopyTransmit_beam, CanopyTransmit_dif, 
              rad%reffbm, rad%reffdf                                        &
            ) !EffSurfRefl_beam, EffSurfRefl_dif
-
-
 
-      ENDIF
+ENDIF
 
-   ! Calculate canopy variables:
-   CALL define_canopy(bal,rad,rough,air,met,dels,ssnow,soil,veg, canopy, climate, sunlit_veg_mask, canopy%vlaiw )
-
-   ssnow%otss_0 = ssnow%otss
-   ssnow%otss = ssnow%tss
-   ! RML moved out of following IF after discussion with Eva
-   ssnow%owetfac = ssnow%wetfac
+! on 1st call tss, wetfac initialized in _um_init_soilsnow  
+! on subsequent calls it has the value as updated in soilsnow 
+IF( cable_runtime%um_explicit ) THEN
+  ssnow%otss = ssnow%tss
+  ssnow%owetfac = ssnow%wetfac
+  ! unfortunately for clarity here, define_canopy immediately sets
+  ! canopy%cansto = canopy%oldcansto, so we need this initialization
+  canopy%oldcansto = canopy%cansto
+ENDIF
 
-   IF( cable_runtime%um ) THEN
-      
-     IF( cable_runtime%um_implicit ) THEN
-         CALL soil_snow(dels, soil, ssnow, canopy, met, bal,veg)
-         !#539 move of snow_Aging routine  
-         CALL snow_aging(ssnow%snage,mp,dels,ssnow%snowd,ssnow%osnowd,ssnow%tggsn(:,1),&
-                          ssnow%tgg(:,1),ssnow%isflag,veg%iveg,soil%isoilm) 
-      ENDIF
-
-   ELSE
-      call soil_snow(dels, soil, ssnow, canopy, met, bal,veg)
-      !#539 move of snow_Aging routine  
-      CALL snow_aging(ssnow%snage,mp,dels,ssnow%snowd,ssnow%osnowd,ssnow%tggsn(:,1),&
-                       ssnow%tgg(:,1),ssnow%isflag,veg%iveg,soil%isoilm) 
-   ENDIF
-
-   ssnow%deltss = ssnow%tss-ssnow%otss
-   ! correction required for energy balance in online simulations
-   IF( cable_runtime%um ) THEN
-   
-      canopy%fhs = canopy%fhs + ( ssnow%tss-ssnow%otss ) * ssnow%dfh_dtg
-      
-      canopy%fhs_cor = canopy%fhs_cor + ( ssnow%tss-ssnow%otss ) * ssnow%dfh_dtg
-      
-      canopy%fh = canopy%fhv + canopy%fhs
+! Calculate canopy variables:
+CALL define_canopy( bal, rad, rough, air, met, dels, ssnow, soil, veg, canopy, &
+                    climate, sunlit_veg_mask, canopy%vlaiw )
 
-   canopy%fes = canopy%fes + ( ssnow%tss-ssnow%otss ) *                        &
-                ( ssnow%dfe_ddq * ssnow%ddq_dtg )
-                !( ssnow%cls * ssnow%dfe_ddq * ssnow%ddq_dtg )
-   
-   canopy%fes_cor = canopy%fes_cor + ( ssnow%tss-ssnow%otss ) *                &
-                    ( ssnow%cls * ssnow%dfe_ddq * ssnow%ddq_dtg )
+IF( cable_runtime%um_explicit ) THEN
+  ! reset tss, wetfac, cansto to value corresponding to beginning of timestep 
+  ssnow%tss     = ssnow%otss
+  ssnow%wetfac  = ssnow%owetfac
+  canopy%cansto = canopy%oldcansto
+ENDIF
 
-   ENDIF
+IF( cable_runtime%um_implicit ) THEN
+  
+  CALL soil_snow(dels, soil, ssnow, canopy, met, bal,veg)
+  !#539 move of snow_Aging routine  
+  CALL snow_aging(ssnow%snage,mp,dels,ssnow%snowd,ssnow%osnowd,ssnow%tggsn(:,1),&
+                   ssnow%tgg(:,1),ssnow%isflag,veg%iveg,soil%isoilm) 
+  
+  ssnow%deltss = ssnow%tss-ssnow%otss ! from ESM1.5 could substitute below
 
-   ! need to adjust fe after soilsnow
-   canopy%fev  = canopy%fevc + canopy%fevw
+  ! correction required for energy balance in online simulations
+  IF( cable_user%SOIL_STRUC=='default') THEN
+    
+    canopy%fhs = canopy%fhs + ( ssnow%tss-ssnow%otss ) * ssnow%dfh_dtg
+    canopy%fhs_cor = canopy%fhs_cor + ( ssnow%tss-ssnow%otss ) * ssnow%dfh_dtg
+    canopy%fh = canopy%fhv + canopy%fhs
+    
+    !INH rewritten in terms of %dfe_dtg - NB factor %cls was a bug
+    canopy%fes = canopy%fes + ( ssnow%tss-ssnow%otss ) * ssnow%dfe_dtg
+    !INH NB factor %cls in %fes_cor was a bug - see Ticket #135 #137
+    canopy%fes_cor = canopy%fes_cor + (ssnow%tss-ssnow%otss) * ssnow%dfe_dtg
+    
+    IF (cable_user%L_REV_CORR) THEN
+      
+      !INH need to add on corrections to all terms in the soil energy balance
+      canopy%fns_cor = canopy%fns_cor + (ssnow%tss-ssnow%otss)*ssnow%dfn_dtg
+  
+      !NB %fns_cor also added onto out%Rnet and out%LWnet in cable_output and
+      !cable_checks as the correction term needs to pass through the 
+      !canopy in entirity not be partially absorbed and %fns not used there 
+      !(as would be the case if rad%flws were changed)
+      canopy%fns = canopy%fns + ( ssnow%tss-ssnow%otss )*ssnow%dfn_dtg
 
-   ! Calculate total latent heat flux:
-   canopy%fe = canopy%fev + canopy%fes
+      canopy%ga_cor = canopy%ga_cor + ( ssnow%tss-ssnow%otss )*canopy%dgdtg
+      canopy%ga = canopy%ga + ( ssnow%tss-ssnow%otss )*canopy%dgdtg
+  
+      !assign all the correction to %fes to %fess - none to %fesp
+      canopy%fess = canopy%fess + ( ssnow%tss-ssnow%otss ) * ssnow%dfe_dtg
+  
+    ENDIF
 
-   ! Calculate net radiation absorbed by soil + veg
-   canopy%rnet = canopy%fns + canopy%fnv
+  ENDIF
 
-   ! Calculate radiative/skin temperature:
-   rad%trad = ( ( 1.-rad%transd ) * canopy%tv**4 +                             &
-              rad%transd * ssnow%tss**4 )**0.25
+ENDIF
 
+! need to adjust fe after soilsnow
+canopy%fev  = canopy%fevc + canopy%fevw
+
+! Calculate total latent heat flux:
+canopy%fe = canopy%fev + canopy%fes
+
+! Calculate net radiation absorbed by soil + veg
+canopy%rnet = canopy%fns + canopy%fnv
+
+! Calculate radiative/skin temperature:
+!Jan 2018: UM assumes a single emissivity for the surface in the radiation scheme
+!To accommodate this a single value of is 1. is assumed in ACCESS
+! any leaf/soil emissivity /=1 must be incorporated into rad%trad.  
+! check that emissivities (pft and nvg) set = 1 within the UM i/o configuration
+! CM2 - further adapted to pass the correction term onto %trad correctly
+
+veg_wt    = 1.0 - rad%transd
+veg_trad  = Cemleaf * canopy%tv**4
+soil_wt   = rad%transd 
+soil_trad = Cemsoil * ssnow%tss**4
+
+rad%trad = ( veg_wt * veg_trad )  + ( soil_wt * soil_trad )
+rad%trad = rad%trad**0.25
+
+! In physical model only (i.e. without CASA-CNP)
+
+!! calculate canopy%frp
+!CALL plantcarb(veg,bgc,met,canopy)
+!
+!!calculate canopy%frs
+!CALL soilcarb(soil, ssnow, veg, bgc, met, canopy)
+!
+!CALL carbon_pl(dels, soil, ssnow, veg, canopy, bgc)
+!
+!canopy%fnpp = -1.0* canopy%fpn - canopy%frp
+!canopy%fnee = canopy%fpn + canopy%frs + canopy%frp
+ 
+RETURN
 END SUBROUTINE cbm
 
 END MODULE cable_cbm_module