Enum PhaseInteraction

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

public enum PhaseInteraction
extends java.lang.Enum<PhaseInteraction>
  • Nested Class Summary

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

    java.lang.Enum.EnumDesc<E extends java.lang.Enum<E>>
  • Enum Constant Summary

    Enum Constants
    Enum Constant Description
    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.
    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".
    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.
    TURN
    Used by addToBranch when the path turns within a segment.
  • Method Summary

    Modifier and Type Method Description
    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.

    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

    • 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.
    • 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 type, in the order they are declared.
      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 name
      java.lang.NullPointerException - if the argument is null