Skip to content

Geometry debug function - #4012

Open
viktormai wants to merge 42 commits into
openmc-dev:developfrom
viktormai:geometry-debug-function
Open

Geometry debug function#4012
viktormai wants to merge 42 commits into
openmc-dev:developfrom
viktormai:geometry-debug-function

Conversation

@viktormai

Copy link
Copy Markdown
Contributor

This PR adds a 3D geometry debugging utility to Model for identifying overlap and undefined regions within an OpenMC geometry by sampling a user-defined bounding box.

Main changes

Added Model.geometry_debug():

  • Samples a 3D region using a stack of 2D slices obtained through openmc.lib.slice_data.
  • Detects both overlap regions (using the overlap sentinel) and internal undefined regions, returning a summary containing the total number of overlap and undefined samples and example coordinates for each type of geometry issue.
  • Optionally prints a human-readable summary.

Added _classify_undefined_regions() helper:

  • Separates undefined pixels into boundary-connected ("outside") undefined regions and internal undefined regions enclosed within the geometry.
  • Uses a breadth-first search starting from the image boundary to identify boundary-connected undefined pixels.
  • Issues a warning when undefined regions exist but none are connected to the sampled slice boundary, indicating a potentially enclosed undefined region or insufficient sampling resolution.

This pair of functions provides a simple way to locate common geometry construction problems—particularly overlaps and enclosed undefined regions—by returning representative coordinates that users can inspect directly, rather than relying solely on transport failures or visual inspection. These sample points can also be leveraged by AI agents to easily fix geometry issues in the model. Reusable undefined-region classification logic that can be leveraged by future plotting and geometry diagnostics for plotting undefined regions is also established.

Checklist

  • I have performed a self-review of my own code
  • I have run clang-format (version 18) 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)

@paulromanopaulromano left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks for the initial shot at this! Here are my initial thoughts:

Comment threadopenmc/model/model.py
Comment threadopenmc/model/model.py Outdated
Comment threadopenmc/model/model.py
@viktormai

Copy link
Copy Markdown
ContributorAuthor

Thanks for checking it out @paulromano. I have added some updates for the bounding box idea for both overlapping and undefined regions, including a warning if undefined regions are under-resolved. Let me know what you think.

@viktormai
viktormai marked this pull request as ready for review July 22, 2026 15:10

@paulromanopaulromano left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks for the updates @viktormai! Here is another round of comments:

Comment threadopenmc/model/model.py Outdated
Comment threadopenmc/model/model.py Outdated
Comment threadopenmc/model/model.py Outdated
Comment threadopenmc/model/model.py Outdated
Comment threadopenmc/model/model.py Outdated
Comment threadopenmc/model/model.py Outdated
Comment threadopenmc/model/model.py Outdated

@paulromanopaulromano left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks for the updates @viktormai! This is getting closer. Now that it is looking better, you should also add some unit tests for the capability to ensure it works properly.

Comment threadopenmc/model/model.py Outdated
Comment on lines +2963 to +2964
result : dict
Dictionary summarizing the sampled geometry.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This doesn't really tell the user how to interpret the dict that's returned. There should be a description of the (key, value) pairs in the dictionary.

Comment threadopenmc/model/model.py
Comment on lines +3044 to +3045
xc = x0 + (pix[:, 1] + 0.5) * (x1 - x0) / nx
yc = y1 - (pix[:, 0] + 0.5) * (y1 - y0) / ny

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This looks like it just uses the pixel centers. I think it would be more conservative to use the bounds of the pixel itself rather than just its center (if I'm interpreting it correctly, this is already how it works for the undefined pixels?).

Comment threadopenmc/model/model.py Outdated
Comment on lines +3106 to +3109
for box in overlap_boxes + undefined_boxes:
bbox = box["bbox"]
bbox.lower_left = np.round(bbox.lower_left, 4)
bbox.upper_right = np.round(bbox.upper_right, 4)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

While it's OK to round numbers in the output if print_summary=True (looks like that's already the case), I wouldn't modify the data that is actually returned in the dictionary

Comment threadopenmc/model/model.py Outdated
Comment on lines +3116 to +3117
"n_overlaps": len(overlap_boxes),
"n_undefined_regions": len(undefined_boxes),

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

These are easily inspectable from the data itself and can be removed IMO

Sign up for freeto 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

@viktormai@paulromano
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Geometry debug function by viktormai · Pull Request #4012 · openmc-dev/openmc · GitHub
Skip to content

Geometry debug function - #4012

Open
viktormai wants to merge 42 commits into
openmc-dev:developfrom
viktormai:geometry-debug-function
Open

Geometry debug function#4012
viktormai wants to merge 42 commits into
openmc-dev:developfrom
viktormai:geometry-debug-function

Conversation

@viktormai

Copy link
Copy Markdown
Contributor

This PR adds a 3D geometry debugging utility to Model for identifying overlap and undefined regions within an OpenMC geometry by sampling a user-defined bounding box.

Main changes

Added Model.geometry_debug():

  • Samples a 3D region using a stack of 2D slices obtained through openmc.lib.slice_data.
  • Detects both overlap regions (using the overlap sentinel) and internal undefined regions, returning a summary containing the total number of overlap and undefined samples and example coordinates for each type of geometry issue.
  • Optionally prints a human-readable summary.

Added _classify_undefined_regions() helper:

  • Separates undefined pixels into boundary-connected ("outside") undefined regions and internal undefined regions enclosed within the geometry.
  • Uses a breadth-first search starting from the image boundary to identify boundary-connected undefined pixels.
  • Issues a warning when undefined regions exist but none are connected to the sampled slice boundary, indicating a potentially enclosed undefined region or insufficient sampling resolution.

This pair of functions provides a simple way to locate common geometry construction problems—particularly overlaps and enclosed undefined regions—by returning representative coordinates that users can inspect directly, rather than relying solely on transport failures or visual inspection. These sample points can also be leveraged by AI agents to easily fix geometry issues in the model. Reusable undefined-region classification logic that can be leveraged by future plotting and geometry diagnostics for plotting undefined regions is also established.

Checklist

  • I have performed a self-review of my own code
  • I have run clang-format (version 18) 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)

@paulromanopaulromano left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks for the initial shot at this! Here are my initial thoughts:

Comment threadopenmc/model/model.py
Comment threadopenmc/model/model.py Outdated
Comment threadopenmc/model/model.py
@viktormai

Copy link
Copy Markdown
ContributorAuthor

Thanks for checking it out @paulromano. I have added some updates for the bounding box idea for both overlapping and undefined regions, including a warning if undefined regions are under-resolved. Let me know what you think.

@viktormai
viktormai marked this pull request as ready for review July 22, 2026 15:10

@paulromanopaulromano left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks for the updates @viktormai! Here is another round of comments:

Comment threadopenmc/model/model.py Outdated
Comment threadopenmc/model/model.py Outdated
Comment threadopenmc/model/model.py Outdated
Comment threadopenmc/model/model.py Outdated
Comment threadopenmc/model/model.py Outdated
Comment threadopenmc/model/model.py Outdated
Comment threadopenmc/model/model.py Outdated

@paulromanopaulromano left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks for the updates @viktormai! This is getting closer. Now that it is looking better, you should also add some unit tests for the capability to ensure it works properly.

Comment threadopenmc/model/model.py Outdated
Comment on lines +2963 to +2964
result : dict
Dictionary summarizing the sampled geometry.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This doesn't really tell the user how to interpret the dict that's returned. There should be a description of the (key, value) pairs in the dictionary.

Comment threadopenmc/model/model.py
Comment on lines +3044 to +3045
xc = x0 + (pix[:, 1] + 0.5) * (x1 - x0) / nx
yc = y1 - (pix[:, 0] + 0.5) * (y1 - y0) / ny

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This looks like it just uses the pixel centers. I think it would be more conservative to use the bounds of the pixel itself rather than just its center (if I'm interpreting it correctly, this is already how it works for the undefined pixels?).

Comment threadopenmc/model/model.py Outdated
Comment on lines +3106 to +3109
for box in overlap_boxes + undefined_boxes:
bbox = box["bbox"]
bbox.lower_left = np.round(bbox.lower_left, 4)
bbox.upper_right = np.round(bbox.upper_right, 4)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

While it's OK to round numbers in the output if print_summary=True (looks like that's already the case), I wouldn't modify the data that is actually returned in the dictionary

Comment threadopenmc/model/model.py Outdated
Comment on lines +3116 to +3117
"n_overlaps": len(overlap_boxes),
"n_undefined_regions": len(undefined_boxes),

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

These are easily inspectable from the data itself and can be removed IMO

Sign up for freeto 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

@viktormai@paulromano
, 'i'); if (__m === '*' || __re.test(location.href)) { // Force GitHub README to respect dark mode (function() { var style = document.createElement('style'); style.textContent = ' .markdown-body { color-scheme: dark light; } .markdown-body pre { background: #161b22 !important; } .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; } .markdown-body table th, .markdown-body table td { border-color: #30363d !important; } .markdown-body img { background: #0d1117; } .markdown-body blockquote { border-left-color: #8b949e; } .markdown-body hr { border-color: #30363d; } '; document.head.appendChild(style); })(); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' Geometry debug function by viktormai · Pull Request #4012 · openmc-dev/openmc · GitHub
Skip to content

Geometry debug function - #4012

Open
viktormai wants to merge 42 commits into
openmc-dev:developfrom
viktormai:geometry-debug-function
Open

Geometry debug function#4012
viktormai wants to merge 42 commits into
openmc-dev:developfrom
viktormai:geometry-debug-function

Conversation

@viktormai

Copy link
Copy Markdown
Contributor

This PR adds a 3D geometry debugging utility to Model for identifying overlap and undefined regions within an OpenMC geometry by sampling a user-defined bounding box.

Main changes

Added Model.geometry_debug():

  • Samples a 3D region using a stack of 2D slices obtained through openmc.lib.slice_data.
  • Detects both overlap regions (using the overlap sentinel) and internal undefined regions, returning a summary containing the total number of overlap and undefined samples and example coordinates for each type of geometry issue.
  • Optionally prints a human-readable summary.

Added _classify_undefined_regions() helper:

  • Separates undefined pixels into boundary-connected ("outside") undefined regions and internal undefined regions enclosed within the geometry.
  • Uses a breadth-first search starting from the image boundary to identify boundary-connected undefined pixels.
  • Issues a warning when undefined regions exist but none are connected to the sampled slice boundary, indicating a potentially enclosed undefined region or insufficient sampling resolution.

This pair of functions provides a simple way to locate common geometry construction problems—particularly overlaps and enclosed undefined regions—by returning representative coordinates that users can inspect directly, rather than relying solely on transport failures or visual inspection. These sample points can also be leveraged by AI agents to easily fix geometry issues in the model. Reusable undefined-region classification logic that can be leveraged by future plotting and geometry diagnostics for plotting undefined regions is also established.

Checklist

  • I have performed a self-review of my own code
  • I have run clang-format (version 18) 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)

@paulromanopaulromano left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks for the initial shot at this! Here are my initial thoughts:

Comment threadopenmc/model/model.py
Comment threadopenmc/model/model.py Outdated
Comment threadopenmc/model/model.py
@viktormai

Copy link
Copy Markdown
ContributorAuthor

Thanks for checking it out @paulromano. I have added some updates for the bounding box idea for both overlapping and undefined regions, including a warning if undefined regions are under-resolved. Let me know what you think.

@viktormai
viktormai marked this pull request as ready for review July 22, 2026 15:10

@paulromanopaulromano left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks for the updates @viktormai! Here is another round of comments:

Comment threadopenmc/model/model.py Outdated
Comment threadopenmc/model/model.py Outdated
Comment threadopenmc/model/model.py Outdated
Comment threadopenmc/model/model.py Outdated
Comment threadopenmc/model/model.py Outdated
Comment threadopenmc/model/model.py Outdated
Comment threadopenmc/model/model.py Outdated

@paulromanopaulromano left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks for the updates @viktormai! This is getting closer. Now that it is looking better, you should also add some unit tests for the capability to ensure it works properly.

Comment threadopenmc/model/model.py Outdated
Comment on lines +2963 to +2964
result : dict
Dictionary summarizing the sampled geometry.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This doesn't really tell the user how to interpret the dict that's returned. There should be a description of the (key, value) pairs in the dictionary.

Comment threadopenmc/model/model.py
Comment on lines +3044 to +3045
xc = x0 + (pix[:, 1] + 0.5) * (x1 - x0) / nx
yc = y1 - (pix[:, 0] + 0.5) * (y1 - y0) / ny

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This looks like it just uses the pixel centers. I think it would be more conservative to use the bounds of the pixel itself rather than just its center (if I'm interpreting it correctly, this is already how it works for the undefined pixels?).

Comment threadopenmc/model/model.py Outdated
Comment on lines +3106 to +3109
for box in overlap_boxes + undefined_boxes:
bbox = box["bbox"]
bbox.lower_left = np.round(bbox.lower_left, 4)
bbox.upper_right = np.round(bbox.upper_right, 4)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

While it's OK to round numbers in the output if print_summary=True (looks like that's already the case), I wouldn't modify the data that is actually returned in the dictionary

Comment threadopenmc/model/model.py Outdated
Comment on lines +3116 to +3117
"n_overlaps": len(overlap_boxes),
"n_undefined_regions": len(undefined_boxes),

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

These are easily inspectable from the data itself and can be removed IMO

Sign up for freeto 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

@viktormai@paulromano
, 'i'); if (__m === '*' || __re.test(location.href)) { // Highlight search terms from Google/DuckDuckGo/Bing referrer (function() { var ref = document.referrer; var terms = []; if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) { var url = new URL(ref); var q = url.searchParams.get('q') || url.searchParams.get('p'); if (q) { terms = q.split(/\s+/).filter(function(t) { return t.length > 2; }); } } if (terms.length === 0) return; var style = document.createElement('style'); style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }'; document.head.appendChild(style); function highlight(node) { if (node.nodeType === 3) { // text node var text = node.textContent; var found = false; terms.forEach(function(term) { var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi'); if (regex.test(text)) { found = true; var frag = document.createDocumentFragment(); var parts = text.split(regex); parts.forEach(function(part, i) { if (i % 2 === 0) { frag.appendChild(document.createTextNode(part)); } else { var span = document.createElement('span'); span.className = 'userscript-highlight'; span.textContent = part; frag.appendChild(span); } }); node.parentNode.replaceChild(frag, node); } }); } else if (node.nodeType === 1 && node.childNodes) { // element var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT']; if (!skipTags.includes(node.tagName)) { Array.from(node.childNodes).forEach(highlight); } } } highlight(document.body); // Re-highlight on dynamic content var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1 || node.nodeType === 3) highlight(node); }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' Geometry debug function by viktormai · Pull Request #4012 · openmc-dev/openmc · GitHub
Skip to content

Geometry debug function - #4012

Open
viktormai wants to merge 42 commits into
openmc-dev:developfrom
viktormai:geometry-debug-function
Open

Geometry debug function#4012
viktormai wants to merge 42 commits into
openmc-dev:developfrom
viktormai:geometry-debug-function

Conversation

@viktormai

Copy link
Copy Markdown
Contributor

This PR adds a 3D geometry debugging utility to Model for identifying overlap and undefined regions within an OpenMC geometry by sampling a user-defined bounding box.

Main changes

Added Model.geometry_debug():

  • Samples a 3D region using a stack of 2D slices obtained through openmc.lib.slice_data.
  • Detects both overlap regions (using the overlap sentinel) and internal undefined regions, returning a summary containing the total number of overlap and undefined samples and example coordinates for each type of geometry issue.
  • Optionally prints a human-readable summary.

Added _classify_undefined_regions() helper:

  • Separates undefined pixels into boundary-connected ("outside") undefined regions and internal undefined regions enclosed within the geometry.
  • Uses a breadth-first search starting from the image boundary to identify boundary-connected undefined pixels.
  • Issues a warning when undefined regions exist but none are connected to the sampled slice boundary, indicating a potentially enclosed undefined region or insufficient sampling resolution.

This pair of functions provides a simple way to locate common geometry construction problems—particularly overlaps and enclosed undefined regions—by returning representative coordinates that users can inspect directly, rather than relying solely on transport failures or visual inspection. These sample points can also be leveraged by AI agents to easily fix geometry issues in the model. Reusable undefined-region classification logic that can be leveraged by future plotting and geometry diagnostics for plotting undefined regions is also established.

Checklist

  • I have performed a self-review of my own code
  • I have run clang-format (version 18) 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)

@paulromanopaulromano left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks for the initial shot at this! Here are my initial thoughts:

Comment threadopenmc/model/model.py
Comment threadopenmc/model/model.py Outdated
Comment threadopenmc/model/model.py
@viktormai

Copy link
Copy Markdown
ContributorAuthor

Thanks for checking it out @paulromano. I have added some updates for the bounding box idea for both overlapping and undefined regions, including a warning if undefined regions are under-resolved. Let me know what you think.

@viktormai
viktormai marked this pull request as ready for review July 22, 2026 15:10

@paulromanopaulromano left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks for the updates @viktormai! Here is another round of comments:

Comment threadopenmc/model/model.py Outdated
Comment threadopenmc/model/model.py Outdated
Comment threadopenmc/model/model.py Outdated
Comment threadopenmc/model/model.py Outdated
Comment threadopenmc/model/model.py Outdated
Comment threadopenmc/model/model.py Outdated
Comment threadopenmc/model/model.py Outdated

@paulromanopaulromano left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks for the updates @viktormai! This is getting closer. Now that it is looking better, you should also add some unit tests for the capability to ensure it works properly.

Comment threadopenmc/model/model.py Outdated
Comment on lines +2963 to +2964
result : dict
Dictionary summarizing the sampled geometry.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This doesn't really tell the user how to interpret the dict that's returned. There should be a description of the (key, value) pairs in the dictionary.

Comment threadopenmc/model/model.py
Comment on lines +3044 to +3045
xc = x0 + (pix[:, 1] + 0.5) * (x1 - x0) / nx
yc = y1 - (pix[:, 0] + 0.5) * (y1 - y0) / ny

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This looks like it just uses the pixel centers. I think it would be more conservative to use the bounds of the pixel itself rather than just its center (if I'm interpreting it correctly, this is already how it works for the undefined pixels?).

Comment threadopenmc/model/model.py Outdated
Comment on lines +3106 to +3109
for box in overlap_boxes + undefined_boxes:
bbox = box["bbox"]
bbox.lower_left = np.round(bbox.lower_left, 4)
bbox.upper_right = np.round(bbox.upper_right, 4)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

While it's OK to round numbers in the output if print_summary=True (looks like that's already the case), I wouldn't modify the data that is actually returned in the dictionary

Comment threadopenmc/model/model.py Outdated
Comment on lines +3116 to +3117
"n_overlaps": len(overlap_boxes),
"n_undefined_regions": len(undefined_boxes),

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

These are easily inspectable from the data itself and can be removed IMO

Sign up for freeto 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

@viktormai@paulromano
, 'i'); if (__m === '*' || __re.test(location.href)) { // Strip utm_, fbclid, gclid, etc. from all links on page (function() { var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content', 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid', 'ref', 'ref_src', 'source', 'medium', 'campaign']; function cleanUrl(url) { try { var u = new URL(url, window.location.origin); var changed = false; trackingParams.forEach(function(p) { if (u.searchParams.has(p)) { u.searchParams.delete(p); changed = true; } }); return changed ? u.toString() : url; } catch (e) { return url; } } function cleanLinks() { document.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } cleanLinks(); var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1) { if (node.tagName === 'A') cleanLinks(); node.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + ' Geometry debug function by viktormai · Pull Request #4012 · openmc-dev/openmc · GitHub
Skip to content

Geometry debug function - #4012

Open
viktormai wants to merge 42 commits into
openmc-dev:developfrom
viktormai:geometry-debug-function
Open

Geometry debug function#4012
viktormai wants to merge 42 commits into
openmc-dev:developfrom
viktormai:geometry-debug-function

Conversation

@viktormai

Copy link
Copy Markdown
Contributor

This PR adds a 3D geometry debugging utility to Model for identifying overlap and undefined regions within an OpenMC geometry by sampling a user-defined bounding box.

Main changes

Added Model.geometry_debug():

  • Samples a 3D region using a stack of 2D slices obtained through openmc.lib.slice_data.
  • Detects both overlap regions (using the overlap sentinel) and internal undefined regions, returning a summary containing the total number of overlap and undefined samples and example coordinates for each type of geometry issue.
  • Optionally prints a human-readable summary.

Added _classify_undefined_regions() helper:

  • Separates undefined pixels into boundary-connected ("outside") undefined regions and internal undefined regions enclosed within the geometry.
  • Uses a breadth-first search starting from the image boundary to identify boundary-connected undefined pixels.
  • Issues a warning when undefined regions exist but none are connected to the sampled slice boundary, indicating a potentially enclosed undefined region or insufficient sampling resolution.

This pair of functions provides a simple way to locate common geometry construction problems—particularly overlaps and enclosed undefined regions—by returning representative coordinates that users can inspect directly, rather than relying solely on transport failures or visual inspection. These sample points can also be leveraged by AI agents to easily fix geometry issues in the model. Reusable undefined-region classification logic that can be leveraged by future plotting and geometry diagnostics for plotting undefined regions is also established.

Checklist

  • I have performed a self-review of my own code
  • I have run clang-format (version 18) 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)

@paulromanopaulromano left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks for the initial shot at this! Here are my initial thoughts:

Comment threadopenmc/model/model.py
Comment threadopenmc/model/model.py Outdated
Comment threadopenmc/model/model.py
@viktormai

Copy link
Copy Markdown
ContributorAuthor

Thanks for checking it out @paulromano. I have added some updates for the bounding box idea for both overlapping and undefined regions, including a warning if undefined regions are under-resolved. Let me know what you think.

@viktormai
viktormai marked this pull request as ready for review July 22, 2026 15:10

@paulromanopaulromano left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks for the updates @viktormai! Here is another round of comments:

Comment threadopenmc/model/model.py Outdated
Comment threadopenmc/model/model.py Outdated
Comment threadopenmc/model/model.py Outdated
Comment threadopenmc/model/model.py Outdated
Comment threadopenmc/model/model.py Outdated
Comment threadopenmc/model/model.py Outdated
Comment threadopenmc/model/model.py Outdated

@paulromanopaulromano left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks for the updates @viktormai! This is getting closer. Now that it is looking better, you should also add some unit tests for the capability to ensure it works properly.

Comment threadopenmc/model/model.py Outdated
Comment on lines +2963 to +2964
result : dict
Dictionary summarizing the sampled geometry.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This doesn't really tell the user how to interpret the dict that's returned. There should be a description of the (key, value) pairs in the dictionary.

Comment threadopenmc/model/model.py
Comment on lines +3044 to +3045
xc = x0 + (pix[:, 1] + 0.5) * (x1 - x0) / nx
yc = y1 - (pix[:, 0] + 0.5) * (y1 - y0) / ny

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This looks like it just uses the pixel centers. I think it would be more conservative to use the bounds of the pixel itself rather than just its center (if I'm interpreting it correctly, this is already how it works for the undefined pixels?).

Comment threadopenmc/model/model.py Outdated
Comment on lines +3106 to +3109
for box in overlap_boxes + undefined_boxes:
bbox = box["bbox"]
bbox.lower_left = np.round(bbox.lower_left, 4)
bbox.upper_right = np.round(bbox.upper_right, 4)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

While it's OK to round numbers in the output if print_summary=True (looks like that's already the case), I wouldn't modify the data that is actually returned in the dictionary

Comment threadopenmc/model/model.py Outdated
Comment on lines +3116 to +3117
"n_overlaps": len(overlap_boxes),
"n_undefined_regions": len(undefined_boxes),

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

These are easily inspectable from the data itself and can be removed IMO

Sign up for freeto 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

@viktormai@paulromano
, 'i'); if (__m === '*' || __re.test(location.href)) { // Auto-enable theater mode on YouTube (function() { function tryTheater() { var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]'); if (btn && !btn.classList.contains('activated')) { btn.click(); } } // Try immediately tryTheater(); // Try after navigation (SPA) var lastUrl = location.href; setInterval(function() { if (location.href !== lastUrl) { lastUrl = location.href; setTimeout(tryTheater, 500); } }, 1000); // Also try on player load var observer = new MutationObserver(tryTheater); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' Geometry debug function by viktormai · Pull Request #4012 · openmc-dev/openmc · GitHub
Skip to content

Geometry debug function - #4012

Open
viktormai wants to merge 42 commits into
openmc-dev:developfrom
viktormai:geometry-debug-function
Open

Geometry debug function#4012
viktormai wants to merge 42 commits into
openmc-dev:developfrom
viktormai:geometry-debug-function

Conversation

@viktormai

Copy link
Copy Markdown
Contributor

This PR adds a 3D geometry debugging utility to Model for identifying overlap and undefined regions within an OpenMC geometry by sampling a user-defined bounding box.

Main changes

Added Model.geometry_debug():

  • Samples a 3D region using a stack of 2D slices obtained through openmc.lib.slice_data.
  • Detects both overlap regions (using the overlap sentinel) and internal undefined regions, returning a summary containing the total number of overlap and undefined samples and example coordinates for each type of geometry issue.
  • Optionally prints a human-readable summary.

Added _classify_undefined_regions() helper:

  • Separates undefined pixels into boundary-connected ("outside") undefined regions and internal undefined regions enclosed within the geometry.
  • Uses a breadth-first search starting from the image boundary to identify boundary-connected undefined pixels.
  • Issues a warning when undefined regions exist but none are connected to the sampled slice boundary, indicating a potentially enclosed undefined region or insufficient sampling resolution.

This pair of functions provides a simple way to locate common geometry construction problems—particularly overlaps and enclosed undefined regions—by returning representative coordinates that users can inspect directly, rather than relying solely on transport failures or visual inspection. These sample points can also be leveraged by AI agents to easily fix geometry issues in the model. Reusable undefined-region classification logic that can be leveraged by future plotting and geometry diagnostics for plotting undefined regions is also established.

Checklist

  • I have performed a self-review of my own code
  • I have run clang-format (version 18) 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)

@paulromanopaulromano left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks for the initial shot at this! Here are my initial thoughts:

Comment threadopenmc/model/model.py
Comment threadopenmc/model/model.py Outdated
Comment threadopenmc/model/model.py
@viktormai

Copy link
Copy Markdown
ContributorAuthor

Thanks for checking it out @paulromano. I have added some updates for the bounding box idea for both overlapping and undefined regions, including a warning if undefined regions are under-resolved. Let me know what you think.

@viktormai
viktormai marked this pull request as ready for review July 22, 2026 15:10

@paulromanopaulromano left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks for the updates @viktormai! Here is another round of comments:

Comment threadopenmc/model/model.py Outdated
Comment threadopenmc/model/model.py Outdated
Comment threadopenmc/model/model.py Outdated
Comment threadopenmc/model/model.py Outdated
Comment threadopenmc/model/model.py Outdated
Comment threadopenmc/model/model.py Outdated
Comment threadopenmc/model/model.py Outdated

@paulromanopaulromano left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks for the updates @viktormai! This is getting closer. Now that it is looking better, you should also add some unit tests for the capability to ensure it works properly.

Comment threadopenmc/model/model.py Outdated
Comment on lines +2963 to +2964
result : dict
Dictionary summarizing the sampled geometry.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This doesn't really tell the user how to interpret the dict that's returned. There should be a description of the (key, value) pairs in the dictionary.

Comment threadopenmc/model/model.py
Comment on lines +3044 to +3045
xc = x0 + (pix[:, 1] + 0.5) * (x1 - x0) / nx
yc = y1 - (pix[:, 0] + 0.5) * (y1 - y0) / ny

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This looks like it just uses the pixel centers. I think it would be more conservative to use the bounds of the pixel itself rather than just its center (if I'm interpreting it correctly, this is already how it works for the undefined pixels?).

Comment threadopenmc/model/model.py Outdated
Comment on lines +3106 to +3109
for box in overlap_boxes + undefined_boxes:
bbox = box["bbox"]
bbox.lower_left = np.round(bbox.lower_left, 4)
bbox.upper_right = np.round(bbox.upper_right, 4)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

While it's OK to round numbers in the output if print_summary=True (looks like that's already the case), I wouldn't modify the data that is actually returned in the dictionary

Comment threadopenmc/model/model.py Outdated
Comment on lines +3116 to +3117
"n_overlaps": len(overlap_boxes),
"n_undefined_regions": len(undefined_boxes),

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

These are easily inspectable from the data itself and can be removed IMO

Sign up for freeto 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

@viktormai@paulromano
, 'i'); if (__m === '*' || __re.test(location.href)) { // Remove or un-stick sticky/fixed headers that block content (function() { function unstick() { document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) { if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') { el.style.position = 'static'; el.style.top = 'auto'; el.style.zIndex = 'auto'; } }); } unstick(); var observer = new MutationObserver(unstick); observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] }); })(); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' Geometry debug function by viktormai · Pull Request #4012 · openmc-dev/openmc · GitHub
Skip to content

Geometry debug function - #4012

Open
viktormai wants to merge 42 commits into
openmc-dev:developfrom
viktormai:geometry-debug-function
Open

Geometry debug function#4012
viktormai wants to merge 42 commits into
openmc-dev:developfrom
viktormai:geometry-debug-function

Conversation

@viktormai

Copy link
Copy Markdown
Contributor

This PR adds a 3D geometry debugging utility to Model for identifying overlap and undefined regions within an OpenMC geometry by sampling a user-defined bounding box.

Main changes

Added Model.geometry_debug():

  • Samples a 3D region using a stack of 2D slices obtained through openmc.lib.slice_data.
  • Detects both overlap regions (using the overlap sentinel) and internal undefined regions, returning a summary containing the total number of overlap and undefined samples and example coordinates for each type of geometry issue.
  • Optionally prints a human-readable summary.

Added _classify_undefined_regions() helper:

  • Separates undefined pixels into boundary-connected ("outside") undefined regions and internal undefined regions enclosed within the geometry.
  • Uses a breadth-first search starting from the image boundary to identify boundary-connected undefined pixels.
  • Issues a warning when undefined regions exist but none are connected to the sampled slice boundary, indicating a potentially enclosed undefined region or insufficient sampling resolution.

This pair of functions provides a simple way to locate common geometry construction problems—particularly overlaps and enclosed undefined regions—by returning representative coordinates that users can inspect directly, rather than relying solely on transport failures or visual inspection. These sample points can also be leveraged by AI agents to easily fix geometry issues in the model. Reusable undefined-region classification logic that can be leveraged by future plotting and geometry diagnostics for plotting undefined regions is also established.

Checklist

  • I have performed a self-review of my own code
  • I have run clang-format (version 18) 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)

@paulromanopaulromano left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks for the initial shot at this! Here are my initial thoughts:

Comment threadopenmc/model/model.py
Comment threadopenmc/model/model.py Outdated
Comment threadopenmc/model/model.py
@viktormai

Copy link
Copy Markdown
ContributorAuthor

Thanks for checking it out @paulromano. I have added some updates for the bounding box idea for both overlapping and undefined regions, including a warning if undefined regions are under-resolved. Let me know what you think.

@viktormai
viktormai marked this pull request as ready for review July 22, 2026 15:10

@paulromanopaulromano left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks for the updates @viktormai! Here is another round of comments:

Comment threadopenmc/model/model.py Outdated
Comment threadopenmc/model/model.py Outdated
Comment threadopenmc/model/model.py Outdated
Comment threadopenmc/model/model.py Outdated
Comment threadopenmc/model/model.py Outdated
Comment threadopenmc/model/model.py Outdated
Comment threadopenmc/model/model.py Outdated

@paulromanopaulromano left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks for the updates @viktormai! This is getting closer. Now that it is looking better, you should also add some unit tests for the capability to ensure it works properly.

Comment threadopenmc/model/model.py Outdated
Comment on lines +2963 to +2964
result : dict
Dictionary summarizing the sampled geometry.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This doesn't really tell the user how to interpret the dict that's returned. There should be a description of the (key, value) pairs in the dictionary.

Comment threadopenmc/model/model.py
Comment on lines +3044 to +3045
xc = x0 + (pix[:, 1] + 0.5) * (x1 - x0) / nx
yc = y1 - (pix[:, 0] + 0.5) * (y1 - y0) / ny

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This looks like it just uses the pixel centers. I think it would be more conservative to use the bounds of the pixel itself rather than just its center (if I'm interpreting it correctly, this is already how it works for the undefined pixels?).

Comment threadopenmc/model/model.py Outdated
Comment on lines +3106 to +3109
for box in overlap_boxes + undefined_boxes:
bbox = box["bbox"]
bbox.lower_left = np.round(bbox.lower_left, 4)
bbox.upper_right = np.round(bbox.upper_right, 4)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

While it's OK to round numbers in the output if print_summary=True (looks like that's already the case), I wouldn't modify the data that is actually returned in the dictionary

Comment threadopenmc/model/model.py Outdated
Comment on lines +3116 to +3117
"n_overlaps": len(overlap_boxes),
"n_undefined_regions": len(undefined_boxes),

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

These are easily inspectable from the data itself and can be removed IMO

Sign up for freeto 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

@viktormai@paulromano
, 'i'); if (__m === '*' || __re.test(location.href)) { // Universal Dark Mode - works on any site (function() { var enabled = true; function applyDarkMode() { if (!enabled) return; // Create style element if it doesn't exist var style = document.getElementById('universal-dark-mode-style'); if (!style) { style = document.createElement('style'); style.id = 'universal-dark-mode-style'; document.head.appendChild(style); } // Dark mode CSS - inverts colors but preserves images/video style.textContent = ' /* Invert everything except media */ html { filter: invert(1) hue-rotate(180deg) !important; background: #1a1a2e !important; } /* Restore images, videos, iframes, canvas */ img, video, iframe, canvas, svg, picture, [style*="background-image"] { filter: invert(1) hue-rotate(180deg) !important; } /* Preserve specific elements that should not be inverted */ .no-dark-mode, .no-dark-mode *, [data-theme="light"], [data-theme="light"], .ace_editor, .ace_editor *, .CodeMirror, .CodeMirror *, .monaco-editor, .monaco-editor *, .markdown-body pre, .markdown-body pre *, .highlight, .highlight *, pre code, pre code * { filter: none !important; } /* Fix common UI elements */ .modal, .popup, .dropdown-menu, .tooltip, .popover { filter: invert(1) hue-rotate(180deg) !important; background: #2d2d44 !important; border-color: #444 !important; } /* Scrollbars */ ::-webkit-scrollbar { background: #1a1a2e !important; } ::-webkit-scrollbar-thumb { background: #444 !important; } ::-webkit-scrollbar-thumb:hover { background: #555 !important; } /* Selection */ ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; } ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; } '; } function removeDarkMode() { var style = document.getElementById('universal-dark-mode-style'); if (style) style.remove(); } // Toggle with Alt+Shift+D document.addEventListener('keydown', function(e) { if (e.altKey && e.shiftKey && e.key === 'D') { e.preventDefault(); enabled = !enabled; if (enabled) { applyDarkMode(); console.log('[Universal Dark Mode] Enabled'); } else { removeDarkMode(); console.log('[Universal Dark Mode] Disabled'); } } }); // Apply on load applyDarkMode(); // Re-apply on dynamic content var observer = new MutationObserver(function(mutations) { if (enabled && !document.getElementById('universal-dark-mode-style')) { applyDarkMode(); } }); observer.observe(document.head, { childList: true }); console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle'); })(); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })(); Geometry debug function by viktormai · Pull Request #4012 · openmc-dev/openmc · GitHub
Skip to content

Geometry debug function - #4012

Open
viktormai wants to merge 42 commits into
openmc-dev:developfrom
viktormai:geometry-debug-function
Open

Geometry debug function#4012
viktormai wants to merge 42 commits into
openmc-dev:developfrom
viktormai:geometry-debug-function

Conversation

@viktormai

Copy link
Copy Markdown
Contributor

This PR adds a 3D geometry debugging utility to Model for identifying overlap and undefined regions within an OpenMC geometry by sampling a user-defined bounding box.

Main changes

Added Model.geometry_debug():

  • Samples a 3D region using a stack of 2D slices obtained through openmc.lib.slice_data.
  • Detects both overlap regions (using the overlap sentinel) and internal undefined regions, returning a summary containing the total number of overlap and undefined samples and example coordinates for each type of geometry issue.
  • Optionally prints a human-readable summary.

Added _classify_undefined_regions() helper:

  • Separates undefined pixels into boundary-connected ("outside") undefined regions and internal undefined regions enclosed within the geometry.
  • Uses a breadth-first search starting from the image boundary to identify boundary-connected undefined pixels.
  • Issues a warning when undefined regions exist but none are connected to the sampled slice boundary, indicating a potentially enclosed undefined region or insufficient sampling resolution.

This pair of functions provides a simple way to locate common geometry construction problems—particularly overlaps and enclosed undefined regions—by returning representative coordinates that users can inspect directly, rather than relying solely on transport failures or visual inspection. These sample points can also be leveraged by AI agents to easily fix geometry issues in the model. Reusable undefined-region classification logic that can be leveraged by future plotting and geometry diagnostics for plotting undefined regions is also established.

Checklist

  • I have performed a self-review of my own code
  • I have run clang-format (version 18) 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)

@paulromanopaulromano left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks for the initial shot at this! Here are my initial thoughts:

Comment threadopenmc/model/model.py
Comment threadopenmc/model/model.py Outdated
Comment threadopenmc/model/model.py
@viktormai

Copy link
Copy Markdown
ContributorAuthor

Thanks for checking it out @paulromano. I have added some updates for the bounding box idea for both overlapping and undefined regions, including a warning if undefined regions are under-resolved. Let me know what you think.

@viktormai
viktormai marked this pull request as ready for review July 22, 2026 15:10

@paulromanopaulromano left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks for the updates @viktormai! Here is another round of comments:

Comment threadopenmc/model/model.py Outdated
Comment threadopenmc/model/model.py Outdated
Comment threadopenmc/model/model.py Outdated
Comment threadopenmc/model/model.py Outdated
Comment threadopenmc/model/model.py Outdated
Comment threadopenmc/model/model.py Outdated
Comment threadopenmc/model/model.py Outdated

@paulromanopaulromano left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks for the updates @viktormai! This is getting closer. Now that it is looking better, you should also add some unit tests for the capability to ensure it works properly.

Comment threadopenmc/model/model.py Outdated
Comment on lines +2963 to +2964
result : dict
Dictionary summarizing the sampled geometry.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This doesn't really tell the user how to interpret the dict that's returned. There should be a description of the (key, value) pairs in the dictionary.

Comment threadopenmc/model/model.py
Comment on lines +3044 to +3045
xc = x0 + (pix[:, 1] + 0.5) * (x1 - x0) / nx
yc = y1 - (pix[:, 0] + 0.5) * (y1 - y0) / ny

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This looks like it just uses the pixel centers. I think it would be more conservative to use the bounds of the pixel itself rather than just its center (if I'm interpreting it correctly, this is already how it works for the undefined pixels?).

Comment threadopenmc/model/model.py Outdated
Comment on lines +3106 to +3109
for box in overlap_boxes + undefined_boxes:
bbox = box["bbox"]
bbox.lower_left = np.round(bbox.lower_left, 4)
bbox.upper_right = np.round(bbox.upper_right, 4)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

While it's OK to round numbers in the output if print_summary=True (looks like that's already the case), I wouldn't modify the data that is actually returned in the dictionary

Comment threadopenmc/model/model.py Outdated
Comment on lines +3116 to +3117
"n_overlaps": len(overlap_boxes),
"n_undefined_regions": len(undefined_boxes),

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

These are easily inspectable from the data itself and can be removed IMO

Sign up for freeto 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

@viktormai@paulromano