Add helper functions for sampling/calculating direction in interactors #1301
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
amandalund
added
physics
sethrj
approved these changes
Jul 1, 2024
Comment on lines
41
to
44
| inline CELER_FUNCTION Real3 calc_exiting_direction(real_type inc_momentum, | ||
| real_type out_momentum, | ||
| Real3 const& inc_dir, | ||
| Real3 const& out_dir) |
There was a problem hiding this comment.
What do you think about a little detail helper:
struct Momentum {
real_type magnitude;
Real3 const& direction;
};so the components are more strongly associated:
result.direction = calc_exiting_direction(
{inc_momentum_.value(), inc_direction_},
{gamma_energy_.value(), secondary_->direction});
Comment on lines
22
to
24
| * Sample azimuthal angle, calculate Cartesian vector, and rotate direction. | ||
| */ | ||
| struct CartesianTransformSampler |
There was a problem hiding this comment.
Maybe something like ...
Suggested change
| * Sample azimuthal angle, calculate Cartesian vector, and rotate direction. | |
| */ | |
| struct CartesianTransformSampler | |
| * Sample an exiting direction from a polar cosine and incident direction. | |
| * | |
| * Combine an already-sampled change in polar cosine (dot product of incident | |
| * and exiting) with a sampled uniform azimuthal direction, and apply that | |
| * rotation to the original track's incident direction. | |
| */ | |
| struct ExitingDirectionSampler |
sethrj
approved these changes
Jul 1, 2024
src/celeritas/phys/PhysicsUtils.hh
Outdated
| @@ -3,54 +3,62 @@ | |||
| // See the top-level COPYRIGHT file for details. | |||
| // SPDX-License-Identifier: (Apache-2.0 OR MIT) | |||
| //---------------------------------------------------------------------------// | |||
| //! \file celeritas/em/interactor/detail/Utils.hh | |||
| //! \file celeritas/phys/PhysicsUtils.hh | |||
There was a problem hiding this comment.
What do you think about InteractionUtils? 😅 or is that the final "bring me a rock" that will break the camel's back...
There was a problem hiding this comment.
I did ask for it... sounds good!
src/celeritas/phys/PhysicsUtils.hh
Outdated
| */ | ||
| inline CELER_FUNCTION Real3 calc_exiting_direction(Momentum inc_momentum, | ||
| Momentum out_momentum) | ||
| { |
There was a problem hiding this comment.
Should we take the opportunity to add assertions on magnitude > 0? (Or >= 0?)
sethrj
approved these changes
Jul 1, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
As discussed in #1291, this adds a couple helper functions for the physics interactors. Any suggestions for better names would be welcome.