org.opensha.sha.earthquake.rupForecastImpl
Class PointSourceERF

java.lang.Object
  org.opensha.sha.earthquake.AbstractERF
      org.opensha.sha.earthquake.rupForecastImpl.PointSourceERF

All Implemented Interfaces:

Serializable, Comparable<BaseERF>, Iterable<ProbEqkSource>, EventListener, Named, XMLSaveable, ParameterChangeListener, TimeSpanChangeListener, BaseERF, ERF

public class PointSourceERF
extends AbstractERF

Title: PointPoissonERF

Description: This ERF creates a single point source with a single rupture for the following user-defined parameters:

• magnitude
• Location (lat, lon, depth of point source)
• rake - the rake (in degrees) assigned to all ruptures.
• dip - the dip (in degrees) assigned to all rupture surfaces.
• probability - the probability of the rupture (timeSpan is null)

The source is non-Poissonain.

Version:

1.0

Author:

Ned Field Date : Sept., 2004

See Also:

Serialized Form

Field Summary

static String	DIP_PARAM_NAME
static String	MAG_PARAM_NAME
static String	NAME
static String	PROB_PARAM_NAME
static String	RAKE_PARAM_NAME
static String	SRC_DEPTH_PARAM_NAME
static String	SRC_LAT_PARAM_NAME
static String	SRC_LON_PARAM_NAME

Fields inherited from class org.opensha.sha.earthquake.AbstractERF

adjustableParams, parameterChangeFlag, timeSpan, XML_METADATA_NAME

Constructor Summary

PointSourceERF()
Constructor for this source (no arguments)

Method Summary

String	getName() Return the name for this class
int	getNumSources() Returns the number of earthquake sources (always "1" here)
ProbEqkSource	getSource(int iSource) Return the earhthquake source at index i.
ArrayList	getSourceList() This returns a list of sources (contains only one here)
void	updateForecast() update the source based on the paramters (only if a parameter value has changed)

Methods inherited from class org.opensha.sha.earthquake.AbstractERF

baseERF_FromXML, baseERF_ToXML, compareTo, drawRandomEventSet, fromXMLMetadata, getAdjustableParameterList, getApplicableRegion, getIncludedTectonicRegionTypes, getNumRuptures, getParameter, getRupture, getRuptureClone, getSourceClone, getTimeSpan, iterator, parameterChange, setParameter, setParameterChangeFlag, setTimeSpan, timeSpanChange, toXMLMetadata, updateAndSaveForecast

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final String NAME

See Also:

Constant Field Values

MAG_PARAM_NAME

public static final String MAG_PARAM_NAME

See Also:

Constant Field Values

PROB_PARAM_NAME

public static final String PROB_PARAM_NAME

See Also:

Constant Field Values

RAKE_PARAM_NAME

public static final String RAKE_PARAM_NAME

See Also:

Constant Field Values

DIP_PARAM_NAME

public static final String DIP_PARAM_NAME

See Also:

Constant Field Values

SRC_LAT_PARAM_NAME

public static final String SRC_LAT_PARAM_NAME

See Also:

Constant Field Values

SRC_LON_PARAM_NAME

public static final String SRC_LON_PARAM_NAME

See Also:

Constant Field Values

SRC_DEPTH_PARAM_NAME

public static final String SRC_DEPTH_PARAM_NAME

See Also:

Constant Field Values

Constructor Detail

PointSourceERF

public PointSourceERF()

Constructor for this source (no arguments)

Method Detail

updateForecast

public void updateForecast()

update the source based on the paramters (only if a parameter value has changed)

getSource

public ProbEqkSource getSource(int iSource)

Return the earhthquake source at index i. Note that this returns a pointer to the source held internally, so that if any parameters are changed, and this method is called again, the source obtained by any previous call to this method will no longer be valid.

Parameters:

iSource - : index of the desired source (only "0" allowed here).

Returns:

Returns the ProbEqkSource at index i

getNumSources

public int getNumSources()

Returns the number of earthquake sources (always "1" here)

Returns:

integer value specifying the number of earthquake sources

getSourceList

public ArrayList getSourceList()

This returns a list of sources (contains only one here)

Specified by:

getSourceList in interface ERF

Overrides:

getSourceList in class AbstractERF

Returns:

ArrayList of Prob Earthquake sources

getName

public String getName()

Return the name for this class

Returns:

: return the name for this class