Update several parameters, element kinds #127
+138
−31
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,21 @@ | ||
| (s:beambeam.params)= | ||
| ## BeamBeamP: BeamBeam Parameters | ||
EZoni marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| The `BeamBeamP` parameter group describes a particle beam element | ||
| from the opposite moving colliding beam. | ||
|
|
||
| The inputs of `BeamBeamP` are: | ||
| ```{code} yaml | ||
| BeamBeamP: | ||
| sigma_x: 0.001 # The horizontal beam size of the opposite beam (default: 1 mm). | ||
| sigma_y: 0.001 # The vertical beam size of the opposite beam (default: 1 mm). | ||
| sigma_z: 0.0 # The longitudinal beam size of the opposite beam (default: 0 m). | ||
| alpha_x: 0.0 # The horizontal Twiss parameter alpha at interaction point (default: 0). | ||
| beta_x: 1.0 # The horizontal Twiss parameter beta at interaction point (default 1 m). | ||
| alpha_y: 0.0 # The vertical Twiss parameter alpha at interaction point (default 0 m). | ||
| beta_y: 1.0 # The vertical Twiss parameter beta at interaction point (default 1 m). | ||
| charge: 1.0 # The charge of the opposite beam (default: 1 for proton). | ||
| energy: 1e12 # The total energy in eV of the opposite beam (default: 1e12. | ||
| N_particle: 0.0 # Number of particles in the opposite beam (default: 0). | ||
| ``` | ||
|
Comment on lines
8
to
20
Member
There was a problem hiding this comment. I think this doesn't follow the conventions we agreed on in #127 (comment), namely MyParameterGroupP:
param1: 12.3 # [eV] A parameter with default value 12.3 in units of eV.
param2: null # [eV] A parameter without default value in units of eV.
param3: null # [unitless] A parameter without default value, unitless.
Member
There was a problem hiding this comment. Note that the comments here were meant to explain the meaning of the convention. For example, I don't think it's necessary to repeat the default values in the comment. |
||
|
|
||
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2,5 +2,38 @@ | |
| (s:init.particle.params)= | ||
| ## InitialParticleP: Initial Particle Coordinates Parameters | ||
|
|
||
| The `InitialParticleP` parameter group contains parameters for describing the | ||
| initial beam particle distribution based on its first two moments. | ||
| The components of this group are: | ||
| ```{code} yaml | ||
| InitialParticleP: | ||
| distribution_type: "" # [string] name of initial distribution type | ||
| x_off: null # <x>, <> denotes average over distribution | ||
| px_off: null # <px> | ||
| y_off: null # <y> | ||
| py_off: null # <py> | ||
| z_off: null # <z> | ||
| pz_off: null # <pz> | ||
| sigma_xx: null # <x^2> | ||
| sigma_pxpx: null # <px^2> | ||
| sigma_yy: null # <y^2> | ||
| sigma_pypy: null # <py^2> | ||
| sigma_zz: null # <z^2> | ||
| sigma_pzpz: null # <pz^2> | ||
| sigma_xpx: null # <xpx> | ||
| sigma_xy: null # <xy> | ||
| sigma_xpy: null # <xpy> | ||
| sigma_xz: null # <xz> | ||
| sigma_xpz: null # <xpz> | ||
| sigma_pxy: null # <pxy> | ||
| sigma_pxpy: null # <pxpy> | ||
| sigma_pxz: null # <pxz> | ||
| sigma_pxpz: null # <pxpz> | ||
| sigma_ypy: null # <ypy> | ||
| sigma_yz: null # <yz> | ||
| sigma_ypz: null # <ypz> | ||
| sigma_pyz: null # <pyz> | ||
| sigma_pypz: null # <pypz> | ||
| sigma_zpz: null # <zpz> | ||
|
Comment on lines
+10
to
+37
Member
There was a problem hiding this comment. How about using numbers for subscripts? EG:
Author
There was a problem hiding this comment. @DavidSagan The reason that I used sigma_pypy instead of sigma_24 is because we have z_off and pz_off defined first. If we use sigma_24, should we change the first 6 centroid definition as off_1, off_2,... or mean_1, mean_2,...? |
||
| ``` | ||
|
|
||
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -5,5 +5,12 @@ | |
| Tracking parameters are highly program specific but it is useful to have a group | ||
| having some standardization. | ||
|
|
||
| The `TrackingP` parameter group contains parameters for describing the particle | ||
| tracking. | ||
| The components of this group are: | ||
| ```{code} yaml | ||
| ReferenceP: | ||
| ... | ||
| ``` | ||
| In Construction... | ||
|
|
||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do we really want to have the assumption that the strong beam is Gaussian. If a program does not make this assumption then what kind of lattice element should it use?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If we don't assume a Gaussian distribution, then we might need more parameters than just sigmas for this element. On the other hand, without Gaussian assumption does allow more flexibility.