Skip to content

Conversation

@joewallwork
Copy link
Contributor

@joewallwork joewallwork commented Oct 14, 2025

XIOS: Handle DGSField

Towards #911
Merges into #934

Task List

  • Defined the tests that specify a complete and functioning change (It may help to create a design specification & test specification)
  • Implemented the source code change that satisfies the tests
  • Documented the feature by providing worked example
  • Updated the README or other documentation
  • Completed the pre-Request checklist below

Change Description

Currently the XIOS implementation accounts for HField, VertexField, and DGField. This PR extends it to cover DGSField.


Test Description

The XIOS read and write tests are updated to account for this field type.


Documentation Impact

The XIOS docs page is updated to mention DGSField and the fact the field type needs to be set in the case of file writing.


Pre-Request Checklist

  • The requirements of this pull request are fully captured in an issue or design specification and are linked and summarised in the description of this PR
  • No new warnings are generated
  • The documentation has been updated (or an issue has been created to track the corresponding change)
  • Methods and Tests are commented such that they can be understood without having to obtain additional context
  • This PR/Issue is labelled as a bug/feature/enhancement/breaking change
  • This change conforms to the conventions described in the README

@joewallwork joewallwork self-assigned this Oct 14, 2025
@joewallwork joewallwork added enhancement New feature or request ICCS Tasks or reviews for the ICCS team labels Oct 14, 2025
@joewallwork joewallwork mentioned this pull request Oct 14, 2025
11 tasks
@joewallwork joewallwork marked this pull request as ready for review October 14, 2025 19:12
Copy link
Contributor

@TomMelt TomMelt left a comment

Choose a reason for hiding this comment

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

Super thanks @jwallwork23 this also looks hot to go 🔥

@joewallwork joewallwork force-pushed the issue917_xios-write-diag-time branch from 0e09b2c to c11c35a Compare October 21, 2025 13:26
@joewallwork
Copy link
Contributor Author

[Rebased on top of issue917_xios-write-diag-time]

Base automatically changed from issue917_xios-write-diag-time to develop November 5, 2025 10:56
@joewallwork
Copy link
Contributor Author

I'm going to go ahead and merge this given that @timspainNERSC approved #951 and the changes here take a similar form - just for a different discretisation.

@joewallwork joewallwork merged commit 94a2656 into develop Nov 10, 2025
9 checks passed
@joewallwork joewallwork deleted the issue911_xios-dgs branch November 10, 2025 10:17
joewallwork added a commit that referenced this pull request Nov 10, 2025
# XIOS: Handle `CGField`

Fixes #911
Merges into #952 

### Task List
- [x] Defined the tests that specify a complete and functioning change
(*It may help to create a [design specification & test
specification](../../../wiki/Specification-Template)*)
- [x] Implemented the source code change that satisfies the tests
- [x] Documented the feature by providing worked example
- [x] Updated the README or other documentation
- [x] Completed the pre-Request checklist below

---
# Change Description

Currently the XIOS implementation accounts for `HField`, `VertexField`,
and `DGField`. #952 extends to cover `DGSField`. This PR extends further
to cover `CGField`.

This involved checking the global and local dimensions and start index
are set up correctly, as well as the XIOS domain, grid, and field.

Several error messages were also made clearer as part of this change.

---
# Test Description

The XIOS read and write tests are updated to account for the CG field
type.

A minor looping issue is also fixed in the value checking - it was
missing the final value for `VertexField`. As such, the value checking
code in `XiosRead_test` was reworked to loop over fields first and then
dimensions. To make this easier to check, I changed the coordinate field
to align with the coordinates of the grid (assuming unit spacing in each
direction).

Note that the file reading code accounts for halos out-of-the-box!
:angel:

---
# Documentation Impact

`CGField` is mentioned in the XIOS docs page.

---
### Pre-Request Checklist

- [x] The requirements of this pull request are fully captured in an
issue or design specification and are linked and summarised in the
description of this PR
- [x] No new warnings are generated
- [x] The documentation has been updated (or an issue has been created
to track the corresponding change)
- [x] Methods and Tests are commented such that they can be understood
without having to obtain additional context
- [x] This PR/Issue is labelled as a bug/feature/enhancement/breaking
change
- [x] This change conforms to the conventions described in the README
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request ICCS Tasks or reviews for the ICCS team

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants