org.opensha.sha.faultSurface
Interface RuptureSurface

All Known Subinterfaces:
EvenlyGriddedSurface
All Known Implementing Classes:
AbstractEvenlyGriddedSurface, AbstractEvenlyGriddedSurfaceWithSubsets, ApproxEvenlyGriddedSurface, CompoundSurface, CyberShakeEvenlyGriddedSurface, EvenlyGridCenteredSurface, EvenlyGriddedSurfFromSimpleFaultData, FourPointEvenlyGriddedSurface, FrankelGriddedSurface, GriddedSubsetSurface, GriddedSurfaceImpl, InterpolatedEvenlyGriddedSurface, PointSource13b.PointSurface13b, PointSurface, QuadSurface, SimpleListricGriddedSurface, StirlingGriddedSurface, UCERF2_Final_StirlingGriddedSurface

public interface RuptureSurface

This interface defines a rupture surfaces. This does not specify how a rupture surface is to be represented (in order to maintan flexibility), but rather specifies what information a rupture surface needs to provide (see method descriptions for details).

Author:
field

Method Summary
 double getArea()
          This returns the surface area in km-sq
 double getAveDip()
          Average dip (degrees) of rupture surface
 double getAveDipDirection()
          Average dip direction (degrees) of rupture surface
 double getAveGridSpacing()
          This returns the average grid spacing used to define the discretization used in what's returned by the methods here that contain "Discretized" in their names.
 double getAveLength()
          This returns the average length of the surface in km
 double getAveRupTopDepth()
          Average depth (km) to top of rupture (always a positive number)
 double getAveStrike()
          Average strike (degrees) of rupture surface
 double getAveWidth()
          Average down-dip width (km) of rupture surface
 double getDistanceJB(Location siteLoc)
          This returns distance JB (shortest horz distance in km to surface projection of rupture), assuming the location has zero depth (for numerical expediency).
 double getDistanceRup(Location siteLoc)
          This returns rupture distance (kms to closest point on the rupture surface), assuming the location has zero depth (for numerical expediency).
 double getDistanceSeis(Location siteLoc)
          This returns "distance seis" (shortest distance in km to point on rupture deeper than 3 km), assuming the location has zero depth (for numerical expediency).
 double getDistanceX(Location siteLoc)
          This returns distance X (the shortest distance in km to the rupture upper edge extended to infinity), where values >= 0 are on the hanging wall and values < 0 are on the foot wall.
 LocationList getEvenlyDiscritizedListOfLocsOnSurface()
          This returns a list of locations that are evenly spread (at least approximately) over the rupture surface, with a spacing given by what's returned by the getGridSpacing() method.
 LocationList getEvenlyDiscritizedLowerEdge()
          This returns a list of locations that are evenly spread along the lower edge of the surface.
 LocationList getEvenlyDiscritizedPerimeter()
          This returns a list of locations that are evenly spread (at least approximately) over the surface perimeter, with a spacing given by what's returned by the getGridSpacing() method.
 FaultTrace getEvenlyDiscritizedUpperEdge()
          This returns a list of locations that are evenly spread along the upper edge of the surface.
 Location getFirstLocOnUpperEdge()
          This returns the first location on the upper edge of the surface
 double getFractionOfSurfaceInRegion(Region region)
          The is returns the fraction of this rupture surface that's inside the given region.
 String getInfo()
          This is a string giving brief info about the surface (e.g., used in GUIs)
 Location getLastLocOnUpperEdge()
          This returns the last location on the upper edge of the surface
 ListIterator<Location> getLocationsIterator()
          This returns what's given by getEvenlyDiscritizedListOfLocsOnSurface() as an interator
 double getMinDistance(RuptureSurface surface)
          Calculate the minimum distance of this rupture surface to the given surface
 LocationList getPerimeter()
          Get a list of locations that constitutes the perimeter of the surface (not necessarily evenly spaced)
 FaultTrace getUpperEdge()
          This returns the upper edge of the rupture surface (where the locations are not necessarily equally spaced).
 boolean isPointSurface()
          This indicates whether this is a point surface
 

Method Detail

getAveDip

double getAveDip()
Average dip (degrees) of rupture surface

Returns:

getAveStrike

double getAveStrike()
Average strike (degrees) of rupture surface

Returns:

getAveLength

double getAveLength()
This returns the average length of the surface in km

Returns:
double

getAveWidth

double getAveWidth()
Average down-dip width (km) of rupture surface

Returns:

getArea

double getArea()
This returns the surface area in km-sq

Returns:
double

getEvenlyDiscritizedListOfLocsOnSurface

LocationList getEvenlyDiscritizedListOfLocsOnSurface()
This returns a list of locations that are evenly spread (at least approximately) over the rupture surface, with a spacing given by what's returned by the getGridSpacing() method. Further details are specified by the implementing class. Don't assume the locations are ordered as one reads the words on a page in a book (not the case for CompoundGriddedSurface).

Returns:

getLocationsIterator

ListIterator<Location> getLocationsIterator()
This returns what's given by getEvenlyDiscritizedListOfLocsOnSurface() as an interator

Returns:

getEvenlyDiscritizedPerimeter

LocationList getEvenlyDiscritizedPerimeter()
This returns a list of locations that are evenly spread (at least approximately) over the surface perimeter, with a spacing given by what's returned by the getGridSpacing() method. Further details are specified by the implementing class. These locations should be ordered starting along the top and moving along following the Aki and Richards convention.

Returns:

getEvenlyDiscritizedUpperEdge

FaultTrace getEvenlyDiscritizedUpperEdge()
This returns a list of locations that are evenly spread along the upper edge of the surface. Further details are specified by the implementing class. These locations should be ordered along the fault following the Aki and Richards convention.

Returns:

getEvenlyDiscritizedLowerEdge

LocationList getEvenlyDiscritizedLowerEdge()
This returns a list of locations that are evenly spread along the lower edge of the surface. Further details are specified by the implementing class. These locations should be ordered along the fault following the Aki and Richards convention.

Returns:

getAveGridSpacing

double getAveGridSpacing()
This returns the average grid spacing used to define the discretization used in what's returned by the methods here that contain "Discretized" in their names.

Returns:

getDistanceRup

double getDistanceRup(Location siteLoc)
This returns rupture distance (kms to closest point on the rupture surface), assuming the location has zero depth (for numerical expediency).

Returns:

getDistanceJB

double getDistanceJB(Location siteLoc)
This returns distance JB (shortest horz distance in km to surface projection of rupture), assuming the location has zero depth (for numerical expediency).

Returns:

getDistanceSeis

double getDistanceSeis(Location siteLoc)
This returns "distance seis" (shortest distance in km to point on rupture deeper than 3 km), assuming the location has zero depth (for numerical expediency).

Returns:

getDistanceX

double getDistanceX(Location siteLoc)
This returns distance X (the shortest distance in km to the rupture upper edge extended to infinity), where values >= 0 are on the hanging wall and values < 0 are on the foot wall. The location is assumed to be at zero depth (for numerical expediency).

Returns:

getAveRupTopDepth

double getAveRupTopDepth()
Average depth (km) to top of rupture (always a positive number)

Returns:

getAveDipDirection

double getAveDipDirection()
Average dip direction (degrees) of rupture surface

Returns:

getUpperEdge

FaultTrace getUpperEdge()
This returns the upper edge of the rupture surface (where the locations are not necessarily equally spaced). This may be the original Fault Trace used to define the surface, but not necessarily.

Returns:

getPerimeter

LocationList getPerimeter()
Get a list of locations that constitutes the perimeter of the surface (not necessarily evenly spaced)


getFirstLocOnUpperEdge

Location getFirstLocOnUpperEdge()
This returns the first location on the upper edge of the surface

Returns:

getLastLocOnUpperEdge

Location getLastLocOnUpperEdge()
This returns the last location on the upper edge of the surface

Returns:

getFractionOfSurfaceInRegion

double getFractionOfSurfaceInRegion(Region region)
The is returns the fraction of this rupture surface that's inside the given region.

Parameters:
region -
Returns:

getInfo

String getInfo()
This is a string giving brief info about the surface (e.g., used in GUIs)


isPointSurface

boolean isPointSurface()
This indicates whether this is a point surface

Returns:

getMinDistance

double getMinDistance(RuptureSurface surface)
Calculate the minimum distance of this rupture surface to the given surface

Parameters:
surface - EvenlyGriddedSurface
Returns:
distance in km