org.opensha.sha.imr
Enum AttenRelRef

java.lang.Object
  extended by java.lang.Enum<AttenRelRef>
      extended by org.opensha.sha.imr.AttenRelRef
All Implemented Interfaces:
Serializable, Comparable<AttenRelRef>, Named

public enum AttenRelRef
extends Enum<AttenRelRef>
implements Named

This enum supplies references to AttenuationRelationship implementations. Each reference can return instances of the AttenuationRelationship it represents as well as limited metadata such as the IMR's name and development status. Static methods are provided to facilitate retrieval of specific Sets of references and Lists of instances.

Version:
$Id: AttenRelRef.java 10712 2014-05-19 22:21:04Z kmilner $
Author:
Peter Powers

Enum Constant Summary
AB_2006_140
          Atkinson and Booore (2006) with 140bar stress drop.
AB_2006_200
          Atkinson and Booore (2006) with 140bar stress drop.
ABRAHAM_2000
          Abrahamson (2000)
AS_1997
          Abrahmson and Silva (1997)
AS_2005
          [NGA prelim] Abrahamson & Silva (2008)
AS_2008
          [NGA] Abrahamson & Silva (2008)
ASK_2014
           
BA_2006
          [NGA prelim] Boore & Atkinson (2008)
BA_2008
          [NGA] Boore & Atkinson (2008)
BA_2008_INTERP
          Interpolation between periods using BA.
BC_2004
          Bazzuro & Cornell (2004)
BJF_1997
          Boore, Joyner & Fumal (1997)
BS_2003
          Baturay & Stewart (2003)
BSSA_2014
           
CAMPBELL_1997
          Campbell (1997)
CAMPBELL_2003
          Campbell CEUS (2003).
CB_2003
          Campbell & Bozorgnia (2003)
CB_2006
          [NGA prelim] Campbell & Bozorgnia (2008)
CB_2008
          [NGA] Campbell & Bozorgnia (2008)
CB_2014
           
CS_2005
          Choi & Stewart (2005)
CY_2006
          [NGA prelim] Chiou & Youngs (2008)
CY_2008
          [NGA] Chiou & Youngs (2008)
CY_2014
           
CYBERSHAKE
          Cybershake fake attnuation relation
DAHLE_1995
          Dahle et al.
FEA_1996
          Frankel et al.
FIELD_2000
          Field (2000)
GK_2014
           
GOULET_2006
          Goulet et al.
IDRISS_2014
           
MCVERRY_2000
          McVerry et al.
NGA_2008_3AVG
          Average of 3 NGA's.
NGA_2008_4AVG
          Average of 4 NGA's.
NGAWest_2014_AVG
           
NSHMP_2008
          Average of 3 NGA's used in the 20008 NSHMP
NSHMP_2008_CEUS
          Multiple weighted attenuation relationships used in 20008 CEUS NSHMP
SADIGH_1997
          Sadigh et al.
SADIGH_1999
          Sadigh et al.
SHAKE_2003
          ShakeMap
SILVA_2002
          Silva et al.
SITESPEC_2006
          Site specific model
SOMERVILLE_2001
          Somerville et al.
TORO_1997
          Toro et al.
TP_2005
          Tavakoli and Pezeshk (2005).
USGS_2004_COMBO
          USGS combined
WC_1994
          Wells & Coppersmith (1994) displacement model
ZHAO_2006
          Zhao et al.
 
Method Summary
static Set<AttenRelRef> get()
          Convenience method to return references for all AttenuationRelationship implementations that are currently production quality (i.e.
static Set<AttenRelRef> get(DevStatus... stati)
          Convenience method to return references to AttenuationRelationship implementations at the specified levels of development.
static Set<AttenRelRef> get(ServerPrefs prefs)
          Convenience method to return references for all AttenuationRelationship implementations that should be included in applications with the given ServerPrefs.
 Class<? extends AttenuationRelationship> getAttenRelClass()
           
 String getName()
          Returns the name of this object
 String getShortName()
           
 AttenuationRelationship instance(ParameterChangeWarningListener listener)
          Returns a new instance of the attenuation relationship represented by this reference.
static List<AttenuationRelationship> instanceList(ParameterChangeWarningListener listener, boolean sorted)
          Returns a List of AttenuationRelationship instances that are currently production quality (i.e.
static List<AttenuationRelationship> instanceList(ParameterChangeWarningListener listener, boolean sorted, AttenRelRef... refs)
          Returns a List of AttenuationRelationship instances specified by the supplied references.
static List<AttenuationRelationship> instanceList(ParameterChangeWarningListener listener, boolean sorted, Collection<AttenRelRef> refs)
          Returns a List of AttenuationRelationship instances specified by the supplied Collection of references.
static List<AttenuationRelationship> instanceList(ParameterChangeWarningListener listener, boolean sorted, DevStatus... stati)
          Returns a List of AttenuationRelationship instances at a specified level of development.
static List<AttenuationRelationship> instanceList(ParameterChangeWarningListener listener, boolean sorted, ServerPrefs prefs)
          Returns a List of AttenuationRelationship instances that are appropriate for an application with the given ServerPrefs.
 DevStatus status()
          Returns the development status of the referenced AttenuationRelationship.
 String toString()
           
static AttenRelRef valueOf(String name)
          Returns the enum constant of this type with the specified name.
static AttenRelRef[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

CB_2008

public static final AttenRelRef CB_2008
[NGA] Campbell & Bozorgnia (2008)


BA_2008

public static final AttenRelRef BA_2008
[NGA] Boore & Atkinson (2008)


AS_2008

public static final AttenRelRef AS_2008
[NGA] Abrahamson & Silva (2008)


CY_2008

public static final AttenRelRef CY_2008
[NGA] Chiou & Youngs (2008)


GOULET_2006

public static final AttenRelRef GOULET_2006
Goulet et al. (2006)


ZHAO_2006

public static final AttenRelRef ZHAO_2006
Zhao et al. (2006)


CS_2005

public static final AttenRelRef CS_2005
Choi & Stewart (2005)


BC_2004

public static final AttenRelRef BC_2004
Bazzuro & Cornell (2004)


USGS_2004_COMBO

public static final AttenRelRef USGS_2004_COMBO
USGS combined


BS_2003

public static final AttenRelRef BS_2003
Baturay & Stewart (2003)


CB_2003

public static final AttenRelRef CB_2003
Campbell & Bozorgnia (2003)


SHAKE_2003

public static final AttenRelRef SHAKE_2003
ShakeMap


FIELD_2000

public static final AttenRelRef FIELD_2000
Field (2000)


ABRAHAM_2000

public static final AttenRelRef ABRAHAM_2000
Abrahamson (2000)


MCVERRY_2000

public static final AttenRelRef MCVERRY_2000
McVerry et al. (2000)


SADIGH_1999

public static final AttenRelRef SADIGH_1999
Sadigh et al. (1999)


AS_1997

public static final AttenRelRef AS_1997
Abrahmson and Silva (1997)


BJF_1997

public static final AttenRelRef BJF_1997
Boore, Joyner & Fumal (1997)


CAMPBELL_1997

public static final AttenRelRef CAMPBELL_1997
Campbell (1997)


SADIGH_1997

public static final AttenRelRef SADIGH_1997
Sadigh et al. (1997)


DAHLE_1995

public static final AttenRelRef DAHLE_1995
Dahle et al. (1995)


BA_2008_INTERP

public static final AttenRelRef BA_2008_INTERP
Interpolation between periods using BA.


NGA_2008_4AVG

public static final AttenRelRef NGA_2008_4AVG
Average of 4 NGA's.


NGA_2008_3AVG

public static final AttenRelRef NGA_2008_3AVG
Average of 3 NGA's.


NSHMP_2008

public static final AttenRelRef NSHMP_2008
Average of 3 NGA's used in the 20008 NSHMP


NSHMP_2008_CEUS

public static final AttenRelRef NSHMP_2008_CEUS
Multiple weighted attenuation relationships used in 20008 CEUS NSHMP


AB_2006_140

public static final AttenRelRef AB_2006_140
Atkinson and Booore (2006) with 140bar stress drop. For NSHMP CEUS.


AB_2006_200

public static final AttenRelRef AB_2006_200
Atkinson and Booore (2006) with 140bar stress drop. For NSHMP CEUS.


CAMPBELL_2003

public static final AttenRelRef CAMPBELL_2003
Campbell CEUS (2003). For NSHMP CEUS.


FEA_1996

public static final AttenRelRef FEA_1996
Frankel et al. (1996). For NSHMP CEUS.


SOMERVILLE_2001

public static final AttenRelRef SOMERVILLE_2001
Somerville et al. (2001). For NSHMP CEUS.


SILVA_2002

public static final AttenRelRef SILVA_2002
Silva et al. (2002). For NSHMP CEUS.


TORO_1997

public static final AttenRelRef TORO_1997
Toro et al. (1997). For NSHMP CEUS.


TP_2005

public static final AttenRelRef TP_2005
Tavakoli and Pezeshk (2005). For NSHMP CEUS.


CYBERSHAKE

public static final AttenRelRef CYBERSHAKE
Cybershake fake attnuation relation


ASK_2014

public static final AttenRelRef ASK_2014

BSSA_2014

public static final AttenRelRef BSSA_2014

CB_2014

public static final AttenRelRef CB_2014

CY_2014

public static final AttenRelRef CY_2014

GK_2014

public static final AttenRelRef GK_2014

IDRISS_2014

public static final AttenRelRef IDRISS_2014

NGAWest_2014_AVG

public static final AttenRelRef NGAWest_2014_AVG

CB_2006

public static final AttenRelRef CB_2006
[NGA prelim] Campbell & Bozorgnia (2008)


BA_2006

public static final AttenRelRef BA_2006
[NGA prelim] Boore & Atkinson (2008)


AS_2005

public static final AttenRelRef AS_2005
[NGA prelim] Abrahamson & Silva (2008)


CY_2006

public static final AttenRelRef CY_2006
[NGA prelim] Chiou & Youngs (2008)


SITESPEC_2006

public static final AttenRelRef SITESPEC_2006
Site specific model


WC_1994

public static final AttenRelRef WC_1994
Wells & Coppersmith (1994) displacement model

Method Detail

values

public static AttenRelRef[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
for (AttenRelRef c : AttenRelRef.values())
    System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they are declared

valueOf

public static AttenRelRef valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:
name - the name of the enum constant to be returned.
Returns:
the enum constant with the specified name
Throws:
IllegalArgumentException - if this enum type has no constant with the specified name
NullPointerException - if the argument is null

toString

public String toString()
Overrides:
toString in class Enum<AttenRelRef>

getName

public String getName()
Description copied from interface: Named
Returns the name of this object

Specified by:
getName in interface Named

getShortName

public String getShortName()

status

public DevStatus status()
Returns the development status of the referenced AttenuationRelationship.

Returns:
the development status

getAttenRelClass

public Class<? extends AttenuationRelationship> getAttenRelClass()

instance

public AttenuationRelationship instance(ParameterChangeWarningListener listener)
Returns a new instance of the attenuation relationship represented by this reference.

Parameters:
listener - to initialize instances with; may be null
Returns:
a new AttenuationRelationship instance

get

public static Set<AttenRelRef> get()
Convenience method to return references for all AttenuationRelationship implementations that are currently production quality (i.e. fully tested and documented), under development, or experimental. The Set of references returned does not include deprecated references.

Returns:
reference Set of all non-deprecated AttenuationRelationships
See Also:
DevStatus

get

public static Set<AttenRelRef> get(ServerPrefs prefs)
Convenience method to return references for all AttenuationRelationship implementations that should be included in applications with the given ServerPrefs. Production applications only include production IMRs, and development applications include everything but deprecated IMRs.

Parameters:
prefs - ServerPrefs instance for which IMRs should be selected
Returns:

get

public static Set<AttenRelRef> get(DevStatus... stati)
Convenience method to return references to AttenuationRelationship implementations at the specified levels of development.

Parameters:
stati - the development level(s) of the AttenuationRelationship references to be retrieved
Returns:
a Set of AttenuationRelationship references
See Also:
DevStatus

instanceList

public static List<AttenuationRelationship> instanceList(ParameterChangeWarningListener listener,
                                                         boolean sorted)
Returns a List of AttenuationRelationship instances that are currently production quality (i.e. fully tested and documented), under development, or experimental. The list of AttenuationRelationships returned does not include deprecated implementations.

Parameters:
listener - to initialize instances with; may be null
sorted - whether to sort the list by name
Returns:
a List of all non-deprecated AttenuationRelationships

instanceList

public static List<AttenuationRelationship> instanceList(ParameterChangeWarningListener listener,
                                                         boolean sorted,
                                                         ServerPrefs prefs)
Returns a List of AttenuationRelationship instances that are appropriate for an application with the given ServerPrefs.

Parameters:
listener - to initialize instances with; may be null
sorted - whether to sort the list by name
prefs - ServerPrefs instance for which IMRs should be selected
Returns:
a List of all non-deprecated AttenuationRelationships

instanceList

public static List<AttenuationRelationship> instanceList(ParameterChangeWarningListener listener,
                                                         boolean sorted,
                                                         Collection<AttenRelRef> refs)
Returns a List of AttenuationRelationship instances specified by the supplied Collection of references.

Parameters:
listener - to initialize instances with; may be null
sorted - whether to sort the list by name
refs - to instances to retrieve
Returns:
a List of all non-deprecated AttenuationRelationships

instanceList

public static List<AttenuationRelationship> instanceList(ParameterChangeWarningListener listener,
                                                         boolean sorted,
                                                         AttenRelRef... refs)
Returns a List of AttenuationRelationship instances specified by the supplied references.

Parameters:
listener - to initialize instances with; may be null
sorted - whether to sort the list by name
refs - to instances to retrieve
Returns:
a List of all non-deprecated AttenuationRelationships

instanceList

public static List<AttenuationRelationship> instanceList(ParameterChangeWarningListener listener,
                                                         boolean sorted,
                                                         DevStatus... stati)
Returns a List of AttenuationRelationship instances at a specified level of development.

Parameters:
listener - to initialize instances with; may be null
sorted - whether to sort the list by name
stati - the development level(s) of the AttenuationRelationship references to be retrieved
Returns:
a List of AttenuationRelationships