Replicate COMPUTE_ANNEXED_DOFS in adjoint namelist for PSyKAl lite code

applications/adjoint_tests/example/configuration.nml

@@ -1,3 +1,7 @@
+&adjoint
+l_compute_annexed_dofs=.false.,
+/
+
 &base_mesh
 file_prefix='mesh_C12_MG',
 geometry='spherical',

applications/jedi_lfric_tests/example/configuration.nml

@@ -1,3 +1,6 @@
+&adjoint
+l_compute_annexed_dofs=.true.,
+/
 &base_mesh
 file_prefix='mesh_C12_MG',
 geometry='spherical',

applications/jedi_lfric_tests/example_forecast/configuration.nml

@@ -26,6 +26,9 @@ forecast_length='P0DT6H0M0S',
 
 #### Configure LFRic
 
+&adjoint
+l_compute_annexed_dofs=.true.,
+/
 &base_mesh
 file_prefix='mesh_C12',
 geometry='spherical',

applications/jedi_lfric_tests/example_forecast_pseudo/configuration.nml

@@ -29,6 +29,9 @@ time_step='P0DT1H0M0S',
 
 #### Configure LFRic
 
+&adjoint
+l_compute_annexed_dofs=.true.,
+/
 &base_mesh
 file_prefix='mesh_C12',
 geometry='spherical',

applications/jedi_lfric_tests/example_forecast_pseudo/configuration_op.nml

@@ -29,6 +29,9 @@ time_step='P0DT1H0M0S',
 
 #### Configure LFRic
 
+&adjoint
+l_compute_annexed_dofs=.true.,
+/
 &base_mesh
 file_prefix='mesh_C12',
 geometry='spherical',

applications/jedi_lfric_tests/example_id_tlm_tests/configuration.nml

@@ -34,6 +34,10 @@ time_step='P0DT1H0M0S',
 adjoint_test_tolerance=1.0e-4,
 forecast_length='P0DT6H0M0S',
 /
+
+&adjoint
+l_compute_annexed_dofs=.true.,
+/
 &base_mesh
 file_prefix='mesh_C12_MG',
 geometry='spherical',

applications/jedi_lfric_tests/example_tlm_forecast_tl/configuration.nml

@@ -34,6 +34,9 @@ time_step='P0DT1H0M0S',
 adjoint_test_tolerance=1.0e-3,
 forecast_length='P0DT6H0M0S',
 /
+&adjoint
+l_compute_annexed_dofs=.true.,
+/
 &base_mesh
 file_prefix='mesh_C12_MG',
 geometry='spherical',

applications/jedi_lfric_tests/example_tlm_forecast_tl/configuration_op.nml

@@ -38,6 +38,9 @@ forecast_length='P0DT6H0M0S',
 
 #### Configure LFRic
 
+&adjoint
+l_compute_annexed_dofs=.true.,
+/
 &base_mesh
 file_prefix='mesh_C12',
 geometry='spherical',

applications/jedi_lfric_tests/example_tlm_tests/configuration.nml

@@ -34,6 +34,9 @@ time_step='P0DT1H0M0S',
 adjoint_test_tolerance=1.0e-2,
 forecast_length='P0DT6H0M0S',
 /
+&adjoint
+l_compute_annexed_dofs=.true.,
+/
 &base_mesh
 file_prefix='mesh_C12_MG',
 geometry='spherical',

rose-stem/app/adjoint_tests/rose-app.conf

@@ -16,7 +16,8 @@ mode=mkdir
 
 [file:configuration.nml]
 mode=auto
-source=(namelist:aerosol)
+source=namelist:adjoint
+      = (namelist:aerosol)
       =  namelist:base_mesh
       = (namelist:blayer)
       =  namelist:boundaries
@@ -99,6 +100,9 @@ source=(namelist:aerosol)
       = (namelist:vertadvect)
       = (namelist:wind_forcing)
 
+[namelist:adjoint]
+l_compute_annexed_dofs=.false.
+
 [!!namelist:aerosol]
 !!aclw_file=''
 !!acsw_file=''

science/adjoint/rose-meta/lfric-adjoint/HEAD/rose-meta.conf

@@ -1 +1,17 @@
 import=lfric-linear/HEAD
+
+[namelist:adjoint]
+compulsory=true
+description=Provides extra information for the adjoint model.
+help=
+ns=namelist/Adjoint
+sort-key=Section-A07
+title=Adjoint
+
+[namelist:adjoint=l_compute_annexed_dofs]
+compulsory=true
+description=Boolean to control whether to loop into annexed dofs or not. MUST be false in the adjoint_tests app, otherwise true.
+help=If true then loop into annexed dofs in PSyKAl lite code, else only loop into owned dofs and set halo dirty
+!kind=default
+ns=namelist/Adjoint/Testing
+type=logical

science/adjoint/rose-meta/lfric-adjoint/versions.py

@@ -1,3 +1,4 @@
+import re
 import sys
 
 from metomi.rose.upgrade import MacroUpgrade  # noqa: F401
@@ -31,3 +32,37 @@ def upgrade(self, config, meta_config=None):
         # Add settings
         return config, self.reports
 """
+
+
+class vn31_t322(MacroUpgrade):
+    """Upgrade macro for ticket #322 by Terence Vockerodt."""
+
+    BEFORE_TAG = "vn3.1"
+    AFTER_TAG = "vn3.1_t322"
+
+    def upgrade(self, config, meta_config=None):
+        # Adds new namelist entry alphabetically
+        source = self.get_setting_value(
+            config, ["file:configuration.nml", "source"]
+        )
+        if "namelist:adjoint" not in source:
+            # Insert adjoint to configuration
+            for line in source.split("\n"):
+                namelist = line.strip("()")
+                namelist = namelist.strip()
+                if "namelist:adjoint" < namelist:
+                    source = re.sub(
+                        line,
+                        rf" namelist:adjoint\n{line}",
+                        source,
+                    )
+                    break
+            self.change_setting_value(
+                config, ["file:configuration.nml", "source"], source
+            )
+        # Default value
+        self.add_setting(
+            config, ["namelist:adjoint", "l_compute_annexed_dofs"], ".true."
+        )
+
+        return config, self.reports

science/adjoint/source/psy/adj_sci_psykal_builtin_light_mod.f90

@@ -7,6 +7,7 @@
 !> @brief Adjoint of the sci_psykal_builtin_light_mod routines
 module adj_sci_psykal_builtin_light_mod
 
+  use adjoint_config_mod,            only: l_compute_annexed_dofs
   use, intrinsic :: iso_fortran_env, only : real32, real64
   use constants_mod,                 only: r_def, i_def
   use field_mod,                     only: field_type, field_proxy_type
@@ -65,12 +66,20 @@ subroutine invoke_adj_copy_field_32_64(fsrce_32, fdest_64)
      ! Set-up all of the loop bounds
      !
      loop0_start = 1
-     if (fsrce_32_proxy%is_dirty(depth=1)) then
-       ! only copy the owned dofs
-       loop0_stop = fdest_64_proxy%vspace%get_last_dof_annexed()
+     ! Need namelist variable to replicate COMPUTE_ANNEXED_DOFS
+     ! from PSyclone config. This is a workaround until
+     ! https://github.com/stfc/PSyclone/issues/2674 is fixed.
+     if (l_compute_annexed_dofs) then
+       if (fsrce_32_proxy%is_dirty(depth=1)) then
+         ! only copy the owned + annexed dofs
+         loop0_stop = fdest_64_proxy%vspace%get_last_dof_annexed()
+       else
+         ! copy the 1st halo row as well
+         loop0_stop = fdest_64_proxy%vspace%get_last_dof_halo(1)
+       end if
      else
-       ! copy the 1st halo row as well
-       loop0_stop = fdest_64_proxy%vspace%get_last_dof_halo(1)
+       ! only copy the owned dofs
+       loop0_stop = fdest_64_proxy%vspace%get_last_dof_owned()
      end if
      !
      ! Call kernels and communication routines
@@ -131,12 +140,20 @@ subroutine invoke_adj_copy_field_32_32(fsrce_32, fdest_32)
      ! Set-up all of the loop bounds
      !
      loop0_start = 1
-     if (fsrce_32_proxy%is_dirty(depth=1)) then
-       ! only copy the owned dofs
-       loop0_stop = fdest_32_proxy%vspace%get_last_dof_annexed()
+     ! Need namelist variable to replicate COMPUTE_ANNEXED_DOFS
+     ! from PSyclone config. This is a workaround until
+     ! https://github.com/stfc/PSyclone/issues/2674 is fixed.
+     if (l_compute_annexed_dofs) then
+       if (fsrce_32_proxy%is_dirty(depth=1)) then
+         ! only copy the owned + annexed dofs
+         loop0_stop = fdest_32_proxy%vspace%get_last_dof_annexed()
+       else
+         ! copy the 1st halo row as well
+         loop0_stop = fdest_32_proxy%vspace%get_last_dof_halo(1)
+       end if
      else
-       ! copy the 1st halo row as well
-       loop0_stop = fdest_32_proxy%vspace%get_last_dof_halo(1)
+       ! only copy the owned dofs
+       loop0_stop = fdest_32_proxy%vspace%get_last_dof_owned()
      end if
      !
      ! Call kernels and communication routines
@@ -197,12 +214,20 @@ subroutine invoke_adj_copy_field_64_64(fsrce_64, fdest_64)
      ! Set-up all of the loop bounds
      !
      loop0_start = 1
-     if (fsrce_64_proxy%is_dirty(depth=1)) then
-       ! only copy the owned dofs
-       loop0_stop = fdest_64_proxy%vspace%get_last_dof_annexed()
+     ! Need namelist variable to replicate COMPUTE_ANNEXED_DOFS
+     ! from PSyclone config. This is a workaround until
+     ! https://github.com/stfc/PSyclone/issues/2674 is fixed.
+     if (l_compute_annexed_dofs) then
+       if (fsrce_64_proxy%is_dirty(depth=1)) then
+         ! only copy the owned + annexed dofs
+         loop0_stop = fdest_64_proxy%vspace%get_last_dof_annexed()
+       else
+         ! copy the 1st halo row as well
+         loop0_stop = fdest_64_proxy%vspace%get_last_dof_halo(1)
+       end if
      else
-       ! copy the 1st halo row as well
-       loop0_stop = fdest_64_proxy%vspace%get_last_dof_halo(1)
+       ! only copy the owned dofs
+       loop0_stop = fdest_64_proxy%vspace%get_last_dof_owned()
      end if
      !
      ! Call kernels and communication routines