gov.usgs.earthquake.nshmp.eq.model

Class AreaSource

java.lang.Object

gov.usgs.earthquake.nshmp.eq.model.AreaSource

All Implemented Interfaces:

Source, Named, Iterable<Rupture>

public class AreaSource
extends Object
implements Source

Area source representation. An AreaSource represents a region over which there is a equal likelihood of earthquake occurrence, as specified by a single IncrementalMfd.

Internally, an AreaSource distributes ruptures over a grid of point Sources; the resolution of the grid may scale with distance from a site according to the assigned AreaSource.GridScaling. An AreaSource therefore supplies an iterableForLocation(Location). If no location-dependent scaling is specified, this custom Iterable's iterator() behaves the same as the built-in iterator(). If the specified scaling is location-dependent, the standard iterator() returns ruptures derived from 0.1° spaced sources.

Author:

Peter Powers

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AreaSource.GridScaling Point source discretization scaling.

Method Summary

Modifier and Type	Method and Description
LocationList	border() Return the border of this AreaSource.
int	id() A numeric identifier for this Source.
Iterable<Rupture>	iterableForLocation(Location loc) Return a Rupture iterator over distributed point Sources whose spacing is a function of the distance from the supplied Location.
Iterator<Rupture>	iterator() For non-uniform GridScaling, this iterator returns ruptures derived from 0.1° spaced sources.
Location	location(Location site) The centroid of this source.
List<XySequence>	mfds() The MFDs that define earthquake rates for this source.
String	name() Returns an object's display name.
int	size() The number of Ruptures for an AreaSource will vary if GridScaling is non-uniform.
SourceType	type() The SourceType identifier.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

name

public String name()

Description copied from interface: Named

Returns an object's display name.

Specified by:

name in interface Named

Returns:

the name

size

public int size()

The number of Ruptures for an AreaSource will vary if GridScaling is non-uniform. In such cases, this method returns the number of ruptures that would be expected from 0.1° spaced point sources.

Specified by:

size in interface Source

id

public int id()

Description copied from interface: Source

A numeric identifier for this Source.

Specified by:

id in interface Source

type

public SourceType type()

Description copied from interface: Source

The SourceType identifier.

Specified by:

type in interface Source

location

public Location location(Location site)

The centroid of this source. This method always returns the same value, ignoring the supplied site Location.

Specified by:

location in interface Source

mfds

public List<XySequence> mfds()

Description copied from interface: Source

The MFDs that define earthquake rates for this source.

Specified by:

mfds in interface Source

border

public LocationList border()

Return the border of this AreaSource.

iterator

public Iterator<Rupture> iterator()

For non-uniform GridScaling, this iterator returns ruptures derived from 0.1° spaced sources.

Specified by:

iterator in interface Iterable<Rupture>

iterableForLocation

public Iterable<Rupture> iterableForLocation(Location loc)

Return a Rupture iterator over distributed point Sources whose spacing is a function of the distance from the supplied Location.

Parameters:

loc - Location of interest