Package edu.sc.seis.TauP

Enum Class PhaseInteraction

java.lang.Object
java.lang.Enum<PhaseInteraction>
edu.sc.seis.TauP.PhaseInteraction
All Implemented Interfaces:
Serializable, Comparable<PhaseInteraction>, Constable
public enum PhaseInteraction extends Enum<PhaseInteraction>

  • Enum Constant Details

    • START_UP

      public static final PhaseInteraction START_UP

    • START_DOWN

      public static final PhaseInteraction START_DOWN

    • START_FLAT

      public static final PhaseInteraction START_FLAT

    • 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.

    • DIFFRACTTURN

      public static final PhaseInteraction DIFFRACTTURN
      An upward turn after a flat diffracted segment, such as the upward leg of Pdiff. Similar to TURN, but must ray start at bottom of layer.

    • DIFFRACTDOWN

      public static final PhaseInteraction DIFFRACTDOWN
      A downward turn after a flat diffracted segment, such as the K leg of PdiffdnKS

    • HEADTURN

      public static final PhaseInteraction HEADTURN
      An upward turn after a flat head segment, such as the upward leg of Pn. Similar to TRANSUP, as must ray start at top of lower layer.

    • 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 propagates 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 propagates 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 Details

    • values

      public static PhaseInteraction[] 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 PhaseInteraction 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

    • isUpgoingActionBefore

      public static boolean isUpgoingActionBefore(PhaseInteraction endAction)

    • isDowngoingActionBefore

      public static boolean isDowngoingActionBefore(PhaseInteraction endAction)

    • isUpgoingActionAfter

      public static boolean isUpgoingActionAfter(PhaseInteraction endAction)

    • layerPropogationTypeAfter

      public static LayerPropogationType layerPropogationTypeAfter(PhaseInteraction endAction)

    • isDowngoingActionAfter

      public static boolean isDowngoingActionAfter(PhaseInteraction endAction)

    • endOffset

      public static int endOffset(PhaseInteraction endAction)