org.opensha.sha.imr.attenRelImpl
Class BA_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.BA_2008_AttenRel
All Implemented Interfaces:
Serializable, Comparable<IntensityMeasureRelationship>, EventListener, Named, ShortNamed, XMLSaveable, ParameterChangeListener, IntensityMeasureRelationship, ScalarIMR
Direct Known Subclasses:
NSHMP08_WUS.NSHMP_BA_2008

public class BA_2008_AttenRel
extends AttenuationRelationship
implements ParameterChangeListener

Implementation of the Boore & Atkinson (2008) next generation attenuation relationship (NGA). See: Ground-Motion Prediction Equations for the Average Horizontal Component of PGA, PGV, and 5%-Damped PSA at Spectral Periods between 0.01 s and 10.0 s", Earthquake Spectra, Volume 24, Number 1, pp. 99-138.

Supported Intensity-Measure Parameters:

Other Independent Parameters: Verification - This model has been tested against: 1) a verification file generated independently by Ken Campbell, implemented in the JUnit test class BA_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:
$Id: BA_2008_AttenRel.java 10874 2014-10-08 18:58:51Z kmilner $
Author:
Edward H. Field
See Also:
Serialized Form

Field Summary
protected  double a1
           
protected  double a2
           
protected  double[] b_lin
           
protected  double[] b1
           
protected  double[] b2
           
protected  double[] c1
           
protected  double[] c2
           
protected  double[] c3
           
protected static Double DISTANCE_JB_WARN_MAX
           
protected static Double DISTANCE_JB_WARN_MIN
           
protected  double[] e1
           
protected  double[] e2
           
protected  double[] e3
           
protected  double[] e4
           
protected  double[] e5
           
protected  double[] e6
           
protected  double[] e7
           
static String FLT_TYPE_NORMAL
           
static String FLT_TYPE_REVERSE
           
static String FLT_TYPE_STRIKE_SLIP
           
static String FLT_TYPE_UNKNOWN
           
protected  double[] h
           
protected  double m_ref
           
protected static Double MAG_WARN_MAX
           
protected static Double MAG_WARN_MIN
           
protected  double[] mh
           
static String NAME
           
protected  double[] period
           
protected  double pgalow
           
protected  double r_ref
           
protected  double[] s
           
protected  double[] s_tm
           
protected  double[] s_tu
           
static String SHORT_NAME
           
protected  double[] t_m
           
protected  double[] t_u
           
protected  double v_ref
           
protected  double v1
           
protected  double v2
           
protected static Double VS30_WARN_MAX
           
protected static Double VS30_WARN_MIN
           
 
Fields inherited from class org.opensha.sha.imr.AttenuationRelationship
aftershockParam, cavParam, componentParam, D, 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
BA_2008_AttenRel(ParameterChangeWarningListener listener)
          Constructs a new instance of this attenuation relationship.
 
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.
 double getMean(int iper, double vs30, double rjb, double mag, String fltType, double pga4nl)
           
 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.
 double getStdDev(int iper, String stdDevType, String fltType)
           
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 parameter change listeners.
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.
 void parameterChange(ParameterChangeEvent e)
          This listens for parameter changes and updates the primitive parameters accordingly
 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()
          Allows the user to set the default parameter values for the selected Attenuation Relationship.
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

SHORT_NAME

public static final String SHORT_NAME
See Also:
Constant Field Values

NAME

public static final String NAME
See Also:
Constant Field Values

period

protected double[] period

b_lin

protected double[] b_lin

b1

protected double[] b1

b2

protected double[] b2

c1

protected double[] c1

c2

protected double[] c2

c3

protected double[] c3

h

protected double[] h

e1

protected double[] e1

e2

protected double[] e2

e3

protected double[] e3

e4

protected double[] e4

e5

protected double[] e5

e6

protected double[] e6

e7

protected double[] e7

mh

protected double[] mh

s

protected double[] s

t_u

protected double[] t_u

s_tu

protected double[] s_tu

t_m

protected double[] t_m

s_tm

protected double[] s_tm

a1

protected double a1

pgalow

protected double pgalow

a2

protected double a2

v1

protected double v1

v2

protected double v2

v_ref

protected double v_ref

m_ref

protected double m_ref

r_ref

protected double r_ref

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

VS30_WARN_MIN

protected static final Double VS30_WARN_MIN

VS30_WARN_MAX

protected static final Double VS30_WARN_MAX

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

FLT_TYPE_NORMAL

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

BA_2008_AttenRel

public BA_2008_AttenRel(ParameterChangeWarningListener listener)
Constructs a new instance of this attenuation relationship.

Parameters:
listener -
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. NGA report is not explicit, but values within 30-degrees of horz for SS was how the NGA data were defined.

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 of the exceedence probability distribution.

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()
Allows the user to set the default parameter values for the selected Attenuation Relationship.

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()
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

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

getMean

public double getMean(int iper,
                      double vs30,
                      double rjb,
                      double mag,
                      String fltType,
                      double pga4nl)

getStdDev

public double getStdDev(int iper,
                        String stdDevType,
                        String fltType)

parameterChange

public void parameterChange(ParameterChangeEvent e)
This listens for parameter changes and updates the primitive parameters accordingly

Specified by:
parameterChange in interface ParameterChangeListener
Parameters:
e - ParameterChangeEvent

resetParameterEventListeners

public void resetParameterEventListeners()
Allows to reset the change listeners on the parameters

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

initParameterEventListeners

protected void initParameterEventListeners()
Adds the parameter change listeners. This allows to listen to when-ever the parameter is changed.

Overrides:
initParameterEventListeners in class AttenuationRelationship

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.