Package gov.usgs.earthquake.nshmp.model

Class SystemRuptureSet

java.lang.Object

gov.usgs.earthquake.nshmp.model.IterableRuptureSet

gov.usgs.earthquake.nshmp.model.SystemRuptureSet

All Implemented Interfaces:

RuptureSet, Iterable<Rupture>

public class SystemRuptureSet
extends IterableRuptureSet

Fault-system rupture set. May be used fro crustal faults or subduction interface.

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 rupture set.
class	SystemRuptureSet.SystemRupture	A single rupture in a fault system.

Field Summary

Fields

Modifier and Type	Field	Description
SystemRuptureSet.Statistics	stats

Method Summary

Modifier and Type	Method	Description
boolean	checkDistance(Location site, double distance)	Return true if this rupture set is within the supplied distance from a location, false otherwise.
boolean	equals(Object obj)
List<Feature>	features()	The GeoJSON features for this rupture set.
Rupture	get(int index)	Return the rupture at the specified index.
GmmTree	gmmTree()	Return the ground motion model logic tree associated with this Rupture Set.
int	hashCode()
int	id()	The numeric ID of this rupture set.
Iterator<Rupture>	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 of this rupture set.
int	size()	The number of ruptures in this rupture set.
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 gov.usgs.earthquake.nshmp.model.IterableRuptureSet

checkDistance

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

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()

Description copied from class: IterableRuptureSet

The number of ruptures in this rupture set.

Specified by:

size in interface RuptureSet

Specified by:

size in class IterableRuptureSet

get

public Rupture get(int index)

Description copied from class: IterableRuptureSet

Return the rupture at the specified index.

Specified by:

get in class IterableRuptureSet

Parameters:

index - of the rupture to retrieve.

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()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

iterator

public Iterator<Rupture> iterator()

checkDistance

public boolean checkDistance(Location site,
                             double distance)

Description copied from class: IterableRuptureSet

Return true if this rupture set is within the supplied distance from a location, false otherwise.

Specified by:

checkDistance in class IterableRuptureSet

Parameters:

site - of interest

distance - to check

section

public GriddedSurface section(int index)

The fault section surface corresponding to the supplied index.

This method exists because system rupture 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

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