gov.usgs.earthquake.nshmp.calc

Enum ReturnPeriod

java.lang.Object

java.lang.Enum<ReturnPeriod>

gov.usgs.earthquake.nshmp.calc.ReturnPeriod

All Implemented Interfaces:

Serializable, Comparable<ReturnPeriod>

public enum ReturnPeriod
extends Enum<ReturnPeriod>

Identifiers of common return periods, also referred to in PSHA as probabilities of exceedance.

Each identifier is structured as follows, for example PE2IN50:

• Reads as a 2% Poisson probability of exceeding some measure of ground motion in a 50 year period.
• Is equivalent to an annual rate of occurrence of ~0.000404 (see annualRate()).
• Or once every 2475 years or so (see duration() ).

Note that the Mfds class includes useful static utilities for working with Poisson probabilities, rates, and time spans.

Author:

Peter Powers

See Also:

Mfds

Enum Constant Summary

Enum Constants

Enum Constant and Description
PE10IN50 A 10% probability of exceedance in 50 years.
PE1IN100 A 1% probability of exceedance in 100 years.
PE1IN1000 A 1% probability of exceedance in 1,000 years.
PE1IN10000 A 1% probability of exceedance in 10,000 years.
PE1IN50 A 1% probability of exceedance in 50 years.
PE2IN50 A 2% probability of exceedance in 50 years.
PE40IN50 A 40% probability of exceedance in 50 years.
PE5IN50 A 5% probability of exceedance in 50 years.

Method Summary

Modifier and Type	Method and Description
double	annualRate() Return the annual rate of occurrence represented by this time period.
int	duration() Return the duration (number of years spanned) by this return period.
String	toString()
static ReturnPeriod	valueOf(String name) Returns the enum constant of this type with the specified name.
static ReturnPeriod[]	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

PE1IN10000

public static final ReturnPeriod PE1IN10000

A 1% probability of exceedance in 10,000 years.

PE1IN1000

public static final ReturnPeriod PE1IN1000

A 1% probability of exceedance in 1,000 years.

PE1IN100

public static final ReturnPeriod PE1IN100

A 1% probability of exceedance in 100 years.

PE1IN50

public static final ReturnPeriod PE1IN50

A 1% probability of exceedance in 50 years.

PE2IN50

public static final ReturnPeriod PE2IN50

A 2% probability of exceedance in 50 years.

PE5IN50

public static final ReturnPeriod PE5IN50

A 5% probability of exceedance in 50 years.

PE10IN50

public static final ReturnPeriod PE10IN50

A 10% probability of exceedance in 50 years.

PE40IN50

public static final ReturnPeriod PE40IN50

A 40% probability of exceedance in 50 years.

Method Detail

values

public static ReturnPeriod[] 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 (ReturnPeriod c : ReturnPeriod.values())
    System.out.println(c);

Returns:

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

valueOf

public static ReturnPeriod 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<ReturnPeriod>

annualRate

public double annualRate()

Return the annual rate of occurrence represented by this time period.

duration

public int duration()

Return the duration (number of years spanned) by this return period.