Skip to content

Correct bug in global mesh#309

Open
mike-hobson wants to merge 1 commit intoMetOffice:mainfrom
mike-hobson:fix_global_mesh_bug
Open

Correct bug in global mesh#309
mike-hobson wants to merge 1 commit intoMetOffice:mainfrom
mike-hobson:fix_global_mesh_bug

Conversation

@mike-hobson
Copy link
Contributor

@mike-hobson mike-hobson commented Mar 12, 2026

PR Summary

Sci/Tech Reviewer: @ukmo-juan-castillo
Code Reviewer: @cameronbateman-mo

In global_mesh_mod there is a method (get_cell_id) that returns the cell id of a cell that is a given x- and y- distance from a starting cell id. A bug has been introduced into this routine so that if a negative x-direction distance is given, it inadvertently reverses the sense of the y-direction. This hasn't affected us so far, as our usage has only been with positive x-offsets.

A fix has been agreed with the author of the change that introduced the bug (#220) that simply reverses the sense of the y-direction for negative x-direction. This maintains the functionality that #220 added, but also fixes the broken behaviour.

I have updated the unit tests to add tests that would have picked up this problem and made them a little tidier

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 Core rose-stem suite
  • If required (e.g. API changes) I have also run the LFRic Apps test suite using this branch
  • 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)

trac.log

Test Suite Results - lfric_core - fix_global_mesh_bug/run1

Suite Information

Item Value
Suite Name fix_global_mesh_bug/run1
Suite User mike.hobson
Workflow Start 2026-03-12T11:13:52
Groups Run developer
Dependency Reference Main Like
lfric_core mike-hobson/lfric_core@fix_global_mesh_bug False
SimSys_Scripts MetOffice/[email protected] True

Task Information

✅ succeeded tasks - 384

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

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)
  • 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

Copy link

@ukmo-juan-castillo ukmo-juan-castillo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The changes match the code author's proposed solution. New tests have been added to fully check the functionality of the relevant code and they pass successfully. I personally run other tests successfully. Everything is in order and the new tests are welcome.

Copy link
Contributor

@mo-rickywong mo-rickywong left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This change Looks fine to me as code owner

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants