Skip to content

Particle Enums: Use Consistently and Rename - #351

Merged
ax3l merged 11 commits into
BLAST-ImpactX:developmentfrom
ax3l:topic-rename-AoS
Apr 27, 2023
Merged

ax3l merged 11 commits into
BLAST-ImpactX:developmentfrom
ax3l:topic-rename-AoS

Conversation

@ax3l

@ax3l ax3l commented Apr 25, 2023

Copy link
Copy Markdown
Member
  • rename: m_qm to qm because it is charge over mass, not its inverse
  • rename AoS to use s-based description by default: z->t
  • Rename AddNParticles parameter, since we add particles for fixed s
  • Use enums consistently whe we access .pos arguments, instead of 0-2

@ax3l
ax3l requested a review from cemitch99 April 25, 2023 21:37
@ax3l ax3l added the component: core Core ImpactX functionality label Apr 25, 2023
@ax3l
ax3l force-pushed the topic-rename-AoS branch 5 times, most recently from f4237f7 to 7a97555 Compare April 25, 2023 22:14
- rename: `m_qm` to `qm` because it is charge over mass, not its inverse
- rename AoS to use s-based description by default: `z`->`t`
- Rename `AddNParticles` parameter, since we add particles for fixed `s`
- Use enums consistently whe we access `.pos` arguments, instead of `0-2`
@ax3l
ax3l force-pushed the topic-rename-AoS branch from 7a97555 to d3e80eb Compare April 25, 2023 22:16
@ax3l ax3l mentioned this pull request Apr 25, 2023
Comment thread docs/source/usage/python.rst
Comment thread docs/source/usage/python.rst Outdated
Comment thread src/particles/ImpactXParticleContainer.H Outdated
Comment thread src/particles/ImpactXParticleContainer.H Outdated
Comment thread src/particles/ImpactXParticleContainer.cpp Outdated
Comment thread src/particles/ImpactXParticleContainer.cpp Outdated
Comment thread src/particles/ImpactXParticleContainer.cpp Outdated
Comment thread src/particles/transformation/ToFixedS.H
Comment thread src/particles/transformation/ToFixedT.H
Comment thread src/python/ImpactXParticleContainer.cpp Outdated
Comment thread src/python/ImpactXParticleContainer.cpp Outdated

@cemitch99 cemitch99 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Added mostly comments about the appearance of pz vs pt.

Comment thread docs/source/usage/python.rst Outdated
Co-authored-by: Chad Mitchell <46825199+cemitch99@users.noreply.github.com>
Comment thread src/particles/transformation/ToFixedS.H
Comment thread src/particles/transformation/ToFixedS.H Outdated
Comment thread src/particles/transformation/ToFixedS.H Outdated
Comment thread src/particles/transformation/ToFixedS.H Outdated
@ax3l
ax3l force-pushed the topic-rename-AoS branch from 8cb8bd6 to 8abd5a6 Compare April 27, 2023 18:24
Comment thread src/particles/transformation/ToFixedT.H Outdated
@ax3l

ax3l commented Apr 27, 2023

Copy link
Copy Markdown
Member Author

@cemitch99 I found a way to define alias for z and pz, which makes the code less confusing :)

@ax3l
ax3l force-pushed the topic-rename-AoS branch from 14bac62 to 78f116a Compare April 27, 2023 18:35
ax3l added 4 commits April 27, 2023 11:37
Mention s-based interpretation first, because its the most commonly
used throughout the code base.
Comment thread src/particles/transformation/ToFixedS.H

@cemitch99 cemitch99 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Ok, looks good to me. Thanks!

@ax3l
ax3l merged commit 02aa22e into BLAST-ImpactX:development Apr 27, 2023
@ax3l
ax3l deleted the topic-rename-AoS branch April 27, 2023 22:05
Comment on lines +68 to +69
ux, ///< momentum in x, scaled by the magnitude of the reference momentum [unitless] (at fixed s or t)
uy, ///< momentum in y, scaled by the magnitude of the reference momentum [unitless] (at fixed s or t)

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Follow-up: let's call those px and py, too.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

In #353

z, ///< position in z [m] (at fixed t) OR time-of-flight ct [m] (at fixed s)
x, ///< position in x [m] (at fixed s OR fixed t)
y, ///< position in y [m] (at fixed s OR fixed t)
t, ///< time-of-flight c*t [m] (at fixed s)

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

c * time-of-flight

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

In #353

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

Labels

component: core Core ImpactX functionality

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants