Skip to content

Conversation

@tkittel
Copy link
Contributor

@tkittel tkittel commented Nov 5, 2025

Adding new scattering_process_struct_init function and apply it in all union processes. The ulterior motive is that this will allow us to add to or modify this struct in the future without having to edit all the union processes.


Development OS / boundary conditions

Tested on Ubuntu 24 + conda with latest McCode and mctest --instr=union


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 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
    • 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

@tkittel tkittel added the Union Items related to the Union subsystem label Nov 5, 2025
@tkittel tkittel changed the title Tk union init Add new scattering_process_struct_init function for union processes Nov 5, 2025
Copy link
Contributor

@mads-bertelsen mads-bertelsen left a comment

Choose a reason for hiding this comment

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

This is a nice pattern, certainly catches some annoying bugs before they happen and lets us add new control parameters with a sensible default without altering all process components. It can also be expanded with the common inputs, such as interact_fraction abd the process enumerator that is required for all processes.

Similar initialization functions should exists for all the major structs, geometry, logger and so forth.

@mads-bertelsen mads-bertelsen merged commit 79c2ba8 into mccode-dev:main Nov 17, 2025
22 checks passed
tkittel added a commit to tkittel/McCode that referenced this pull request Nov 18, 2025
willend added a commit that referenced this pull request Nov 18, 2025
Followup fix to #2177 with correct order of memset args
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Union Items related to the Union subsystem

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants