Package xal.model.elem

Enum Class SpectrumMapRfGap.PHASECALC

java.lang.Object

java.lang.Enum<SpectrumMapRfGap.PHASECALC>

xal.model.elem.SpectrumMapRfGap.PHASECALC

All Implemented Interfaces:

Serializable, Comparable<SpectrumMapRfGap.PHASECALC>, Constable

Enclosing class:

SpectrumMapRfGap

public static enum SpectrumMapRfGap.PHASECALC
extends Enum<SpectrumMapRfGap.PHASECALC>

Enumeration specifying the method of phase and energy gain calculation. The gap may be switched between the given simulation modes to achieve differing objectives. Specially we can simulate a "perfect" gap in order to facilitate design calculations, or simulate various degrees of deviation from design parameters to observe operating effects.

Since:

Feb 5, 2015

Author:

Christopher K. Allen

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
DESIGN	Design Phase: Use gap design phase and design transit time factor to compute energy.
DYNENERGY	Dynamic Energy: Use dynamic phase plus iterative algorithm for energy including both S(β) and T(β) transit time factors accounting for gap offset.
DYNPHASE	Dynamic Phase: Use probe phase with cavity spatial fields (i.e., mode structure) and gap offset for phase, design transit time factor T(β) for energy calculation.

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

DESIGN

public static final SpectrumMapRfGap.PHASECALC DESIGN

Design Phase: Use gap design phase and design transit time factor to compute energy.

DYNPHASE

public static final SpectrumMapRfGap.PHASECALC DYNPHASE

Dynamic Phase: Use probe phase with cavity spatial fields (i.e., mode structure) and gap offset for phase, design transit time factor T(β) for energy calculation.

DYNENERGY

public static final SpectrumMapRfGap.PHASECALC DYNENERGY

Dynamic Energy: Use dynamic phase plus iterative algorithm for energy including both S(β) and T(β) transit time factors accounting for gap offset.

Method Details

values

public static SpectrumMapRfGap.PHASECALC[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static SpectrumMapRfGap.PHASECALC valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null