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

Clarifying documentation for Cones #2892

Merged
merged 8 commits into from
Mar 9, 2024

Conversation

MicahGale
Copy link
Contributor

@MicahGale MicahGale commented Mar 4, 2024

Description

This provides some clarification on how Cone surfaces are formed, to address some user confusion that occured.

Fixes #2891.

Checklist

  • I have performed a self-review of my own code
  • I have run clang-format (version 15) on any C++ source files (if applicable)
  • I have followed the style guidelines for Python source files (if applicable)
  • I have made corresponding changes to the documentation (if applicable)
  • I have added tests that prove my fix is effective or that my feature works (if applicable)

Copy link
Contributor

@pshriwise pshriwise left a comment

Choose a reason for hiding this comment

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

Thanks for this update @MicahGale! Minor changes suggested here.

openmc/surface.py Outdated Show resolved Hide resolved
openmc/surface.py Outdated Show resolved Hide resolved
openmc/surface.py Outdated Show resolved Hide resolved
openmc/surface.py Outdated Show resolved Hide resolved
openmc/surface.py Outdated Show resolved Hide resolved
openmc/surface.py Outdated Show resolved Hide resolved
@MicahGale MicahGale marked this pull request as ready for review March 6, 2024 20:52
Copy link
Contributor

@pshriwise pshriwise left a comment

Choose a reason for hiding this comment

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

Some class name corrections and a typo fix to tackle but then I think this looks good!

openmc/surface.py Outdated Show resolved Hide resolved
openmc/surface.py Outdated Show resolved Hide resolved
openmc/surface.py Outdated Show resolved Hide resolved
openmc/surface.py Outdated Show resolved Hide resolved
openmc/surface.py Outdated Show resolved Hide resolved
@MicahGale
Copy link
Contributor Author

I came across this documentation:

A one-sided cone is composed of a normal cone surface and an “ambiguity” surface that eliminates the ambiguity as to which region of space is included. This class acts as a proper surface, meaning that unary + and - operators applied to it will produce a half-space. The negative side is defined to be the region inside of the cone.

I feel like "ambiguity" surface here is a bit counterintuitive. Would "disambiguation" surface be better?

@MicahGale MicahGale requested a review from pshriwise March 6, 2024 23:36
@pshriwise
Copy link
Contributor

I came across this documentation:

A one-sided cone is composed of a normal cone surface and an “ambiguity” surface that eliminates the ambiguity as to which region of space is included. This class acts as a proper surface, meaning that unary + and - operators applied to it will produce a half-space. The negative side is defined to be the region inside of the cone.

I feel like "ambiguity" surface here is a bit counterintuitive. Would "disambiguation" surface be better?

Based on the purpose described here, I would agree.

Copy link
Contributor

@pshriwise pshriwise left a comment

Choose a reason for hiding this comment

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

Thanks @MicahGale!

@pshriwise pshriwise enabled auto-merge (squash) March 7, 2024 23:14
@MicahGale MicahGale requested a review from gridley March 8, 2024 13:53
Copy link
Contributor

@gridley gridley left a comment

Choose a reason for hiding this comment

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

LGTM @MicahGale!

@pshriwise pshriwise merged commit 7ed1278 into openmc-dev:develop Mar 9, 2024
18 checks passed
@MicahGale MicahGale deleted the 2981-improve-surf-docs branch March 13, 2024 21:08
church89 pushed a commit to openmsr/openmc that referenced this pull request Jul 18, 2024
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.

Improve docstrings for Cones (and possibly others)
3 participants