org.opensha.sha.imr.attenRelImpl
Class AS_2008_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.AS_2008_AttenRel
All Implemented Interfaces:
Serializable, Comparable<IntensityMeasureRelationship>, EventListener, Named, ShortNamed, XMLSaveable, ParameterChangeListener, IntensityMeasureRelationship, ScalarIMR

public class AS_2008_AttenRel
extends AttenuationRelationship
implements ParameterChangeListener

Title: AS_2008_AttenRel

Description: This implements the Attenuation Relationship published by Abrahamson & Silva (2008, "Summary of the Abrahamson & Silva NGA Ground-Motion Relations", Earthquake Spectra, Volume 24, Number 1, pp. 67-97)

Supported Intensity-Measure Parameters:

Other Independent Parameters:

NOTES: distRupMinusJB_OverRupParam is used rather than distancJBParameter because the latter should not be held constant when distanceRupParameter is changed (e.g., in the AttenuationRelationshipApplet). The same is true for distRupMinusDistX_OverRupParam.

When setting parameters from a passed-in EqkRupture, aftershockParam is always set to false (we could change this if aftershock info is added to an EqkRupture, but it's not clear this is justified).

If depthTo1pt0kmPerSecParam is null, it is set from Vs30 using their equation (17).

Verification - This model has been tested against: 1) a verification file generated independently by Ken Campbell, implemented in the JUnit test class AS_2008_test; and 2) by the test class NGA08_Site_EqkRup_Tests, which makes sure parameters are set properly when Site and EqkRupture objects are passed in.

Version:
2.0, Feb 2009
Author:
Christine Goulet & Ned Field
See Also:
Serialized Form

Field Summary
static String FLT_TYPE_NORMAL
           
static String FLT_TYPE_REVERSE
           
static String FLT_TYPE_STRIKE_SLIP
           
static String NAME
          Name of IMR
static String SHORT_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
AS_2008_AttenRel(ParameterChangeWarningListener listener)
          This initializes several ParameterList objects.
 
Method Summary
 double getf10(int iper, double vs30, double depthTo1pt0kmPerSec)
          Returns the value of f10 to be applied to the final median computation
 double getf5(int iper, double vs30, double pga_rock)
          Returns the value of f5 for vs30, to be used in getMean for constant displacement model
 URL getInfoURL()
          This provides a URL where more info on this model can be obtained
 double getMean()
          Calculates the mean
 String getName()
          Returns name of the IntensityMeasureRelationship.
 String getShortName()
          Returns a Short Name for the IMR
 double getStdDev()
          This returns the standard deviation (stdDev) of the intensity-measure level for the current set of parameters.
 double getStdDev(int iper, String stdDevType, String component, double vs30, double pga_rock, double vsm)
           
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 initParameterEventListeners()
          Adds the Listeners to the parameters so that Attenuation can listen to any kind of changes to parameter values.
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 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)
          CG: This comment was for CB 2008.
 void parameterChange(ParameterChangeEvent e)
          Function that must be implemented by all Listeners for ParameterChangeEvents.
 void resetParameterEventListeners()
          Allows to reset the change listeners on the parameters
protected  void setCoeffIndex()
          This function returns the array index for the coeffs corresponding to the chosen IMT
 void setEqkRupture(EqkRupture eqkRupture)
          Sets the EqkRupture object in the IMR as a reference to the one passed in.
protected  void setFaultTypeFromRake(double rake)
          Set style of faulting from the rake angle.
 void setParamDefaults()
          This sets the defaults for all the parameters.
protected  void setPropagationEffectParams()
          Calculates the value of each propagation effect parameter from the current Site and ProbEqkRupture objects.
 void setSite(Site site)
          Sets the Site object as a reference to that passed in.
 
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, isTectonicRegionSupported, isTectonicRegionSupported, 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
Name of IMR

See Also:
Constant Field Values

SHORT_NAME

public static final String SHORT_NAME
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

FLT_TYPE_NORMAL

public static final String FLT_TYPE_NORMAL
See Also:
Constant Field Values
Constructor Detail

AS_2008_AttenRel

public AS_2008_AttenRel(ParameterChangeWarningListener listener)
This initializes several ParameterList objects.

Method Detail

setEqkRupture

public void setEqkRupture(EqkRupture eqkRupture)
                   throws InvalidRangeException
Description copied from class: AbstractIMR
Sets the EqkRupture object in the IMR as a reference to the one passed in.

Specified by:
setEqkRupture in interface IntensityMeasureRelationship
Overrides:
setEqkRupture in class AbstractIMR
Parameters:
eqkRupture - The new EqkRupture object
Throws:
InvalidRangeException

setSite

public void setSite(Site site)
             throws ParameterException
Description copied from class: AbstractIMR
Sets the Site object as a reference to that passed in.

Specified by:
setSite in interface IntensityMeasureRelationship
Overrides:
setSite in class AbstractIMR
Parameters:
site - The new site object
Throws:
ParameterException

setPropagationEffectParams

protected void setPropagationEffectParams()
Description copied from class: AttenuationRelationship
Calculates the value of each propagation effect parameter from the current Site and ProbEqkRupture objects.

Specified by:
setPropagationEffectParams in class AttenuationRelationship

setFaultTypeFromRake

protected void setFaultTypeFromRake(double rake)
Set style of faulting from the rake angle. Values derived from Abrahamson and Silva PEER NGA report.

Parameters:
rake - in degrees

setCoeffIndex

protected void setCoeffIndex()
                      throws ParameterException
This function returns the array index for the coeffs corresponding to the chosen IMT

Throws:
ParameterException

getMean

public double getMean()
Calculates the mean

Specified by:
getMean in interface ScalarIMR
Returns:
The mean value

getStdDev

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

Specified by:
getStdDev in interface ScalarIMR
Returns:
The stdDev value

setParamDefaults

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

Specified by:
setParamDefaults in interface IntensityMeasureRelationship

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 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()
Description copied from class: AbstractIMR
Returns name of the IntensityMeasureRelationship.

Specified by:
getName in interface Named
Specified by:
getName in interface IntensityMeasureRelationship
Overrides:
getName in class AbstractIMR
Returns:
The name string

getShortName

public String getShortName()
Description copied from interface: IntensityMeasureRelationship
Returns a Short Name for the IMR

Specified by:
getShortName in interface ShortNamed
Specified by:
getShortName in interface IntensityMeasureRelationship
Returns:
String

getf5

public double getf5(int iper,
                    double vs30,
                    double pga_rock)
Returns the value of f5 for vs30, to be used in getMean for constant displacement model


getf10

public double getf10(int iper,
                     double vs30,
                     double depthTo1pt0kmPerSec)
Returns the value of f10 to be applied to the final median computation


getStdDev

public double getStdDev(int iper,
                        String stdDevType,
                        String component,
                        double vs30,
                        double pga_rock,
                        double vsm)
Parameters:
iper -
stdDevType -
component -
vs30 -
vsm - (vs flag for measured/estimated)
Returns:

parameterChange

public void parameterChange(ParameterChangeEvent e)
Description copied from interface: ParameterChangeListener
Function that must be implemented by all Listeners for ParameterChangeEvents.

Specified by:
parameterChange in interface ParameterChangeListener
Parameters:
e - The Event which triggered this function call

resetParameterEventListeners

public void resetParameterEventListeners()
Description copied from class: AttenuationRelationship
Allows to reset the change listeners on the parameters

Specified by:
resetParameterEventListeners in interface ScalarIMR
Overrides:
resetParameterEventListeners in class AttenuationRelationship

initParameterEventListeners

protected void initParameterEventListeners()
Description copied from class: AttenuationRelationship
Adds the Listeners to the parameters so that Attenuation can listen to any kind of changes to parameter values.

Overrides:
initParameterEventListeners in class AttenuationRelationship

getInfoURL

public URL getInfoURL()
               throws MalformedURLException
Description copied from class: AbstractIMR
This provides a URL where more info on this model can be obtained

Specified by:
getInfoURL in interface IntensityMeasureRelationship
Overrides:
getInfoURL in class AbstractIMR
Throws:
MalformedURLException - if returned URL is not a valid URL. This default implementation returns nothing

main

public static void main(String[] args)
CG: This comment was for CB 2008. Need to check with Ned what's the reason behind it: This tests rJB numerical precision with respect to the f_hngR term. Looks OK now.

Parameters:
args -