gov.usgs.earthquake.nshmp.eq.model

Class SystemSourceSet

java.lang.Object

gov.usgs.earthquake.nshmp.eq.model.SystemSourceSet

All Implemented Interfaces:

SourceSet<SystemSourceSet.SystemSource>, Named, Comparable<SourceSet<SystemSourceSet.SystemSource>>, Iterable<SystemSourceSet.SystemSource>

public final class SystemSourceSet
extends Object

Wrapper class for related SystemSourceSet.SystemSources.

Author:

Peter Powers

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
SystemSourceSet.Statistics	stats

Method Summary

Modifier and Type	Method and Description
int	compareTo(SourceSet<T> other)
Predicate<SystemSourceSet.SystemSource>	distanceFilter(Location loc, double distance) Return a Predicate that evaluates to true if this source is within distance of the supplied Location.
GmmSet	groundMotionModels() Return the GroundMotionModels associated with this SourceSet as a GmmSet.
int	id() A unique integer id.
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<SystemSourceSet.SystemSource>	iterator()
String	name() Returns an object's display name.
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.
int	size() The number of Sources in this SourceSet.
static Function<SystemSourceSet,InputList>	toInputsFunction(Site site) Return an instance of a Function that converts a SystemSourceSet to a ground motion model InputList.
static Function<SystemSourceSet,IntervalArray>	toRatesFunction(Location location, double distance, IntervalArray modelMfd) Return an instance of a Function that converts a SystemSourceSet to a ground motion model InputList.
String	toString()
SourceType	type() The SourceType identifier.
double	weight() The weight applicable to this SourceSet.

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

Field Detail

stats

public final SystemSourceSet.Statistics stats

Method Detail

type

public SourceType type()

Description copied from interface: SourceSet

The SourceType identifier.

size

public int size()

Description copied from interface: SourceSet

The number of Sources in this SourceSet.

iterator

public Iterator<SystemSourceSet.SystemSource> iterator()

distanceFilter

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

Description copied from interface: SourceSet

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 deaggregation 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

toRatesFunction

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

Return an instance of a Function that converts a SystemSourceSet 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<SystemSourceSet,InputList> toInputsFunction(Site site)

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

Parameters:

site - with which to initialize instance.

compareTo

public int compareTo(SourceSet<T> other)

Specified by:

compareTo in interface Comparable<SourceSet<T extends Source>>

name

public String name()

Description copied from interface: Named

Returns an object's display name.

Specified by:

name in interface Named

Returns:

the name

toString

public String toString()

Overrides:

toString in class Object

id

public int id()

Description copied from interface: SourceSet

A unique integer id.

Specified by:

id in interface SourceSet<T extends Source>

weight

public double weight()

Description copied from interface: SourceSet

The weight applicable to this SourceSet.

Specified by:

weight in interface SourceSet<T extends Source>

groundMotionModels

public GmmSet groundMotionModels()

Description copied from interface: SourceSet

Return the GroundMotionModels associated with this SourceSet as a GmmSet.

Specified by:

groundMotionModels in interface SourceSet<T extends Source>

See Also:

GmmSet

iterableForLocation

public Iterable<T> iterableForLocation(Location loc)

Description copied from interface: SourceSet

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 SourceSet.

Specified by:

iterableForLocation in interface SourceSet<T extends Source>

Parameters:

loc - Location of interest

iterableForLocation

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

Description copied from interface: SourceSet

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

Specified by:

iterableForLocation in interface SourceSet<T extends Source>

Parameters:

loc - Location of interest

distance - limit