gov.usgs.earthquake.nshmp.gmm

Class GmmInput.Builder

java.lang.Object

gov.usgs.earthquake.nshmp.gmm.GmmInput.Builder

Enclosing class:

GmmInput

public static class GmmInput.Builder
extends Object

Method Summary

Modifier and Type	Method and Description
GmmInput	build()
GmmInput.Builder	dip(double dip) Set the rupture dip.
GmmInput.Builder	distances(Distance distances) Set the Joyner-Boore distance, rupture distance, and distance X with a Distance object.
GmmInput.Builder	distances(double rJB, double rRup, double rX) Set the Joyner-Boore distance, rupture distance, and distance X.
GmmInput.Builder	fromCopy(GmmInput model) Return a Builder prepopulated with values copied from the supplied model.
GmmInput.Builder	mag(double Mw) Set the moment magnitude.
GmmInput.Builder	rake(double rake) Set the rupture rake.
GmmInput.Builder	rJB(double rJB) Set the Joyner-Boore distance (distance to surface projection of rupture).
GmmInput.Builder	rRup(double rRup) Set the rupture distance (distance to rupture plane).
GmmInput.Builder	rX(double rX) Set the distance X (shortest distance to extended strike of rupture).
GmmInput.Builder	set(GmmInput.Field id, String s) Set a field in this builder.
GmmInput.Builder	vs30(double vs30) Set the vs30 at site.
GmmInput.Builder	vs30(double vs30, boolean vsInf) Set both the vs30 at site and whether vs30 is inferred or measured.
GmmInput.Builder	vsInf(boolean vsInf) Set whether vs30 is inferred or measured.
GmmInput.Builder	width(double width) Set the rupture width.
GmmInput.Builder	withDefaults() Return a Builder prepopulated with default values.
GmmInput.Builder	z1p0(double z1p0) Set the depth to 1.0 km/s (in km).
GmmInput.Builder	z2p5(double z2p5) Set the depth to 2.5 km/s (in km).
GmmInput.Builder	zHyp(double zHyp) Set the depth to rupture hypocenter.
GmmInput.Builder	zTop(double zTop) Set the depth to top of rupture.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

fromCopy

public GmmInput.Builder fromCopy(GmmInput model)

Return a Builder prepopulated with values copied from the supplied model.

Parameters:

model - to copy

Throws:

IllegalStateException - if any other builder method has already been called without first calling build()

withDefaults

public GmmInput.Builder withDefaults()

Return a Builder prepopulated with default values. Builder has the following presets:

• Mw: 6.5
• rJB: 10.0 (km)
• rRup: 10.3 (km)
• rX: 10.0 (km)
• dip: 90˚
• width: 14.0 (km)
• zTop: 0.5 (km)
• zHyp: 7.5 (km)
• rake: 0˚
• vs30: 760 (m/s)
• vsInf: true
• z2p5: NaN
• z1p0: NaN

Throws:

IllegalStateException - if any other builder method has already been called without first calling build()

set

public GmmInput.Builder set(GmmInput.Field id,
                            String s)

Set a field in this builder. String values are converted to the appropriate class required by the field.

Parameters:

id - of the field to set

s - string value that will be converted to appropriate class

mag

public GmmInput.Builder mag(double Mw)

Set the moment magnitude.

rJB

public GmmInput.Builder rJB(double rJB)

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

rRup

public GmmInput.Builder rRup(double rRup)

Set the rupture distance (distance to rupture plane).

rX

public GmmInput.Builder rX(double rX)

Set the distance X (shortest distance to extended strike of rupture).

distances

public GmmInput.Builder distances(double rJB,
                                  double rRup,
                                  double rX)

Set the Joyner-Boore distance, rupture distance, and distance X.

distances

public GmmInput.Builder distances(Distance distances)

Set the Joyner-Boore distance, rupture distance, and distance X with a Distance object.

dip

public GmmInput.Builder dip(double dip)

Set the rupture dip.

width

public GmmInput.Builder width(double width)

Set the rupture width.

zTop

public GmmInput.Builder zTop(double zTop)

Set the depth to top of rupture.

zHyp

public GmmInput.Builder zHyp(double zHyp)

Set the depth to rupture hypocenter.

rake

public GmmInput.Builder rake(double rake)

Set the rupture rake.

vs30

public GmmInput.Builder vs30(double vs30)

Set the vs30 at site.

vsInf

public GmmInput.Builder vsInf(boolean vsInf)

Set whether vs30 is inferred or measured.

vs30

public GmmInput.Builder vs30(double vs30,
                             boolean vsInf)

Set both the vs30 at site and whether vs30 is inferred or measured.

z1p0

public GmmInput.Builder z1p0(double z1p0)

Set the depth to 1.0 km/s (in km).

z2p5

public GmmInput.Builder z2p5(double z2p5)

Set the depth to 2.5 km/s (in km).

build

public GmmInput build()