Radaer api la side - part two initialisation by alanjhewitt · Pull Request #698 · MetOffice/lfric_apps

Alan J Hewitt (alanjhewitt) · 2026-08-07T09:45:01Z

PR Summary

Sci/Tech Reviewer: Mohit Dalvi (@mcdalvi)
Code Reviewer: Pierre Siddall (@Pierre-siddall)

I developed the original lfric to radaer functionality in 2020. Like a lot of developments back then, it was needed in a hurry and so I developed a fudged solution with technical debt.

We will need user flexibility soon to be able to run radaer with different user settings, hence this part two of two development.

In part two, the previously hard coded lists (from part one) are instead generated from user settings based on the value of i_mode_setup if running with setting "ukca". For settings "glomap_clim" and "dust_and_clim", the user is not allowed to set i_mode_setup as this will always be setting SUBCOCSSDU_7mode (previously setting 8 in the UM).

These lists are to be determined during the initialisation step and saved for the rest of the run.

I will also include some documentation to describe the RADAER API.

It was not intended but RADAER was previously hardcoded with l_ukca_radaer_sustrat set as true. As this ticket includes this as a namelist item, I have set made this default to true for all current suites. This is a legitimate science option, although later some suites may wish to turn this off.

linked Radaer api ukca side - part two initialisation ukca#45
linked MetOffice/um/pull/130

Code Quality Checklist

I have performed a self-review of my own code
My code follows the project's style guidelines
Comments have been included that aid understanding and enhance the readability of the code
My changes generate no new warnings
All automated checks in the CI pipeline have completed successfully

Testing

I have tested this change locally, using the LFRic Apps rose-stem suite
If any tests fail (rose-stem or CI) the reason is understood and acceptable (e.g. kgo changes)
I have added tests to cover new functionality as appropriate (e.g. system tests, unit tests, etc.)
Any new tests have been assigned an appropriate amount of compute resource and have been allocated to an appropriate testing group (i.e. the developer tests are for jobs which use a small amount of compute resource and complete in a matter of minutes)

Test Suite Results - lfric_apps - BoB_radaer_api_la_side_5y/run1

Suite Information

Item	Value
Suite Name	BoB_radaer_api_la_side_5y/run1
Suite User	alan.j.hewitt
Workflow Start	2026-09-08T11:59:58
Groups Run	all

Dependency	Reference	Main Like
casim	MetOffice/casim@2026.07.1	True
jules	MetOffice/jules@2026.07.1	True
lfric_apps	alanjhewitt/lfric_apps@BoB_radaer_api_la_side_5y	False
lfric_core	MetOffice/lfric_core@3e965e8	True
moci	MetOffice/moci@2026.07.1	True
SimSys_Scripts	MetOffice/SimSys_Scripts@77a5166	True
socrates	MetOffice/socrates@2026.07.1	True
socrates-spectral	MetOffice/socrates-spectral@2026.07.1	True
ukca	alanjhewitt/ukca@radaer_api_ukca_side_5	True

Task Information

✅ succeeded tasks - 1602

Security Considerations

I have reviewed my changes for potential security issues
Sensitive data is properly handled (if applicable)
Authentication and authorisation are properly implemented (if applicable)

Performance Impact

Performance of the code has been considered and, if applicable, suitable performance measurements have been conducted

AI Assistance and Attribution

Some of the content of this change has been produced with the assistance of Generative AI tool name (e.g., Met Office Github Copilot Enterprise, Github Copilot Personal, ChatGPT GPT-4, etc) and I have followed the Simulation Systems AI policy (including attribution labels)

Documentation

Where appropriate I have updated documentation related to this change and confirmed that it builds correctly

Please see build of documentation here

https://wwwspice/~alan.j.hewitt/lfric_apps/radaer_api_la_side_5/html/science_guide/radaer/index.html

PSyclone Approval

If you have edited any PSyclone-related code (e.g. PSyKAl-lite, Kernel interface, optimisation scripts, LFRic data structure code) then please contact the TCD Team

Sci/Tech Review

I understand this area of code and the changes being added
The proposed changes correspond to the pull request description
Documentation is sufficient (do documentation papers need updating) - description added
Sufficient testing has been completed

(Please alert the code reviewer via a tag when you have approved the SR)

Code Review

All dependencies have been resolved
Related Issues have been properly linked and addressed
CLA compliance has been confirmed
Code quality standards have been met
Tests are adequate and have passed
Documentation is complete and accurate
Security considerations have been addressed
Performance impact is acceptable

James Bruten (james-bruten-mo) · 2026-08-07T12:19:26Z


-"""
-Copy this template and complete to add your macro
+class vn32_t683(MacroUpgrade):


Given the metadata changes, this is the only file where you should add an upgrade macro. When apply_macros.py gets run, it will copy the macro to all relevant places based on the metadata inheritance. Please revert all the other changes to versions.py files.

LFRic macro guidance: https://metoffice.github.io/simulation-systems/Development/macros.html#upgrade-macros-in-lfric

This reverts commit 1b91106.

This reverts commit 763c39a.

This reverts commit 84f4601.

This reverts commit 8281df6.

This reverts commit 453666d.

Alan J Hewitt (alanjhewitt) · 2026-08-25T17:20:09Z

Hi Mohit,

This development is now ready for SciTech review.

Regards, Alan

iboutle

A couple of minor points

iboutle · 2026-08-26T08:25:00Z

+                                             ["namelist:aerosol",
+                                              "glomap_mode"])
+
+        if glomap_mode == "'dust_and_clim'":


I would suggest removing this and just setting mode_setup=SUBCOCSSDU_7mode in the upgrade macro. The value when dust and clim is selected is irrelevant because it's trigger ignored, but doing this makes duonly_2mode the default value in the GUI, and I think 7mode would be the better default to appear when someone switches on ukca.

iboutle · 2026-08-26T08:44:09Z

+    ! sustrat turned on
+    l_ukca_radaer_sustrat_local = .true.
+
+    if ( l_radaer) then


Should this whole routine just be wrapped in "if l_radaer", i.e. the call from gungho_model_mod, rather than repeated instances inside the routine?

Mohit Dalvi (mcdalvi)

Passing back to Alan

Mohit Dalvi (mcdalvi) · 2026-08-27T09:48:28Z

+!> @brief RADAER initialisation subroutine for science configuration
+
+module um_radaer_init_mod
+


I am aware this is a legacy thing, but for new modules/ routines could the 'um_' prefix be avoided?

yes, i can change this. i will make it a separate commit so that changes in this file can still be seen.

update - it turns out that "git mv" command preserves history.

Mohit Dalvi (mcdalvi) · 2026-08-27T09:50:11Z

+  use ukca_radaer_lfric_init_mod,    only: ukca_radaer_lfric_init
+
+  use ukca_config_specification_mod, only: i_sussbcocdu_7mode,                 &
+                                           i_du_2mode


UKCA variables and routines are expected to be accessed only via ukca_api_mod and usually aliased with a ukca_ prefix to differentiate from local variables.

Mohit Dalvi (mcdalvi) · 2026-08-27T09:51:15Z


+  use ukca_config_specification_mod, only: i_sussbcocdu_7mode,                 &
+                                           i_du_2mode
+


UKCA variables expected to be accessed only via ukca_api_mod.

Mohit Dalvi (mcdalvi) · 2026-08-27T09:54:03Z

+      case default
+        write( log_scratch_space, '(A,I0)' )                                   &
+        'Developers should include additional mode settings here: ', mode_setup
+        call log_event( log_scratch_space, LOG_LEVEL_ERROR )


The message could be clarified that the option passed in is not supported.

Mohit Dalvi (mcdalvi)

Thanks Alan, Sci-tech Review passed

Pierre Siddall (Pierre-siddall)

Hi Alan J Hewitt (@alanjhewitt), thanks for this, this mostly looks good to me bar what I think may be a small typo in one of the restructured text files and combining two blocks of repeated code into a single conditional statement. Let me know if I've missed any context with these. Otherwise when these are fixed I'll be happy to approve this PR.

Pierre Siddall (Pierre-siddall) · 2026-09-02T12:42:18Z

+  else if ( glomap_mode == glomap_mode_dust_and_clim ) then
+    ! dust_and_clim runs with a diffent mode_setup between ukca and radaer
+    ! this is always fixed to ukca_i_sussbcocdu_7mode.
+    i_mode_setup_radaer_local = ukca_i_sussbcocdu_7mode
+
+    ! Tune BC turned off
+    i_ukca_tune_bc_local      = ukca_i_ukca_tune_bc_off
+
+    ! Dust ageing not allowed for dust only ukca
+    l_dust_mp_ageing_local    = .false.
+
+    ! sustrat turned on
+    l_ukca_radaer_sustrat_local = .true.
+
+    call ukca_radaer_lfric_init( i_mode_setup_radaer_local,                    &
+                                 i_ukca_tune_bc_local,                         &
+                                 l_dust_mp_ageing_local,                       &
+                                 l_ukca_radaer_sustrat_local )
+
+  else if ( glomap_mode == glomap_mode_radaer_test ) then
+    ! This was developed for aqua planet runs and may be redundant
+    ! For now fix this to ukca_i_sussbcocdu_7mode.
+    i_mode_setup_radaer_local = ukca_i_sussbcocdu_7mode
+
+    ! Tune BC turned off
+    i_ukca_tune_bc_local      = ukca_i_ukca_tune_bc_off
+
+    ! Dust ageing turned off
+    l_dust_mp_ageing_local    = .false.
+
+    ! sustrat turned on
+    l_ukca_radaer_sustrat_local = .true.
+
+    call ukca_radaer_lfric_init( i_mode_setup_radaer_local,                    &
+                                 i_ukca_tune_bc_local,                         &
+                                 l_dust_mp_ageing_local,                       &
+                                 l_ukca_radaer_sustrat_local )


Given there are two else if statements which run the same block of code it makes sense to combine these using an OR operator.

Suggested change

else if ( glomap_mode == glomap_mode_dust_and_clim ) then

! dust_and_clim runs with a diffent mode_setup between ukca and radaer

! this is always fixed to ukca_i_sussbcocdu_7mode.

i_mode_setup_radaer_local = ukca_i_sussbcocdu_7mode

! Tune BC turned off

i_ukca_tune_bc_local = ukca_i_ukca_tune_bc_off

! Dust ageing not allowed for dust only ukca

l_dust_mp_ageing_local = .false.

! sustrat turned on

l_ukca_radaer_sustrat_local = .true.

call ukca_radaer_lfric_init( i_mode_setup_radaer_local, &

i_ukca_tune_bc_local, &

l_dust_mp_ageing_local, &

l_ukca_radaer_sustrat_local )

else if ( glomap_mode == glomap_mode_radaer_test ) then

! This was developed for aqua planet runs and may be redundant

! For now fix this to ukca_i_sussbcocdu_7mode.

i_mode_setup_radaer_local = ukca_i_sussbcocdu_7mode

! Tune BC turned off

i_ukca_tune_bc_local = ukca_i_ukca_tune_bc_off

! Dust ageing turned off

l_dust_mp_ageing_local = .false.

! sustrat turned on

l_ukca_radaer_sustrat_local = .true.

call ukca_radaer_lfric_init( i_mode_setup_radaer_local, &

i_ukca_tune_bc_local, &

l_dust_mp_ageing_local, &

l_ukca_radaer_sustrat_local )

else if ( glomap_mode == glomap_mode_dust_and_clim .or. glomap_mode == glomap_mode_radaer_test ) then

! dust_and_clim runs with a diffent mode_setup between ukca and radaer

! this is always fixed to ukca_i_sussbcocdu_7mode.

i_mode_setup_radaer_local = ukca_i_sussbcocdu_7mode

! Tune BC turned off

i_ukca_tune_bc_local = ukca_i_ukca_tune_bc_off

! Dust ageing not allowed for dust only ukca

l_dust_mp_ageing_local = .false.

! sustrat turned on

l_ukca_radaer_sustrat_local = .true.

call ukca_radaer_lfric_init( i_mode_setup_radaer_local, &

i_ukca_tune_bc_local, &

l_dust_mp_ageing_local, &

l_ukca_radaer_sustrat_local )

merging changes from older branch

453666d

Alan J Hewitt (alanjhewitt) requested review from a team, iboutle and James Bruten (james-bruten-mo) as code owners August 7, 2026 09:45

Alan J Hewitt (alanjhewitt) requested review from Matthew Hambley (MatthewHambley) and removed request for a team August 7, 2026 09:45

github-actions Bot assigned Alan J Hewitt (alanjhewitt) Aug 7, 2026

Alan J Hewitt (alanjhewitt) added 2 commits August 7, 2026 10:54

Add RADAER API documentation

3f2eaa9

Add documentation

1b91106

Alan J Hewitt (alanjhewitt) marked this pull request as draft August 7, 2026 09:57

Alan J Hewitt (alanjhewitt) added documentation Improvements or additions to documentation Linked UKCA This PR is linked to a MetOffice/ukca PR macro This PR contains a metadata upgrade macro labels Aug 7, 2026

Alan J Hewitt (alanjhewitt) added 2 commits August 7, 2026 12:00

tidy

f114df3

I think I need new namelist in all of these

8281df6

James Bruten (james-bruten-mo) reviewed Aug 7, 2026

View reviewed changes

Alan J Hewitt (alanjhewitt) added 13 commits August 7, 2026 13:39

Beginning of initialisation pipework to UKCA repo

84f4601

Beginning of initialisation pipework to UKCA repo

763c39a

Revert " Add documentation"

d8f4d36

This reverts commit 1b91106.

Revert " Beginning of initialisation pipework to UKCA repo"

13cc02d

This reverts commit 763c39a.

Revert " Beginning of initialisation pipework to UKCA repo"

7501b76

This reverts commit 84f4601.

Revert " I think I need new namelist in all of these"

f6e3b82

This reverts commit 8281df6.

Revert " merging changes from older branch"

2d4b474

This reverts commit 453666d.

messy - but now only one versions.py

568abf9

maybe sorted git revert

3ccbb0d

only ukca setting should trigger i_mode_setup

09bd990

pass dust ageing and BC tuning setting to radaer in namelist

b2541ef

dust ageing not allowed for dust only

a132533

initialisation pipework

8deee3e

Alan J Hewitt (alanjhewitt) mentioned this pull request Aug 11, 2026

Radaer api ukca side - part two initialisation MetOffice/ukca#45

Open

26 tasks

Only initialise when l_radaer is true

81ab53c

github-actions Bot added the cla-modified The CLA has been modified as part of this PR - added by GA label Aug 24, 2026

Alan J Hewitt (alanjhewitt) added 4 commits August 24, 2026 17:01

use allocatable lists specific to i_mode_setup

c6b5b0f

include new UKCA module

a83cb0f

l_sustrat is now a namelist option

71375a4

sustrat defaults to true

88d1e96

Alan J Hewitt (alanjhewitt) requested a review from Mohit Dalvi (mcdalvi) August 25, 2026 16:59

Alan J Hewitt (alanjhewitt) marked this pull request as ready for review August 25, 2026 17:19

Alan J Hewitt (alanjhewitt) requested review from a team and Joerg Henrichs (hiker) as code owners August 25, 2026 17:19

Alan J Hewitt (alanjhewitt) requested review from James Bruten (james-bruten-mo) and removed request for a team August 25, 2026 17:19

iboutle requested changes Aug 26, 2026

View reviewed changes

Mohit Dalvi (mcdalvi) reviewed Aug 27, 2026

View reviewed changes

Alan J Hewitt (alanjhewitt) added 6 commits August 27, 2026 14:44

Mohit and Ian suggested changes

fba5745

I used git mv to hopefully preserve history

b2fe4b5

Remove trailing white space

c5a32d6

build error

9c6c53a

validate rose meta failure

766fafb

reverted change - not sure what problem is

7fa3de0

Mohit Dalvi (mcdalvi) self-requested a review August 28, 2026 16:11

Mohit Dalvi (mcdalvi) approved these changes Aug 28, 2026

View reviewed changes

github-actions Bot requested a review from Pierre Siddall (Pierre-siddall) August 28, 2026 16:13

iboutle approved these changes Sep 1, 2026

View reviewed changes

Merge branch 'MetOffice:main' into radaer_api_la_side_5

732b25a

github-actions Bot removed the cla-modified The CLA has been modified as part of this PR - added by GA label Sep 1, 2026

Alan J Hewitt (alanjhewitt) added the Linked UM This PR is linked to a MetOffice/um PR label Sep 1, 2026

Pierre Siddall (Pierre-siddall) requested changes Sep 2, 2026

View reviewed changes

code review suggested change

ff01512

		!> @brief RADAER initialisation subroutine for science configuration

		module um_radaer_init_mod


		use ukca_config_specification_mod, only: i_sussbcocdu_7mode, &
		i_du_2mode

Uh oh!

Conversation

Alan J Hewitt (alanjhewitt) commented Aug 7, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR Summary

Code Quality Checklist

Testing

Test Suite Results - lfric_apps - BoB_radaer_api_la_side_5y/run1

Suite Information

Task Information

Security Considerations

Performance Impact

AI Assistance and Attribution

Documentation

PSyclone Approval

Sci/Tech Review

Code Review

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Alan J Hewitt (alanjhewitt) commented Aug 25, 2026

Uh oh!

iboutle left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Mohit Dalvi (mcdalvi) left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Mohit Dalvi (mcdalvi) left a comment

Choose a reason for hiding this comment

Uh oh!

Pierre Siddall (Pierre-siddall) left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

Alan J Hewitt (alanjhewitt) commented Aug 7, 2026 •

edited

Loading