org.opensha.sha.imr
Class PropagationEffect

java.lang.Object
  extended by org.opensha.sha.imr.PropagationEffect
All Implemented Interfaces:
Serializable, EventListener, ParameterChangeListener

Deprecated.

@Deprecated
public class PropagationEffect
extends Object
implements Serializable, ParameterChangeListener

Title: PropagationEffect

Description:

Version:
1.0
Author:
Ned Field
See Also:
Serialized Form

Field Summary
protected  ParameterList adjustableParams
          Deprecated.  
static String APPROX_DIST_PARAM_NAME
          Deprecated.  
protected  boolean DISTANCE_X_STALE
          Deprecated.  
protected  double distanceJB
          Deprecated. this distance measure for the DistanceJBParameter
protected  double distanceRup
          Deprecated. this distance measure for the DistanceRupParameter
protected  double distanceSeis
          Deprecated. this distance measure for the DistanceSeisParameter
protected  double distanceX
          Deprecated. this distance measure for the DistanceX_Parameter
protected  DistanceX_Parameter distanceX_Parameter
          Deprecated.  
protected  EqkRupture eqkRupture
          Deprecated. The EqkRupture used for calculating the PropagationEffect parameter values.
protected  boolean fix_dist_JB
          Deprecated.  
static String NSHMP_PT_SRC_CORR_PARAM_NAME
          Deprecated.  
static String POINT_SRC_CORR_PARAM_NAME
          Deprecated.  
protected  Site site
          Deprecated. The Site used for calculating the PropagationEffect parameter values.
protected  boolean STALE
          Deprecated.  
 
Constructor Summary
PropagationEffect()
          Deprecated. No Argument consructor
PropagationEffect(Site site, EqkRupture eqkRupture)
          Deprecated. Constructor that is give Site and EqkRupture objects
 
Method Summary
 void fixDistanceJB(boolean fixIt)
          Deprecated. Setting this as true will change the calculated distanceJB value to 0.0 if it's less than half the distance between diagonally neighboring points on the rupture surface (otherwise it's never exactly zero everywhere above the entire surface).
 ParameterList getAdjustableParameterList()
          Deprecated.  
 ListIterator getAdjustableParamsIterator()
          Deprecated. get the adjustable parameters
 double getDistanceJB()
          Deprecated. This returns distance JB (shortest horz distance to surface projection of rupture)
 double getDistanceRup()
          Deprecated. This returns rupture distance
 double getDistanceSeis()
          Deprecated. This returns distance seis
 double getDistanceX()
          Deprecated. This returns distance X (see DistanceX_Parameter)
 EqkRupture getEqkRupture()
          Deprecated. Returns the EqkRupture object
 Object getParamValue(String paramName)
          Deprecated. This returns the value for the parameter-name given
 Site getSite()
          Deprecated. Returns the Site object
 boolean isParamSupported(Parameter param)
          Deprecated.  
 boolean isParamSupported(String paramName)
          Deprecated.  
 void parameterChange(ParameterChangeEvent event)
          Deprecated. Function that must be implemented by all Listeners for ParameterChangeEvents.
 void setAll(EqkRupture eqkRupture, Site site)
          Deprecated. Sets both the EqkRupture and Site object
 void setEqkRupture(EqkRupture eqkRupture)
          Deprecated. Sets the EqkRupture object
 void setParamValue(Parameter param)
          Deprecated. This sets the value of the passed in parameter with that computed internally.
 void setSite(Site site)
          Deprecated. Sets the Site object
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

APPROX_DIST_PARAM_NAME

public static final String APPROX_DIST_PARAM_NAME
Deprecated. 
See Also:
Constant Field Values

POINT_SRC_CORR_PARAM_NAME

public static final String POINT_SRC_CORR_PARAM_NAME
Deprecated. 
See Also:
Constant Field Values

NSHMP_PT_SRC_CORR_PARAM_NAME

public static final String NSHMP_PT_SRC_CORR_PARAM_NAME
Deprecated. 
See Also:
Constant Field Values

adjustableParams

protected ParameterList adjustableParams
Deprecated. 

site

protected Site site
Deprecated. 
The Site used for calculating the PropagationEffect parameter values.


eqkRupture

protected EqkRupture eqkRupture
Deprecated. 
The EqkRupture used for calculating the PropagationEffect parameter values.


distanceRup

protected double distanceRup
Deprecated. 
this distance measure for the DistanceRupParameter


distanceJB

protected double distanceJB
Deprecated. 
this distance measure for the DistanceJBParameter


fix_dist_JB

protected boolean fix_dist_JB
Deprecated. 

distanceSeis

protected double distanceSeis
Deprecated. 
this distance measure for the DistanceSeisParameter


distanceX

protected double distanceX
Deprecated. 
this distance measure for the DistanceX_Parameter


distanceX_Parameter

protected DistanceX_Parameter distanceX_Parameter
Deprecated. 

STALE

protected boolean STALE
Deprecated. 

DISTANCE_X_STALE

protected boolean DISTANCE_X_STALE
Deprecated. 
Constructor Detail

PropagationEffect

public PropagationEffect()
Deprecated. 
No Argument consructor


PropagationEffect

public PropagationEffect(Site site,
                         EqkRupture eqkRupture)
Deprecated. 
Constructor that is give Site and EqkRupture objects

Method Detail

getSite

public Site getSite()
Deprecated. 
Returns the Site object


getEqkRupture

public EqkRupture getEqkRupture()
Deprecated. 
Returns the EqkRupture object


setSite

public void setSite(Site site)
Deprecated. 
Sets the Site object


fixDistanceJB

public void fixDistanceJB(boolean fixIt)
Deprecated. 
Setting this as true will change the calculated distanceJB value to 0.0 if it's less than half the distance between diagonally neighboring points on the rupture surface (otherwise it's never exactly zero everywhere above the entire surface). This is useful where differences between 0.0 and 0.5 km are important. The default value is false.

Parameters:
fixIt -

setEqkRupture

public void setEqkRupture(EqkRupture eqkRupture)
Deprecated. 
Sets the EqkRupture object


setAll

public void setAll(EqkRupture eqkRupture,
                   Site site)
Deprecated. 
Sets both the EqkRupture and Site object


getParamValue

public Object getParamValue(String paramName)
Deprecated. 
This returns the value for the parameter-name given


getDistanceRup

public double getDistanceRup()
Deprecated. 
This returns rupture distance

Returns:

getDistanceJB

public double getDistanceJB()
Deprecated. 
This returns distance JB (shortest horz distance to surface projection of rupture)

Returns:

getDistanceSeis

public double getDistanceSeis()
Deprecated. 
This returns distance seis

Returns:

getDistanceX

public double getDistanceX()
Deprecated. 
This returns distance X (see DistanceX_Parameter)

Returns:

setParamValue

public void setParamValue(Parameter param)
Deprecated. 
This sets the value of the passed in parameter with that computed internally. This ignores warnings exceptions.


isParamSupported

public boolean isParamSupported(String paramName)
Deprecated. 
Parameters:
paramName -
Returns:

isParamSupported

public boolean isParamSupported(Parameter param)
Deprecated. 
Parameters:
param -
Returns:

parameterChange

public void parameterChange(ParameterChangeEvent event)
Deprecated. 
Description copied from interface: ParameterChangeListener
Function that must be implemented by all Listeners for ParameterChangeEvents.

Specified by:
parameterChange in interface ParameterChangeListener
Parameters:
event - The Event which triggered this function call

getAdjustableParameterList

public ParameterList getAdjustableParameterList()
Deprecated. 
Returns:
the adjustable ParameterList

getAdjustableParamsIterator

public ListIterator getAdjustableParamsIterator()
Deprecated. 
get the adjustable parameters

Returns: