org.opensha.sha.gcim.imr.attenRelImpl
Class KS_2006_AttenRel

java.lang.Object
  org.opensha.sha.imr.AbstractIMR
      org.opensha.sha.imr.AttenuationRelationship
          org.opensha.sha.gcim.imr.attenRelImpl.KS_2006_AttenRel

All Implemented Interfaces:

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

public class KS_2006_AttenRel
extends AttenuationRelationship
implements ScalarIMR, Named, ParameterChangeListener

Title: KS_2006_AttenRel

Description: This implements the Attenuation Relationship published by Kempton and Stewart (2006, "Prediction equations for significant duration of earthquake ground motions considering site and near-source effects", Earthquake Spectra, 22(4):985-1013. The "base" model is given here (i.e. their Equation 13 and Table 6) At this point (v1.0) only the "acceleration-based" durations are coded Supported Intensity-Measure Parameters:

• Ds575Param - Significant duration over which 5% to 75% of the arias intensity is developed
• Ds595Param - Significant duration over which 5% to 95% of the arias intensity is developed

Other Independent Parameters:

• magParam - moment Magnitude
• distanceRupParam - closest distance to fault surface
• vs30Param - 30-meter shear wave velocity
• stdDevTypeParam - The type of standard deviation

Verification - Verified against the Matlab implementation of Bradley and also with the figures in the above paper, but yet to do Junit tests - //TODO

Version:

1.0

Author:

Brendon Bradley

See Also:

Serialized Form

Field Summary

protected static Double	DISTANCE_RUP_WARN_MAX
protected static Double	DISTANCE_RUP_WARN_MIN
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

KS_2006_AttenRel(ParameterChangeWarningListener warningListener)
This initializes several ParameterList objects.

Method Summary

double	getMean() Calculates the mean of the exceedence probability distribution.
double	getMean(int imIndex, double vs30, double rRup, double mag)
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 imIndex, String stdDevType)
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) This sets the eqkRupture related parameters (magParam) based on the eqkRupture passed in.
void	setParamDefaults() Allows the user to set the default parameter values for the selected Attenuation Relationship.
protected void	setPropagationEffectParams() This sets the propagation-effect parameter (distanceRupParam) 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).

Methods inherited from class org.opensha.sha.imr.AttenuationRelationship

getAllParamMetadata, getEpsilon, getEpsilon, getExceedProbabilities, 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, getInfoURL, 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.ScalarIMR

getAllParamMetadata, getEpsilon, getEpsilon, getExceedProbabilities, getExceedProbability, getExceedProbIndependentParams, getExceedProbIndependentParamsIterator, getIML_AtExceedProb, getIML_AtExceedProb, getIML_AtExceedProbIndependentParams, getIML_AtExceedProbIndependentParamsIterator, getMeanIndependentParams, getMeanIndependentParamsIterator, getSA_ExceedProbSpectrum, getSA_IML_AtExceedProbSpectrum, getStdDevIndependentParams, getStdDevIndependentParamsIterator, isTectonicRegionSupported, isTectonicRegionSupported, setIntensityMeasureLevel, setSiteLocation, setUserMaxDistance

Methods inherited from interface org.opensha.sha.imr.IntensityMeasureRelationship

getEqkRupture, getEqkRuptureParams, getEqkRuptureParamsIterator, getExceedProbability, getInfoURL, getIntensityMeasure, getIntensityMeasureLevel, getOtherParams, getOtherParamsIterator, getParameter, getPropagationEffectParams, getPropagationEffectParamsIterator, getSite, getSiteParams, getSiteParamsIterator, getSupportedIntensityMeasures, getSupportedIntensityMeasuresIterator, isIntensityMeasureSupported, isIntensityMeasureSupported, setAll, setExceedProb, setIntensityMeasure, setIntensityMeasure, setIntensityMeasureLevel, 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

MAG_WARN_MIN

protected static final Double MAG_WARN_MIN

MAG_WARN_MAX

protected static final Double MAG_WARN_MAX

DISTANCE_RUP_WARN_MIN

protected static final Double DISTANCE_RUP_WARN_MIN

DISTANCE_RUP_WARN_MAX

protected static final Double DISTANCE_RUP_WARN_MAX

VS30_WARN_MIN

protected static final Double VS30_WARN_MIN

VS30_WARN_MAX

protected static final Double VS30_WARN_MAX

Constructor Detail

KS_2006_AttenRel

public KS_2006_AttenRel(ParameterChangeWarningListener warningListener)

This initializes several ParameterList objects.

Method Detail

setEqkRupture

public void setEqkRupture(EqkRupture eqkRupture)
                   throws InvalidRangeException

This sets the eqkRupture related parameters (magParam) based on the eqkRupture passed in. The internally held eqkRupture object is also set as that passed in. Warning constraints 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 sets the propagation-effect parameter (distanceRupParam) based on the current site and eqkRupture.

Specified by:

setPropagationEffectParams in class AttenuationRelationship

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 IntensityMeasureRelationship

Returns:

String

getMean

public double getMean(int imIndex,
                      double vs30,
                      double rRup,
                      double mag)

Parameters:

imIndex -

vs30 -

rRup -

mag -

Returns:

getStdDev

public double getStdDev(int imIndex,
                        String stdDevType)

Parameters:

imIndex -

stdDevType -

component -

Returns:

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