org.opensha.sha.imr.attenRelImpl
Class ShakeMap_2003_AttenRel

java.lang.Object
  org.opensha.sha.imr.AbstractIMR
      org.opensha.sha.imr.AttenuationRelationship
          org.opensha.sha.imr.attenRelImpl.ShakeMap_2003_AttenRel

All Implemented Interfaces:

Serializable, Comparable<IntensityMeasureRelationship>, Named, XMLSaveable, IntensityMeasureRelationship, ScalarIMR

public class ShakeMap_2003_AttenRel
extends AttenuationRelationship

Title: ShakeMap_2003_AttenRel

Description: This implements the Attenuation Relationship used by the ShakeMap group (2003), which is a hybrid of BJF (1997) and the low- magnitude regression developed by Vincent Quitoriano (where the former is used above mag=5.5, the latter is used below 5.0 and a linear-ramp average is used in between). However, rather than using Vs30 as the site paremeter, this uses the Wills et al. (2000, Bull. Seism. Soc. Am., 90, S187-S208) classification scheme and the nonlinear amplification factors of Borcherdt (1994, Earthquake Spectra, 10, 617-654). There is very little written documentation of this relationship, and what exists is full of typos and outdated information. This class was composed by Ned Field based on numerous queries to David Wald, Vincent Quitoriano, and Bruce Worden.

Supported Intensity-Measure Parameters:

• pgaParam - Peak Ground Acceleration
• SAParam - Spectral Acceleration at 0.0, 0.3, 1.0, and 3.0 second periods
• pgvParam - Peak Ground Velocity (computed from 1-sec SA using the Newmark-Hall (1982) scalar)
• mmiParam - Modified Mercalli Intensity computed from PGA and PGV as in Wald et al. (1999, Earthquake Spectra)

Other Independent Parameters:

• magParam - moment Magnitude
• distanceJBParam - closest distance to surface projection of fault
• willsSiteParam - The site classes used in the Wills et al. (2000) map
• fltTypeParam - Style of faulting
• componentParam - Component of shaking (only one)
• stdDevTypeParam - The type of standard deviation

Important Notes:

Because for the low-magnitude regression the different sigma estimates were available only for PGA (only total sigma was available for PGV and SA), the different sigmas represent those of PGA scaled by the relative difference of the totals. Again, this only applies at low maginitudes, and the approximated values should be very close to the true values.

This class supports a "Greater of Two Horz." component by multiplying the average horizontal component median by a factor of 1.15. This value was taken directly from the official ShakeMap documentation. The standard deviation for this component is set the same as the average horizontal (not sure if this is correct).

Regarding the Modified Mercalli Intensity (MMI) IMT, note that what is returned by the getMean() method is the natural-log of MMI. Although this is not technically correct (since MMI is not log-normally distributed), it was the easiest way to implement it for now. Furthermore, because the probability distribution of MMI (computed from PGA or PGV) is presently unknown, we cannot compute the standard deviation, probability of exceedance, or the IML at any probability other than 0.5. Therefore, a RuntimeException is thrown if one tries any of these when the chosen IMT is MMI. We can relax this when someone comes up with the probability distribution (which can't be Gaussian because MMI values below 1 and above 10 are not allowed).

Version:

1.0

Author:

Edward H. Field

See Also:

Serialized Form

Field Summary

protected Hashtable	coefficientsBJF Hashtable of coefficients for the supported intensityMeasures
protected Hashtable	coefficientsSM
protected static Double	DISTANCE_JB_WARN_MAX
protected static Double	DISTANCE_JB_WARN_MIN
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
protected MMI_Param	mmiParam MMI parameter, the natural log of the "Modified Mercalli Intensity" IMT.
static String	NAME
static String	SHORT_NAME
static String	WILLS_SITE_B
static String	WILLS_SITE_BC
static String	WILLS_SITE_C
static String	WILLS_SITE_CD
static String	WILLS_SITE_D
static String	WILLS_SITE_DE
static String	WILLS_SITE_DEFAULT
static String	WILLS_SITE_E
static String	WILLS_SITE_INFO
static String	WILLS_SITE_NAME

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

ShakeMap_2003_AttenRel(ParameterChangeWarningListener listener)
No-Arg constructor.

Method Summary

double	getIML_AtExceedProb() This overides the parent to take care if MMI is the chosen IMT.
URL	getInfoURL() This provides a URL where more info on this model can be obtained
double	getMean() Note that for MMI this returns the natural log of MMI (this should be changed later)
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 willsSiteParam 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.
static void	main(String[] args)
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 (willsSiteParam) based on what is in the Site object passed in (the Site object must have a parameter with the same name as that in willsSiteParam).
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, getExceedProbIndependentParams, getExceedProbIndependentParamsIterator, 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

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

DISTANCE_JB_WARN_MAX

protected static final Double DISTANCE_JB_WARN_MAX

WILLS_SITE_NAME

public static final String WILLS_SITE_NAME

See Also:

Constant Field Values

WILLS_SITE_INFO

public static final String WILLS_SITE_INFO

See Also:

Constant Field Values

WILLS_SITE_B

public static final String WILLS_SITE_B

See Also:

Constant Field Values

WILLS_SITE_BC

public static final String WILLS_SITE_BC

See Also:

Constant Field Values

WILLS_SITE_C

public static final String WILLS_SITE_C

See Also:

Constant Field Values

WILLS_SITE_CD

public static final String WILLS_SITE_CD

See Also:

Constant Field Values

WILLS_SITE_D

public static final String WILLS_SITE_D

See Also:

Constant Field Values

WILLS_SITE_DE

public static final String WILLS_SITE_DE

See Also:

Constant Field Values

WILLS_SITE_E

public static final String WILLS_SITE_E

See Also:

Constant Field Values

WILLS_SITE_DEFAULT

public static final String WILLS_SITE_DEFAULT

See Also:

Constant Field Values

mmiParam

protected MMI_Param mmiParam

MMI parameter, the natural log of the "Modified Mercalli Intensity" IMT.

coefficientsBJF

protected Hashtable coefficientsBJF

Hashtable of coefficients for the supported intensityMeasures

coefficientsSM

protected Hashtable coefficientsSM

Constructor Detail

ShakeMap_2003_AttenRel

public ShakeMap_2003_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 (willsSiteParam) based on what is in the Site object passed in (the Site object must have a parameter with the same name as that in willsSiteParam). This also sets the internally held Site object as that passed in.

Specified by:

setSite in interface IntensityMeasureRelationship

Overrides:

setSite in class AbstractIMR

Parameters:

site - The new site value which contains a Wills site Param.

Throws:

ParameterException - Thrown if the Site object doesn't contain a Wills site 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

Note that for MMI this returns the natural log of MMI (this should be changed later)

Returns:

Throws:

IMRException

getIML_AtExceedProb

public double getIML_AtExceedProb()
                           throws ParameterException

This overides the parent to take care if MMI is the chosen IMT.

Specified by:

getIML_AtExceedProb in interface ScalarIMR

Overrides:

getIML_AtExceedProb in class AttenuationRelationship

Returns:

The intensity-measure level

Throws:

ParameterException - Description of the Exception

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 willsSiteParam 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".

main

public static void main(String[] args)

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.