Site (nshmp-haz)

java.lang.Object
- gov.usgs.earthquake.nshmp.calc.Site

All Implemented Interfaces:

Named
```
public class Site
extends Object
implements Named
```
Site characteristics container. Take note of default values; the minimum information required to create a Site is its location. Not all GroundMotionModels will use all fields and additional fields may be added at any time in the future.
Terminology:
- Vs30: Average shear wave velocity down to a depth of 30 m, in units of m/s. This value may be inferred or measured (see vsInferred).
- z1.0: Depth to a shear wave velocity of 1.0 km/sec, in units of km.
- z2.5: Depth to a shear wave velocity of 2.5 km/sec, in units of km.
Both z1.0 and z2.5, collectively referred to as basin-terms, have default values of Double.NaN. When supplied with the default, those GroundMotionModels that support basin terms will use an author defined model, typically based on Vs30, to compute basin amplification (or demplification).
Note: If a CalcConfig.SiteData.basinDataProvider has been set, any non-null or non-NaN z1p0 or z2p5 values supplied by the provider take precedence over defaults or recent calls to the builder.
Author:

Peter Powers

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Site.Builder
A reusable Site builder.

Nested Classes
Modifier and Type	Class and Description
`static class`	`Site.Builder` A reusable `Site` builder.

Field Summary

Fields
Modifier and Type	Field and Description
`static Set<String>`	`KEYS`
`Location`	`location` The location of this site.
`String`	`name` The site name.
`static String`	`NO_NAME` The name used for a `Site` with no supplied name.
`static double`	`VS_30_DEFAULT` Default `vs30` value: `760 m/s`.
`static boolean`	`VS_INF_DEFAULT` Default `vsInferred` inferred value: `true`.
`double`	`vs30` The average shear-wave velocity down to 30 meters depth.
`static Range<Double>`	`VS30_RANGE` Supported `vs30` values: `[150..2000] m/s`.
`boolean`	`vsInferred` Whether Vs30 was inferred, `true`, or measured, `false`.
`double`	`z1p0` Depth to the shear-wave velocity horizon of 1.0 km/s, in km.
`static double`	`Z1P0_DEFAULT` Default `z1p0` value: `NaN` (`GroundMotionModel`s will use a default value or model)
`static Range<Double>`	`Z1P0_RANGE` Supported `z1p0` values: `[0..5] km`.
`double`	`z2p5` Depth to the shear-wave velocity horizon of 2.5 km/s, in km.
`static double`	`Z2P5_DEFAULT` Default `z2p5` value: `NaN` (`GroundMotionModel`s will use a default value or model)
`static Range<Double>`	`Z2P5_RANGE` Supported `z2p5` values: `[0..10] km`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static Site.Builder`	`builder()` Return a fresh `Site.Builder`.
`String`	`name()` Returns an object's display name.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - NO_NAME
```
public static final String NO_NAME
```
    The name used for a Site with no supplied name.
    
    See Also:
    
    Constant Field Values
  - VS_30_DEFAULT
```
public static final double VS_30_DEFAULT
```
    Default vs30 value: 760 m/s.
    
    See Also:
    
    Constant Field Values
  - VS30_RANGE
```
public static final Range<Double> VS30_RANGE
```
    Supported vs30 values: [150..2000] m/s.
  - VS_INF_DEFAULT
```
public static final boolean VS_INF_DEFAULT
```
    Default vsInferred inferred value: true.
    
    See Also:
    
    Constant Field Values
  - Z1P0_DEFAULT
```
public static final double Z1P0_DEFAULT
```
    Default z1p0 value: NaN
    (GroundMotionModels will use a default value or model)
    
    See Also:
    
    Constant Field Values
  - Z1P0_RANGE
```
public static final Range<Double> Z1P0_RANGE
```
    Supported z1p0 values: [0..5] km.
  - Z2P5_DEFAULT
```
public static final double Z2P5_DEFAULT
```
    Default z2p5 value: NaN
    (GroundMotionModels will use a default value or model)
    
    See Also:
    
    Constant Field Values
  - Z2P5_RANGE
```
public static final Range<Double> Z2P5_RANGE
```
    Supported z2p5 values: [0..10] km.
  - name
```
public final String name
```
    The site name.
  - location
```
public final Location location
```
    The location of this site. This is the only field that must be explicitely set in a Site.Builder.
  - vs30
```
public final double vs30
```
    The average shear-wave velocity down to 30 meters depth.
    Default: 760.0 m/s
  - vsInferred
```
public final boolean vsInferred
```
    Whether Vs30 was inferred, true, or measured, false.
    Default: true (inferred)
  - z1p0
```
public final double z1p0
```
    Depth to the shear-wave velocity horizon of 1.0 km/s, in km.
    Default: NaN
    (GroundMotionModels will use a default value or model)
  - z2p5
```
public final double z2p5
```
    Depth to the shear-wave velocity horizon of 2.5 km/s, in km.
    Default: NaN
    (GroundMotionModels will use a default value or model)
  - KEYS
```
public static final Set<String> KEYS
```
- Method Detail
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - name
```
public String name()
```
    Description copied from interface: Named
    
    Returns an object's display name.
    
    Specified by:
    
    name in interface Named
    
    Returns:
    
    the name
  - builder
```
public static Site.Builder builder()
```
    Return a fresh Site.Builder.

Class Site

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NO_NAME

VS_30_DEFAULT

VS30_RANGE

VS_INF_DEFAULT

Z1P0_DEFAULT

Z1P0_RANGE

Z2P5_DEFAULT

Z2P5_RANGE

name

location

vs30

vsInferred

z1p0

z2p5

KEYS

Method Detail

toString

name

builder