Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve MPI communication documentation #1129

Merged
merged 2 commits into from
Nov 18, 2024

Conversation

Edward-RSE
Copy link
Collaborator

This PR is addressing issue #1126, which states the documentation for MPI communication is not sufficient for the complexity of the code.

To address this I have written a new page in the Sphinx documentation which breaks down the communication code in detail. This page documents how the standard communication pattern works and how the size of the comm buffer is calculated (with simple code examples). It also includes a section on how to add a new variable to an existing communication.

I opted to create a Sphinx page instead of adding to the Doxygen comments for each function, to keep that comment block from becoming too unwieldily and long. In each comment block, I reference the new Sphinx page for anyone who wants more details.

(I also noticed that the malloc's in a lot of the functions were unchecked, so I have added checks to make sure memory is allocated correctly)

@kslong
Copy link
Collaborator

kslong commented Nov 16, 2024

I think that is a good way to have dealt with this issue, including having a reference in the .c file to the documentation on sphinx. I am happy for this to be merged.

@Edward-RSE Edward-RSE merged commit c36ee5c into sirocco-rt:dev Nov 18, 2024
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.

2 participants