13.80 POLAR—Sets polarization of a beam if spin-tracking is enabled

Sets polarization of a beam if spin-tracking is enabled
Parallel capable? : yes
GPU capable? : no
Back-tracking capable? : no
Spin-tracking capable? : yes






Parameter NameUnits Type Default

Description






POLARIZATION double 0.0

desired polarization






VX double 0.0

x component of vector for polarization direction






VY double 0.0

y component of vector for polarization direction






VZ double 0.0

z component of vector for polarization direction






MODE STRINGtwostate

mode of spin vector generation (twostate, narrowcone, widecone)






ON_PASS NULLlong 0

If <0, polarization is unchanged; otherwise, pass on which polarization is changed.






GROUP string NULL

Optionally used to assign an element to a group, with a user-defined name. Group names will appear in the parameter output file in the column ElementGroup






This element assigns spin vectors to the particles to provide a specified degree of polarization P in a specified direction ^v = ⃗
V∕V , where ⃗
V = (V X,V Y,V Z). It has no effect if spin_tracking=0 in run_setup.

There are four available modes, controlled by the MODE parameter:

POLYSERIES