org.opensha.sha.imr.attenRelImpl
Class BJF_1997_AttenRel

java.lang.Object
  extended by org.opensha.sha.imr.AbstractIMR
      extended by org.opensha.sha.imr.AttenuationRelationship
          extended by org.opensha.sha.imr.attenRelImpl.BJF_1997_AttenRel
All Implemented Interfaces:
Serializable, Comparable<IntensityMeasureRelationship>, Named, ShortNamed, XMLSaveable, IntensityMeasureRelationship, ScalarIMR

public class BJF_1997_AttenRel
extends AttenuationRelationship

Title: BJF_1997_AttenRel

Description: This implements the Attenuation Relationship developed by Boore, Joyner & Fumal (1997, Seismological Research Letters, vol 68, num 1, pp 128-153)

Supported Intensity-Measure Parameters:

Other Independent Parameters:

Version:
1.0
Author:
Steven W. Rock & Edward H. Field
See Also:
Serialized Form

Field Summary
protected  Hashtable coefficients
          Hashtable of coefficients for the supported intensityMeasures
protected static Double DISTANCE_JB_WARN_MAX
           
protected static Double DISTANCE_JB_WARN_MIN
          Joyner-Boore Distance parameter
static String FLT_TYPE_REVERSE
           
static String FLT_TYPE_STRIKE_SLIP
           
static String FLT_TYPE_UNKNOWN
           
protected static Double MAG_WARN_MAX
           
protected static Double MAG_WARN_MIN
           
static String NAME
           
static String SHORT_NAME
           
protected static Double VS30_WARN_MAX
           
protected static Double VS30_WARN_MIN
           
 
Fields inherited from class org.opensha.sha.imr.AttenuationRelationship
aftershockParam, cavParam, componentParam, depthTo1pt0kmPerSecParam, depthTo2pt5kmPerSecParam, dipParam, distanceJBParam, distanceRupParam, distanceSeisParam, distRupMinusDistX_OverRupParam, distRupMinusJB_OverRupParam, ds575Param, ds595Param, ERR, exceedProbIndependentParams, fltTypeParam, focalDepthParam, hangingWallFlagParam, imlAtExceedProbIndependentParams, magParam, meanIndependentParams, pgaParam, pgdParam, pgvParam, rakeParam, rupTopDepthParam, rupWidthParam, saDampingParam, saParam, saPeriodParam, sigmaTruncLevelParam, sigmaTruncTypeParam, stdDevIndependentParams, stdDevTypeParam, tectonicRegionTypeParam, USER_MAX_DISTANCE, VERY_SMALL_MEAN, vs30_TypeParam, vs30Param
 
Fields inherited from class org.opensha.sha.imr.AbstractIMR
eqkRupture, eqkRuptureParams, EXCEED_PROB_DEFAULT, EXCEED_PROB_INFO, EXCEED_PROB_MAX, EXCEED_PROB_MIN, EXCEED_PROB_NAME, exceedProbParam, im, intensityMeasureChanged, listener, otherParams, propagationEffectParams, site, siteParams, supportedIMParams, url_info_string, XML_METADATA_IMT_NAME, XML_METADATA_NAME, XML_METADATA_SITE_PARAMETERS_NAME
 
Fields inherited from interface org.opensha.commons.metadata.XMLSaveable
XML_METADATA_NAME
 
Constructor Summary
BJF_1997_AttenRel(ParameterChangeWarningListener listener)
          No-Arg constructor.
 
Method Summary
 URL getInfoURL()
          This provides a URL where more info on this model can be obtained
 double getMean()
          Calculates the mean of the exceedence probability distribution.
 String getName()
          get the name of this IMR
 String getShortName()
          Returns the Short Name of each AttenuationRelationship
 double getStdDev()
          This returns the standard deviation (stdDev) of the intensity-measure level for the current set of parameters.
protected  void initCoefficients()
          This creates the hashtable of coefficients for the supported intensityMeasures (im).
protected  void initEqkRuptureParams()
          Creates the two Potential Earthquake parameters (magParam and fltTypeParam) and adds them to the eqkRuptureParams list.
protected  void initIndependentParamLists()
          This creates the lists of independent parameters that the various dependent parameters (mean, standard deviation, exceedance probability, and IML at exceedance probability) depend upon.
protected  void initOtherParams()
          Creates other Parameters that the mean or stdDev depends upon, such as the Component or StdDevType parameters.
protected  void initPropagationEffectParams()
          Creates the single Propagation Effect parameter and adds it to the propagationEffectParams list.
protected  void initSiteParams()
          Creates the Vs30 site parameter and adds it to the siteParams list.
protected  void initSupportedIntensityMeasureParams()
          Creates the two supported IM parameters (PGA and SA), as well as the independenParameters of SA (periodParam and dampingParam) and adds them to the supportedIMParams list.
 void setEqkRupture(EqkRupture eqkRupture)
          This sets the eqkRupture related parameters (magParam and fltTypeParam) based on the eqkRupture passed in.
protected  void setFaultTypeFromRake(double rake)
          Determines the style of faulting from the rake angle (which comes from the eqkRupture object) and fills in the value of the fltTypeParam.
 void setParamDefaults()
          This sets the defaults for all the parameters.
protected  void setPropagationEffectParams()
          This calculates the Distance JB propagation effect parameter based on the current site and eqkRupture.
 void setSite(Site site)
          This sets the site-related parameter (vs30Param) based on what is in the Site object passed in (the Site object must have a parameter with the same name as that in vs30Param).
protected  void updateCoefficients()
          This function determines which set of coefficients in the HashMap are to be used given the current intensityMeasure (im) Parameter.
 
Methods inherited from class org.opensha.sha.imr.AttenuationRelationship
getAllParamMetadata, getEpsilon, getEpsilon, getExceedProbabilities, getExceedProbability, getExceedProbability, getExceedProbability, getExceedProbability, getExceedProbIndependentParams, getExceedProbIndependentParamsIterator, getIML_AtExceedProb, getIML_AtExceedProb, getIML_AtExceedProbIndependentParams, getIML_AtExceedProbIndependentParamsIterator, getMeanIndependentParams, getMeanIndependentParamsIterator, getSA_ExceedProbSpectrum, getSA_IML_AtExceedProbSpectrum, getStdDevIndependentParams, getStdDevIndependentParamsIterator, getTotExceedProbability, initParameterEventListeners, isTectonicRegionSupported, isTectonicRegionSupported, resetParameterEventListeners, setIntensityMeasureLevel, setIntensityMeasureLevel, setSiteLocation, setUserMaxDistance
 
Methods inherited from class org.opensha.sha.imr.AbstractIMR
compareTo, fromXMLMetadata, getEqkRupture, getEqkRuptureParams, getEqkRuptureParamsIterator, getIntensityMeasure, getIntensityMeasureLevel, getOtherParams, getOtherParamsIterator, getParameter, getPropagationEffectParams, getPropagationEffectParamsIterator, getSite, getSiteParams, getSiteParamsIterator, getSupportedIntensityMeasures, getSupportedIntensityMeasuresIterator, isIntensityMeasureSupported, isIntensityMeasureSupported, setAll, setExceedProb, setIntensityMeasure, setIntensityMeasure, setWarningListener, toXMLMetadata
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.opensha.sha.imr.IntensityMeasureRelationship
getEqkRupture, getEqkRuptureParams, getEqkRuptureParamsIterator, getIntensityMeasure, getIntensityMeasureLevel, getOtherParams, getOtherParamsIterator, getParameter, getPropagationEffectParams, getPropagationEffectParamsIterator, getSite, getSiteParams, getSiteParamsIterator, getSupportedIntensityMeasures, getSupportedIntensityMeasuresIterator, isIntensityMeasureSupported, isIntensityMeasureSupported, setAll, setExceedProb, setIntensityMeasure, setIntensityMeasure, toXMLMetadata
 
Methods inherited from interface java.lang.Comparable
compareTo
 

Field Detail

NAME

public static final String NAME
See Also:
Constant Field Values

SHORT_NAME

public static final String SHORT_NAME
See Also:
Constant Field Values

FLT_TYPE_UNKNOWN

public static final String FLT_TYPE_UNKNOWN
See Also:
Constant Field Values

FLT_TYPE_STRIKE_SLIP

public static final String FLT_TYPE_STRIKE_SLIP
See Also:
Constant Field Values

FLT_TYPE_REVERSE

public static final String FLT_TYPE_REVERSE
See Also:
Constant Field Values

VS30_WARN_MIN

protected static final Double VS30_WARN_MIN

VS30_WARN_MAX

protected static final Double VS30_WARN_MAX

MAG_WARN_MIN

protected static final Double MAG_WARN_MIN

MAG_WARN_MAX

protected static final Double MAG_WARN_MAX

DISTANCE_JB_WARN_MIN

protected static final Double DISTANCE_JB_WARN_MIN
Joyner-Boore Distance parameter


DISTANCE_JB_WARN_MAX

protected static final Double DISTANCE_JB_WARN_MAX

coefficients

protected Hashtable coefficients
Hashtable of coefficients for the supported intensityMeasures

Constructor Detail

BJF_1997_AttenRel

public BJF_1997_AttenRel(ParameterChangeWarningListener listener)
No-Arg constructor. This initializes several ParameterList objects.

Method Detail

setFaultTypeFromRake

protected void setFaultTypeFromRake(double rake)
                             throws InvalidRangeException
Determines the style of faulting from the rake angle (which comes from the eqkRupture object) and fills in the value of the fltTypeParam. Options are "Reverse" if 150>rake>30, "Strike-Slip" if rake is within 30 degrees of 0 or 180, and "Unkown" otherwise (which means normal-faulting events are assigned as "Unkown"; confirmed by David Boore via email as being correct).

Parameters:
rake - in degrees
Throws:
InvalidRangeException - If not valid rake angle

setEqkRupture

public void setEqkRupture(EqkRupture eqkRupture)
                   throws InvalidRangeException
This sets the eqkRupture related parameters (magParam and fltTypeParam) based on the eqkRupture passed in. The internally held eqkRupture object is also set as that passed in. Warning constrains are ingored.

Specified by:
setEqkRupture in interface IntensityMeasureRelationship
Overrides:
setEqkRupture in class AbstractIMR
Parameters:
eqkRupture - The new eqkRupture value
Throws:
InvalidRangeException - thrown if rake is out of bounds

setSite

public void setSite(Site site)
             throws ParameterException
This sets the site-related parameter (vs30Param) based on what is in the Site object passed in (the Site object must have a parameter with the same name as that in vs30Param). This also sets the internally held Site object as that passed in. WarningExceptions are ingored

Specified by:
setSite in interface IntensityMeasureRelationship
Overrides:
setSite in class AbstractIMR
Parameters:
site - The new site value which contains a Vs30 Parameter
Throws:
ParameterException - Thrown if the Site object doesn't contain a Vs30 parameter

setPropagationEffectParams

protected void setPropagationEffectParams()
This calculates the Distance JB propagation effect parameter based on the current site and eqkRupture.

Specified by:
setPropagationEffectParams in class AttenuationRelationship

updateCoefficients

protected void updateCoefficients()
                           throws ParameterException
This function determines which set of coefficients in the HashMap are to be used given the current intensityMeasure (im) Parameter. The lookup is done keyed on the name of the im, plus the period value if im.getName() == "SA" (seperated by "/"). SWR: I choose the name update instead of set, because set is so common to java bean fields, i.e. getters and setters, that set() usually implies passing in a new value to the java bean field. I prefer update or refresh to functions that change internal values internally

Throws:
ParameterException

getMean

public double getMean()
               throws IMRException
Calculates the mean of the exceedence probability distribution. The exact formula is:

double mean = b1 +
coeff.b2 * ( mag - 6 ) +
coeff.b3 * ( Math.pow( ( mag - 6 ), 2 ) ) +
coeff.b5 * ( Math.log( Math.pow( ( distanceJB * distanceJB + coeff.h * coeff.h ), 0.5 ) ) ) +
coeff.bv * ( Math.log( vs30 / coeff.va ) )

Returns:
The mean value
Throws:
IMRException

getStdDev

public double getStdDev()
                 throws IMRException
Description copied from interface: ScalarIMR
This returns the standard deviation (stdDev) of the intensity-measure level for the current set of parameters.

Returns:
The stdDev value
Throws:
IMRException

setParamDefaults

public void setParamDefaults()
Description copied from interface: IntensityMeasureRelationship
This sets the defaults for all the parameters.


initIndependentParamLists

protected void initIndependentParamLists()
This creates the lists of independent parameters that the various dependent parameters (mean, standard deviation, exceedance probability, and IML at exceedance probability) depend upon. NOTE: these lists do not include anything about the intensity-measure parameters or any of thier internal independentParamaters.


initSiteParams

protected void initSiteParams()
Creates the Vs30 site parameter and adds it to the siteParams list. Makes the parameters noneditable.

Specified by:
initSiteParams in class AttenuationRelationship

initEqkRuptureParams

protected void initEqkRuptureParams()
Creates the two Potential Earthquake parameters (magParam and fltTypeParam) and adds them to the eqkRuptureParams list. Makes the parameters noneditable.

Specified by:
initEqkRuptureParams in class AttenuationRelationship

initPropagationEffectParams

protected void initPropagationEffectParams()
Creates the single Propagation Effect parameter and adds it to the propagationEffectParams list. Makes the parameters noneditable.

Specified by:
initPropagationEffectParams in class AttenuationRelationship

initSupportedIntensityMeasureParams

protected void initSupportedIntensityMeasureParams()
Creates the two supported IM parameters (PGA and SA), as well as the independenParameters of SA (periodParam and dampingParam) and adds them to the supportedIMParams list. Makes the parameters noneditable.

Specified by:
initSupportedIntensityMeasureParams in class AttenuationRelationship

initOtherParams

protected void initOtherParams()
Creates other Parameters that the mean or stdDev depends upon, such as the Component or StdDevType parameters.

Overrides:
initOtherParams in class AttenuationRelationship

getName

public String getName()
get the name of this IMR

Specified by:
getName in interface Named
Specified by:
getName in interface IntensityMeasureRelationship
Overrides:
getName in class AbstractIMR
Returns:
the name of this IMR

getShortName

public String getShortName()
Returns the Short Name of each AttenuationRelationship

Returns:
String

initCoefficients

protected void initCoefficients()
This creates the hashtable of coefficients for the supported intensityMeasures (im). The key is the im parameter name, plus the period value for SA (separated by "/"). For example, the key for SA at 1.0 second period is "SA/1.0".


getInfoURL

public URL getInfoURL()
               throws MalformedURLException
This provides a URL where more info on this model can be obtained

Specified by:
getInfoURL in interface IntensityMeasureRelationship
Overrides:
getInfoURL in class AbstractIMR
Returns:
the URL to the AttenuationRelationship document on the Web.
Throws:
MalformedURLException - if returned URL is not a valid URL.