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

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

public class Frankel96_CharEqkSource
extends ProbEqkSource

Title: Frankel96CharEqkSource

Description: Frankel 1996 Characteristic type A earthquake sources

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_CharEqkSource(double rake, double mag, double rate, AbstractEvenlyGriddedSurfaceWithSubsets surface, String faultName)
          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.
 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
 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_CharEqkSource

public Frankel96_CharEqkSource(double rake,
                               double mag,
                               double rate,
                               AbstractEvenlyGriddedSurfaceWithSubsets surface,
                               String faultName)
Constructor for this class

Parameters:
rake - : ave rake of the surface
mag - : Magnitude of the earthquake
rate - : Rate (events/yr) at this mag
surface - : Fault Surface
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:

setTimeSpan

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

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

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

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