jwallwork23 commented 1 month ago

Wrap XIOS API calls part 2: setters

Fixes #558

Task List

[x] Defined the tests that specify a complete and functioning change (It may help to create a design specification & test specification)
[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

Note that #555 will need to be merged first. This PR wraps more of the XIOS API for use in neXtSIM-DG. In particular, it allows neXtSIM-DG to create XIOS objects itself rather than relying on XML input files.

[x] Wrap axis setters from XIOS API.
[x] Wrap domain setters from XIOS API.
[x] Wrap grid setters from XIOS API.
[x] Wrap field setters from XIOS API.
[x] Wrap file setters from XIOS API.
[x] Method for creating an axis.
[x] Method for creating a domain.
[x] Method for creating a grid.
[x] Method for creating a field.
[x] Method for creating a file.
[x] Method for associating a domain with a grid.
[x] Method for associating an axis with a grid.
[x] Method for associating a field with a file.

Test Description

Update TestXiosInit_MPI2.cpp...

[x] To test setter methods.
[x] To test creation methods (checking valid IDs).
[x] To test association methods.

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] File dates have been updated to reflect modification date
[x] This change conforms to the conventions described in the README

jwallwork23 commented 3 weeks ago

Managed to figure this out! We can set up the entire example using the API introduced in this PR.

Also opened #571, which will allow us to reduce iodef.xml further.

jwallwork23 commented 2 weeks ago

Thanks very much for reviewing this @TomMelt!

nextsimhub / nextsimdg