uaa.feral.physical.behaviors
Class EvolveHydrology

java.lang.Object
  extended by uaa.feral.physical.behaviors.EvolveHydrology
All Implemented Interfaces:
HydroBehavior
Direct Known Subclasses:
GroundWaterModelWrapper, RemoteSensingEstimator, StaticDischargeModel, VolumeEstimatorModel

public abstract class EvolveHydrology
extends java.lang.Object
implements HydroBehavior

Abstract class for hydrological behaviors evolving the hydrological unit

Author:
Mark Altaweel

Constructor Summary
EvolveHydrology()
           
 
Method Summary
static HydroBehavior CreateHydroModel(ScenarioData sd, java.lang.String modelType)
           
 double getDegradeAmount()
           
 java.lang.String getName()
          Method to get the name of the model
 ScenarioData getScenarioData()
           
 java.util.Map<java.lang.String,java.util.Map<java.lang.Integer,double[]>> getWaterBodyData()
          Method gets data for a water body based on the water body's name, with data containing info on monthly discharge/volume
 java.util.Map<java.lang.String,java.lang.Double> getWaterQuantityByBody()
          Method to get the current estimated discharge for rivers
 boolean isDegradeQuantity()
          Check to see if hydrology quantity is degraded
 void runModel()
          Method to run the model
 void setData(java.util.Map<java.lang.String,java.util.Map<java.lang.Integer,double[]>> data)
          Discharge/volume data set according to river/water source name and data arranged by month (month represented by an integer
 void setDegradeAmount(double degradeAmount)
           
 void setDegradeQuantity(boolean degradeQuantity)
           
 void setScenarioData(ScenarioData scenarioData)
          Method to set the scenario data
 void setTickReset(double tickReset)
          Method to reset when a model should reset to older data.
 void setupModelData()
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface uaa.feral.physical.behaviors.HydroBehavior
setDischargeInfo
 

Constructor Detail

EvolveHydrology

public EvolveHydrology()
Method Detail

runModel

public void runModel()
Description copied from interface: HydroBehavior
Method to run the model

Specified by:
runModel in interface HydroBehavior

getName

public java.lang.String getName()
Description copied from interface: HydroBehavior
Method to get the name of the model

Specified by:
getName in interface HydroBehavior

setupModelData

public void setupModelData()

getWaterQuantityByBody

public java.util.Map<java.lang.String,java.lang.Double> getWaterQuantityByBody()
Description copied from interface: HydroBehavior
Method to get the current estimated discharge for rivers

Specified by:
getWaterQuantityByBody in interface HydroBehavior
Returns:

setData

public void setData(java.util.Map<java.lang.String,java.util.Map<java.lang.Integer,double[]>> data)
Description copied from interface: HydroBehavior
Discharge/volume data set according to river/water source name and data arranged by month (month represented by an integer

Specified by:
setData in interface HydroBehavior
Parameters:
data - the data map containing discharge/volume information

getWaterBodyData

public java.util.Map<java.lang.String,java.util.Map<java.lang.Integer,double[]>> getWaterBodyData()
Description copied from interface: HydroBehavior
Method gets data for a water body based on the water body's name, with data containing info on monthly discharge/volume

Specified by:
getWaterBodyData in interface HydroBehavior
Returns:
a map with the water body's data

setTickReset

public void setTickReset(double tickReset)
Description copied from interface: HydroBehavior
Method to reset when a model should reset to older data. This is intended to be used in a Markov model

Specified by:
setTickReset in interface HydroBehavior
Parameters:
tickReset - tick when to reset

CreateHydroModel

public static HydroBehavior CreateHydroModel(ScenarioData sd,
                                             java.lang.String modelType)

isDegradeQuantity

public boolean isDegradeQuantity()
Description copied from interface: HydroBehavior
Check to see if hydrology quantity is degraded

Specified by:
isDegradeQuantity in interface HydroBehavior
Returns:
a boolean to see if degrade quantity or not

setDegradeQuantity

public void setDegradeQuantity(boolean degradeQuantity)

getScenarioData

public ScenarioData getScenarioData()

setScenarioData

public void setScenarioData(ScenarioData scenarioData)
Description copied from interface: HydroBehavior
Method to set the scenario data

Specified by:
setScenarioData in interface HydroBehavior
Parameters:
scenarioData - the scenario data

getDegradeAmount

public double getDegradeAmount()

setDegradeAmount

public void setDegradeAmount(double degradeAmount)