The WaterSim type exposes the following members.
Constructors
Name | Description | |
---|---|---|
WaterSim |
Constructor - Loads DLL (if not yet loaded) and initializes the model, only one instance of this class can be created. Will throw an exception if more than one is created
|
Methods
Name | Description | |
---|---|---|
Colorado_Historical_Extraction_Start_Year_RangeCheck |
Colorado_Historical_Extraction_Start_Year_RangeCheck
| |
CreateDirectory |
Creates a Directory of directoryName if it does not exist. Relative references is from the directory the program is executing from
| |
Dispose |
Must be called before WaterSim object loses scope or is lost (reassigned).
| |
FastGetAnnualData | Fast get annual data. | |
LockSimulation |
Locks the simulation so not parameters can be set until unlocked.
/// | |
PCTEffluentRangeCheck |
PCTEffluentRangeCheck
| |
PCTReclaimedRangeCheck |
PCTReclaimedRangeCheck - Check to see of all the PCT reclaimed model paramters do nt eceeed 100% total
| |
PCTResComRangeCheck |
PCTResComRangeCheck - Checks to see if Residential an Commerical water use PCT does not excede 100.
| |
Provider_Demand_Option_Label | Provider demand option label. | |
SaltVerde_Historical_Extraction_Start_Year_RangeCheck |
SaltVerde_Historical_Extraction_Start_Year_RangeCheck
| |
Simulation_AllYears |
Runs all years of the specified simulation
| |
Simulation_Initialize |
Must be called to setup a Simulation . Simulation can be run in two ways,
calling SimulationNextYear() for each year to be run, call SimulationAllYears() which runs all the years
All simulations should be stopped with StopSimulation(), which will make sure all files are closed
Will reset SimulationLock to false;
| |
Simulation_NextYear |
Runs one year of simulation, no pre or post process is evoked.
| |
Simulation_Stop | Stops simulation stop | |
simulationYears | ||
UnLockSimulation |
Fields
Name | Description | |
---|---|---|
Colorado_Annual_Deliveries | The colorado annual deliveries | |
ColoradoBureau | The Colorado River Bureau/Historical River Range | |
ColoradoPaleo | The Colorado River Paleo River Range | |
ColoradoUser | Colorado river range for user supplied data | |
Demand_Deficit | The demand deficit | |
Effluent_Created | The effluent created | |
Effluent_Discharged | The effluent discharged | |
Effluent_To_PowerPlant | The effluent to power plant | |
Effluent_To_Vadose | The effluent to vadose | |
GPCD_Used | The gpcd used | |
Groundwater_Balance | The groundwater balance | |
Groundwater_Bank_Balance | The groundwater bank balance | |
Groundwater_Bank_Used | The groundwater bank used | |
Groundwater_Pumped_Municipal | The groundwater pumped municipal | |
PCT_Effluent_to_PowerPlant | The percent effluent to power plant | |
PCT_Effluent_to_Vadose | The percent effluent to vadose | |
PCT_Groundwater_Treated | The percent groundwater treated | |
PCT_Growth_Rate_Adjustment | The percent growth rate adjustment | |
PCT_Max_Demand_Reclaim | The percent maximum demand reclaim | |
PCT_Outdoor_WaterUse | The percent outdoor water use | |
PCT_Reclaimed_Outdoor_Use | The percent reclaimed outdoor use | |
PCT_Reclaimed_to_DirectInject | The percent reclaimed to direct inject | |
PCT_Reclaimed_to_RO | The percent reclaimed to Reverse Osmosis | |
PCT_Reclaimed_to_Vadose | The percent reclaimed to vadose | |
PCT_Reclaimed_to_Water_Supply | The percent reclaimed to water supply | |
PCT_RO_to_Water_Supply | The percent reverse osmosis water to water supply | |
PCT_SurfaceWater_to_WaterBank | The percent surface water to water bank | |
PCT_Wastewater_Reclaimed | The percent wastewater reclaimed | |
PCT_Wastewater_to_Effluent | The percent wastewater to effluent | |
PCT_WaterSupply_to_ComInd | The percent water supply to com ind | |
PCT_WaterSupply_to_Residential | The percent water supply to residential | |
pdoAverageGPCDandPOP | Average gpcd and pop | |
pdoDecliningGPCDandPOP | Declining gpcd and pop | |
pdoDemandFromFile | Demand from file | |
pdoUserGPCDandPOP | User gpcd and pop | |
Population_Used | The population used | |
Reclaimed_Water_Created | The reclaimed water created | |
Reclaimed_Water_Discharged | The reclaimed water discharged | |
Reclaimed_Water_to_DirectInject | The reclaimed water to direct inject | |
Reclaimed_Water_To_Vadose | The reclaimed water to vadose | |
Reclaimed_Water_Used | The reclaimed water used | |
RO_Reclaimed_Water_Created | The ro reclaimed water created | |
RO_Reclaimed_Water_to_DirectInject | The ro reclaimed water to direct inject | |
RO_Reclaimed_Water_Used | The ro reclaimed water used | |
rsBureausource | Constant for Bureau Historical River Record source | |
rsPaleosource | Constant for Tree Ring Paleo River Record source | |
rsUsersource | Constant for User Riversource | |
SaltVerde_Annual_Deliveries_SRP | The salt verde annual deliveries srp | |
SaltVerde_Class_BC_Designations | ||
SaltVerdeBureau | The Salt Verde Bureau/Historical River Range | |
SaltVerdePaleo | The Salt Verde Rivers Paleo/Tree Ring River Range | |
SaltVerdeUser | Salt Verde river range for user supplied data | |
Surface_to_Vadose_Time_Lag | The surface to vadose time lag | |
SurfaceWater__to_Vadose | Surface water to vadose | |
Total_Demand | The total demand | |
Use_GPCD | The gpcd to use with User Supplied GPCD | |
Use_SurfaceWater_to_WaterBank | The use surface water to water bank | |
Use_WaterSupply_to_DirectInject | The amount of water to direct inject | |
WaterBank_Source_Option | The water bank source option |
Properties
Name | Description | |
---|---|---|
APiVersion |
Version of the API interface
| |
Colorado_Climate_Adjustment_Percent | Gets or sets the colorado climate adjustment percent. | |
Colorado_Historical_Data_Source | Gets or sets the colorado historical data source. | |
Colorado_Historical_Extraction_Start_Year | Gets or sets the colorado historical extraction start year. | |
Colorado_River_Flow | Gets the colorado river flow. | |
Colorado_User_Adjustment_Percent | Gets or sets the colorado user adjustment percent. | |
Colorado_User_Adjustment_StartYear | Gets or sets the colorado user adjustment start year. | |
Colorado_User_Adjustment_Stop_Year | Gets or sets the colorado user adjustment stop year. | |
CreateModelOutputFiles |
Tells FORTRAN model to write debug files. Must be set TRUE before WaterSim constructor is called.
| |
Effluent_To_Agriculture | Gets the effluent to agriculture. | |
Mead_Storage | Gets the mead storage. | |
ModelBuild |
Verson of the Fortran Model
| |
ParamManager |
Provides access to the Parameter Manager
| |
PostProcess |
Called after each year run
Write Only
| |
Powell_Storage | Gets the powell storage. | |
PreProcess |
Called before each year run,
Write Only
| |
ProcessManager |
Provides access to the Process Manager
| |
Provider_Demand_Option | Gets or sets the provider demand option. | |
SaltVerde_Climate_Adjustment_Percent | Gets or sets the salt verde climate adjustment percent. | |
SaltVerde_Historical_Data_Source | Gets or sets the salt verde historical data source. | |
SaltVerde_Historical_Extraction_Start_Year | Gets or sets the salt verde historical extraction start year. | |
SaltVerde_River_Flow | Gets the salt verde river flow. | |
SaltVerde_Storage | Gets the salt verde storage. | |
SaltVerde_User_Adjustment_Percent | Gets or sets the salt verde user adjustment percent. | |
SaltVerde_User_Adjustment_Start_Year | Gets or sets the salt verde user adjustment start year. | |
SaltVerde_User_Adjustment_Stop_Year | Gets or sets the salt verde user adjustment stop year. | |
Simulation_End_Year | Gets or sets the simulation end year. | |
Simulation_Start_Year |
Simulation_Start_Year
| |
SimulationLock |
Property Locks the simulation so no parameters can be set until unlocked.
|