Radaer api la side - part two initialisation

build/extract/extract.yaml

@@ -114,6 +114,7 @@ ukca:
     - src/control/core/top_level/ukca_init.F90
     - src/control/core/top_level/ukca_main1-ukca_main1.F90
     - src/control/core/top_level/ukca_radaer_lfric_api_mod.F90
+    - src/control/core/top_level/ukca_radaer_lfric_init_mod.F90
     - src/control/core/top_level/ukca_setup_mod.F90
     - src/control/core/top_level/ukca_solang.F90
     - src/control/core/top_level/ukca_step_control_mod.F90
@@ -356,6 +357,10 @@ ukca:
     - src/science/radaer/spcrg3a_mod.F90
     - src/science/radaer/ukca_radaer_band_average.F90
     - src/science/radaer/ukca_radaer_compute_aod.F90
+    - src/science/radaer/ukca_radaer_lfric_list_mod.F90
+    - src/science/radaer/ukca_radaer_lfric_saved_mod.F90
+    - src/science/radaer/ukca_radaer_lfric_settings_mod.F90
+    - src/science/radaer/ukca_radaer_lfric_struct_mod.F90
     - src/science/radaer/ukca_radaer_lut_mod.F90
     - src/science/radaer/ukca_radaer_populate_lut_mod.F90
     - src/science/radaer/ukca_radaer_precalc_mod.F90

dependencies.yaml

@@ -50,5 +50,5 @@ socrates-spectral:
     ref: 2026.07.1
 
 ukca:
-    source: git@github.com:MetOffice/ukca.git
-    ref: 9fc2b6da8701f4904911b561a2738e3f16c4e501
+    source: git@github.com:alanjhewitt/ukca.git
+    ref: radaer_api_ukca_side_5

documentation/source/science_guide/radaer/index.rst

@@ -0,0 +1,26 @@
+.. -----------------------------------------------------------------------------
+    (c) Crown copyright Met Office. All rights reserved.
+    The file LICENCE, distributed with this code, contains details of the terms
+    under which the code may be used.
+   -----------------------------------------------------------------------------
+.. _radaer_api_index:
+
+Summary of RADAER
+================================
+
+RADAER is a package of software within the UKCA repository that is called
+independently of the rest of UKCA. Functionally, it sits in slow physics and
+deals with the interactions between aerosols and SOCRATES (radiation) and is
+called prior to the SOCRATES radiation code.
+
+RADAER gets called directly from its parent applications (for example in
+LFRic_apps via radaer_kernel_mod).
+
+
+
+
+.. toctree::
+    :maxdepth: 1
+    :glob:
+
+    *

documentation/source/science_guide/radaer/radaer_api.rst

@@ -0,0 +1,34 @@
+.. -----------------------------------------------------------------------------
+    (c) Crown copyright Met Office. All rights reserved.
+    The file LICENCE, distributed with this code, contains details of the terms
+    under which the code may be used.
+   -----------------------------------------------------------------------------
+
+==========
+RADAER API
+==========
+
+:Author: Alan J Hewitt
+
+Description of RADAER API
+=========================
+
+Radaer will be available to the parent application via a single API module as
+a minimal set of top_level subroutines. These will include an initialisation
+function to correctly set up radaer for the user inputs and a runtime module.
+
+Names of subroutines presented via the API will start ```ukca_radaer_```
+
+All run time communication between the parent model and UKCA will be via
+argument lists.
+
+All RADAER state variables will be available to the parent model between
+time steps as native FORTRAN arrays, for inspection and possible modification.
+The fields in these arrays will be in a specific order and size, which will
+differ depending on user configuration. The lists of fields will be determined
+by field names retrieved by the parent at run time.
+
+The RADAER interface was designed to be very lean. No significant further
+developments are intended for radaer. There is scope to revisit the lean
+interface in future, if significant developments are required. However,
+replacing RADAER with a different package is more likely to happen in future.

interfaces/physics_schemes_interface/rose-meta/um-aerosol/HEAD/rose-meta.conf

@@ -120,7 +120,7 @@ help=Which emissions options to use
     =GC5 uses 2D ancillaries for bc_biomass and om_biomass,
     = and uses all SO2 at low level
 ns=namelist/Science/UM Aerosol
-sort-key=Panel-A02
+sort-key=Panel-A04
 trigger=namelist:files=emiss_bc_biomass_ancil_path: 'GC3';
        =namelist:files=emiss_om_biomass_ancil_path: 'GC3';
        =namelist:files=emiss_so2_high_ancil_path: 'GC3';
@@ -187,6 +187,7 @@ trigger=namelist:aerosol=activation_scheme: 'climatology','dust_and_clim' ;
        =namelist:aerosol=ukca_scale_marine_pom_ems: 'ukca' ;
        =namelist:aerosol=ukca_scale_sea_salt_ems: 'ukca' ;
        =namelist:aerosol=horiz_d: 'ukca','dust_and_clim';
+       =namelist:aerosol=mode_setup: 'ukca';
        =namelist:aerosol=us_am: 'ukca','dust_and_clim';
 value-titles=off,climatology,ukca,dust_and_clim,radaer_test
 values='off','climatology','ukca','dust_and_clim','radaer_test'
@@ -200,6 +201,50 @@ range=0:99.9
 sort-key=Panel-F01
 type=real
 
+[namelist:aerosol=mode_setup]
+compulsory=true
+description=Set GLOMAP Aerosol Components and Modes
+!enumeration=true
+help=The GLOMAP aerosol scheme is currently available in the configurations
+    =described below:
+    =
+    =DUonly_2mode (previously option (6) in the UM)
+    =  Dust (DU) in insoluble accumulation and insoluble coarse mode.
+    =  This is sometimes labelled as DUonly_2mode
+    =
+    =SUBCOCSSDU_7mode (previously option (8) in the UM)
+    =  Sulphate (SU) Black Carbon (BC) Organic Carbon (OC) Sea Salt (SS)
+    =  Dust (DU) components in 4 soluble modes and 3 insoluble modes.
+    =  This is sometimes labelled SUBCOCSSDU_7mode .
+    =
+    =Coming soon SUBCOCSSDUNH_7mode ( previously option (12) ) for UKESM2.
+    =
+    =Coming soon SolInsol.
+    =
+    =mode_setup is not triggered by glomap_mode_climatology .
+    =glomap_mode_climatology is hard coded to (8) SUBCOCSSDU_7mode .
+    =
+    =Setting glomap_mode_dust_and_clim calls UKCA with (6) dust only. The
+    =dust prognostic fields are combined with climatology aerosol fields from
+    =other components (SU, BC, OC, SS). CDNC and RADAER outputs are then
+    =calculated with GLOMAP setting (8) SUBCOCSSDU_7mode .
+    =glomap_mode_dust_and_clim is used for operational NWP which requires dust
+    =prognostic fields for visibility and everything else needs to be fast.
+sort-key=Panel-A03
+trigger=namelist:aerosol=l_dust_mp_ageing: 'SUBCOCSSDU_7mode' ;
+value-titles=DUonly_2mode,SUBCOCSSDU_7mode
+values='DUonly_2mode','SUBCOCSSDU_7mode'
+
+[namelist:aerosol=l_dust_mp_ageing]
+compulsory=true
+description=Turn on ageing, nucleation scavenging, coagulation,
+           =activation, and hetero chemistry for
+           =UKCA-mode dust and microplastics
+#fail-if=this ==".true." and namelist:aerosol=mode_setup==6
+ns=namelist/Science/UM Aerosol
+sort-key=Panel-A05
+type=logical
+
 [namelist:aerosol=l_radaer]
 compulsory=true
 description=Direct effect of climatology aerosols in RADAER
@@ -215,6 +260,17 @@ trigger=namelist:aerosol=aclw_file: .true. ;
        =namelist:aerosol=crsw_file: .true. ;
        =namelist:aerosol=prec_file: .true. ;
        =namelist:aerosol=n_radaer_step: .true. ;
+       =namelist:aerosol=l_ukca_radaer_sustrat: .true. ;
+type=logical
+
+[namelist:aerosol=l_ukca_radaer_sustrat]
+compulsory=true
+description=Sulphuric acid aerosol in stratosphere
+help=Direct effect of UKCA-MODE aerosols will assume sulphuric acid
+    =optical properties for sulphate aerosol in the stratosphere
+    =aerosol optical depth.
+ns=namelist/Science/UM Aerosol
+sort-key=Panel-B01a
 type=logical
 
 [namelist:aerosol=marine_pom_ems_scaling]
@@ -223,7 +279,7 @@ description=Marine POM emission scale factor
 help=Scaling factor for marine particulate organic matter emission
 !kind=double
 range=0.0:10.0
-sort-key=Panel-A02b
+sort-key=Panel-A04b
 type=real
 
 [namelist:aerosol=murk]
@@ -314,7 +370,7 @@ description=Sea salt emission scale factor
 help=Scaling factor for sea salt emission
 !kind=double
 range=0.0:10.0
-sort-key=Panel-A02d
+sort-key=Panel-A04d
 type=real
 
 [namelist:aerosol=sulphuric_strat_climatology]
@@ -350,7 +406,7 @@ help=Number of segments used in ukca_aero_ctl. This is required to be greater
     = than 1 to run GLOMAP with OpenMP multithreading.
 !kind=default
 ns=namelist/Science/UM Aerosol
-sort-key=Panel-A01
+sort-key=Panel-A02
 type=integer
 
 [namelist:aerosol=ukca_scale_marine_pom_ems]
@@ -363,7 +419,7 @@ help=This logical activates the scaling factor marine_pom_ems_scaling.
     =it maybe be necessary to scale emissions to gain agreement across
     =resolutions.
 !kind=default
-sort-key=Panel-A02a
+sort-key=Panel-A04a
 trigger=namelist:aerosol=marine_pom_ems_scaling: .true. ;
 type=logical
 
@@ -376,7 +432,7 @@ help=This logical activates the scaling factor sea_salt_ems_scaling.
     =generally stronger at higher resolutions. Hence it maybe be necessary
     =to scale emissions to gain agreement across resolutions.
 !kind=default
-sort-key=Panel-A02c
+sort-key=Panel-A04c
 trigger=namelist:aerosol=sea_salt_ems_scaling: .true. ;
 type=logical
 

interfaces/physics_schemes_interface/rose-meta/um-aerosol/versions.py

@@ -18,16 +18,53 @@ def __repr__(self):
     __str__ = __repr__
 
 
-"""
-Copy this template and complete to add your macro
+class vn32_t698(MacroUpgrade):
+    """
+    Upgrade macro for ticket #698 by Alan J Hewitt.
 
-class vnXX_txxx(MacroUpgrade):
-    # Upgrade macro for <TICKET> by <Author>
+    Users can now select UKCA GLOMAP setting via namelist.
+    Note that dust_and_clim is treated by UKCA as if setting (6)
+    but is treated by RADAER as if setting (8).
 
-    BEFORE_TAG = "vnX.X"
-    AFTER_TAG = "vnX.X_txxx"
+    Users can now set dust ageing via the namelist.
+
+    Users can now set radaer SUstrat via the namelist.
+
+    """
+
+    BEFORE_TAG = "vn3.2"
+    AFTER_TAG = "vn3.2_t698"
 
     def upgrade(self, config, meta_config=None):
         # Add settings
+
+        glomap_mode = self.get_setting_value(config,
+                                             ["namelist:aerosol",
+                                              "glomap_mode"])
+
+        if glomap_mode == "'dust_and_clim'":
+            # Existing suites with dust_and_clim need mode_setup==6
+            mode_setup = "'DUonly_2mode'"
+        elif glomap_mode == "'ukca'":
+            # Existing suites with ukca need mode_setup==8
+            mode_setup = "'SUBCOCSSDU_7mode'"
+        else:
+            # This is trigger ignored - default to SUBCOCSSDU_7mode
+            mode_setup = "'SUBCOCSSDU_7mode'"
+
+        # Add new settings with the specified option
+        self.add_setting( config,
+                          ["namelist:aerosol","mode_setup"],
+                          mode_setup )
+
+        # Default to false since this is the setting in all existing tests
+        self.add_setting( config,
+                          ["namelist:aerosol", "l_dust_mp_ageing"],
+                          ".false." )
+
+        # Default to true since this is the setting in all existing tests
+        self.add_setting( config,
+                          ["namelist:aerosol", "l_ukca_radaer_sustrat"],
+                          ".true." )
+
         return config, self.reports
-"""

interfaces/physics_schemes_interface/rose-meta/um-chemistry/HEAD/rose-meta.conf

@@ -182,7 +182,7 @@ description=Number of halvings for ASAD chemistry timestep
 fail-if=this < 0 or this > 5 ;
        =# number of chemistry timestep halvings must be between 0 and 5
 help=The number of times the chemistry timestep chem_timestep value is halved
-    = in UKCA's ASAD chemistry solver.
+    = in UKCA\'s ASAD chemistry solver.
     =
     = For large values of ukca_chem_seg_size, setting a positive value of
     = i_chem_timestep_halvings can skip unnecessary calculations.