Skip to content

Union logger transformations#2426

Open
mads-bertelsen wants to merge 11 commits into
mainfrom
union_logger_transformations
Open

Union logger transformations#2426
mads-bertelsen wants to merge 11 commits into
mainfrom
union_logger_transformations

Conversation

@mads-bertelsen
Copy link
Copy Markdown
Contributor

@mads-bertelsen mads-bertelsen commented Apr 29, 2026 •
edited
Loading

Free-form text area

Please describe what your PR is adding in terms of features or bugfixes:

In the Union system, loggers and absorption loggers handled coordinate transformation from the master to their local coordinate system in different ways. That has been streamlined so they both perform the transformation in the logger, as the transformation is not always necessary which saves computation time (think logging just the time).
Fixed issue the caused loggers to not account for rotation.
Fixed issue that prevented conditional on absorption loggers in certain circumstances.

Updated all tests of loggers and absorption loggers to include:

  • Union master with weird coordinates making the transformation harder, wrong transformation would result in 0 intensity
  • Included conditional component for all such tests, activating a very different code path in each, and provided test for that

Many tests lacked examples, this has been rectified in all cases except where only event output is possible. One component lacked a test, and it was added.

Development OS / boundary conditions

Please describe what OS you developed and tested your additions on, and if any special dependencies are required:

PR Checklist for contributing to McStas/McXtrace

For a coherent and useful contribution to McStas/McXtrace, please fill in relevant parts of the checklist:

  • My contribution includes patches to an existing component file

    • I have used the mcdoc utility and rendered a reasonable documentation page for the component (please attach as screenshot in comments!)
    • I have ensured that basic use of the component is OK (e.g. an instrument using it compiles?)
    • I have used the mctest utility to test one or more instruments making use of the component (please attach mcviewtest report as screenshot in comments)
    • I have used the mccode-clangformat tool to apply the standard McCode component indentation scheme
    • I have used the mcrun --c-lint "linter" and followed advice to remove most / all warnings that are raised

  • My contribution includes patches to an existing instrument file

    • I have used the mcdoc utility and rendered a reasonable documentation page for the instrument (please attach as screenshot in comments!)
    • I have used the mctest utility to test the instrument (please attach mcviewtest report as screenshot in comments)
    • I have used the mcrun --c-lint "linter" and followed advice to remove most / all warnings that are raised

  • My contribution includes a new component file

    • I have ensured that naming of parameters are in the style of existing components. (Please check the McStas or McXtrace NOMENCLATURE docs.)
    • I have ensured that component parameters are in the usually units of McStas or McXtrace (SI + neutron/x-ray 'usual' units)
    • I have used the mcdoc utility and rendered a reasonable documentation page for the component (please attach as screenshot in comments!)
    • I have ensured that basic use of the component is OK (e.g. an instrument using it compiles?)
    • I have included a corresponding example instrument and will fill in the new instrument section below
    • I have used the mccode-clangformat tool to apply the standard McCode component indentation scheme
    • My new component is added within the contrib component category

  • My contribution includes a new instrument file

    • I have used the mcdoc utility and rendered a reasonable documentation page for the instrument (please attach as screenshot in comments!)
    • I have ensured that basic use of the instrument is OK (e.g. it compiles?)
    • ... and provided reasonable default parameters in that instrument that produce reasonable output
    • ... and maybe even added a %Example: line to describe expected behaviour
    • I have used the mcrun --c-lint "linter" and followed advice to remove most / all warnings that are raised
    • My new instrument is added within the examples hierarchy in a folder in the style of examples/ESS/New_stuff/New_stuff.instr
    • My new instrument has a new, unique filename, not clashing with existing example instruments
    • My new instrument requires a data/input file. If the datafile is specific for my instrument I have left it in the same example folder, but if general use I have placed it in the global data folder.

  • My work touches the code-generator in mccode/src

    • I have added reasoning and documentation for the change through an ADR record in our GRAMMAR section
    • I am attaching test output in the comments

  • My work touches / adds to the runtime lib code (.c,.h etc in multiple locations

    • I am have added reasoning and documentation for the change below
    • I am attaching test output in the comments

  • My PR is meant to fix a specific, existing issue

    • I have indicated the issue number here:
    • I have added documentation for the fix and possible side effects

  • My contribution contains something else

    • Explanation is added in free form text above or below the checklist

@mads-bertelsen mads-bertelsen marked this pull request as draft April 29, 2026 14:52
@mads-bertelsen
Copy link
Copy Markdown
Contributor Author

mads-bertelsen commented Apr 30, 2026

Screenshot of very simple mcdoc page for the new test instrument

Screenshot 2026-04-30 at 10 30 23

@mads-bertelsen mads-bertelsen force-pushed the union_logger_transformations branch from bd56d3b to 754c277 Compare May 4, 2026 14:40
@mads-bertelsen mads-bertelsen changed the title [DRAFT] Union logger transformations Union logger transformations May 4, 2026
@mads-bertelsen
Copy link
Copy Markdown
Contributor Author

mads-bertelsen commented May 4, 2026

Tests, linting, mcdoc and formatting pass locally for all logger and abs_logger components

@mads-bertelsen mads-bertelsen mentioned this pull request May 4, 2026
Open
@willend
Copy link
Copy Markdown
Contributor

willend commented May 4, 2026

@mads-bertelsen the remaining error in the mcstas-basictest workflow, gcc Windows is very likely not an issue in your code.

The NCrystal dependency is in place but is not (currently) properly found / linked correctly on that configuration. (The “fully” conda workflow works fine.)

@mads-bertelsen mads-bertelsen marked this pull request as ready for review May 4, 2026 20:21
@mads-bertelsen
Fixing lack of rotation for logger components.
bc58110 
Logger components had coordinate transformation from master to local in their code, and didn't take rotation into account.

Abs_loggers on the other hand had the transformation done in master, this was moved into the abs_loggers to be more consistent with loggers.

It was decided to have transformation in the loggers, abs_loggers instead of master for performance reasons, a logger may look on just the
time, and then there is no need to transform position and wavevector.
@mads-bertelsen
Fixed errors caught by compiler.
94c12a6
@mads-bertelsen
Further fixe, now all existing tests runs successfully.
85ecb12 
Additional tests are needed and will be added to the branch.
@mads-bertelsen
Update of tests to include:
90e3a0c 
- Union_master at weird position, requires loggers to correct with their transformation, harder test
- Added conditional component to all abs_logger and logger tests, testing a significantly different code path for each

Found issue in conditionals as relating to absorption loggers with speicifc target, fixed that.
@mads-bertelsen
Fixed typo in expected intensity
9c799c3
@mads-bertelsen
Added check for malloc returning NULL pointer across all loggers and …
790a440 
…abs_loggers and Powder_process.

Renamed geometries in text to avoid names of drawcalls such as box and sphere, which prevents mcdisplay functionality.

Reduced uncertainty in certain tests to ensure they are very likely to succeed when running with standard 1E6 rays.
@mads-bertelsen
clang formattet all components
672a808
@mads-bertelsen
Updating NCrystal_process to modern standard as its tests were failin…
4189833 
…g on windows blocking the PR.
@mads-bertelsen
Adding _WIN32 to define flags that change import syntax for windows.
c37a54f
@mads-bertelsen
Updated headers of test instruments.
5e26d07
@mads-bertelsen mads-bertelsen force-pushed the union_logger_transformations branch from 98bbc57 to 5e26d07 Compare May 11, 2026 09:21
@mads-bertelsen
Found some uninitialized values and a slight error in malloc size. Pe…
9d5a151 
…rhaps could be cause of rare crash on windows.
@mads-bertelsen
Copy link
Copy Markdown
Contributor Author

mads-bertelsen commented May 11, 2026

During one test on windows there were a number of runtime failures on very simple test instruments that all used a conditional component, but only that single run. Looked through all code related to conditionals for memory allocation errors and found two issues that were fixed:

  • one wrong type in a malloc(sizeoff( )) where it allocated space for an entire structure instead of just a pointer, though this asked for more space than necessary
  • lack of free in a function that effectively reallocs a certain kind of list

All tests pass locally and on GitHub actions. Maybe these helped, maybe it was something else, but have not been able to reproduce that test error since.

Think this is ready to merge!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@mads-bertelsen @willend