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

public class McVerryetal_2000_AttenRel
extends AttenuationRelationship
implements ParameterChangeListener

Title: McVerryetal_2000_AttenRel

Description: This implements the Attenuation Relationship published by McVerry et al (2000, "Crustal and subduction zone attenuation relations for New Zealand Earthquakes", Proc 12th World conference on earthquake engineering A more complete description of the attenuation relation can be found at McVerry et al (2006, "New Zealand Acceleration Response Spectrum Attenuation Relations for Crustal and Subduction Zone Earthquakes", Bulletin of the New Zealand Society of Earthquake Engineering Vol 39. No. 4 pp1-58) Supported Intensity-Measure Parameters:

Other Independent Parameters:

Verification - Compared with a Matlab implementation 2 July 2009

Version:
1.0
Author:
Brendon A. Bradley
See Also:
Serialized Form

Field Summary
static String COMPONENT_GEOMEAN
           
static String COMPONENT_LARGERHORIZ
           
protected static Double DISTANCE_RUP_WARN_MAX
           
protected static Double DISTANCE_RUP_WARN_MIN
           
static String FLT_TEC_ENV_CRUSTAL
           
static String FLT_TEC_ENV_INTERFACE
           
static String FLT_TEC_ENV_SLAB
           
static String FLT_TEC_ENV_VOLCANIC
           
static String FLT_TYPE_DEEP_SLAB
           
static String FLT_TYPE_INTERFACE
           
static String FLT_TYPE_NORMAL
           
static String FLT_TYPE_REVERSE
           
static String FLT_TYPE_REVERSE_OBLIQUE
           
static String FLT_TYPE_STRIKE_SLIP
           
protected static Double FOCALDEPTH_WARN_MAX
           
protected static Double FOCALDEPTH_WARN_MIN
           
protected static Double MAG_WARN_MAX
           
protected static Double MAG_WARN_MIN
           
static String NAME
           
static String SHORT_NAME
           
static String SITE_TYPE_A
           
static String SITE_TYPE_B
           
static String SITE_TYPE_C
           
static String SITE_TYPE_D
           
static String SITE_TYPE_DEFAULT
           
static String SITE_TYPE_INFO
           
static String SITE_TYPE_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
McVerryetal_2000_AttenRel(ParameterChangeWarningListener warningListener)
          This initializes several ParameterList objects.
 
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, StringParameter siteTypeParam, double rRup, double mag, double Hc, String fltType, String component)
           
 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 component)
           
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()
          This creates Site-related parameters, which are all associated parameters that the exceedance probability depends upon.
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 and fltTypeParam) based on the eqkRupture passed in.
protected  void setFaultTypeFromRake(double rake)
          Determines the 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()
          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, 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

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

FOCALDEPTH_WARN_MIN

protected static final Double FOCALDEPTH_WARN_MIN

FOCALDEPTH_WARN_MAX

protected static final Double FOCALDEPTH_WARN_MAX

SITE_TYPE_NAME

public static final String SITE_TYPE_NAME
See Also:
Constant Field Values

SITE_TYPE_INFO

public static final String SITE_TYPE_INFO
See Also:
Constant Field Values

SITE_TYPE_A

public static final String SITE_TYPE_A
See Also:
Constant Field Values

SITE_TYPE_B

public static final String SITE_TYPE_B
See Also:
Constant Field Values

SITE_TYPE_C

public static final String SITE_TYPE_C
See Also:
Constant Field Values

SITE_TYPE_D

public static final String SITE_TYPE_D
See Also:
Constant Field Values

SITE_TYPE_DEFAULT

public static final String SITE_TYPE_DEFAULT
See Also:
Constant Field Values

FLT_TEC_ENV_CRUSTAL

public static final String FLT_TEC_ENV_CRUSTAL

FLT_TEC_ENV_INTERFACE

public static final String FLT_TEC_ENV_INTERFACE

FLT_TEC_ENV_SLAB

public static final String FLT_TEC_ENV_SLAB

FLT_TEC_ENV_VOLCANIC

public static final String FLT_TEC_ENV_VOLCANIC

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_REVERSE_OBLIQUE

public static final String FLT_TYPE_REVERSE_OBLIQUE
See Also:
Constant Field Values

FLT_TYPE_NORMAL

public static final String FLT_TYPE_NORMAL
See Also:
Constant Field Values

FLT_TYPE_INTERFACE

public static final String FLT_TYPE_INTERFACE
See Also:
Constant Field Values

FLT_TYPE_DEEP_SLAB

public static final String FLT_TYPE_DEEP_SLAB
See Also:
Constant Field Values

COMPONENT_GEOMEAN

public static final String COMPONENT_GEOMEAN
See Also:
Constant Field Values

COMPONENT_LARGERHORIZ

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

McVerryetal_2000_AttenRel

public McVerryetal_2000_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 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

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

setFaultTypeFromRake

protected void setFaultTypeFromRake(double rake)
                             throws InvalidRangeException
Determines the style of faulting from the rake angle. Their report is not explicit, so these ranges come from an email that told us to decide, but that within 30-degrees of horz for SS was how the NGA data were defined.

Parameters:
rake - in degrees
Throws:
InvalidRangeException - If not valid rake angle

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()
Description copied from class: AttenuationRelationship
This creates Site-related parameters, which are all associated parameters that the exceedance probability depends upon. All implementation is in the subclass (it's defined here as a reminder/suggestions).

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,
                      StringParameter siteTypeParam,
                      double rRup,
                      double mag,
                      double Hc,
                      String fltType,
                      String component)

getStdDev

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

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.