dive4elements/river: artifacts/src/main/java/org/dive4elements/river/artifacts/sinfo/tkhcalculation/Tkh.java annotate

annotate artifacts/src/main/java/org/dive4elements/river/artifacts/sinfo/tkhcalculation/Tkh.java @ 8940:82998242ba84

Preparing for additional outputs of SINFO-Tkh

author	gernotbelger
date	Tue, 06 Mar 2018 18:51:18 +0100
parents	d9dbf0b74bc2
children

rev	line source
8915 d9dbf0b74bc2 Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation. gernotbelger parents: diff changeset	1 /** Copyright (C) 2017 by Bundesanstalt für Gewässerkunde
d9dbf0b74bc2 Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation. gernotbelger parents: diff changeset	2 * Software engineering by
d9dbf0b74bc2 Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation. gernotbelger parents: diff changeset	3 * Björnsen Beratende Ingenieure GmbH
d9dbf0b74bc2 Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation. gernotbelger parents: diff changeset	4 * Dr. Schumacher Ingenieurbüro für Wasser und Umwelt
d9dbf0b74bc2 Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation. gernotbelger parents: diff changeset	5 *
d9dbf0b74bc2 Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation. gernotbelger parents: diff changeset	6 * This file is Free Software under the GNU AGPL (>=v3)
d9dbf0b74bc2 Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation. gernotbelger parents: diff changeset	7 * and comes with ABSOLUTELY NO WARRANTY! Check out the
d9dbf0b74bc2 Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation. gernotbelger parents: diff changeset	8 * documentation coming with Dive4Elements River for details.
d9dbf0b74bc2 Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation. gernotbelger parents: diff changeset	9 */
d9dbf0b74bc2 Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation. gernotbelger parents: diff changeset	10 package org.dive4elements.river.artifacts.sinfo.tkhcalculation;
d9dbf0b74bc2 Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation. gernotbelger parents: diff changeset	11
d9dbf0b74bc2 Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation. gernotbelger parents: diff changeset	12 import java.io.Serializable;
d9dbf0b74bc2 Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation. gernotbelger parents: diff changeset	13
d9dbf0b74bc2 Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation. gernotbelger parents: diff changeset	14 /**
d9dbf0b74bc2 Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation. gernotbelger parents: diff changeset	15 * Result of a transport bodies height calculation.
d9dbf0b74bc2 Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation. gernotbelger parents: diff changeset	16 *
d9dbf0b74bc2 Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation. gernotbelger parents: diff changeset	17 * @author Gernot Belger
d9dbf0b74bc2 Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation. gernotbelger parents: diff changeset	18 */
d9dbf0b74bc2 Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation. gernotbelger parents: diff changeset	19 public final class Tkh implements Serializable {
d9dbf0b74bc2 Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation. gernotbelger parents: diff changeset	20
d9dbf0b74bc2 Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation. gernotbelger parents: diff changeset	21 private static final long serialVersionUID = 1L;
d9dbf0b74bc2 Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation. gernotbelger parents: diff changeset	22
d9dbf0b74bc2 Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation. gernotbelger parents: diff changeset	23 private final double km;
d9dbf0b74bc2 Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation. gernotbelger parents: diff changeset	24
d9dbf0b74bc2 Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation. gernotbelger parents: diff changeset	25 private final double wst;
d9dbf0b74bc2 Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation. gernotbelger parents: diff changeset	26
d9dbf0b74bc2 Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation. gernotbelger parents: diff changeset	27 private final double meanBedHeight;
d9dbf0b74bc2 Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation. gernotbelger parents: diff changeset	28
8940 82998242ba84 Preparing for additional outputs of SINFO-Tkh gernotbelger parents: 8915 diff changeset	29 private final double flowDepth;
82998242ba84 Preparing for additional outputs of SINFO-Tkh gernotbelger parents: 8915 diff changeset	30
82998242ba84 Preparing for additional outputs of SINFO-Tkh gernotbelger parents: 8915 diff changeset	31 private final double flowDepthTkh;
82998242ba84 Preparing for additional outputs of SINFO-Tkh gernotbelger parents: 8915 diff changeset	32
8915 d9dbf0b74bc2 Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation. gernotbelger parents: diff changeset	33 private final double discharge;
d9dbf0b74bc2 Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation. gernotbelger parents: diff changeset	34
d9dbf0b74bc2 Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation. gernotbelger parents: diff changeset	35 private final SoilKind kind;
d9dbf0b74bc2 Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation. gernotbelger parents: diff changeset	36
d9dbf0b74bc2 Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation. gernotbelger parents: diff changeset	37 private final double tkh;
d9dbf0b74bc2 Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation. gernotbelger parents: diff changeset	38
d9dbf0b74bc2 Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation. gernotbelger parents: diff changeset	39 private final double tkhUp;
d9dbf0b74bc2 Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation. gernotbelger parents: diff changeset	40
d9dbf0b74bc2 Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation. gernotbelger parents: diff changeset	41 private final double tkhDown;
d9dbf0b74bc2 Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation. gernotbelger parents: diff changeset	42
8940 82998242ba84 Preparing for additional outputs of SINFO-Tkh gernotbelger parents: 8915 diff changeset	43 private final double velocity;
82998242ba84 Preparing for additional outputs of SINFO-Tkh gernotbelger parents: 8915 diff changeset	44
82998242ba84 Preparing for additional outputs of SINFO-Tkh gernotbelger parents: 8915 diff changeset	45 private final double d50;
82998242ba84 Preparing for additional outputs of SINFO-Tkh gernotbelger parents: 8915 diff changeset	46
82998242ba84 Preparing for additional outputs of SINFO-Tkh gernotbelger parents: 8915 diff changeset	47 private final double tau;
82998242ba84 Preparing for additional outputs of SINFO-Tkh gernotbelger parents: 8915 diff changeset	48
82998242ba84 Preparing for additional outputs of SINFO-Tkh gernotbelger parents: 8915 diff changeset	49 public Tkh(final double km, final double wst, final double meanBedHeight, final double flowDepth, final double discharge) {
82998242ba84 Preparing for additional outputs of SINFO-Tkh gernotbelger parents: 8915 diff changeset	50 this(km, wst, meanBedHeight, flowDepth, discharge, null);
8915 d9dbf0b74bc2 Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation. gernotbelger parents: diff changeset	51 }
d9dbf0b74bc2 Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation. gernotbelger parents: diff changeset	52
8940 82998242ba84 Preparing for additional outputs of SINFO-Tkh gernotbelger parents: 8915 diff changeset	53 public Tkh(final double km, final double wst, final double meanBedHeight, final double flowDepth, final double discharge, final SoilKind kind) {
82998242ba84 Preparing for additional outputs of SINFO-Tkh gernotbelger parents: 8915 diff changeset	54 this(km, wst, meanBedHeight, flowDepth, Double.NaN, discharge, kind, Double.NaN, Double.NaN, Double.NaN, Double.NaN, Double.NaN, Double.NaN);
82998242ba84 Preparing for additional outputs of SINFO-Tkh gernotbelger parents: 8915 diff changeset	55 }
82998242ba84 Preparing for additional outputs of SINFO-Tkh gernotbelger parents: 8915 diff changeset	56
82998242ba84 Preparing for additional outputs of SINFO-Tkh gernotbelger parents: 8915 diff changeset	57 public Tkh(final double km, final double wst, final double meanBedHeight, final double flowDepth, final double flowDepthTkh, final double discharge,
82998242ba84 Preparing for additional outputs of SINFO-Tkh gernotbelger parents: 8915 diff changeset	58 final SoilKind kind, final double tkh, final double tkhUp, final double tkhDown, final double velocity, final double d50, final double tau) {
8915 d9dbf0b74bc2 Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation. gernotbelger parents: diff changeset	59 this.km = km;
d9dbf0b74bc2 Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation. gernotbelger parents: diff changeset	60 this.wst = wst;
d9dbf0b74bc2 Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation. gernotbelger parents: diff changeset	61 this.meanBedHeight = meanBedHeight;
8940 82998242ba84 Preparing for additional outputs of SINFO-Tkh gernotbelger parents: 8915 diff changeset	62 this.flowDepth = flowDepth;
82998242ba84 Preparing for additional outputs of SINFO-Tkh gernotbelger parents: 8915 diff changeset	63 this.flowDepthTkh = flowDepthTkh;
8915 d9dbf0b74bc2 Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation. gernotbelger parents: diff changeset	64 this.discharge = discharge;
d9dbf0b74bc2 Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation. gernotbelger parents: diff changeset	65 this.kind = kind;
d9dbf0b74bc2 Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation. gernotbelger parents: diff changeset	66 this.tkh = tkh;
d9dbf0b74bc2 Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation. gernotbelger parents: diff changeset	67 this.tkhUp = tkhUp;
d9dbf0b74bc2 Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation. gernotbelger parents: diff changeset	68 this.tkhDown = tkhDown;
8940 82998242ba84 Preparing for additional outputs of SINFO-Tkh gernotbelger parents: 8915 diff changeset	69 this.velocity = velocity;
82998242ba84 Preparing for additional outputs of SINFO-Tkh gernotbelger parents: 8915 diff changeset	70 this.d50 = d50;
82998242ba84 Preparing for additional outputs of SINFO-Tkh gernotbelger parents: 8915 diff changeset	71 this.tau = tau;
8915 d9dbf0b74bc2 Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation. gernotbelger parents: diff changeset	72 }
d9dbf0b74bc2 Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation. gernotbelger parents: diff changeset	73
d9dbf0b74bc2 Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation. gernotbelger parents: diff changeset	74 public double getStation() {
d9dbf0b74bc2 Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation. gernotbelger parents: diff changeset	75 return this.km;
d9dbf0b74bc2 Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation. gernotbelger parents: diff changeset	76 }
d9dbf0b74bc2 Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation. gernotbelger parents: diff changeset	77
d9dbf0b74bc2 Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation. gernotbelger parents: diff changeset	78 public double getTkh() {
d9dbf0b74bc2 Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation. gernotbelger parents: diff changeset	79 return this.tkh;
d9dbf0b74bc2 Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation. gernotbelger parents: diff changeset	80 }
d9dbf0b74bc2 Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation. gernotbelger parents: diff changeset	81
d9dbf0b74bc2 Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation. gernotbelger parents: diff changeset	82 public SoilKind getKind() {
d9dbf0b74bc2 Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation. gernotbelger parents: diff changeset	83 return this.kind;
d9dbf0b74bc2 Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation. gernotbelger parents: diff changeset	84 }
d9dbf0b74bc2 Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation. gernotbelger parents: diff changeset	85
d9dbf0b74bc2 Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation. gernotbelger parents: diff changeset	86 public double getUp() {
d9dbf0b74bc2 Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation. gernotbelger parents: diff changeset	87 return this.tkhUp;
d9dbf0b74bc2 Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation. gernotbelger parents: diff changeset	88 }
d9dbf0b74bc2 Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation. gernotbelger parents: diff changeset	89
d9dbf0b74bc2 Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation. gernotbelger parents: diff changeset	90 public double getDown() {
d9dbf0b74bc2 Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation. gernotbelger parents: diff changeset	91 return this.tkhDown;
d9dbf0b74bc2 Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation. gernotbelger parents: diff changeset	92 }
d9dbf0b74bc2 Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation. gernotbelger parents: diff changeset	93
d9dbf0b74bc2 Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation. gernotbelger parents: diff changeset	94 public double getWaterlevel() {
d9dbf0b74bc2 Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation. gernotbelger parents: diff changeset	95 return this.wst;
d9dbf0b74bc2 Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation. gernotbelger parents: diff changeset	96 }
d9dbf0b74bc2 Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation. gernotbelger parents: diff changeset	97
d9dbf0b74bc2 Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation. gernotbelger parents: diff changeset	98 public double getDischarge() {
d9dbf0b74bc2 Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation. gernotbelger parents: diff changeset	99 return this.discharge;
d9dbf0b74bc2 Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation. gernotbelger parents: diff changeset	100 }
d9dbf0b74bc2 Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation. gernotbelger parents: diff changeset	101
d9dbf0b74bc2 Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation. gernotbelger parents: diff changeset	102 public double getMeanBedHeight() {
d9dbf0b74bc2 Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation. gernotbelger parents: diff changeset	103 return this.meanBedHeight;
d9dbf0b74bc2 Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation. gernotbelger parents: diff changeset	104 }
8940 82998242ba84 Preparing for additional outputs of SINFO-Tkh gernotbelger parents: 8915 diff changeset	105
82998242ba84 Preparing for additional outputs of SINFO-Tkh gernotbelger parents: 8915 diff changeset	106 public double getFlowDepth() {
82998242ba84 Preparing for additional outputs of SINFO-Tkh gernotbelger parents: 8915 diff changeset	107 return this.flowDepth;
82998242ba84 Preparing for additional outputs of SINFO-Tkh gernotbelger parents: 8915 diff changeset	108 }
82998242ba84 Preparing for additional outputs of SINFO-Tkh gernotbelger parents: 8915 diff changeset	109
82998242ba84 Preparing for additional outputs of SINFO-Tkh gernotbelger parents: 8915 diff changeset	110 public double getFlowDepthTkh() {
82998242ba84 Preparing for additional outputs of SINFO-Tkh gernotbelger parents: 8915 diff changeset	111 return this.flowDepthTkh;
82998242ba84 Preparing for additional outputs of SINFO-Tkh gernotbelger parents: 8915 diff changeset	112 }
82998242ba84 Preparing for additional outputs of SINFO-Tkh gernotbelger parents: 8915 diff changeset	113
82998242ba84 Preparing for additional outputs of SINFO-Tkh gernotbelger parents: 8915 diff changeset	114 public double getVelocity() {
82998242ba84 Preparing for additional outputs of SINFO-Tkh gernotbelger parents: 8915 diff changeset	115 return this.velocity;
82998242ba84 Preparing for additional outputs of SINFO-Tkh gernotbelger parents: 8915 diff changeset	116 }
82998242ba84 Preparing for additional outputs of SINFO-Tkh gernotbelger parents: 8915 diff changeset	117
82998242ba84 Preparing for additional outputs of SINFO-Tkh gernotbelger parents: 8915 diff changeset	118 public double getD50() {
82998242ba84 Preparing for additional outputs of SINFO-Tkh gernotbelger parents: 8915 diff changeset	119 return this.d50;
82998242ba84 Preparing for additional outputs of SINFO-Tkh gernotbelger parents: 8915 diff changeset	120 }
82998242ba84 Preparing for additional outputs of SINFO-Tkh gernotbelger parents: 8915 diff changeset	121
82998242ba84 Preparing for additional outputs of SINFO-Tkh gernotbelger parents: 8915 diff changeset	122 public double getTau() {
82998242ba84 Preparing for additional outputs of SINFO-Tkh gernotbelger parents: 8915 diff changeset	123 return this.tau;
82998242ba84 Preparing for additional outputs of SINFO-Tkh gernotbelger parents: 8915 diff changeset	124 }
8915 d9dbf0b74bc2 Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation. gernotbelger parents: diff changeset	125 }

Mercurial > dive4elements > river

annotate artifacts/src/main/java/org/dive4elements/river/artifacts/sinfo/tkhcalculation/Tkh.java @ 8940:82998242ba84