diff artifacts/src/main/java/org/dive4elements/river/artifacts/model/minfo/SedimentLoadCalculation.java @ 6948:d4108d6c4000

Cosmetics, docs.
author Felix Wolfsteller <felix.wolfsteller@intevation.de>
date Fri, 30 Aug 2013 09:47:15 +0200
parents 2119f13f95ab
children 40da4a6e2cfb
line wrap: on
line diff
--- a/artifacts/src/main/java/org/dive4elements/river/artifacts/model/minfo/SedimentLoadCalculation.java	Fri Aug 30 09:45:04 2013 +0200
+++ b/artifacts/src/main/java/org/dive4elements/river/artifacts/model/minfo/SedimentLoadCalculation.java	Fri Aug 30 09:47:15 2013 +0200
@@ -125,6 +125,9 @@
         return null;
     }
 
+    /**
+     * @param[out] resLoad resulting SedimentLoad
+     */
     private void calculateEpochKm(
         List<SedimentLoad> epochLoads,
         SedimentLoad resLoad,
@@ -243,7 +246,10 @@
         return result;
     }
 
-    /** Calculate/Fetch values at off. epochs. */
+    /**
+     * Calculate/Fetch values at off. epochs.
+     * @param i index in epochs.
+     */
     private SedimentLoadResult calculateOffEpoch(int i) {
         SedimentLoad load = SedimentLoadFactory.getLoadWithData(
             this.river,
@@ -521,7 +527,13 @@
 
     /**
      * Transform values in load.
+     * Background is to transform values measured in
+     * t/a to m^3/a or vice versa using the specific
+     * measured relationships.
+     *
      * @param load The load of which values should be transformed.
+     * @param year The year at which to look at density (e.g. 2003).
+     *
      * @return parameter load with transformed values.
      */
     private SedimentLoad calculateUnit(SedimentLoad load, int year) {

http://dive4elements.wald.intevation.org