org.opensha.sha.earthquake.rupForecastImpl.WG02
Class WG02_CharEqkSource

java.lang.Object
  extended by org.opensha.sha.earthquake.ProbEqkSource
      extended by org.opensha.sha.earthquake.rupForecastImpl.WG02.WG02_CharEqkSource
All Implemented Interfaces:
java.io.Serializable, java.lang.Iterable<ProbEqkRupture>, Named, EqkSource

public class WG02_CharEqkSource
extends ProbEqkSource

Title: WG02_CharEqkSource

Description: Working Group 2002 characteristic earthquake source

Copyright: Copyright (c) 2003

Company:

Version:
1.0
Author:
Edward Field
See Also:
Serialized Form

Field Summary
 
Fields inherited from class org.opensha.sha.earthquake.ProbEqkSource
isPoissonian
 
Constructor Summary
WG02_CharEqkSource(double prob, double meanMag, double magSigma, double nSigmaTrunc, double deltaMag, AbstractEvenlyGriddedSurfaceWithSubsets rupSurface, double rupArea, double rupOffset, java.lang.String sourceName, double rake)
          Constructor for this class
 
Method Summary
 LocationList getAllSourceLocs()
          It returns a list of all the locations which make up the surface for this source.
 double getMinDistance(Site site)
          This returns the shortest dist to either end of the fault trace, or to the mid point of the fault trace.
 java.lang.String getName()
          get the name of this class
 int getNumRuptures()
          Get the number of ruptures for this source
 ProbEqkRupture getRupture(int nRupture)
          Get the ith rupture for this source This is a handle(or reference) to existing class variable.
 AbstractEvenlyGriddedSurface getSourceSurface()
          This gives the entire surface of the source
 
Methods inherited from class org.opensha.sha.earthquake.ProbEqkSource
computeApproxTotalProbAbove, computeEquivTotalMomentRate, computeTotalEquivMeanAnnualRate, computeTotalProb, computeTotalProbAbove, computeTotalProbAbove, drawRandomEqkRuptureIndices, drawRandomEqkRuptures, drawSingleRandomEqkRuptureIndex, drawSingleRandomEqkRuptureIndex, getInfo, getRuptureClone, getRuptureList, getRupturesIterator, getSourceMetadata, getTectonicRegionType, isPoissonianSource, isSourcePoissonian, iterator, setInfo, setTectonicRegionType
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

WG02_CharEqkSource

public WG02_CharEqkSource(double prob,
                          double meanMag,
                          double magSigma,
                          double nSigmaTrunc,
                          double deltaMag,
                          AbstractEvenlyGriddedSurfaceWithSubsets rupSurface,
                          double rupArea,
                          double rupOffset,
                          java.lang.String sourceName,
                          double rake)
Constructor for this class

Parameters:
prob: - probability of event
meanMag: - Mean magnitude for the Gaussian Mag. Freq. Dist.
magSigma: - Standared deviation for the Gaussian Mag. Freq. Dist.
nSigmaTrunc: - Number of sigmas where trunction occurs on the Gaussian Dist.
deltaMag: - The discretization interval for the Mag. Freq. Dist.
rupSurface: - The rupture surface
rupArea: - The rupture area (may be smaller than surface due to aseismic slip)
rupOffset: - The offset length for sub-ruptures ("floating" ruptures)
rupName: - The name to assign for this rupture
rake: - The rake for the event
Method Detail

getAllSourceLocs

public LocationList getAllSourceLocs()
It returns a list of all the locations which make up the surface for this source.

Returns:
LocationList - List of all the locations which constitute the surface of this source

getSourceSurface

public AbstractEvenlyGriddedSurface getSourceSurface()
Description copied from interface: EqkSource
This gives the entire surface of the source

Returns:

getNumRuptures

public int getNumRuptures()
Description copied from class: ProbEqkSource
Get the number of ruptures for this source

Specified by:
getNumRuptures in interface EqkSource
Specified by:
getNumRuptures in class ProbEqkSource
Returns:
the total num of rutures for the mag which is 1 for the char type fault

getRupture

public ProbEqkRupture getRupture(int nRupture)
Description copied from class: ProbEqkSource
Get the ith rupture for this source This is a handle(or reference) to existing class variable. If this function is called again, then output from previous function call will not remain valid because of passing by reference It is a secret, fast but dangerous method

Specified by:
getRupture in interface EqkSource
Specified by:
getRupture in class ProbEqkSource
Parameters:
nRupture -
Returns:
the object for the ProbEqkRupture

getMinDistance

public double getMinDistance(Site site)
This returns the shortest dist to either end of the fault trace, or to the mid point of the fault trace.

Specified by:
getMinDistance in class ProbEqkSource
Parameters:
site -
Returns:
minimum distance

getName

public java.lang.String getName()
get the name of this class

Specified by:
getName in interface Named
Overrides:
getName in class ProbEqkSource
Returns: