org.opensha.sha.earthquake.rupForecastImpl.Frankel96
Class Frankel96_GR_EqkSource

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

public class Frankel96_GR_EqkSource
extends ProbEqkSource

Title: Frankel96_GR_EqkSource

Description: frankel 1996 Gutenberg Richter Type B earthquake source

Copyright: Copyright (c) 2002

Company:

Version:
1.0
Author:
Nitin Gupta & Vipin Gupta
See Also:
Serialized Form

Field Summary
 
Fields inherited from class org.opensha.sha.earthquake.ProbEqkSource
isPoissonian, name
 
Constructor Summary
Frankel96_GR_EqkSource(double rake, double bValue, double magLower, double magUpper, double moRate, double delta, double rupOffset, AbstractEvenlyGriddedSurfaceWithSubsets surface, String faultName)
          constructor specifying the values needed for Gutenberg Richter and also for constructing the rupture
 
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.
 String getName()
          get the name of this class
 int getNumRuptures()
          this functions sums up all the ruptures for all magnitudes
 ProbEqkRupture getRupture(int nthRupture)
          This method sets the probability of the different rupture surface for different mag
 AbstractEvenlyGriddedSurface getSourceSurface()
          This gives the entire surface of the source
 void setTimeSpan(double yrs)
          Set the time span in years
 
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

Frankel96_GR_EqkSource

public Frankel96_GR_EqkSource(double rake,
                              double bValue,
                              double magLower,
                              double magUpper,
                              double moRate,
                              double delta,
                              double rupOffset,
                              AbstractEvenlyGriddedSurfaceWithSubsets surface,
                              String faultName)
constructor specifying the values needed for Gutenberg Richter and also for constructing the rupture

Parameters:
rake - : Average rake of the surface
bValue - : b Value in the GR distribution
magLower - : magLower as in GR distribution
magUpper - : magUpper as in GR distribution
moRate - : moment rate of GR distribution (N-m/yr)
delta - : delta as in GR distribution
surface - : Fault Surface
Method Detail

getNumRuptures

public int getNumRuptures()
this functions sums up all the ruptures for all magnitudes

Specified by:
getNumRuptures in interface EqkSource
Specified by:
getNumRuptures in class ProbEqkSource
Returns:
the total num of rutures for all magnitudes

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:

getRupture

public ProbEqkRupture getRupture(int nthRupture)
This method sets the probability of the different rupture surface for different mag

Specified by:
getRupture in interface EqkSource
Specified by:
getRupture in class ProbEqkSource
Parameters:
nthRupture - : it is to find the mag and rate to which that rupture number correspond
Returns:
the object of the ProbEqkRupture class after setting the probability

setTimeSpan

public void setTimeSpan(double yrs)
Set the time span in years

Parameters:
yrs - : timeSpan as specified in Number of years

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 String getName()
get the name of this class

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