gernotbelger@8915: /** Copyright (C) 2017 by Bundesanstalt für Gewässerkunde
gernotbelger@8915:  * Software engineering by
gernotbelger@8915:  *  Björnsen Beratende Ingenieure GmbH
gernotbelger@8915:  *  Dr. Schumacher Ingenieurbüro für Wasser und Umwelt
gernotbelger@8915:  *
gernotbelger@8915:  * This file is Free Software under the GNU AGPL (>=v3)
gernotbelger@8915:  * and comes with ABSOLUTELY NO WARRANTY! Check out the
gernotbelger@8915:  * documentation coming with Dive4Elements River for details.
gernotbelger@8915:  */
gernotbelger@8915: package org.dive4elements.river.artifacts.sinfo.tkhcalculation;
gernotbelger@8915: 
gernotbelger@8915: import java.io.Serializable;
gernotbelger@8915: 
gernotbelger@8915: /**
gernotbelger@8915:  * Result of a transport bodies height calculation.
gernotbelger@8915:  *
gernotbelger@8915:  * @author Gernot Belger
gernotbelger@8915:  */
gernotbelger@8915: public final class Tkh implements Serializable {
gernotbelger@8915: 
gernotbelger@8915:     private static final long serialVersionUID = 1L;
gernotbelger@8915: 
gernotbelger@8915:     private final double km;
gernotbelger@8915: 
gernotbelger@8915:     private final double wst;
gernotbelger@8915: 
gernotbelger@8915:     private final double meanBedHeight;
gernotbelger@8915: 
gernotbelger@8940:     private final double flowDepth;
gernotbelger@8940: 
gernotbelger@8940:     private final double flowDepthTkh;
gernotbelger@8940: 
gernotbelger@8915:     private final double discharge;
gernotbelger@8915: 
gernotbelger@8915:     private final SoilKind kind;
gernotbelger@8915: 
gernotbelger@8915:     private final double tkh;
gernotbelger@8915: 
gernotbelger@8915:     private final double tkhUp;
gernotbelger@8915: 
gernotbelger@8915:     private final double tkhDown;
gernotbelger@8915: 
gernotbelger@8940:     private final double velocity;
gernotbelger@8940: 
gernotbelger@8940:     private final double d50;
gernotbelger@8940: 
gernotbelger@8940:     private final double tau;
gernotbelger@8940: 
gernotbelger@8940:     public Tkh(final double km, final double wst, final double meanBedHeight, final double flowDepth, final double discharge) {
gernotbelger@8940:         this(km, wst, meanBedHeight, flowDepth, discharge, null);
gernotbelger@8915:     }
gernotbelger@8915: 
gernotbelger@8940:     public Tkh(final double km, final double wst, final double meanBedHeight, final double flowDepth, final double discharge, final SoilKind kind) {
gernotbelger@8940:         this(km, wst, meanBedHeight, flowDepth, Double.NaN, discharge, kind, Double.NaN, Double.NaN, Double.NaN, Double.NaN, Double.NaN, Double.NaN);
gernotbelger@8940:     }
gernotbelger@8940: 
gernotbelger@8940:     public Tkh(final double km, final double wst, final double meanBedHeight, final double flowDepth, final double flowDepthTkh, final double discharge,
gernotbelger@8940:             final SoilKind kind, final double tkh, final double tkhUp, final double tkhDown, final double velocity, final double d50, final double tau) {
gernotbelger@8915:         this.km = km;
gernotbelger@8915:         this.wst = wst;
gernotbelger@8915:         this.meanBedHeight = meanBedHeight;
gernotbelger@8940:         this.flowDepth = flowDepth;
gernotbelger@8940:         this.flowDepthTkh = flowDepthTkh;
gernotbelger@8915:         this.discharge = discharge;
gernotbelger@8915:         this.kind = kind;
gernotbelger@8915:         this.tkh = tkh;
gernotbelger@8915:         this.tkhUp = tkhUp;
gernotbelger@8915:         this.tkhDown = tkhDown;
gernotbelger@8940:         this.velocity = velocity;
gernotbelger@8940:         this.d50 = d50;
gernotbelger@8940:         this.tau = tau;
gernotbelger@8915:     }
gernotbelger@8915: 
gernotbelger@8915:     public double getStation() {
gernotbelger@8915:         return this.km;
gernotbelger@8915:     }
gernotbelger@8915: 
gernotbelger@8915:     public double getTkh() {
gernotbelger@8915:         return this.tkh;
gernotbelger@8915:     }
gernotbelger@8915: 
gernotbelger@8915:     public SoilKind getKind() {
gernotbelger@8915:         return this.kind;
gernotbelger@8915:     }
gernotbelger@8915: 
gernotbelger@8915:     public double getUp() {
gernotbelger@8915:         return this.tkhUp;
gernotbelger@8915:     }
gernotbelger@8915: 
gernotbelger@8915:     public double getDown() {
gernotbelger@8915:         return this.tkhDown;
gernotbelger@8915:     }
gernotbelger@8915: 
gernotbelger@8915:     public double getWaterlevel() {
gernotbelger@8915:         return this.wst;
gernotbelger@8915:     }
gernotbelger@8915: 
gernotbelger@8915:     public double getDischarge() {
gernotbelger@8915:         return this.discharge;
gernotbelger@8915:     }
gernotbelger@8915: 
gernotbelger@8915:     public double getMeanBedHeight() {
gernotbelger@8915:         return this.meanBedHeight;
gernotbelger@8915:     }
gernotbelger@8940: 
gernotbelger@8940:     public double getFlowDepth() {
gernotbelger@8940:         return this.flowDepth;
gernotbelger@8940:     }
gernotbelger@8940: 
gernotbelger@8940:     public double getFlowDepthTkh() {
gernotbelger@8940:         return this.flowDepthTkh;
gernotbelger@8940:     }
gernotbelger@8940: 
gernotbelger@8940:     public double getVelocity() {
gernotbelger@8940:         return this.velocity;
gernotbelger@8940:     }
gernotbelger@8940: 
gernotbelger@8940:     public double getD50() {
gernotbelger@8940:         return this.d50;
gernotbelger@8940:     }
gernotbelger@8940: 
gernotbelger@8940:     public double getTau() {
gernotbelger@8940:         return this.tau;
gernotbelger@8940:     }
gernotbelger@8915: }