org.opensha.sha.imr.attenRelImpl
Class Abrahamson_2000_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.Abrahamson_2000_AttenRel
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<IntensityMeasureRelationship>, Named, ShortNamed, XMLSaveable, IntensityMeasureRelationship, ScalarIMR

public class Abrahamson_2000_AttenRel
extends AttenuationRelationship

Title: Abrahamson_2000_AttenRel

Description: This implements the Attenuation Relationship developed by Abrahamson (2000, Proc. of 6th Int. Conf. on Seismic Zonation, Palm Springs, Earthq. Eng. Res. Inst.). NOTE: This is only for strike-slip earthquakes (even though Somerville et al. (1997) handles all types), and is implemented only for the average horizontal component. One can easily add fault normal and fault parallel components too, but the specs would have to be obtained from Norm (the necessary info is not contained in the paper). SA periods down to 0 are included even though the directivity effects are zero below 0.6 sec (PGA is not an option for this reason).

Supported Intensity-Measure Parameters:

Other Independent Parameters:

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

Field Summary
protected static java.lang.Double DISTANCE_RUP_WARN_MAX
           
protected static java.lang.Double DISTANCE_RUP_WARN_MIN
           
static java.lang.String FLT_TYPE_SS
           
protected  java.util.Hashtable horzCoeffs
          Hashtable of coefficients for the supported intensityMeasures
protected static java.lang.Double MAG_WARN_MAX
           
protected static java.lang.Double MAG_WARN_MIN
           
static java.lang.String NAME
           
static java.lang.String SHORT_NAME
           
static java.lang.String SITE_TYPE_DEFAULT
           
static java.lang.String SITE_TYPE_INFO
           
static java.lang.String SITE_TYPE_NAME
           
static java.lang.String SITE_TYPE_ROCK
           
static java.lang.String SITE_TYPE_SOIL
           
protected static java.lang.Double THETA_DEFAULT
           
static java.lang.String THETA_INFO
           
protected static java.lang.Double THETA_MAX
           
protected static java.lang.Double THETA_MIN
           
static java.lang.String THETA_NAME
           
static java.lang.String THETA_UNITS
           
protected  DoubleParameter thetaDirParam
          theta directivity parameter.
protected static java.lang.Double X_DEFAULT
           
static java.lang.String X_INFO
           
protected static java.lang.Double X_MAX
           
protected static java.lang.Double X_MIN
           
static java.lang.String X_NAME
           
protected static java.lang.String X_UNITS
           
protected  DoubleParameter xDirParam
          "X" directivity parameter representing the length ratio, or fraction of fault along strike that ruptures toward the site.
 
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
Abrahamson_2000_AttenRel(ParameterChangeWarningListener listener)
          No-Arg constructor.
 
Method Summary
 java.net.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.
 java.lang.String getName()
          get the name of this IMR
 java.lang.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 Propagation Effect parameters and adds them to the propagationEffectParams list.
protected  void initSiteParams()
          Creates the Site-Type parameter and adds it to the siteParams list.
protected  void initSupportedIntensityMeasureParams()
          Creates the supported IM parameter (only SA), as well as the independenParameters of SA (periodParam and dampingParam) and adds it to the supportedIMParams list.
protected  void setDirectivityParams()
          This computes the directivity parameters
 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; since their paper does not quantify the distinction, Norm advised as follows: Reverse if 67.5
 void setParamDefaults()
          This sets the defaults for all the parameters.
protected  void setPropagationEffectParams()
          This calculates the distanceRupParam and isOnHangingWallParam values based on the current site and eqkRupture.
 void setSite(Site site)
          This sets the site-related parameter (siteTypeParam) based on what is in the Site object passed in (the Site object must have a parameter with the same name as that in siteTypeParam).
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 java.lang.String NAME
See Also:
Constant Field Values

SHORT_NAME

public static final java.lang.String SHORT_NAME
See Also:
Constant Field Values

FLT_TYPE_SS

public static final java.lang.String FLT_TYPE_SS
See Also:
Constant Field Values

SITE_TYPE_NAME

public static final java.lang.String SITE_TYPE_NAME
See Also:
Constant Field Values

SITE_TYPE_INFO

public static final java.lang.String SITE_TYPE_INFO
See Also:
Constant Field Values

SITE_TYPE_ROCK

public static final java.lang.String SITE_TYPE_ROCK
See Also:
Constant Field Values

SITE_TYPE_SOIL

public static final java.lang.String SITE_TYPE_SOIL
See Also:
Constant Field Values

SITE_TYPE_DEFAULT

public static final java.lang.String SITE_TYPE_DEFAULT
See Also:
Constant Field Values

MAG_WARN_MIN

protected static final java.lang.Double MAG_WARN_MIN

MAG_WARN_MAX

protected static final java.lang.Double MAG_WARN_MAX

DISTANCE_RUP_WARN_MIN

protected static final java.lang.Double DISTANCE_RUP_WARN_MIN

DISTANCE_RUP_WARN_MAX

protected static final java.lang.Double DISTANCE_RUP_WARN_MAX

thetaDirParam

protected DoubleParameter thetaDirParam
theta directivity parameter.


THETA_NAME

public static final java.lang.String THETA_NAME
See Also:
Constant Field Values

THETA_UNITS

public static final java.lang.String THETA_UNITS
See Also:
Constant Field Values

THETA_MIN

protected static final java.lang.Double THETA_MIN

THETA_MAX

protected static final java.lang.Double THETA_MAX

THETA_DEFAULT

protected static final java.lang.Double THETA_DEFAULT

THETA_INFO

public static final java.lang.String THETA_INFO
See Also:
Constant Field Values

xDirParam

protected DoubleParameter xDirParam
"X" directivity parameter representing the length ratio, or fraction of fault along strike that ruptures toward the site.


X_NAME

public static final java.lang.String X_NAME
See Also:
Constant Field Values

X_UNITS

protected static final java.lang.String X_UNITS

X_MIN

protected static final java.lang.Double X_MIN

X_MAX

protected static final java.lang.Double X_MAX

X_DEFAULT

protected static final java.lang.Double X_DEFAULT

X_INFO

public static final java.lang.String X_INFO
See Also:
Constant Field Values

horzCoeffs

protected java.util.Hashtable horzCoeffs
Hashtable of coefficients for the supported intensityMeasures

Constructor Detail

Abrahamson_2000_AttenRel

public Abrahamson_2000_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; since their paper does not quantify the distinction, Norm advised as follows: Reverse if 67.5
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 (siteTypeParam) based on what is in the Site object passed in (the Site object must have a parameter with the same name as that in siteTypeParam). 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 object
Throws:
ParameterException - Thrown if the Site object doesn't contain a Vs30 parameter

setPropagationEffectParams

protected void setPropagationEffectParams()
This calculates the distanceRupParam and isOnHangingWallParam values based on the current site and eqkRupture.

Specified by:
setPropagationEffectParams in class AttenuationRelationship

setDirectivityParams

protected void setDirectivityParams()
This computes the directivity parameters


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.

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 Site-Type 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 Propagation Effect parameters and adds them to the propagationEffectParams list. Makes the parameters noneditable.

Specified by:
initPropagationEffectParams in class AttenuationRelationship

initSupportedIntensityMeasureParams

protected void initSupportedIntensityMeasureParams()
Creates the supported IM parameter (only SA), as well as the independenParameters of SA (periodParam and dampingParam) and adds it 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

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.00 second period is "SA/1.00".


getName

public java.lang.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 java.lang.String getShortName()
Returns the Short Name of each AttenuationRelationship

Returns:
String

getInfoURL

public java.net.URL getInfoURL()
                        throws java.net.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:
java.net.MalformedURLException - if returned URL is not a valid URL.