xal.model.alg

Enum EnvelopeTrackerBase.EmitGrowthModel

java.lang.Object

java.lang.Enum<EnvelopeTrackerBase.EmitGrowthModel>

xal.model.alg.EnvelopeTrackerBase.EmitGrowthModel

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<EnvelopeTrackerBase.EmitGrowthModel>

Enclosing class:

EnvelopeTrackerBase

public static enum EnvelopeTrackerBase.EmitGrowthModel
extends java.lang.Enum<EnvelopeTrackerBase.EmitGrowthModel>

RF Gap Emittance Growth Models

Enumerations identifying supported emittance growth models for RF accelerating gaps. (Currently this applies primarily to the longitudinal situation.) at the moment.

Since longitudinal emittance growth mechanism is not well documented in the Trace3D manual, it is somewhat unclear how the effect is being modeled. However, it does appear to create a result that tracks the IMPACT simulation better than the CKA method (at least for one case). At this point it is unclear whether there is an error in the analysis of C.K. Allen, or Trace3D is simply more accurate.

VALUES:
Currently there are two supported mechanisms for emittance growth.
Trace3D: use the same mechanism described in the Trace3D manual.
CKAllen: use the mechanism described by C.K. Allen, et. al. (see below).

References
[1] M. Weiss, "Bunching of Intense Proton Beams with Six-Dimensional Matching to the Linac Acceptance", CERN/MPS/LI report 73-2, Geneva, Switzerland (1978).
[2] K.R. Crandall and D.P. Rusthoi, "Trace 3-D Documentation", LANL Report LA-UR-97-887 (1997), Appendix F.
[3] C.K. Allen, H. Sako, M. Ikegami, and G. Shen, "Emittance Growth Due to Phase Spread for Proton Beams in Radio Frequency Accelerating Gaps", (in preperation).

Since:

Feb 23, 2009

Enum Constant Summary

Enum Constants

Enum Constant and Description
GAUSSIAN1D Gaussian distribution in each (uncorrelated) phase plane
GAUSSIAN3D Gaussian distribution in three spatial dimensions
TRACE3D Use exact model of Trace3D
UNIFORM1D Uniform distribution in each (uncorrelated) phase plane
UNIFORM3D Uniform distribution in three spatial dimensions

Method Summary

Modifier and Type	Method and Description
static EnvelopeTrackerBase.EmitGrowthModel	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static EnvelopeTrackerBase.EmitGrowthModel[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

TRACE3D

public static final EnvelopeTrackerBase.EmitGrowthModel TRACE3D

Use exact model of Trace3D

UNIFORM1D

public static final EnvelopeTrackerBase.EmitGrowthModel UNIFORM1D

Uniform distribution in each (uncorrelated) phase plane

GAUSSIAN1D

public static final EnvelopeTrackerBase.EmitGrowthModel GAUSSIAN1D

Gaussian distribution in each (uncorrelated) phase plane

UNIFORM3D

public static final EnvelopeTrackerBase.EmitGrowthModel UNIFORM3D

Uniform distribution in three spatial dimensions

GAUSSIAN3D

public static final EnvelopeTrackerBase.EmitGrowthModel GAUSSIAN3D

Gaussian distribution in three spatial dimensions

Method Detail

values

public static EnvelopeTrackerBase.EmitGrowthModel[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (EnvelopeTrackerBase.EmitGrowthModel c : EnvelopeTrackerBase.EmitGrowthModel.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static EnvelopeTrackerBase.EmitGrowthModel valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null