CS_2005_AttenRel (OpenSHA)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.opensha.sha.imr.attenRelImpl
Class CS_2005_AttenRel

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

All Implemented Interfaces:: Serializable, Comparable<IntensityMeasureRelationship>, Named, XMLSaveable, IntensityMeasureRelationship, ScalarIMR

public class CS_2005_AttenRel
extends AttenuationRelationship
extends AttenuationRelationship

Title: CS_2005_AttenRel

Description: This implements the Attenuation Relationship developed by Choi and Stewart (2005, "Nonlinear Site Amplification as a Function of 30 m Shear Wave Velocity", Earthquake Spectre, v. 21, pp. 1-30). This applies an alternative site-response correction to the Abrahamson & Silva (1997) relationship.

Supported Intensity-Measure Parameters:

saParam - Response Spectral Acceleration
pgaParam - Peak Ground Acceleration

Other Independent Parameters:

distanceRupParam - closest distance to surface projection of fault
vs30Param - Average 30-meter shear-wave velocity at the site
softSoilParam - To overide Vs30 and apply NEHPR E (see INFO for details)
fltTypeParam - Style of faulting
isOnHangingWallParam - tells if site is directly over the rupture surface
componentParam - Component of shaking (only one)
stdDevTypeParam - The type of standard deviation

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

Field Summary
`protected Hashtable`	`horzCoeffs` Hashtable of coefficients for the supported intensityMeasures
`static String`	`NAME`
`static String`	`SHORT_NAME`
`static Boolean`	`SOFT_SOIL_DEFAULT`
`static String`	`SOFT_SOIL_INFO`
`static String`	`SOFT_SOIL_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.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
`CS_2005_AttenRel(ParameterChangeWarningListener listener)` No-Arg constructor.

Method Summary
`double`	`getMean()` Calculates the mean
`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 Vs30 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.
`void`	`setParamDefaults()` This sets the defaults for all the parameters.
`protected void`	`setPropagationEffectParams()` This does nothing, but is needed.
`void`	`setSite(Site site)` This sets the site-related parameter (vs30Param) based on what is in the Site object passed in.
`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_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.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, initParameterEventListeners, isTectonicRegionSupported, isTectonicRegionSupported, resetParameterEventListeners, 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 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.IntensityMeasureRelationship
`getEqkRupture, getEqkRuptureParams, getEqkRuptureParamsIterator, getInfoURL, getIntensityMeasure, getIntensityMeasureLevel, getOtherParams, getOtherParamsIterator, getParameter, getPropagationEffectParams, getPropagationEffectParamsIterator, getSite, getSiteParams, getSiteParamsIterator, getSupportedIntensityMeasures, getSupportedIntensityMeasuresIterator, isIntensityMeasureSupported, isIntensityMeasureSupported, setAll, setExceedProb, setIntensityMeasure, setIntensityMeasure, toXMLMetadata`

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

getEqkRupture, getEqkRuptureParams, getEqkRuptureParamsIterator, getInfoURL, 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

VS30_WARN_MIN

protected static final Double VS30_WARN_MIN

VS30_WARN_MAX

protected static final Double VS30_WARN_MAX

SOFT_SOIL_NAME

public static final String SOFT_SOIL_NAME

See Also:: Constant Field Values

SOFT_SOIL_INFO

public static final String SOFT_SOIL_INFO

See Also:: Constant Field Values

SOFT_SOIL_DEFAULT

public static final Boolean SOFT_SOIL_DEFAULT

horzCoeffs

protected Hashtable horzCoeffs

Hashtable of coefficients for the supported intensityMeasures

Constructor Detail

CS_2005_AttenRel

public CS_2005_AttenRel(ParameterChangeWarningListener listener)

No-Arg constructor. This initializes several ParameterList objects.

Method Detail

setPropagationEffectParams

protected void setPropagationEffectParams()

This does nothing, but is needed.

Specified by:: setPropagationEffectParams in class AttenuationRelationship

setEqkRupture

public void setEqkRupture(EqkRupture eqkRupture)
                   throws InvalidRangeException

This sets the eqkRupture related parameters.

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 (vs30Param) based on what is in the Site object passed in. WarningExceptions are ingored

Specified by:: setSite in interface IntensityMeasureRelationship
Overrides:: setSite in class AbstractIMR

Parameters:: site - The new site value which contains a Vs30 Parameter
Throws:: ParameterException - Thrown if the Site object doesn't contain a Vs30 parameter

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.

Throws:: ParameterException

getMean

public double getMean()
               throws IMRException

Calculates the mean

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