flags †
Usage: [NO]flag
Turns the flag on. If NO is prepended to flag, the flag is turned off.
Some flags have antonym which works in the opposite way. Flags can be
accessed in the function-syntax with the form "?flag", which returns True (=1)
when the flag is on, or False (=0) otherwise. Some flags can be
accessed by the ON/OFF commands at the MAIN level.
- ABSW
- ABSW or NORELW sets the weights of variable elements independent from
their values in the matching. Otherwise they are weighted relatively.
- BIPOL
- BIPOL or NOUNIPOL allows the change of sign of the value of the
element during the matching. It affects the default keywords of all
elements. This is overridden by MIN, MAX specification or VariableRange of
each element.
- CELL
- CELL or NOINS sets the periodic condition in calculating the
optical-functions.
- CMPLOT
- CMPLOT enables the shift of the center of mass at the begining of
the tracking. This is more or less obsolete.
- COD
- COD turns on finding the closed-orbit in the emittance calculation.
Accessible in MAIN level.
エミッタンス計算時にCODをみつける。
- CODPLOT
- CODPLOT lets the mittance calculation return the information on
the closed-orbit and the beam size around the beam line into the FFS optics
buffer, which can be shown by DISPLAY(DISP) or DRAW commands.
- CONV
- CONV is a flag set by the CALCULATE(CAL) or GO commands. It becomes
True when MatchingResidual is less than CONVERGENCE.
- CONVCASE
- Convert Case (default is ON).
FFSのコマンドラインパース時に、入力文字列をUpper Caseへ変換する.
- CTIME
- CPUタイムの情報を表示する。OFFしておくことを推奨する。(default is ON)
- DAMPONLY
- DAMPONLY is the antonym of FLUC.
- DAPERT
- DAPERT enables the DAPERT procedure in the multi-turn tracking
to obtain the dynamic aperture diagram. Accessible in MAIN level.
- ECHO
- 実行時に台本をダンプする。
- EMIOUT
- EMIOUT turns on the extented output of emittance calculation.
Accessible in MAIN level.
- FFSPRMPT
- When FFSPRMPT is off(default)� the input prompt is In[n]:= , where n
is $Line+1. Otherwise the prompt is the traditinal FFS prompt, showing
the FIT location and the DISP range.
- FIXSEED
- FIXSEED or NOMOVESEED disables the change of the seed of the random
number generator after the particle tracking.
- FLUC
- FLUC or NODAMPONLY enables the diffusion due to synchrotron radiation
in the particle tracking. Otherwise only the damping is enabled when RAD
is ON.
- GAUSS
- GAUSS or NOUNIFORM sets the momentum distribution of the incoming
beam to be Gaussian, otherwise uniform(square) distruibution is assumed.
It affects the beam size calculated by the BEAM command.
- GEOCAL
- When GEOCAL is on(default), the geometry of the beamline is always
updated by CALCULATE(CAL) or GO commands using the current values
of components. The coordinate transformation by SOL is also updated.
When GEOCAL is off, the geometry is never updated. It is useful to
simulate misalignments within a solenoid, etc.
- GEOFIX
- GEOFIX is the antonym of GEOCAL.
- IDEAL
- IDEAL or NOREAL inhibits to use the component-specific deviations
(i.e., machine-errors) in the optics calculation.
- INS
- INS is the antonym of CELL.
- INTRA
- INTRA turns on the calculation of intra-beam scattering in the
emittance calculation. Accessible in MAIN level.
- JITTER
- JITTER or NOQUIET allows jitter of the center-of-mass of the incoming beam
in the case of TRPT. Otherwise the center-of-mass statistically fluctuates
depending on the number of particles.
- LWAKE
- LWAKE turn on optics calculation with Logitudinal WakeFunction
- MOVESEED
- MOVESEED is the antonym of FIXSEED.
- PHOTONS
- When PHOTONS is ON (default is OFF), TrackParticles generates a list of all
photons radiated through the tracking. The list is assigned to a symbol PhotonList.
- PRSVCASE
- Preserve Case (default is OFF).
FFSのコマンドラインパース時に、Element Name/Patternを扱う際に Caseを保存する.
- PSPAC
- When on, performs space-charge simulation in a "strong-strong"
mode. The mesh number and mesh size for each direction are given by "PSPACNX, PSPACNY, PSPACNZ"
and "PSPACDX, PSPACDY, PSPACDZ", respectively.
Do not confuse PSPAC with WSPAC or SPAC.
- QUIET
- QUIET is the antonym of JITEER.
- RAD
- RAD turns on the synchrotron radiation in the particle-tracking.
Accessible in the MAIN level.
- RADCOD
- RADCOD turns on the energy loss due to synchrotron radiation at the
closed-orbit in the emittance calculation. Also turns off the implicit
acceleration in the tracking to compensate the energy loss automatically,
in the case that TRPT is ON. Accessible in MAIN level.
エミッタンス計算時にCOD上のシンクロトロン放射によるエネルギー損失を考慮する。
- RADLIGHT
- When RADLIGHT is on, the function TrackParticles returns a list of
trajectories which are used to calculate the synchrotron radiation field.
- RADTAPER
- RADTAPER is defined to enable "automatic tapering", which scales the strength of all magnets except solenoids along with the local energy deviation of the closed orbit during the tracking and the emittance calculation. To use that, first the 6D closed orbit must be calculated and stored in Twiss["DDP"] by EMIT or Emittance[] with flags
RADCOD; RFSW; CODPLOT; RADTAPER;
Then do tracking with RAD . Please not that since either CALC or GO overwrites Twiss["DDP"] by 4D orbit, so do not do CALC or GO after EMIT.
RADTAPER defaults OFF.
- REAL
- REAL is the antonym of IDEAL.
- RELW
- RELW is the antonym of ABSW.
- RFSW
- RFSW turns on the acceleration by CAVI and TCAVI element in the
particle-tracking and the emittance calculation. Accessible in MAIN level,
but FFS always turns RFSW on at the beginning of the session.
- RING
- RING is the antonym of TRPT.
- SELFCOD
- When on with WSPAC, in tracking, the space charge force is calculated
relative to the center of mass of the current set of particles each time.
Otherwise(default) it is calculated relatice to the colsed orbit given by EMIT.
SELFCOD is useful when the closed orbits given by EMIT and TRACK are different.
- SORG
- When SORG is ON, the origin of path length (LINE["S"]) is set to the component specified by ORG. The default is OFF.
- SPAC
- When SPAC is on, tracking is done with space charge effect.
The actual number of particles in the beam and the number of macro particles
are given by PBUNCH and NP. This calculation assumes a cylindrical symmetry
of the chamber whose radius is given by RADIUS of DRIFT and MULT elements.
If RADIUS is positive, an aperture is also set at RADIUS to make particle
loss. If RADIUS is zero, no space charge calculation is done. If RADIUS is
negative, no space charge effect is taken, but the aperture is set at -RADIUS.
Do not confuse SPAC with WSPAC.
- STABLE
- STABLE is a flag set by the CALCULATE(CAL) or GO commands in the case
of CELL. It becomes True when the closed orbit is found and the optics is
stable in both x and y.
- TRPT
- TRPT or NORING decalres that the beam line is a transport line, not
a part of a storage ring. The nominal momentum be changed in the
bem line due to acceleration. The default momentum distribution becomes
uniform distribution. The default is RING or NOTRPT. TRPT affects
Emittance[] to ignore equilibrium calculation for a transport line.
- TWAKE
- TWAKE turn on optics calculation with Transverse WakeFunction
- UNIFORM
- UNIFORM is the antonym of GAUSS. It assumes the momentum
distribution to be a uniform(square) within +-DP.
- UNIPOL
- UNIPOL is the antonym of BIPOL.
- UNSTABLE
- UNSTABLE is the antonym of STABLE.
- WSPAC
- When on, performs space-charge simulation in a "strong-weak"
mode. The beam size through the beam line is to be calculated by
EMIT with CODPLOT. The space-charge force is calculated assuming Gausian
distribution in all dimensions, and particles/bunch given by PBUNCH.
WSPAC is effective in optics and emittance calculations and tracking.
Do not confuse WSPAC with SPAC.
example in Main Level
ON LOG;
ON RAD FLUC COD RFSW RADCOD;
OFF ECHO CTIME;
example in FFS Level
RAD;
OFF RAD;
![[PukiWiki]](image/pukiwiki.png "[PukiWiki]")
