10.21 DSCATTER—A scattering element to add random changes to particle coordinates according to a user-supplied distribution function

A scattering element to add random changes to particle coordinates according to a user-supplied distribution function
Parallel capable? : yes
GPU capable? : no
Back-tracking capable? : no






Parameter Name UnitsType Default

Description






PLANE STRINGNULL

Plane to scatter: xp, yp, dp (dp is deltaP/P)






FILENAME STRINGNULL

Name of SDDS file containing distribution function.






VALUENAME STRINGNULL

Name of column containing the independent variable for the distribution function data.






CDFNAME STRINGNULL

Name of column containing the cumulative distribution function data.






PDFNAME STRINGNULL

Name of column containing the probability distribution function data.






ONCEPERPARTICLE long 0

If nonzero, each particle can only get scattered once by this element.






FACTOR double 1

Factor by which to multiply the independent variable values.






PROBABILITY double 1

Probability that any particle will be selected for scattering.






GROUPID long -1

Group ID number (nonnegative integer) for linking once-per-particle behavior of multiple elements.






RANDOMSIGN long 0

If non-zero, then the scatter is given a random sign. Useful if distribution data is one-sided.






LIMITPERPASS long -1

Maximum number of particles that will be scattered on each pass.






LIMITTOTAL long -1

Maximum number of particles that will be scatter for each step.






DSCATTER continued

A scattering element to add random changes to particle coordinates according to a user-supplied distribution function






Parameter NameUnitsType Default

Description






STARTONPASS long 0

Pass number to start on.






ENDONPASS long -1

Pass number to end on (inclusive). Ignored if negative.






GROUP stringNULL

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






ECOL