Package xal.tools.beam.optics

Enum Class AcceleratingRfGap.LOC

java.lang.Object

java.lang.Enum<AcceleratingRfGap.LOC>

xal.tools.beam.optics.AcceleratingRfGap.LOC

All Implemented Interfaces:

Serializable, Comparable<AcceleratingRfGap.LOC>, Constable

Enclosing class:

AcceleratingRfGap

public static enum AcceleratingRfGap.LOC
extends Enum<AcceleratingRfGap.LOC>

Enumeration specifying the upstream location or downstream locations for the RF accelerating gap.

Since:

Nov 2, 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
POSTGAP	Constant identifying the post-gap (downstream) location
PREGAP	Constant identifying the pre-gap (upstream) location

Method Summary

Modifier and Type	Method	Description
Complex	dkGapHamiltonian(AcceleratingRfGap gap, double phi, double k)	Compute and return the derivative of the generalized Hamiltonian function dH/dk with respect to particle wave number k for the given accelerating RF gap.
Complex	dphiGapHamiltonian(AcceleratingRfGap gap, double phi, double k)	Compute and return the derivative of the generalized Hamiltonian function dH/dφ with respect to particle phase location φ for the given accelerating RF gap.
Complex	gapHamiltonian(AcceleratingRfGap gap, double phi, double k)	Compute and return the value of the generalized Hamiltonian function H at the given longitudinal phase coordinates for the given accelerating RF gap.
static AcceleratingRfGap.LOC	valueOf(String name)	Returns the enum constant of this class with the specified name.
static AcceleratingRfGap.LOC[]	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

PREGAP

public static final AcceleratingRfGap.LOC PREGAP

Constant identifying the pre-gap (upstream) location

POSTGAP

public static final AcceleratingRfGap.LOC POSTGAP

Constant identifying the post-gap (downstream) location

Method Details

values

public static AcceleratingRfGap.LOC[] 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 AcceleratingRfGap.LOC 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

gapHamiltonian

public Complex gapHamiltonian(AcceleratingRfGap gap,
 double phi,
 double k)

Compute and return the value of the generalized Hamiltonian function H at the given longitudinal phase coordinates for the given accelerating RF gap.

Parameters:

gap - Hamiltonian function for this gap

phi - particle phase location φ (radians)

k - particle wave number k (radians/meter)

Returns:

Hamiltonian function H(φ,k)

Since:

Nov 3, 2015, Christopher K. Allen

See Also:

• AcceleratingRfGap.preGapHamiltonain(double, double)
• AcceleratingRfGap.postGapHamiltonain(double, double)

dphiGapHamiltonian

public Complex dphiGapHamiltonian(AcceleratingRfGap gap,
 double phi,
 double k)

Compute and return the derivative of the generalized Hamiltonian function dH/dφ with respect to particle phase location φ for the given accelerating RF gap.

Parameters:

gap - gap for which the parameters are computed

phi - particle phase location φ (radians)

k - particle wave number k (radians/meter)

Returns:

value of derivative dH(φ,k)/dφ

Since:

Nov 3, 2015, Christopher K. Allen

See Also:

• AcceleratingRfGap.dphiPreGapHamiltonian(double, double)
• AcceleratingRfGap.dphiPostGapHamiltonian(double, double)

dkGapHamiltonian

public Complex dkGapHamiltonian(AcceleratingRfGap gap,
 double phi,
 double k)

Compute and return the derivative of the generalized Hamiltonian function dH/dk with respect to particle wave number k for the given accelerating RF gap.

Parameters:

gap - gap for which the parameters are computed

phi - particle phase location φ (radians)

k - particle wave number k (radians/meter)

Returns:

value of derivative dH(φ,k)/dk

Since:

Nov 3, 2015, Christopher K. Allen

See Also:

• AcceleratingRfGap.dkPreGapHamiltonian(double, double)
• AcceleratingRfGap.dkPostGapHamiltonian(double, double)