Package gov.usgs.earthquake.nshmp.model

Class GriddedRuptureSet

java.lang.Object

gov.usgs.earthquake.nshmp.model.GriddedRuptureSet

All Implemented Interfaces:

RuptureSet, Iterable<GridSource>

Direct Known Subclasses:

GridRuptureSet

public abstract class GriddedRuptureSet
extends Object
implements Iterable<GridSource>

Base implementation for gridded rupture sets. Although most implementations in USGS NSHMs to date are uniformely spaced in latitude and longitude, this class makes no requirement that they be.

Author:

U.S. Geological Survey

Method Summary

Modifier and Type	Method	Description
abstract GridSource	getNode(int index)	Get the grid source at the specified node.
GmmTree	gmmTree()	Return the ground motion model logic tree associated with this Rupture Set.
int	id()	The numeric ID of this rupture set.
Iterator<GridSource>	iterator()
abstract List<Location>	locations()	The list of grid node locations in this rupture set.
String	name()	The display name of the rupture set.
TectonicSetting	setting()	The TectonicSetting of this rupture set.
Iterable<GridSource>	siteIterable(Location site)	Returns an iterable over the grid sources within the cuttoff distance from a site.
Iterable<GridSource>	siteIterable(Location site, double distance)	Returns an iterable over the grid sources within the specified distance from a site.
int	size()	The number of grid nodes in this rupture set.
String	toString()
SourceType	type()	The SourceType identifier.
double	weight()	The weight of the SourceTree branch to which this rupture set is attached.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface gov.usgs.earthquake.nshmp.model.RuptureSet

features, location, mfdTree, totalMfd

Method Detail

size

public int size()

The number of grid nodes in this rupture set.

Specified by:

size in interface RuptureSet

locations

public abstract List<Location> locations()

The list of grid node locations in this rupture set.

getNode

public abstract GridSource getNode(int index)

Get the grid source at the specified node.

Parameters:

index - of the node to retrieve

iterator

public Iterator<GridSource> iterator()

Specified by:

iterator in interface Iterable<GridSource>

siteIterable

public Iterable<GridSource> siteIterable(Location site)

Returns an iterable over the grid sources within the cuttoff distance from a site. The cutoff distance is derived from the GroundMotionModels associated with this rupture set.

Parameters:

site - of interest

See Also:

RuptureSet.gmmTree()

siteIterable

public Iterable<GridSource> siteIterable(Location site,
                                         double distance)

Returns an iterable over the grid sources within the specified distance from a site.

Parameters:

site - of interest

distance - from the site within which grid sources are returned by this iterator

name

public String name()

Description copied from interface: RuptureSet

The display name of the rupture set.

Specified by:

name in interface RuptureSet

id

public int id()

Description copied from interface: RuptureSet

The numeric ID of this rupture set.

Specified by:

id in interface RuptureSet

setting

public TectonicSetting setting()

Description copied from interface: RuptureSet

The TectonicSetting of this rupture set.

Specified by:

setting in interface RuptureSet

type

public SourceType type()

Description copied from interface: RuptureSet

The SourceType identifier.

Specified by:

type in interface RuptureSet

gmmTree

public GmmTree gmmTree()

Description copied from interface: RuptureSet

Return the ground motion model logic tree associated with this Rupture Set.

Specified by:

gmmTree in interface RuptureSet

weight

public double weight()

Description copied from interface: RuptureSet

The weight of the SourceTree branch to which this rupture set is attached.

Specified by:

weight in interface RuptureSet

toString

public String toString()

Overrides:

toString in class Object