changeset 7031:7ee382b3f839

Doc.
author Felix Wolfsteller <felix.wolfsteller@intevation.de>
date Tue, 17 Sep 2013 11:45:44 +0200
parents 6205fe683ac7
children 069acf3cf45e
files artifacts/src/main/java/org/dive4elements/river/artifacts/model/minfo/SedimentLoadCalculation.java
diffstat 1 files changed, 7 insertions(+), 2 deletions(-) [+]
line wrap: on
line diff
--- a/artifacts/src/main/java/org/dive4elements/river/artifacts/model/minfo/SedimentLoadCalculation.java	Tue Sep 17 09:43:27 2013 +0200
+++ b/artifacts/src/main/java/org/dive4elements/river/artifacts/model/minfo/SedimentLoadCalculation.java	Tue Sep 17 11:45:44 2013 +0200
@@ -128,7 +128,12 @@
     }
 
     /**
-     * @param[out] resLoad resulting SedimentLoad
+     * Take Loads and build average of all fractions at given km.
+     * The average fractions value is set in resLoad.
+     *
+     * @param km km at which to build fractions average.
+     * @param epochLoads the loads to build average over.
+     * @param[out] resLoad resulting SedimentLoad.
      */
     private void calculateEpochKm(
         List<SedimentLoad> epochLoads,
@@ -176,7 +181,7 @@
         }
 
         SedimentLoadFraction fr = resLoad.getFraction(km);
-        // Prevent divisions by zero, the fraction defaults to 0d.
+        // Prevent divisions by zero.
         if (cSum != 0) {
             resLoad.setCoarse(km, fr.getCoarse()/cSum, fr.getCoarseRange());
         }

http://dive4elements.wald.intevation.org