Package hec.rss.model

Class YieldAnalysisData

java.lang.Object
hec.rss.model.YieldAnalysisData
All Implemented Interfaces:
Cloneable
public class YieldAnalysisData extends Object implements Cloneable

  • Field Details

    • YA_INCR_SCALE

      public static final int YA_INCR_SCALE
      Flag for increasing scale factor
      See Also:

    • YA_DECR_SCALE

      public static final int YA_DECR_SCALE
      Flag for decreasing scale factor
      See Also:

    • YA_CONVERGED

      public static final int YA_CONVERGED
      Flag that yield analysis has converged
      See Also:

    • YA_RULEFAIL

      public static final int YA_RULEFAIL
      Flag that indicates rule demand not satisfied
      See Also:

    • YA_RULEPASS

      public static final int YA_RULEPASS
      Flag that indicates rule demand satisfied
      See Also:

    • YA_DSS_READ_ERROR

      public static final int YA_DSS_READ_ERROR
      Flag indicating a DSS read error
      See Also:

    • YA_STOP_SCRIPT

      public static final int YA_STOP_SCRIPT
      Flag indicating analysis stopped by scripting
      See Also:

  • Method Details

    • setLowerLimitStor

      public void setLowerLimitStor(double lowerLimitStor)

    • getLowerLimitStor

      public double getLowerLimitStor()

    • setLowerLimitStorTol

      public void setLowerLimitStorTol(double lowerLimitStorTol)

    • getLowerLimitStorTol

      public double getLowerLimitStorTol()

    • setStorageTol

      public void setStorageTol(double storageTol)

    • getStorageTol

      public double getStorageTol()

    • setAvgStartingRuleDemand

      public void setAvgStartingRuleDemand(double avgStartingRuleDemand)

    • getAvgStartingRuleDemand

      public double getAvgStartingRuleDemand()

    • setElevationInterval

      public void setElevationInterval(int elevationInterval)

    • initializeOutputArrays

      public void initializeOutputArrays(int maxIterations)

    • setStartScale

      public void setStartScale(int iterationNumber, double scale)

    • getStartScale

      public double getStartScale(int iterationNumber)

    • setEndScale

      public void setEndScale(int iterationNumber, double scale)

    • getEndScale

      public double getEndScale(int iterationNumber)

    • setLowerScale

      public void setLowerScale(int iterationNumber, double scale)

    • getLowerScale

      public double getLowerScale(int iterationNumber)

    • setUpperScale

      public void setUpperScale(int iterationNumber, double scale)

    • getUpperScale

      public double getUpperScale(int iterationNumber)

    • setIsBracketed

      public void setIsBracketed(int iterationNumber, boolean isBracketed)

    • getIsBracketed

      public boolean getIsBracketed(int iterationNumber)

    • setRuleTest

      public void setRuleTest(int iterationNumber, boolean ruleTest)

    • getRuleTest

      public boolean getRuleTest(int iterationNumber)

    • setStorageTest

      public void setStorageTest(int iterationNumber, boolean storageTest)

    • getStorageTest

      public boolean getStorageTest(int iterationNumber)

    • setStorageTolTest

      public void setStorageTolTest(int iterationNumber, boolean storageTolTest)

    • getStorageTolTest

      public boolean getStorageTolTest(int iterationNumber)

    • setStartCritPeriod

      public void setStartCritPeriod(int iterationNumber, int startCritPeriod)

    • getStartCritPeriod

      public int getStartCritPeriod(int iterationNumber)

    • setMinCritPeriod

      public void setMinCritPeriod(int iterationNumber, int minCritPeriod)

    • getMinCritPeriod

      public int getMinCritPeriod(int iterationNumber)

    • setEndCritPeriod

      public void setEndCritPeriod(int iterationNumber, int endCritPeriod)

    • getEndCritPeriod

      public int getEndCritPeriod(int iterationNumber)

    • setMinStorage

      public void setMinStorage(int iterationNumber, double minStorage)

    • getMinStorage

      public double getMinStorage(int iterationNumber)

    • setAvgSimStorage

      public void setAvgSimStorage(int iterationNumber, double avgSimStorage)

    • getAvgSimStorage

      public double getAvgSimStorage(int iterationNumber)

    • setAvgConPoolStorage

      public void setAvgConPoolStorage(int iterationNumber, double avgConPoolStorage)

    • getAvgConPoolStorage

      public double getAvgConPoolStorage(int iterationNumber)

    • setMaxDemandShortage

      public void setMaxDemandShortage(int iterationNumber, double maxDemandShortage)

    • getMaxDemandShortage

      public double getMaxDemandShortage(int iterationNumber)

    • setAccumDemandShortage

      public void setAccumDemandShortage(int iterationNumber, double accumDemandShortage)

    • getAccumDemandShortage

      public double getAccumDemandShortage(int iterationNumber)

    • setLimitingRuleTol

      public void setLimitingRuleTol(int iterationNumber, double limitingRuleTol)

    • getLimitingRuleTol

      public double getLimitingRuleTol(int iterationNumber)

    • setDecision

      public void setDecision(int iterationNumber, int decision)

    • getDecision

      public int getDecision(int iterationNumber)

    • setUseBisection

      public void setUseBisection(int iterationNumber, boolean useBisection)

    • getUseBisection

      public boolean getUseBisection(int iterationNumber)

    • setHeuristicRatioIncr

      public void setHeuristicRatioIncr(int iterationNumber, double heuristicRatioIncr)

    • getHeuristicRatioIncr

      public double getHeuristicRatioIncr(int iterationNumber)

    • setHeuristicRatioDecr

      public void setHeuristicRatioDecr(int iterationNumber, double heuristicRatioDecr)

    • getHeuristicRatioDecr

      public double getHeuristicRatioDecr(int iterationNumber)

    • setScalesConverged

      public void setScalesConverged(int iterationNumber)

    • getTotalIterations

      public int getTotalIterations()
      Returns the total number of iterations in the yield analysis run. Is often invalid input: '<' maxIterations because convergence reached sooner.
      Returns:
      totalIterations the actual number of iterations in the yield analysis

    • getFinalScaleFactor

      public double getFinalScaleFactor()

    • getFinalAvgAnnualDemand

      public double getFinalAvgAnnualDemand()

    • writePairedData

      public boolean writePairedData(RssRun run, YieldAnalysis ya)

    • writePairedDataReverse

      public boolean writePairedDataReverse(RssRun run, YieldAnalysis ya)

    • readPairedData

      public boolean readPairedData(RssRun run, YieldAnalysis ya)

    • readPairedDataReverse

      public boolean readPairedDataReverse(RssRun run, ReverseYieldAnalysisBase rya)

    • printFYComputeMessages

      public void printFYComputeMessages(RssRun run, YieldAnalysis ya, int iterationNumber)

    • printRevFYComputeMessages

      public void printRevFYComputeMessages(RssRun run, ReverseYieldAnalysisBase rya, int iterationNumber)

    • getStartCritDate

      public String getStartCritDate(int iter)

    • getMinCritDate

      public String getMinCritDate(int iter)

    • getEndCritDate

      public String getEndCritDate(int iter)

    • intMinToString

      public static String intMinToString(int mins)

    • clone

      public Object clone()
      Overrides:
      clone in class Object