edu.sc.seis.TauP
Class SlownessModel

java.lang.Object
  |
  +--edu.sc.seis.TauP.SlownessModel
All Implemented Interfaces:
java.lang.Cloneable, java.io.Serializable
Direct Known Subclasses:
SphericalSModel

public abstract class SlownessModel
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable

This class provides storage and methods for generating slowness-depth pairs.

See Also:
Serialized Form

Field Summary
 boolean DEBUG
          True to enable debugging output.
static boolean PWAVE
          Just useful for calling methods that need to know whether to use P or S waves.
static boolean SWAVE
          Just useful for calling methods that need to know whether to use P or S waves.
 boolean verbose
          True to enable verbose output.
 
Constructor Summary
SlownessModel()
           
 
Method Summary
 TimeDist approxDistance(int slownessTurnLayer, double p, boolean isPWave)
          generate approximate distance, in radians, for a ray from a surface source that turns at the bottom of the given slowness layer.
 java.lang.Object clone()
           
 void createSample(VelocityModel velModel)
          This method takes a velocity model and creates a vector containing slowness-depth layers that, hopefully, adequately sample both slowness and depth so that the travel time as a function of distance can be reconstructed from the theta function.
 boolean depthInFluid(double depth)
          Determines if the given depth is contained within a fluid zone.
 boolean depthInFluid(double depth, DepthRange fluidZoneDepth)
          Determines if the given depth is contained within a fluid zone.
 boolean depthInHighSlowness(double depth, double rayParam, boolean isPWave)
          Determines if the given depth and corresponding slowness is contained within a high slowness zone.
 boolean depthInHighSlowness(double depth, double rayParam, DepthRange highSZoneDepth, boolean isPWave)
          Determines if the given depth and corresponding slowness is contained within a high slowness zone.
 double findDepth(double rayParam, boolean isPWave)
          Finds a depth corresponding to a slowness over the whole VelocityModel.
 double findDepth(double rayParam, double topDepth, double botDepth, boolean isPWave)
          Finds a depth corresponding to a slowness between two given depths in the Velocity Model.
 double findDepth(double p, int topCriticalLayer, int botCriticalLayer, boolean isPWave)
          Finds a depth corresponding to a slowness between two given velocity layers, including the top and the bottom.
 CriticalDepth getCriticalDepth(int i)
           
 DepthRange[] getHighSlowness(boolean isPWave)
           
 double getMaxDeltaP()
           
 double getMaxDepthInterval()
           
 double getMaxInterpError()
          gets the maximum value of the estimated error due to linear interpolation.
 double getMaxRangeInterval()
           
 double getMinDeltaP()
           
 double getMinRayParam(double depth, boolean isPWave)
           
 double getMinTurnRayParam(double depth, boolean isPWave)
           
 int getNumCriticalDepths()
           
 int getNumLayers(boolean isPWave)
           
 double getRadiusOfEarth()
           
 SlownessLayer getSlownessLayerClone(int layerNum, boolean isPWave)
           
 double getSlownessTolerance()
           
abstract  double interpolate(double p, double topVelocity, double topDepth, double slope)
           
 boolean isAllowInnerCoreS()
           
 int layerNumberAbove(double depth, boolean isPWave)
          Finds the index of the slowness layer that contains the given depth Note that if the depth is a layer boundary, it returns the shallower of the two or possibly more (since total reflections are zero thickness layers) layers.
 int layerNumberBelow(double depth, boolean isPWave)
          Finds the index of the slowness layer that contains the given depth Note that if the depth is a layer boundary, it returns the deeper of the two or possibly more (since total reflections are zero thickness layers) layers.
abstract  TimeDist layerTimeDist(double rayParam, int layerNum, boolean isPWave)
           
 void setAllowInnerCoreS(boolean allowInnerCoreS)
           
 void setMaxDeltaP(double maxDeltaP)
           
 void setMaxDepthInterval(double maxDepthInterval)
           
 void setMaxInterpError(double maxInterpError)
          sets the maximum value of the estimated error due to linear interpolation.
 void setMaxRangeInterval(double maxRangeInterval)
          sets the maximum range interval for surface focus turning waves between slowness samples, input in degrees.
 void setMinDeltaP(double minDeltaP)
           
 void setRadiusOfEarth(double radiusOfEarth)
           
 void setSlownessTolerance(double slownessTolerance)
           
 SplitLayerInfo splitLayer(double depth, boolean isPWave)
           
abstract  double toSlowness(double velocity, double depth)
           
abstract  SlownessLayer toSlownessLayer(VelocityLayer vLayer, boolean isPWave)
           
 java.lang.String toString()
           
abstract  double toVelocity(double slowness, double depth)
           
 boolean validate()
          Performs consistency check on the slowness model.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

DEBUG

public transient boolean DEBUG
True to enable debugging output.

verbose

public transient boolean verbose
True to enable verbose output.

PWAVE

public static final boolean PWAVE
Just useful for calling methods that need to know whether to use P or S waves.

SWAVE

public static final boolean SWAVE
Just useful for calling methods that need to know whether to use P or S waves.
Constructor Detail

SlownessModel

public SlownessModel()
Method Detail

setRadiusOfEarth

public void setRadiusOfEarth(double radiusOfEarth)

setMinDeltaP

public void setMinDeltaP(double minDeltaP)

setMaxDeltaP

public void setMaxDeltaP(double maxDeltaP)

setMaxDepthInterval

public void setMaxDepthInterval(double maxDepthInterval)

setMaxRangeInterval

public void setMaxRangeInterval(double maxRangeInterval)
sets the maximum range interval for surface focus turning waves between slowness samples, input in degrees.

setMaxInterpError

public void setMaxInterpError(double maxInterpError)
sets the maximum value of the estimated error due to linear interpolation. Care should be taken not to set this too small as a very large number of samples may be required. Note also that this is only an estimate of the error, and thus the bound is by no means assured.

setAllowInnerCoreS

public void setAllowInnerCoreS(boolean allowInnerCoreS)

setSlownessTolerance

public void setSlownessTolerance(double slownessTolerance)

getRadiusOfEarth

public final double getRadiusOfEarth()

getMinDeltaP

public final double getMinDeltaP()

getMaxDeltaP

public final double getMaxDeltaP()

getMaxDepthInterval

public final double getMaxDepthInterval()

getMaxRangeInterval

public final double getMaxRangeInterval()

getMaxInterpError

public final double getMaxInterpError()
gets the maximum value of the estimated error due to linear interpolation. Care should be taken not to set this too small as a very large number of samples may be required. Note also that this is only an estimate of the error, and thus the bound is by no means assured.

isAllowInnerCoreS

public final boolean isAllowInnerCoreS()

getSlownessTolerance

public final double getSlownessTolerance()

getNumCriticalDepths

public final int getNumCriticalDepths()

getCriticalDepth

public final CriticalDepth getCriticalDepth(int i)

getNumLayers

public final int getNumLayers(boolean isPWave)

getMinTurnRayParam

public double getMinTurnRayParam(double depth,
                                 boolean isPWave)
                          throws NoSuchLayerException,
                                 SlownessModelException

getMinRayParam

public double getMinRayParam(double depth,
                             boolean isPWave)
                      throws NoSuchLayerException,
                             SlownessModelException

getHighSlowness

public DepthRange[] getHighSlowness(boolean isPWave)

getSlownessLayerClone

public SlownessLayer getSlownessLayerClone(int layerNum,
                                           boolean isPWave)

toSlowness

public abstract double toSlowness(double velocity,
                                  double depth)
                           throws SlownessModelException

toVelocity

public abstract double toVelocity(double slowness,
                                  double depth)
                           throws SlownessModelException

layerTimeDist

public abstract TimeDist layerTimeDist(double rayParam,
                                       int layerNum,
                                       boolean isPWave)
                                throws SlownessModelException

toSlownessLayer

public abstract SlownessLayer toSlownessLayer(VelocityLayer vLayer,
                                              boolean isPWave)
                                       throws SlownessModelException

interpolate

public abstract double interpolate(double p,
                                   double topVelocity,
                                   double topDepth,
                                   double slope)
                            throws SlownessModelException

approxDistance

public TimeDist approxDistance(int slownessTurnLayer,
                               double p,
                               boolean isPWave)
                        throws NoSuchLayerException,
                               SlownessModelException
generate approximate distance, in radians, for a ray from a surface source that turns at the bottom of the given slowness layer.
Throws:
NoSuchLayerException - occurs if no layer in the velocity model contains the given depth.
SlownessModelException - occurs if getNumLayers() == 0 as we cannot compute a distance without a layer.

depthInHighSlowness

public boolean depthInHighSlowness(double depth,
                                   double rayParam,
                                   boolean isPWave)
Determines if the given depth and corresponding slowness is contained within a high slowness zone. Whether the high slowness zone includes its upper boundary and its lower boundaries depends upon the ray parameter. The slowness at the depth is needed because if depth happens to correspond to a discontinuity that marks the bottom of the high slowness zone but the ray is actually a total reflection then it is not part of the high slowness zone. Calls depthInHighSlowness(double, double, DepthRange).
See Also:
depthInHighSlowness.

depthInHighSlowness

public boolean depthInHighSlowness(double depth,
                                   double rayParam,
                                   DepthRange highSZoneDepth,
                                   boolean isPWave)
Determines if the given depth and corresponding slowness is contained within a high slowness zone. Whether the high slowness zone includes its upper boundary and its lower boundaries depends upon the ray parameter. The slowness at the depth is needed because if depth happens to correspond to a discontinuity that marks the bottom of the high slowness zone but the ray is actually a total reflection then it is not part of the high slowness zone. The ray parameter that delimits the zone, ie it can turn at the top and the bottom, is in the zone at the top, but out of the zone at the bottom.

depthInFluid

public boolean depthInFluid(double depth)
Determines if the given depth is contained within a fluid zone. The fluid zone includes its upper boundary but not its lower boundary. Calls depthInFluid(double, DepthRange).
See Also:
depthInFluid(double, DepthRange).

depthInFluid

public boolean depthInFluid(double depth,
                            DepthRange fluidZoneDepth)
Determines if the given depth is contained within a fluid zone. The fluid zone includes its upper boundary but not its lower boundary. The top and bottom of the fluid zone are returned in DepthRange.

splitLayer

public SplitLayerInfo splitLayer(double depth,
                                 boolean isPWave)
                          throws SlownessModelException,
                                 NoSuchLayerException

findDepth

public double findDepth(double rayParam,
                        boolean isPWave)
                 throws SlownessModelException
Finds a depth corresponding to a slowness over the whole VelocityModel. Calls findDepth(double, int, int, char).

findDepth

public double findDepth(double rayParam,
                        double topDepth,
                        double botDepth,
                        boolean isPWave)
                 throws SlownessModelException
Finds a depth corresponding to a slowness between two given depths in the Velocity Model. Calls findDepth(double, int, int, char).

findDepth

public double findDepth(double p,
                        int topCriticalLayer,
                        int botCriticalLayer,
                        boolean isPWave)
                 throws SlownessModelException
Finds a depth corresponding to a slowness between two given velocity layers, including the top and the bottom. We also check to see if the slowness is less than the bottom slowness of these layers but greater than the top slowness of the next deeper layer. This corresponds to a total reflection. In this case a check needs to be made to see if this is an S wave reflecting off of a fluid layer, use P velocity below in this case. We assume that slowness is monotonic within these layers and therefore there is only one depth with the given slowness. This means we return the first depth that we find.
Throws:
SlownessModelException - occurs if topCriticalLayer > botCriticalLayer because there are no layers to search, or if there is an increase in slowness, ie a negative velocity gradient, that just balances the decrease in slowness due to the spherical earth, or if the ray parameter p is not contained within the specified layer range.

createSample

public void createSample(VelocityModel velModel)
                  throws SlownessModelException,
                         NoSuchMatPropException,
                         NoSuchLayerException
This method takes a velocity model and creates a vector containing slowness-depth layers that, hopefully, adequately sample both slowness and depth so that the travel time as a function of distance can be reconstructed from the theta function. It catches NoSuchLayerException which might be generated in the velocity model. This shouldn't happen though.
Throws:
SlownessModelException - occurs if the validation on the velocity model fails, or if the velocity model has no layers.
NoSuchMatPropException - occurs if wavetype is not recognized.
See Also:
VelocityModel

layerNumberAbove

public int layerNumberAbove(double depth,
                            boolean isPWave)
                     throws NoSuchLayerException
Finds the index of the slowness layer that contains the given depth Note that if the depth is a layer boundary, it returns the shallower of the two or possibly more (since total reflections are zero thickness layers) layers.
Returns:
the layer number.
Throws:
NoSuchLayerException - occurs if no layer in the slowness model contains the given depth.

layerNumberBelow

public int layerNumberBelow(double depth,
                            boolean isPWave)
                     throws NoSuchLayerException
Finds the index of the slowness layer that contains the given depth Note that if the depth is a layer boundary, it returns the deeper of the two or possibly more (since total reflections are zero thickness layers) layers.
Returns:
the layer number.
Throws:
NoSuchLayerException - occurs if no layer in the slowness model contains the given depth.

validate

public boolean validate()
                 throws SlownessModelException
Performs consistency check on the slowness model.
Returns:
true if successful, throws SlownessModelException otherwise.
Throws:
SlownessModelException - if any check fails

clone

public java.lang.Object clone()

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object