gov.usgs.earthquake.nshmp.gmm

Class GmmInput

java.lang.Object

gov.usgs.earthquake.nshmp.gmm.GmmInput

Direct Known Subclasses:

HazardInput

public class GmmInput
extends Object

Earthquake Rupture and receiver Site property container used as input to GroundMotionModels (GMMs). Not all GMMs use all properties.

Author:

Peter Powers

See Also:

GroundMotionModel.calc(GmmInput)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GmmInput.Builder
static class	GmmInput.Constraints The constraints associated with each GmmInput field.
static class	GmmInput.Field GmmInput field identifiers.

Field Summary

Fields

Modifier and Type	Field and Description
double	dip Rupture dip.
double	Mw Moment magnitude.
double	rake Rupture rake.
double	rJB Joyner-Boore distance (distance to surface projection of rupture).
double	rRup Rupture distance (distance to rupture plane).
double	rX Distance X (shortest distance to extended strike of rupture).
double	vs30 Vs30 at site.
boolean	vsInf Whether vs30 is inferred or measured.
double	width Rupture width.
double	z1p0 Depth to 1.0 km/s (in km).
double	z2p5 Depth to 2.5 km/s (in km).
double	zHyp Depth to rupture hypocenter.
double	zTop Depth to top of rupture.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GmmInput(double Mw, double rJB, double rRup, double rX, double dip, double width, double zTop, double zHyp, double rake, double vs30, boolean vsInf, double z1p0, double z2p5) Create a deterministic rupture and site property container with all properties common to the supported set of ground motion models (GMMs).

Method Summary

Modifier and Type	Method and Description
static GmmInput.Builder	builder() Return a GmmInput builder that requires all fields to be explicitely set.
boolean	equals(Object obj)
int	hashCode()
String	toString() Some values [mag, rJB, rRup, rX, zHyp] may be truncated to 2 or 3 decimal places for output.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

Mw

public final double Mw

Moment magnitude.

rJB

public final double rJB

Joyner-Boore distance (distance to surface projection of rupture).

rRup

public final double rRup

Rupture distance (distance to rupture plane).

rX

public final double rX

Distance X (shortest distance to extended strike of rupture).

dip

public final double dip

Rupture dip.

width

public final double width

Rupture width.

zTop

public final double zTop

Depth to top of rupture.

zHyp

public final double zHyp

Depth to rupture hypocenter.

rake

public final double rake

Rupture rake.

vs30

public final double vs30

Vs30 at site.

vsInf

public final boolean vsInf

Whether vs30 is inferred or measured.

z1p0

public final double z1p0

Depth to 1.0 km/s (in km).

z2p5

public final double z2p5

Depth to 2.5 km/s (in km).

Constructor Detail

GmmInput

protected GmmInput(double Mw,
                   double rJB,
                   double rRup,
                   double rX,
                   double dip,
                   double width,
                   double zTop,
                   double zHyp,
                   double rake,
                   double vs30,
                   boolean vsInf,
                   double z1p0,
                   double z2p5)

Create a deterministic rupture and site property container with all properties common to the supported set of ground motion models (GMMs).

It is generally preferred to use a GmmInput.Builder to assemble the components of a GmmInput.

Parameters:

Mw - moment magnitude of rupture

rJB - Joyner-Boore distance to rupture (in km)

rRup - 3D distance to rupture plane (in km)

rX - distance X (in km)

dip - of rupture (in degrees)

width - down-dip rupture width (in km)

zTop - depth to the top of the rupture (in km)

zHyp - hypocentral depth (in km)

rake - of rupture

vs30 - average shear wave velocity in top 30 m (in m/sec)

vsInf - whether vs30 is an inferred or measured value

z1p0 - depth to V_s=1.0 km/sec (in km)

z2p5 - depth to V_s=2.5 km/sec (in km)

Method Detail

builder

public static GmmInput.Builder builder()

Return a GmmInput builder that requires all fields to be explicitely set. This builder is stateful and may be reused (by a single thread) preserving previously set fields. However, repeat calls of builder methods are not permitted until build() has been called.

See Also:

GmmInput.Builder

toString

public String toString()

Some values [mag, rJB, rRup, rX, zHyp] may be truncated to 2 or 3 decimal places for output.

Overrides:

toString in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object