diff --git a/src/main/java/gov/usgs/earthquake/nshmp/gmm/UsgsDampingScaling.java b/src/main/java/gov/usgs/earthquake/nshmp/gmm/UsgsDampingScaling.java index 66e8b5d87e555ff521b8845f10e466489a3231a0..46b1c79bc7fcf95c3b6466b84e65626872cbe528 100644 --- a/src/main/java/gov/usgs/earthquake/nshmp/gmm/UsgsDampingScaling.java +++ b/src/main/java/gov/usgs/earthquake/nshmp/gmm/UsgsDampingScaling.java @@ -79,13 +79,17 @@ public class UsgsDampingScaling { * TODO Disable subduction below 0.1s */ - /** The range of supported damping ratios: {@code [0.5..30]}. */ + /** The range of supported damping scaling factors: {@code [0.5..30]}. */ public static final Range<Double> DAMPING_RATIO_RANGE = Range.closed(0.05, 30.0); private static final String[] DSF_KEYS = { "0.5", "1", "2", "3", "5", "7", "10", "15", "20", "25", "30" }; - private static final List<Double> DSF_VALUES = Arrays.stream(DSF_KEYS) + /** + * The list of supported damping scaling factors (percentage values): + * {@code [0.5, 1, 2, 3, 5, 7, 10, 15, 20, 25, 30]}. + */ + public static final List<Double> DSF_VALUES = Arrays.stream(DSF_KEYS) .map(Double::valueOf) .collect(toList()); @@ -148,7 +152,7 @@ public class UsgsDampingScaling { return XySequence.create(DSF_VALUES, corrCoeffs); } - /** The set of IMTs supported by this class. */ + /** The set of IMTs supported by the damping models in this class. */ public static final Set<Imt> supportedImts() { return INSTANCE_MAP.get(ACTIVE_CRUST).coeffs.keySet(); }