Merge pull request #432 from pmpowers-usgs/basin-cleanup-javadoc

docs and cleanup

Author: pmpowers-usgs

src/gov/usgs/earthquake/nshmp/gmm/AbrahamsonEtAl_2014.java

@@ -45,7 +45,7 @@
  *
  * @author Peter Powers
  * @see Gmm#ASK_14
- * @see Gmm#ASK_14_BASIN_AMP
+ * @see Gmm#ASK_14_BASIN
  */
 public class AbrahamsonEtAl_2014 implements GroundMotionModel {
 

src/gov/usgs/earthquake/nshmp/gmm/AtkinsonMacias_2009.java

@@ -64,7 +64,7 @@
  *
  * @author Peter Powers
  * @see Gmm#AM_09_INTERFACE
- * @see Gmm#AM_09_INTERFACE_BASIN_AMP
+ * @see Gmm#AM_09_INTERFACE_BASIN
  */
 public class AtkinsonMacias_2009 implements GroundMotionModel {
 
@@ -147,10 +147,7 @@ public final ScalarGroundMotion calc(final GmmInput in) {
     double site = siteAmp.siteAmp(μPga, in.vs30);
     double μAm = μRef + site;
 
-    /*
-     * Add CB14 deep basin amplification term if (1) z2p5 is non-NaN, (2) this
-     * instance is basin amplifying and (3) T>0.5s (handled in CB14)
-     */
+    /* Add (possibly depth-tapered) CB14 deep basin term. */
     if (deepBasinEffect()) {
       μAm += cb14.deepBasinScaling(in.z2p5);
     }

src/gov/usgs/earthquake/nshmp/gmm/BcHydro_2012.java

@@ -79,8 +79,8 @@
  * @author Peter Powers
  * @see Gmm#BCHYDRO_12_INTERFACE
  * @see Gmm#BCHYDRO_12_SLAB
- * @see Gmm#BCHYDRO_12_INTERFACE_BASIN_AMP
- * @see Gmm#BCHYDRO_12_SLAB_BASIN_AMP
+ * @see Gmm#BCHYDRO_12_INTERFACE_BASIN
+ * @see Gmm#BCHYDRO_12_SLAB_BASIN
  */
 public abstract class BcHydro_2012 implements GroundMotionModel {
 
@@ -165,10 +165,7 @@ public final ScalarGroundMotion calc(final GmmInput in) {
     double pgaRock = exp(calcMean(coeffsPGA, isSlab(), 0.0, in.Mw, in.rRup, in.zTop, VS30_ROCK));
     double μAsk = calcMean(coeffs, isSlab(), pgaRock, in.Mw, in.rRup, in.zTop, in.vs30);
 
-    /*
-     * Add CB14 deep basin amplification term if (1) z2p5 is non-NaN, (2) this
-     * instance is basin amplifying and (3) T>0.5s (handled in CB14)
-     */
+    /* Add (possibly depth-tapered) CB14 deep basin term. */
     if (deepBasinEffect()) {
       μAsk += cb14.deepBasinScaling(in.z2p5);
     }

src/gov/usgs/earthquake/nshmp/gmm/BooreEtAl_2014.java

@@ -236,13 +236,7 @@ private static final double calcDeltaZ1(
 
     double vsPow4 = vs30 * vs30 * vs30 * vs30;
     double z1ref = exp(-7.15 / 4.0 * log((vsPow4 + A) / B)) / 1000.0;
-    double Δz1 = z1p0 - z1ref;
-
-    // if (basinAmpOnly) {
-    // double Δz1scale = GmmUtils.deltaZ1scale(imt, z1p0);
-    // return Δz1 * Δz1scale;
-    // }
-    return Δz1;
+    return z1p0 - z1ref;
   }
 
   // Aleatory uncertainty model

src/gov/usgs/earthquake/nshmp/gmm/CampbellBozorgnia_2014.java

@@ -179,7 +179,7 @@ private static ScalarGroundMotion calc(
   }
 
   /*
-   * Return the CB14 basin amplification term for deep basins. If z2.5 > 3km,
+   * Return the CB14 basin term for deep basins. If z2.5 > 3km,
    * returns full scaling term; tapers to 0 weight at 1km. Only returns non-zero
    * value at long periods T > 0.5s (blending 0.75s using log T scaling of
    * 0.585)
@@ -335,7 +335,6 @@ private static double basinResponseTerm(
         return zRefTerm;
       }
     }
-
     return z2p5Term;
   }
 

src/gov/usgs/earthquake/nshmp/gmm/ZhaoEtAl_2006.java

@@ -84,8 +84,8 @@
  * @author Peter Powers
  * @see Gmm#ZHAO_06_INTERFACE
  * @see Gmm#ZHAO_06_SLAB
- * @see Gmm#ZHAO_06_INTERFACE_BASIN_AMP
- * @see Gmm#ZHAO_06_SLAB_BASIN_AMP
+ * @see Gmm#ZHAO_06_INTERFACE_BASIN
+ * @see Gmm#ZHAO_06_SLAB_BASIN
  */
 public abstract class ZhaoEtAl_2006 implements GroundMotionModel {
 
@@ -219,10 +219,7 @@ public final ScalarGroundMotion calc(GmmInput in) {
     double zSiteVs30 = siteTermStep(coeffs, in.vs30);
     double μZhao = calcMean(coeffs, isSlab(), zSiteVs30, in);
 
-    /*
-     * Add CB14 deep basin amplification term if (1) z2p5 is non-NaN, (2) this
-     * instance is basin amplifying and (3) T>0.5s (handled in CB14)
-     */
+    /* Add (possibly depth-tapered) CB14 deep basin term. */
     if (basinEffect()) {
       μZhao += cb14.deepBasinScaling(in.z2p5);
     }