Skip to content

Add section on Mesh file contents and Ugrid compliance#144

Merged
mo-lucy-gordon merged 5 commits intoMetOffice:mainfrom
mo-rickywong:AddMeshContents
Sep 1, 2025
Merged

Add section on Mesh file contents and Ugrid compliance#144
mo-lucy-gordon merged 5 commits intoMetOffice:mainfrom
mo-rickywong:AddMeshContents

Conversation

@mo-rickywong
Copy link
Copy Markdown
Contributor

@mo-rickywong Ricky Wong (mo-rickywong) commented Aug 5, 2025

Description

Adds a section on the contents of mesh files produced from the mesh generators. In addition, details of the mesh topology mandatory/optional attributes which meet the UGRID convention requirements as well as metadata supporting applications at the Met Office.

Linked issues

Closes #64 which adds information on face centres in the mesh output files

Developer tags

Type of change

  • New feature (non-breaking change which adds functionality).
  • Breaking change (fix or feature that would cause existing functionality to not work as expected).
  • This change requires a documentation update.

How has this been tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration.

  • New tests have been added.
  • Tests have been modified to accommodate this change.
  • GitHub workflows have been changed or added.

Built and inspected documentation

Checklist:

  • The change has been checked for design compliance by an experienced SSE
  • My code follows the style guidelines of this project.
  • I have commented my code, particularly in hard-to-understand areas.
  • I have made corresponding changes to the documentation.
  • My changes generate no new warnings.
  • I have added tests that prove my fix is effective or that my feature works.
  • New and existing unit tests pass locally with my changes, for both debug and optimised builds.
  • No AI tools have been used in the creation of this change.

Reasoning on why any of the above boxes have not been checked

This is a documentation only change

Review Checks (To be filled in by the reviewer/s)

  • Has the developer completed the appropriate sections above?
  • Is the change compliant with LFRic Core principles?
  • Is the testing coverage sufficient?
  • Have any technical debt workarounds identified had issues opened and interested parties notified?

@stevemullerworth
Copy link
Copy Markdown
Collaborator

The documentation does not meet the current style guide. Specifically, an 80-character per line limit should be followed. Also, the practice of marking headings with dash lines both above and below is non-standard, though we haven't explicitly forbidden it in our standards.

https://curly-memory-j58e8q8.pages.github.io/how_to_contribute/style_guides/documentation_style_guide.html#text-formatting

@mo-rickywong
Copy link
Copy Markdown
Contributor Author

The documentation does not meet the current style guide. Specifically, an 80-character per line limit should be followed. Also, the practice of marking headings with dash lines both above and below is non-standard, though we haven't explicitly forbidden it in our standards.

https://curly-memory-j58e8q8.pages.github.io/how_to_contribute/style_guides/documentation_style_guide.html#text-formatting

Updated, didn't realise there was a style document, thank you

Copy link
Copy Markdown
Contributor

@mo-lucy-gordon mo-lucy-gordon left a comment

Choose a reason for hiding this comment

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

There's a few minor suggestions, and please could you update the branch

Local meshes
-----------------------
When partitioning global meshes for a specific domain decomposition,
additional information is provided in the order to populate the
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Did you mean "in order to" ?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Updated

2. The face centre is calculated as the mean of vector sum of the node
coordinates, allowing for a radius ratio.

3. The face centre coordinates are convert back to (lon, lat).
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I think this should say "converted"

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Updated


* For *Planar meshes*, the domains are constructed to be aligned with the
coordinate axes, whether [lon,lat] or [x,y]. The face centre coordinates
are obtained as an offset from of 1/2 the face width in the axes
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Please re-word "from of 1/2" to make it a little clearer

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Reworded and updated

@mo-lucy-gordon mo-lucy-gordon merged commit 9a06214 into MetOffice:main Sep 1, 2025
2 checks passed
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.

[Documentation]: Face centres in mesh files

3 participants