Package gov.usgs.earthquake.nshmp.model

Class SystemRuptureSet

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<T>

gov.usgs.earthquake.nshmp.model.SystemRuptureSet

All Implemented Interfaces:

RuptureSet<SystemRuptureSet.SystemSource>, Iterable<SystemRuptureSet.SystemSource>, Collection<SystemRuptureSet.SystemSource>, List<SystemRuptureSet.SystemSource>

public class SystemRuptureSet
extends AbstractList<T>

Crustal fault-system rupture set.

Author:

U.S. Geological Survey

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SystemRuptureSet.Statistics	Container of summary data for this sytem source set.
class	SystemRuptureSet.SystemSource	A single source in a fault system.

Field Summary

Fields

Modifier and Type	Field	Description
SystemRuptureSet.Statistics	stats

Fields inherited from class java.util.AbstractList

modCount

Method Summary

Modifier and Type	Method	Description
Predicate<SystemRuptureSet.SystemSource>	distanceFilter(Location loc, double distance)	Return a Predicate that evaluates to true if this source is within distance of the supplied Location.
boolean	equals(Object obj)
List<Feature>	features()	The GeoJSON features for this rupture set.
SystemRuptureSet.SystemSource	get(int index)
GmmTree	gmmTree()	Return the ground motion model logic tree associated with this RuptureSet.
int	hashCode()
int	id()	The numeric ID of this rupture set.
Iterable<T>	iterableForLocation(Location loc)	Return an Iterable over those Sources that are within the cutoff distance of the supplied Location.
Iterable<T>	iterableForLocation(Location loc, double distance)	Return an Iterable over those Sources that are within distance of the supplied Location.
Iterator<SystemRuptureSet.SystemSource>	iterator()
Location	location(Location site)	The closest point on the fault trace, relative to the supplied site Location.
LogicTree<Mfd>	mfdTree()	The logic tree of MFDs in this rupture set.
String	name()	The display name of the rupture set.
GriddedSurface	section(int index)	The fault section surface corresponding to the supplied index.
String	sectionName(int index)	The name of the fault section corresponding to the supplied index.
TectonicSetting	setting()	The TectonicSetting identifier.
int	size()
static Function<SystemRuptureSet,InputList>	toInputsFunction(Site site)	Return an instance of a Function that converts a SystemRuptureSet to a ground motion model InputList.
static Function<SystemRuptureSet,IntervalArray>	toRatesFunction(Location location, double distance, IntervalArray modelMfd)	Return an instance of a Function that converts a SystemRuptureSet to a ground motion model InputList.
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.util.AbstractList

add, add, addAll, clear, indexOf, lastIndexOf, listIterator, listIterator, remove, removeRange, set, subList

Methods inherited from class java.util.AbstractCollection

addAll, contains, containsAll, isEmpty, remove, removeAll, retainAll, toArray, toArray

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.List

add, add, addAll, addAll, clear, contains, containsAll, indexOf, isEmpty, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, replaceAll, retainAll, set, sort, spliterator, subList, toArray, toArray

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

totalMfd

Field Detail

stats

public final SystemRuptureSet.Statistics stats

Method Detail

size

public int size()

Specified by:

size in interface Collection<SystemRuptureSet.SystemSource>

Specified by:

size in interface List<SystemRuptureSet.SystemSource>

Specified by:

size in class AbstractCollection<SystemRuptureSet.SystemSource>

get

public SystemRuptureSet.SystemSource get(int index)

Specified by:

get in interface List<SystemRuptureSet.SystemSource>

Specified by:

get in class AbstractList<SystemRuptureSet.SystemSource>

features

public List<Feature> features()

Description copied from interface: RuptureSet

The GeoJSON features for this rupture set. In many cases only a single Feature will be returned.

mfdTree

public LogicTree<Mfd> mfdTree()

Description copied from interface: RuptureSet

The logic tree of MFDs in this rupture set.

hashCode

public int hashCode()

Specified by:

hashCode in interface Collection<SystemRuptureSet.SystemSource>

Specified by:

hashCode in interface List<SystemRuptureSet.SystemSource>

Overrides:

hashCode in class AbstractList<SystemRuptureSet.SystemSource>

equals

public boolean equals(Object obj)

Specified by:

equals in interface Collection<SystemRuptureSet.SystemSource>

Specified by:

equals in interface List<SystemRuptureSet.SystemSource>

Overrides:

equals in class AbstractList<SystemRuptureSet.SystemSource>

iterator

public Iterator<SystemRuptureSet.SystemSource> iterator()

Specified by:

iterator in interface Collection<SystemRuptureSet.SystemSource>

Specified by:

iterator in interface Iterable<SystemRuptureSet.SystemSource>

Specified by:

iterator in interface List<SystemRuptureSet.SystemSource>

Overrides:

iterator in class AbstractList<SystemRuptureSet.SystemSource>

distanceFilter

public Predicate<SystemRuptureSet.SystemSource> distanceFilter(Location loc,
                                                               double distance)

Description copied from interface: RuptureSet

Return a Predicate that evaluates to true if this source is within distance of the supplied Location. This Predicate performs a quick distance calculation and is used to determine whether this source should be included in a hazard calculation.

Parameters:

loc - Location of interest

distance - limit

section

public GriddedSurface section(int index)

The fault section surface corresponding to the supplied index.

This method exists because system source sets are complex and commonly encapsulate 100K+ sources. The results of a hazard calculation and disaggregation are therefore better represented in the context of individual fault sections, rather than on a per-source basis.

Parameters:

index - of fault section surface to retrieve

sectionName

public String sectionName(int index)

The name of the fault section corresponding to the supplied index.

Parameters:

index - of fault section name to retrieve

location

public Location location(Location site)

The closest point on the fault trace, relative to the supplied site Location.

toRatesFunction

public static Function<SystemRuptureSet,IntervalArray> toRatesFunction(Location location,
                                                                             double distance,
                                                                             IntervalArray modelMfd)

Return an instance of a Function that converts a SystemRuptureSet to a ground motion model InputList.

Parameters:

location - with which to initialize instance.

distance - if interest (relevant source radius)

modelMfd - MFD to populate

toInputsFunction

public static Function<SystemRuptureSet,InputList> toInputsFunction(Site site)

Return an instance of a Function that converts a SystemRuptureSet to a ground motion model InputList.

Parameters:

site - with which to initialize instance.

name

public String name()

Description copied from interface: RuptureSet

The display name of the rupture set.

Specified by:

name in interface RuptureSet<T extends Source>

id

public int id()

Description copied from interface: RuptureSet

The numeric ID of this rupture set.

Specified by:

id in interface RuptureSet<T extends Source>

setting

public TectonicSetting setting()

Description copied from interface: RuptureSet

The TectonicSetting identifier.

Specified by:

setting in interface RuptureSet<T extends Source>

type

public SourceType type()

Description copied from interface: RuptureSet

The SourceType identifier.

Specified by:

type in interface RuptureSet<T extends Source>

gmmTree

public GmmTree gmmTree()

Description copied from interface: RuptureSet

Return the ground motion model logic tree associated with this RuptureSet.

Specified by:

gmmTree in interface RuptureSet<T extends Source>

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<T extends Source>

toString

public String toString()

Overrides:

toString in class AbstractCollection<T extends Source>

iterableForLocation

public Iterable<T> iterableForLocation(Location loc)

Description copied from interface: RuptureSet

Return an Iterable over those Sources that are within the cutoff distance of the supplied Location. The cutoff distance is derived from the GroundMotionModels associated with this RuptureSet.

Specified by:

iterableForLocation in interface RuptureSet<T extends Source>

Parameters:

loc - Location of interest

iterableForLocation

public Iterable<T> iterableForLocation(Location loc,
                                       double distance)

Description copied from interface: RuptureSet

Return an Iterable over those Sources that are within distance of the supplied Location.

Specified by:

iterableForLocation in interface RuptureSet<T extends Source>

Parameters:

loc - Location of interest

distance - limit