gov.usgs.earthquake.nshmp.calc

Class HazardCalcs

java.lang.Object

gov.usgs.earthquake.nshmp.calc.HazardCalcs

public class HazardCalcs
extends Object

Static probabilistic seismic hazard analysis calculators.

Author:

Peter Powers

Constructor Summary

Constructors

Constructor and Description
HazardCalcs()

Method Summary

Modifier and Type	Method and Description
static Deaggregation	deaggIml(Hazard hazard, double iml, Executor exec) Deaggregate probabilistic seismic hazard at the supplied intensity measure level (in units of g).
static Deaggregation	deaggReturnPeriod(Hazard hazard, double returnPeriod, Executor exec) Deaggregate probabilistic seismic hazard at the supplied return period (in years).
static Hazard	hazard(HazardModel model, CalcConfig config, Site site, Executor exec) Compute probabilistic seismic hazard curves at a site using the supplied model and config.
static Function<Source,InputList>	sourceToInputs(Site site) Return a Function that converts a Source along with an initially supplied Site to a list of ground motion model inputs.

Methods inherited from class java.lang.Object

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

Constructor Detail

HazardCalcs

public HazardCalcs()

Method Detail

sourceToInputs

public static Function<Source,InputList> sourceToInputs(Site site)

Return a Function that converts a Source along with an initially supplied Site to a list of ground motion model inputs.

Parameters:

site - to initialize function with

See Also:

InputList

deaggReturnPeriod

public static Deaggregation deaggReturnPeriod(Hazard hazard,
                                              double returnPeriod,
                                              Executor exec)

Deaggregate probabilistic seismic hazard at the supplied return period (in years). Deaggregation will performed for all IMTs specified for hazard.

Call this method with the Hazard result of hazard(HazardModel, CalcConfig, Site, Executor) to which you supply the calculation settings and sites of interest that will also be used for deaggregation.

Note: any model initialization settings in config will be ignored as the supplied model will already have been initialized.

Parameters:

hazard - to deaggregate

returnPeriod - at which to deaggregate (in years)

Returns:

a Deaggregation object

deaggIml

public static Deaggregation deaggIml(Hazard hazard,
                                     double iml,
                                     Executor exec)

Deaggregate probabilistic seismic hazard at the supplied intensity measure level (in units of g). Deaggregation will performed for all IMTs specified for hazard.

Call this method with the Hazard result of hazard(HazardModel, CalcConfig, Site, Executor) to which you supply the calculation settings and sites of interest that will also be used for deaggregation.

Note: any model initialization settings in config will be ignored as the supplied model will already have been initialized.

Parameters:

hazard - to deaggregate

iml - intensity measure level at which to deaggregate (in g)

imt - an optional (single) IMT at which to deaggregate

Returns:

a Deaggregation object

hazard

public static Hazard hazard(HazardModel model,
                            CalcConfig config,
                            Site site,
                            Executor exec)

Compute probabilistic seismic hazard curves at a site using the supplied model and config. If an executor is supplied,the calculation will be distributed; otherwise, it will run on the current thread. Be sure to shutdown any supplied executor after a calculation completes.

Note: any model initialization settings in config will be ignored as the supplied model will already have been initialized.

Parameters:

model - to use

config - calculation configuration

site - of interest

exec - optional Executor to distribute calculation