Package edu.sc.seis.TauP
Enum PhaseInteraction
- java.lang.Object
-
- java.lang.Enum<PhaseInteraction>
-
- edu.sc.seis.TauP.PhaseInteraction
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable<PhaseInteraction>
public enum PhaseInteraction extends java.lang.Enum<PhaseInteraction>
-
-
Enum Constant Summary
Enum Constants Enum Constant Description BACKSCATTER
indicates end of the inbound phase to a scatterer.BACKSCATTER_DOWN
indicates end of the inbound phase to a scatterer, where last segment is downgoing.DIFFRACT
Used by addToBranch when the path diffracts along a boundary.END
Used by addToBranch for the last segment of a phase.END_DOWN
Used by addToBranch for the last segment of a phase ending downgoing, like Ped to receiver at depth.FAIL
HEAD
Used by addToBranch when the path is head wave along a boundary.KMPS
Used by addToBranch when the path is surface wave, so just a velocity.REFLECT_TOPSIDE
Used by addToBranch when the path reflects off the bottom of the end of a segment, ie v.REFLECT_TOPSIDE_CRITICAL
Used by addToBranch when the path critically reflects off the bottom of the end of a segment, ie "V".REFLECT_UNDERSIDE
Used by addToBranch when the path reflects off the top of the end of a segment, ie ^.REFLECT_UNDERSIDE_CRITICAL
Used by addToBranch when the path critically reflects off the top of the end of a segment, ie "^x".SCATTER
indicates end of the inbound phase to a scatterer.SCATTER_DOWN
indicates end of the inbound phase to a scatterer, where last segment is downgoing.START
TRANSDOWN
Used by addToBranch when the path transmits down through the end of a segment.TRANSUP
Used by addToBranch when the path transmits up through the end of a segment.TRANSUPDIFFRACT
Used by addToBranch when the path transmits up across a boundary then diffracts along that boundary.TURN
Used by addToBranch when the path turns within a segment.
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static int
endOffset(PhaseInteraction endAction)
static boolean
isDowngoingActionAfter(PhaseInteraction endAction)
static boolean
isDowngoingActionBefore(PhaseInteraction endAction)
static PhaseInteraction
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.static PhaseInteraction[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
START
public static final PhaseInteraction START
-
TURN
public static final PhaseInteraction TURN
Used by addToBranch when the path turns within a segment. We assume that no ray will turn downward so turning implies turning from downward to upward, ie U.
-
REFLECT_UNDERSIDE
public static final PhaseInteraction REFLECT_UNDERSIDE
Used by addToBranch when the path reflects off the top of the end of a segment, ie ^.
-
REFLECT_TOPSIDE
public static final PhaseInteraction REFLECT_TOPSIDE
Used by addToBranch when the path reflects off the bottom of the end of a segment, ie v.
-
TRANSUP
public static final PhaseInteraction TRANSUP
Used by addToBranch when the path transmits up through the end of a segment.
-
TRANSDOWN
public static final PhaseInteraction TRANSDOWN
Used by addToBranch when the path transmits down through the end of a segment.
-
DIFFRACT
public static final PhaseInteraction DIFFRACT
Used by addToBranch when the path diffracts along a boundary.
-
TRANSUPDIFFRACT
public static final PhaseInteraction TRANSUPDIFFRACT
Used by addToBranch when the path transmits up across a boundary then diffracts along that boundary.
-
HEAD
public static final PhaseInteraction HEAD
Used by addToBranch when the path is head wave along a boundary.
-
KMPS
public static final PhaseInteraction KMPS
Used by addToBranch when the path is surface wave, so just a velocity.
-
SCATTER
public static final PhaseInteraction SCATTER
indicates end of the inbound phase to a scatterer. The ray continues on after scattering in the forward sense, so if inbound clockwise, continues clockwise.
-
SCATTER_DOWN
public static final PhaseInteraction SCATTER_DOWN
indicates end of the inbound phase to a scatterer, where last segment is downgoing. The ray continues on after scattering in the forward sense, so if inbound clockwise, continues clockwise.
-
BACKSCATTER
public static final PhaseInteraction BACKSCATTER
indicates end of the inbound phase to a scatterer. The ray continues on after scattering in the backward sense, so if inbound clockwise, it reverses and propigates counterclockwise.
-
BACKSCATTER_DOWN
public static final PhaseInteraction BACKSCATTER_DOWN
indicates end of the inbound phase to a scatterer, where last segment is downgoing. The ray continues on after scattering in the backward sense, so if inbound clockwise, it reverses and propigates counterclockwise.
-
END
public static final PhaseInteraction END
Used by addToBranch for the last segment of a phase.
-
END_DOWN
public static final PhaseInteraction END_DOWN
Used by addToBranch for the last segment of a phase ending downgoing, like Ped to receiver at depth.
-
REFLECT_UNDERSIDE_CRITICAL
public static final PhaseInteraction REFLECT_UNDERSIDE_CRITICAL
Used by addToBranch when the path critically reflects off the top of the end of a segment, ie "^x". Note this is disabled as it is hard to create a model where this phase interaction is physically possible, delay implement this feature for now.
-
REFLECT_TOPSIDE_CRITICAL
public static final PhaseInteraction REFLECT_TOPSIDE_CRITICAL
Used by addToBranch when the path critically reflects off the bottom of the end of a segment, ie "V".
-
FAIL
public static final PhaseInteraction FAIL
-
-
Method Detail
-
values
public static PhaseInteraction[] 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 (PhaseInteraction c : PhaseInteraction.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static PhaseInteraction 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 namejava.lang.NullPointerException
- if the argument is null
-
isDowngoingActionBefore
public static boolean isDowngoingActionBefore(PhaseInteraction endAction)
-
isDowngoingActionAfter
public static boolean isDowngoingActionAfter(PhaseInteraction endAction)
-
endOffset
public static int endOffset(PhaseInteraction endAction)
-
-