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

sphere2d geometry #250

Merged
merged 12 commits into from
Oct 26, 2023
Merged

sphere2d geometry #250

merged 12 commits into from
Oct 26, 2023

Conversation

ljcarlin
Copy link
Contributor

@ljcarlin ljcarlin commented Oct 12, 2023

PR for sphere2d geometry

Fixed this to be based on develop instead of master.

Proposed changes: Add sphere geometry for use with the 6-tree cubed connectivity. Add configuration to use this geometry in example/simple/simple2.c. Add documentation for p4est_geometry

@ljcarlin ljcarlin mentioned this pull request Oct 12, 2023
@cburstedde
Copy link
Owner

Thanks this looks great!
Were you planning to add documentation/extra code to make clear that abc[2] is never accessed?

@ljcarlin
Copy link
Contributor Author

I haven't finished cleaning up the documentation yet, so I will add that bit too.

I was having trouble making the function we discussed public, so I've been working on the GMT stuff in the meantime.

@cburstedde
Copy link
Owner

cburstedde commented Oct 20, 2023 via email

@ljcarlin
Copy link
Contributor Author

Sounds good!

I finished including all the documentation I intended, so it should be good to go.

There were a few different terms being used to describe local coordinates. I thought the clearest was "tree-local reference coordinates" so I've used it to replace other terms like "AMR space".

I also added assertions so that p4est_geometry_connectivity_X doesn't segfault if given a geometry without vertex information.

@ljcarlin
Copy link
Contributor Author

Sorry for the weird force push. I forgot to rebase upstream commits before pushing. Hope that didn't break anything...

@cburstedde cburstedde marked this pull request as ready for review October 24, 2023 12:47
@cburstedde
Copy link
Owner

No problem! Looking forward to iron out the last remaining doxygen warnings, and possibly getting the p8est_geometry docs aligned.

@ljcarlin
Copy link
Contributor Author

ljcarlin commented Oct 25, 2023

Resolved all the doxygen geometry errors except this one coming from another file:

p4est/src/p4est_vtk.h:92: warning: unable to resolve reference to 'p4est_geometry_t' for \ref command

It's coming from an edgecase that doxygen is not handling well. I will see if I can resolve it.

@ljcarlin
Copy link
Contributor Author

Okay, all doxygen warnings are fixed!

No functional changes.  For consistency and convention, I

 * cross-linked further functions for doxygen,
 * added and slightly reworded some documentation,
 * ran p4estindent on the geometry .c and .h files,
 * removed end-of-line space characters.
@cburstedde
Copy link
Owner

Thanks so much, I've tweaked a bit further, some very old content, too.
I've gone through a couple conventions (running p4estindent on the files, removing superfluous spaces in places).

@cburstedde cburstedde merged commit f72ac27 into cburstedde:develop Oct 26, 2023
18 checks passed
@ljcarlin ljcarlin deleted the geometry branch March 10, 2024 12:34
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