gov.usgs.earthquake.nshmp.eq.fault.surface

Enum RuptureFloating

java.lang.Object

java.lang.Enum<RuptureFloating>

gov.usgs.earthquake.nshmp.eq.fault.surface.RuptureFloating

All Implemented Interfaces:

Serializable, Comparable<RuptureFloating>

public enum RuptureFloating
extends Enum<RuptureFloating>

Rupture floating models for gridded surfaces. Each provides the means to create an immutable List of Ruptures from a GriddedSurface, magnitude, rate, rake, and uncertainty flag.

NOTE: Only ON currently recognizes and applies rupture area uncertainty.

Author:

Peter Powers

Enum Constant Summary

Enum Constants

Enum Constant and Description
NSHM NSHM floating model.
OFF Do not float.
ON Float both down-dip and along-strike.
STRIKE_ONLY Float along-strike only; floaters extend to full down-dip-width.
TRIANGULAR Triangular distribution of hypocenters.

Method Summary

Modifier and Type	Method and Description
abstract List<Rupture>	createFloatingRuptures(GriddedSurface surface, RuptureScaling scaling, double mag, double rate, double rake, boolean uncertainty) Create a List of floating ruptures
static void	main(String[] args)
static RuptureFloating	valueOf(String name) Returns the enum constant of this type with the specified name.
static RuptureFloating[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

OFF

public static final RuptureFloating OFF

Do not float.

ON

public static final RuptureFloating ON

Float both down-dip and along-strike.

STRIKE_ONLY

public static final RuptureFloating STRIKE_ONLY

Float along-strike only; floaters extend to full down-dip-width. This model currently ignores any rupture area sigma.

NSHM

public static final RuptureFloating NSHM

NSHM floating model. This is an approximation to the NSHM fortran analytical floating rupture model where specific magnitude dependent rupture top depths are used. This model currently ignores any rupture area sigma.

TRIANGULAR

public static final RuptureFloating TRIANGULAR

Triangular distribution of hypocenters. This model is motivated by the PEER PSHA validationtest cases. It is implemented to explicitely weight down-dip floating ruptures more hevily down to 10km, and then decrease their weight with depth below. TODO add reference/link to PEER documentation and test cases in repo

Method Detail

values

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

Returns:

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

valueOf

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

createFloatingRuptures

public abstract List<Rupture> createFloatingRuptures(GriddedSurface surface,
                                                     RuptureScaling scaling,
                                                     double mag,
                                                     double rate,
                                                     double rake,
                                                     boolean uncertainty)

Create a List of floating ruptures

Parameters:

surface - (gridded) from which floaters are derived

scaling - the rupture scaling model used to determine floater dimensions

mag - the magnitude of interest

main

public static void main(String[] args)