Package hec.rss.model

Class PumpFlow

java.lang.Object

java.util.Observable

hec.lang.NamedType

hec.rss.model.RssTSLocationObject

hec.rss.model.Function

hec.rss.model.ControlStructure

hec.rss.model.AdjustableFlow

hec.rss.model.PumpFlow

All Implemented Interfaces:

AsciiSerializable, FieldAccessor, TSLocation, PowerPlantContainer, AltInputReportInfc, RssModelVariableConstants, RssReturnStatusConstants, RssTSLocation, TailElevContainer, Serializable, Cloneable, Comparable, Observer, rma.lang.Modifiable

public class PumpFlow
extends AdjustableFlow

Title: HecJava Development

Description:

Copyright: Copyright (c) 2003

Company:

See Also:

• Serialized Form

Field Summary

Fields inherited from class hec.rss.model.AdjustableFlow

FIRST_HINDCAST_COND, KNOWN_RELEASE_CONST, KNOWN_RELEASE_STOR, KNOWN_RELEASE_TS, LAST_HINDCAST_COND

Fields inherited from class hec.lang.NamedType

_description, _ignoreModifiedEvents, _index, _isValid, _modified, _name, defaultDescription, defaultName, DESCRIPTION_CHANGED, NAME_CHANGED, RENAME_EVENT

Fields inherited from interface hec.rss.model.RssModelVariableConstants

CUMLOC_OUTPUT_DATA, GRPID_DIVERSION, GRPID_JUNCTION, GRPID_REACH, GRPID_RESERVOIR, HINDCAST_IDS, HOLDOUT_OUTPUT_DATA, INPUT_DATA, OUTPUT_DATA, PULSE_OUTPUT_DATA, UNREG_OUTPUT_DATA, VID_ADJPARAM_FLOW, VID_CAPACITY_FACTOR, VID_CTRLOUT_HINDFLW, VID_CTRLOUT_RELEASE, VID_DAM_LEAK, VID_DAM_RELEASE, VID_DIV_FLOW, VID_DIV_FLOW_ROUTED, VID_DIV_HINDFLW, VID_DIV_RELEASE, VID_DIVOUT_FLOW, VID_DIVOUT_FLOW_ROUTED, VID_ENERGYREQUIRED_TSINPUT, VID_FIRST, VID_FOREBAY_ELEV, VID_FOREBAY_HEADLOSS, VID_GATE_OPENING, VID_GATE_PERCENTOPEN, VID_JUNC_ELEV, VID_JUNC_FLOW_CUMLOC, VID_JUNC_FLOW_DIV, VID_JUNC_FLOW_HOLD, VID_JUNC_FLOW_IN, VID_JUNC_FLOW_LIMIT, VID_JUNC_FLOW_LOCAL, VID_JUNC_FLOW_PULSE, VID_JUNC_FLOW_REG, VID_JUNC_FLOW_UNREG, VID_JUNC_FLOW_VIOL, VID_JUNC_HINDFLOW, VID_JUNC_INFLOW, VID_JUNC_INFLOW_LOCAL_TOTAL, VID_JUNC_STAGE, VID_JUNC_STAGE_LIMIT, VID_JUNC_STAGE_REG, VID_JUNC_STAGE_UNREG, VID_JUNC_STAGE_VIOL, VID_LAST, VID_NODE_FLOW, VID_NODE_HINDFLW, VID_NODE_HINDSTG, VID_NODE_KNOWNFLOW, VID_NODE_STAGE, VID_OPCTRL_CONSTRAINTID, VID_OPCTRL_DECISION, VID_OPCTRL_MAXLIMIT, VID_OPCTRL_MINLIMIT, VID_OPCTRL_RULEID, VID_OPCTRL_ZONEID, VID_OPRULE_FLOW_SPACE, VID_OPRULE_MAX, VID_OPRULE_MAX_STAGE, VID_OPRULE_MIN, VID_OPRULE_MIN_STAGE, VID_OPRULE_PRIORITY, VID_OPRULE_ROUTE_LAG, VID_OPRULE_ROUTE_MAXOFFSET, VID_OPRULE_ROUTE_MINOFFSET, VID_OPRULE_SPEC, VID_OPRULE_STOR_BAL, VID_OPRULE_STOR_BAL_INDEX, VID_OPRULE_VIOL_ELEV, VID_OPRULE_VIOL_FLOW, VID_OPRULE_VIOL_STAGE, VID_OPRULE_VIOL_STOR, VID_OPRULE_WQCD_ELEV, VID_OPRULEFL_CUMLOC, VID_OPRULETS_TSINPUT, VID_OPSET_ACTIVEZONE, VID_OPSET_GC_ELEV, VID_OPSET_GC_STOR, VID_OPSET_KNOWNZONEELEV, VID_OPSET_PROJECTEDELEV, VID_OPSET_ZONEELEV, VID_OPSET_ZONESTOR, VID_OUTGRP_RELEASE, VID_POOL_AREA, VID_POOL_ELEV, VID_POOL_ELEV_EST, VID_POOL_ELEVROC, VID_POOL_EVAP, VID_POOL_FLOWINTOSTOR, VID_POOL_HINDELEV, VID_POOL_HINDSTOR, VID_POOL_HOLDOUT, VID_POOL_INFLOW, VID_POOL_INPUTEVAP, VID_POOL_NETINFLOW, VID_POOL_OUTFLOW, VID_POOL_OUTFLOW_EST, VID_POOL_SEEP, VID_POOL_STOR, VID_PULSE_BACKQ, VID_PULSE_PULSEQ, VID_PUMP_FLOWAVG, VID_PUMP_VOL, VID_PUMPRULE_FLOWAVG, VID_PUMPRULE_FLOWAVG_CAP, VID_PUMPRULE_FLOWINST, VID_PUMPRULE_FLOWINST_CAP, VID_PUMPRULE_HOURS, VID_PUMPRULE_HOURS_CAP, VID_PUMPRULE_NUMPUMP, VID_PUMPRULE_NUMPUMP_CAP, VID_PUMPRULE_UNITHOURS, VID_PUMPRULE_UNITHOURS_CAP, VID_PUMPRULE_VOL, VID_PUMPRULE_VOL_CAP, VID_PWR_CAPABILITY, VID_PWR_EFF, VID_PWR_ENGYGEN, VID_PWR_ENGYPATTERN, VID_PWR_ENGYPERGEN, VID_PWR_ENGYPERREQD, VID_PWR_ENGYREQD, VID_PWR_ENGYVIOL, VID_PWR_FLWPWR, VID_PWR_HDPWR, VID_PWR_HYDLSS, VID_PWR_MAXCAPACITY, VID_PWR_PER_BALGEN, VID_PWR_PER_GCGEN, VID_PWR_PER_MINPUMPGEN, VID_PWR_PER_MINRELGEN, VID_PWR_PER_POWGEN, VID_PWR_PER_PUMPGEN, VID_PWR_PLNTFAC, VID_PWR_PWRCAP, VID_PWR_REQUIRED, VID_PWR_SPILL, VID_PWR_VIOL, VID_RCH_SEEP, VID_REACH_FLOW_CUMLOC, VID_REACH_FLOW_IN, VID_REACH_FLOW_REG, VID_REACH_FLOW_UNREG, VID_RES_GCRELEASE, VID_RES_HOLDOUT, VID_RES_RELEASE, VID_SPILL_FLOW, VID_SPILL_HINDFLOW, VID_STATE_VAR, VID_STATE_VAR_HIND, VID_TAIL_ELEV, VID_UNCTOUT_FLOW, VID_UNCTOUT_HINDFLW, VID_WA_ACCOUNT_DEMAND, VID_WA_ACCOUNT_INFLOW, VID_WA_CHARGES, VID_WA_CREDIT, VID_WA_CURRENT_MAX_VOLUME, VID_WA_CURRENT_VOLUME, VID_WA_HINDSTOR, VID_WA_LOSSES, VID_WA_PUMPBACK, VID_WA_RULE_DEMAND, VID_WA_SURPLUS, VID_WA_TRANSFERS, WQID_OFFSET

Fields inherited from interface hec.rss.model.RssReturnStatusConstants

RTN_CANCELED, RTN_NOPROBLEM, RTN_OPCHANGE, RTN_PROBLEM

Constructor Summary

Constructors

Constructor	Description
PumpFlow()
PumpFlow(Element elem)

Method Summary

Modifier and Type	Method	Description
int	computeForecastStep(RunTimeStep runtime)
int	computeForecastStep(RunTimeStep runtime, double[] xt, double[] et, int tcnt)
int	computeHindcastStep(RunTimeStep runtime)	compute one release for hind cast
double	computeSubStepFlow(RunTimeStep rts, double xt, double et)
protected AdjustableParameter	createDefaultAdjustableParameter()
double	getCurrentCapacity(RunTimeStep rts)	gets the current maximum release from this outlet this should only be called during a compute
double	getCurrentPumpCapacity(RunTimeStep rts)	gets the current maximum release from this outlet this should only be called during a compute
double	getMaxCapacityForElevation(double elev)	get maximum release capacity for gated outlet
void	setupForSerialization()	Called just before ascii serialization.

Methods inherited from class hec.rss.model.AdjustableFlow

applyHindcastData, calcFlow, clone, computeStepFlow, copyInto, findAdjParam, getActiveTSProxies, getAdjustableParameter, getCapacity, getCapacityValues, getCapacityValuesBySetting, getCurrentCapacity, getCurrentCapacity, getFieldObject, getFlowForGateHeight, getGateCount, getGateHeightForElevFlow, getGateSettings, getGateSettingsParamId, getHindcastCondition, getHindcastDataList, getHindcastValue, getInitialRelease, getMaxCapacity, getPowerPlant, getPrevGateHeight, getPump, getStateRate, getTailwaterElevation, hasDefaultParameters, hasMultipleGateSettings, hasPowerPlant, hasPump, hasReversiblePump, hasTailElev, initForecastOperations, initialize, isNodeComputed, outputReport, setCapacityValues, setCapacityValuesBySetting, setElement, setFieldObject, setGateCount, setGateSettings, setGateSettingsParamId, setHasPowerPlant, setHasPump, setHasReversiblePump, setHasTailElev, setHindcastCondition, setInitialRelease, setMultipleGateSettings, updateSystemState, updateTSProxyList

Methods inherited from class hec.rss.model.ControlStructure

copyInto, getEstimatedFlow, getEstimatedROD, getEstimatedROI, getIntakeGeometry, getRelease, periodAverageFlow, periodAverageFlow, setIntakeGeometry

Methods inherited from class hec.rss.model.Function

cleanupFromDeSerialization, copyInto, getComputedTSRecordProxies, getComputedTSRecordProxies, getDisplayName, getElement, getFlowVolume, getFlowVolume, getForecastEquation, getFullName, getHindcastEquation, getKeyStringForObject, getObjectForKeyString, getOutputBPart, getSystem, getUnitSystem, initForecastLoop, initForPostProcessing, initHindcastLoop, initTSVals, printErrorMessage, printErrorMessage, readData, resetParent, restoreFunctionState, restoreHotstartState, saveFunctionState, saveHotstartState, updateWQTSProxyList, writeData

Methods inherited from class hec.rss.model.RssTSLocationObject

addTSRecord, addTSRecordProxy, addTSRecordProxy, addTSRecordProxy, clearTSProxyList, copyInto, getActiveTSRecordProxies, getTSArray, getTSArray, getTSArray, getTSArray, getTSContainer, getTSContainer, getTSDataSet, getTSRecordProxies, getTSRecordProxy, getTSRecordProxy, getTSRecordProxy, getTSRecordProxy, getTSRecordProxy, getTSRecordProxyVec, removeTSRecord, removeTSRecordProxy, removeTSRecordProxy

Methods inherited from class hec.lang.NamedType

addModifiableListener, compareTo, fireModifiedStateChanged, getDescription, getIgnoreModifiedEvents, getIndex, getName, isModified, isValid, readResolve, removeModifiableListener, rename, set, setDescription, setIgnoreModifiedEvents, setIndex, setModified, setName, setValid, toString, update, useRecursiveModifiedTest

Methods inherited from class java.util.Observable

addObserver, clearChanged, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers, setChanged

Methods inherited from class java.lang.Object

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

Methods inherited from interface hec.rss.model.RssTSLocation

getTSRecordProxy

Methods inherited from interface hec.model.TSLocation

getTSDataSet

Constructor Details

PumpFlow

public PumpFlow()

PumpFlow

public PumpFlow(Element elem)

Method Details

setupForSerialization

public void setupForSerialization()

Description copied from class: AdjustableFlow

Called just before ascii serialization. Prepares the paired data values by setting there dss record path names

Overrides:

setupForSerialization in class AdjustableFlow

createDefaultAdjustableParameter

protected AdjustableParameter createDefaultAdjustableParameter()

Overrides:

createDefaultAdjustableParameter in class AdjustableFlow

getCurrentCapacity

public double getCurrentCapacity(RunTimeStep rts)

gets the current maximum release from this outlet this should only be called during a compute

Overrides:

getCurrentCapacity in class AdjustableFlow

computeSubStepFlow

public double computeSubStepFlow(RunTimeStep rts,
 double xt,
 double et)

Overrides:

computeSubStepFlow in class AdjustableFlow

getMaxCapacityForElevation

public double getMaxCapacityForElevation(double elev)

Description copied from class: AdjustableFlow

get maximum release capacity for gated outlet

Overrides:

getMaxCapacityForElevation in class AdjustableFlow

getCurrentPumpCapacity

public double getCurrentPumpCapacity(RunTimeStep rts)

gets the current maximum release from this outlet this should only be called during a compute

computeForecastStep

public int computeForecastStep(RunTimeStep runtime,
 double[] xt,
 double[] et,
 int tcnt)

Overrides:

computeForecastStep in class AdjustableFlow

computeForecastStep

public int computeForecastStep(RunTimeStep runtime)

Overrides:

computeForecastStep in class AdjustableFlow

computeHindcastStep

public int computeHindcastStep(RunTimeStep runtime)

Description copied from class: AdjustableFlow

compute one release for hind cast

Overrides:

computeHindcastStep in class AdjustableFlow