Package hec.rss.model

Class DownstreamOptions

java.lang.Object
hec.rss.model.DownstreamOptions
All Implemented Interfaces:
AsciiSerializable, FieldAccessor, Serializable, Cloneable
public class DownstreamOptions extends Object implements AsciiSerializable, Serializable, Cloneable
The Class DownstreamOptions.
See Also:

  • Field Details

    • SPACEADJ_UNDEF

      public static final int SPACEADJ_UNDEF
      See Also:

    • SPACEADJ_NONE

      public static final int SPACEADJ_NONE
      See Also:

    • SPACEADJ_LAGGED

      public static final int SPACEADJ_LAGGED
      See Also:

    • SPACEADJ_PREDCORR

      public static final int SPACEADJ_PREDCORR
      See Also:

    • SPACEADJ_PEST

      public static final int SPACEADJ_PEST
      See Also:

    • DEFAULT_SPACE_ADJ

      public static final int DEFAULT_SPACE_ADJ
      default setting for flag triggering use of lagged space correction algorithm
      See Also:

    • DEFAULT_USE_LAGGED_SPACE_ADJ

      @Deprecated public static final boolean DEFAULT_USE_LAGGED_SPACE_ADJ
      Deprecated.
      default setting for flag triggering use of lagged space correction algorithm
      See Also:

    • DEFAULT_LAG_MAX_ITERATIONS

      public static final int DEFAULT_LAG_MAX_ITERATIONS
      The Lag Max Iterations
      See Also:

    • DEFAULT_LAG_FLOW_TOLERANCE

      public static final double DEFAULT_LAG_FLOW_TOLERANCE
      The Lag Flow Tolerance
      See Also:

    • DEFAULT_LAG_FRACTION_LIMIT

      public static final double DEFAULT_LAG_FRACTION_LIMIT
      The lag Fraction Limit.
      See Also:

    • DEFAULT_USE_PREDICTOR

      @Deprecated public static final boolean DEFAULT_USE_PREDICTOR
      Deprecated.
      default Flag that switches Predictor Corrector logic on or off
      See Also:

    • DEFAULT_PREDICTOR_MAX_ITERATIONS

      public static final int DEFAULT_PREDICTOR_MAX_ITERATIONS
      The number of times corrections on the Predictor Corrector method is a multiple of this number
      See Also:

    • DEFAULT_PREDICTOR_CORRECTION_FACTOR

      public static final double DEFAULT_PREDICTOR_CORRECTION_FACTOR
      The PREDICTOR correction_ factor. 0 invalid input: '<' Factor invalid input: '<' 1 controls how aggressive are the corrections made in the Predictor Corrector method. Value close to 1 implies more aggressive corrections, less iterations required, but more unstable. Value close to zero implies smaller corrections, solution is smoother and more stable, but require more iterations to converge
      See Also:

    • DEFAULT_USE_CONSIDER_ROC

      public static final boolean DEFAULT_USE_CONSIDER_ROC
      The Use Consider Rate of Change option, default to false (off)
      See Also:

    • DEFAULT_MAX_LOOKAHEAD_ROC

      public static final int DEFAULT_MAX_LOOKAHEAD_ROC
      The Max number of time steps to lookahead
      See Also:

    • DEFAULT_USE_CONSIDER_RTW

      public static final boolean DEFAULT_USE_CONSIDER_RTW
      The Use Consider Multiplier on estimated routing lag
      See Also:

    • DEFAULT_MULTIPLIER_RTW

      public static final double DEFAULT_MULTIPLIER_RTW
      Multiplier on estimated routing lag
      See Also:

    • WEIGHT_MODEL

      public static double WEIGHT_MODEL
      weight on optimization for routing model fit

    • WEIGHT_REG

      public static double WEIGHT_REG
      weight on optimization for inflow regularization

    • WEIGHT_LIM

      public static double WEIGHT_LIM
      weight on optimization for max or min downstream constraint

    • WEIGHT_ZEROIN

      public static double WEIGHT_ZEROIN
      weight on optimization for constraining reach inflow > 0

  • Constructor Details

    • DownstreamOptions

      public DownstreamOptions()
      Instantiates a new downstream options.

  • Method Details

    • resetDefaults

      public void resetDefaults()
      Reset defaults.

    • setWeightModel

      public void setWeightModel(double d)

    • getWeightModel

      public double getWeightModel()

    • setWeightReg

      public void setWeightReg(double d)

    • getWeightReg

      public double getWeightReg()

    • setWeightLim

      public void setWeightLim(double d)

    • getWeightLim

      public double getWeightLim()

    • setWeightZeroIn

      public void setWeightZeroIn(double d)

    • getWeightZeroIn

      public double getWeightZeroIn()

    • setSpaceAdjType

      public void setSpaceAdjType(int itype)

    • getSpaceAdjType

      public int getSpaceAdjType()

    • getUsePESTAdj

      public boolean getUsePESTAdj()
      Gets the use PEST adj.
      Returns:
      the use lagged space adj

    • getUseLaggedSpaceAdj

      public boolean getUseLaggedSpaceAdj()
      Gets the use lagged space adj.
      Returns:
      the use lagged space adj

    • setLagMaxIterations

      public void setLagMaxIterations(int value)
      Sets the lag max iterations.
      Parameters:
      value - the new lag max iterations

    • getLagMaxIterations

      public int getLagMaxIterations()
      Gets the lag max iterations.
      Returns:
      the lag max iterations

    • setLagFlowTolerance

      public void setLagFlowTolerance(double value)
      Sets the lag flow tolerance.
      Parameters:
      value - the new lag flow tolerance

    • getLagFlowTolerance

      public double getLagFlowTolerance()
      Gets the lag flow tolerance.
      Returns:
      the lag flow tolerance

    • setLagFractionLimit

      public void setLagFractionLimit(double value)
      Sets the lag fraction limit.
      Parameters:
      value - the new lag fraction limit

    • getLagFractionLimit

      public double getLagFractionLimit()
      Gets the lag fraction limit.
      Returns:
      the lag fraction limit

    • getUsePredictor

      public boolean getUsePredictor()
      Use predictor.
      Returns:
      true, if successful

    • setPredictorMaxIterations

      public void setPredictorMaxIterations(int value)
      Sets the predictor max iterations.
      Parameters:
      value - the new predictor max iterations

    • getPredictorMaxIterations

      public int getPredictorMaxIterations()
      Gets the predictor max iterations.
      Returns:
      the predictor max iterations

    • setPredictorCorrectionFactor

      public void setPredictorCorrectionFactor(double value)
      Sets the predictor correction factor.
      Parameters:
      value - the new predictor correction factor

    • getPredictorCorrectionFactor

      public double getPredictorCorrectionFactor()
      Gets the predictor correction factor.
      Returns:
      the predictor correction factor

    • setUseConsiderROC

      public void setUseConsiderROC(boolean value)
      Sets the use consider roc.
      Parameters:
      value - the new use consider roc

    • getUseConsiderROC

      public boolean getUseConsiderROC()
      Gets the use consider roc.
      Returns:
      the use consider roc

    • setMaxLookaheadROC

      public void setMaxLookaheadROC(int value)
      Sets the max lookahead roc.
      Parameters:
      value - the new max lookahead roc

    • getMaxLookaheadROC

      public int getMaxLookaheadROC()
      Gets the max lookahead roc.
      Returns:
      the max lookahead roc

    • setUseConsiderRTW

      public void setUseConsiderRTW(boolean value)

    • getUseConsiderRTW

      public boolean getUseConsiderRTW()

    • setMultiplierRTW

      public void setMultiplierRTW(double value)

    • getMultiplierRTW

      public double getMultiplierRTW()

    • clone

      public DownstreamOptions clone()
      clone this object
      Overrides:
      clone in class Object

    • setFieldObject

      public boolean setFieldObject(Field fld, Object fobj)
      Description copied from interface: FieldAccessor
      This allows access to fields withing the implementing object to set there data.
      Specified by:
      setFieldObject in interface FieldAccessor
      Parameters:
      fld - The java field object representing the member field to be set
      fobj - The data to set in that field
      Returns:
      returns true if successful

    • getFieldObject

      public Object getFieldObject(Field fld)
      Description copied from interface: FieldAccessor
      This method allows access to java.lang.reflect.Field objects within the implementing class.
      Specified by:
      getFieldObject in interface FieldAccessor
      Parameters:
      fld - The field to get.
      Returns:
      The data object that is stored in the given field