Package hec.rss.model

Class YieldAnalysis

java.lang.Object

hec.rss.model.YieldAnalysis

All Implemented Interfaces:

Cloneable

Direct Known Subclasses:

ReservoirYieldAnalysis, ReverseYieldAnalysisBase, WaterAccountYieldAnalysis

public class YieldAnalysis
extends Object
implements Cloneable

The Class YieldAnalysis.

Field Summary

Fields

Modifier and Type	Field	Description
static final double	STORAGE_EPSILON

Constructor Summary

Constructors

Constructor	Description
YieldAnalysis()	Instantiates a new yield analysis.

Method Summary

Modifier and Type	Method	Description
void	calcAvgStartingRuleDemand(RssRun run)
Object	clone()
int	getMaxHeuristicIterations()	Gets the max heuristic iterations.
int	getMaxIterations()	Gets the max iterations.
static double[]	getOpRuleLimitTS(RssRun run, OpRule opRule, RunTimeWindow rtw)
static double[]	getOpRuleResultTS(RssRun run, OpRule opRule, RunTimeWindow rtw)
static double[]	getResPoolStorTS(RssRun run, ReservoirElement res, RunTimeWindow rtw)
static double[]	getResZoneElevTS(RssRun run, StorageZone zone, RunTimeWindow rtw)
static double[]	getResZoneStorTS(RssRun run, StorageZone zone, RunTimeWindow rtw)
static int[]	getSimulationTimeArray(RssRun run, ReservoirElement res, RunTimeWindow rtw)
int	getUseBisectionAfterIts(RssRun run)
static double[]	getWAMaxStorTS(RssRun run, WaterAccount wa, RunTimeWindow rtw)
static double[]	getWARuleLimitTS(RssRun run, WaterAccount wa, RunTimeWindow rtw)
static double[]	getWARuleResultTS(RssRun run, WaterAccount wa, RunTimeWindow rtw)
static int[]	getWASimulationTimeArray(RssRun run, WaterAccount wa, RunTimeWindow rtw)
static double[]	getWAStorTS(RssRun run, WaterAccount wa, RunTimeWindow rtw)
WaterAccount	getWaterAccount(RssAlt alt)
YieldAnalysisData	getYieldAnalysisData()
List<YieldAnalysisRuleRef>	getYieldAnalysisRuleRefs()	Gets the yield analysis rule refs.
List<YieldAnalysisRuleRef>	getYieldAnalysisRuleRefs(RssSystem sys)
int	initializeCompute(RssRun run)
void	initializeOutputArrays()
void	initializeRuleRefs(RssAlt alt)
int	loadData(RssRun run, int iter)
int	loadWaterAccountData(RssRun run, WaterAccount wa, int iter)
boolean	makeDecisionUseBisection(int iterationNumber, int useBisectionAfterIts)
boolean	readFile(BufferedReader reader)	Read file.
void	setMaxHeuristicIterations(int iter)	Sets the max heuristic iterations.
void	setMaxIterations(int maxIterations)	Sets the max iterations.
void	setNextBisectionScaleBracketed(int currentIterationNumber)
void	setNextBisectionScaleNotBracketed(int currentIterationNumber)
void	setNextHeuristicsScaleWA(int currentIterationNumber)
void	setNumLagSteps(StorageZoneRef szRef)
void	setNumRoutingSteps()
void	setNumRoutingSteps(WaterAccount wa)
void	setNumRoutingSteps(List<OpRule> ruleList)
void	setRuleRefs(List<YieldAnalysisRuleRef> rules)	Sets the rule refs.
void	setUseBisectionOnly(boolean set)	Sets the use bisection only.
void	setUseHydropowerRules(boolean useHydropowerRules)	Sets the use hydropower rules.
void	setYieldAnalysisRuleDemandScale(double demandScale)
void	setYieldAnalysisRuleUseDemandScale(boolean useDemandScale)
int	testRule(RssRun run, YieldAnalysisRuleRef yarr, int iter)
int	testStorage(RssRun run, YieldAnalysisRuleRef yarr, int iter)
int	testWaterAccountRule(RssRun run, int iter)
int	testWaterAccountStorage(RssRun run, int iter, double storageTolerance)
void	updateByDemandScale(double demandScale)
boolean	useBisectionOnly()	Use bisection only.
boolean	useHydropowerRules()	Use hydropower rules.
boolean	writeFile(BufferedWriter writer, RssAlt alt)	Write file.

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

STORAGE_EPSILON

public static final double STORAGE_EPSILON

See Also:

• Constant Field Values

Constructor Details

YieldAnalysis

public YieldAnalysis()

Instantiates a new yield analysis.

Method Details

initializeCompute

public int initializeCompute(RssRun run)

initializeRuleRefs

public void initializeRuleRefs(RssAlt alt)

initializeOutputArrays

public void initializeOutputArrays()

getYieldAnalysisData

public YieldAnalysisData getYieldAnalysisData()

getWaterAccount

public WaterAccount getWaterAccount(RssAlt alt)

loadData

public int loadData(RssRun run,
 int iter)

loadWaterAccountData

public int loadWaterAccountData(RssRun run,
 WaterAccount wa,
 int iter)

setNumRoutingSteps

public void setNumRoutingSteps(WaterAccount wa)

setNumRoutingSteps

public void setNumRoutingSteps()

setNumRoutingSteps

public void setNumRoutingSteps(List<OpRule> ruleList)

setNumLagSteps

public void setNumLagSteps(StorageZoneRef szRef)

testRule

public int testRule(RssRun run,
 YieldAnalysisRuleRef yarr,
 int iter)

testWaterAccountRule

public int testWaterAccountRule(RssRun run,
 int iter)

testStorage

public int testStorage(RssRun run,
 YieldAnalysisRuleRef yarr,
 int iter)

testWaterAccountStorage

public int testWaterAccountStorage(RssRun run,
 int iter,
 double storageTolerance)

calcAvgStartingRuleDemand

public void calcAvgStartingRuleDemand(RssRun run)

getUseBisectionAfterIts

public int getUseBisectionAfterIts(RssRun run)

makeDecisionUseBisection

public boolean makeDecisionUseBisection(int iterationNumber,
 int useBisectionAfterIts)

setYieldAnalysisRuleUseDemandScale

public void setYieldAnalysisRuleUseDemandScale(boolean useDemandScale)

setYieldAnalysisRuleDemandScale

public void setYieldAnalysisRuleDemandScale(double demandScale)

updateByDemandScale

public void updateByDemandScale(double demandScale)

setNextBisectionScaleBracketed

public void setNextBisectionScaleBracketed(int currentIterationNumber)

setNextBisectionScaleNotBracketed

public void setNextBisectionScaleNotBracketed(int currentIterationNumber)

setNextHeuristicsScaleWA

public void setNextHeuristicsScaleWA(int currentIterationNumber)

getYieldAnalysisRuleRefs

public List<YieldAnalysisRuleRef> getYieldAnalysisRuleRefs()

Gets the yield analysis rule refs.

Returns:

the yield analysis rule refs

getYieldAnalysisRuleRefs

public List<YieldAnalysisRuleRef> getYieldAnalysisRuleRefs(RssSystem sys)

setMaxIterations

public void setMaxIterations(int maxIterations)

Sets the max iterations.

Parameters:

maxIterations - the new max iterations

getMaxIterations

public int getMaxIterations()

Gets the max iterations.

Returns:

the max iterations

setUseBisectionOnly

public void setUseBisectionOnly(boolean set)

Sets the use bisection only.

Parameters:

set - the new use bisection only

useBisectionOnly

public boolean useBisectionOnly()

Use bisection only.

Returns:

true, if successful

setMaxHeuristicIterations

public void setMaxHeuristicIterations(int iter)

Sets the max heuristic iterations.

Parameters:

iter - the new max heuristic iterations

getMaxHeuristicIterations

public int getMaxHeuristicIterations()

Gets the max heuristic iterations.

Returns:

the max heuristic iterations

setUseHydropowerRules

public void setUseHydropowerRules(boolean useHydropowerRules)

Sets the use hydropower rules.

Parameters:

useHydropowerRules - the new use hydropower rules

useHydropowerRules

public boolean useHydropowerRules()

Use hydropower rules.

Returns:

true, if successful

setRuleRefs

public void setRuleRefs(List<YieldAnalysisRuleRef> rules)

Sets the rule refs.

Parameters:

rules - the new rule refs

getOpRuleLimitTS

public static double[] getOpRuleLimitTS(RssRun run,
 OpRule opRule,
 RunTimeWindow rtw)
                                 throws RemoteException,
FileNotFoundException

Throws:

RemoteException

FileNotFoundException

getWARuleLimitTS

public static double[] getWARuleLimitTS(RssRun run,
 WaterAccount wa,
 RunTimeWindow rtw)
                                 throws RemoteException,
FileNotFoundException

Throws:

RemoteException

FileNotFoundException

getOpRuleResultTS

public static double[] getOpRuleResultTS(RssRun run,
 OpRule opRule,
 RunTimeWindow rtw)
                                  throws RemoteException,
FileNotFoundException

Throws:

RemoteException

FileNotFoundException

getWARuleResultTS

public static double[] getWARuleResultTS(RssRun run,
 WaterAccount wa,
 RunTimeWindow rtw)
                                  throws RemoteException,
FileNotFoundException

Throws:

RemoteException

FileNotFoundException

getResZoneStorTS

public static double[] getResZoneStorTS(RssRun run,
 StorageZone zone,
 RunTimeWindow rtw)
                                 throws RemoteException,
FileNotFoundException

Throws:

RemoteException

FileNotFoundException

getResZoneElevTS

public static double[] getResZoneElevTS(RssRun run,
 StorageZone zone,
 RunTimeWindow rtw)
                                 throws RemoteException,
FileNotFoundException

Throws:

RemoteException

FileNotFoundException

getResPoolStorTS

public static double[] getResPoolStorTS(RssRun run,
 ReservoirElement res,
 RunTimeWindow rtw)
                                 throws RemoteException,
FileNotFoundException

Throws:

RemoteException

FileNotFoundException

getWAStorTS

public static double[] getWAStorTS(RssRun run,
 WaterAccount wa,
 RunTimeWindow rtw)
                            throws RemoteException,
FileNotFoundException

Throws:

RemoteException

FileNotFoundException

getWAMaxStorTS

public static double[] getWAMaxStorTS(RssRun run,
 WaterAccount wa,
 RunTimeWindow rtw)
                               throws RemoteException,
FileNotFoundException

Throws:

RemoteException

FileNotFoundException

getSimulationTimeArray

public static int[] getSimulationTimeArray(RssRun run,
 ReservoirElement res,
 RunTimeWindow rtw)
                                    throws RemoteException,
FileNotFoundException

Throws:

RemoteException

FileNotFoundException

getWASimulationTimeArray

public static int[] getWASimulationTimeArray(RssRun run,
 WaterAccount wa,
 RunTimeWindow rtw)
                                      throws RemoteException,
FileNotFoundException

Throws:

RemoteException

FileNotFoundException

writeFile

public boolean writeFile(BufferedWriter writer,
 RssAlt alt)
                  throws IOException

Write file.

Parameters:

writer - the writer

alt - the alt

Returns:

true, if successful

Throws:

IOException - Signals that an I/O exception has occurred.

readFile

public boolean readFile(BufferedReader reader)
                 throws IOException

Read file.

Parameters:

reader - the reader

Returns:

true, if successful

Throws:

IOException - Signals that an I/O exception has occurred.

clone

public Object clone()

Overrides:

clone in class Object