The WaterSim type exposes the following members.

Constructors

  NameDescription
Public methodWaterSim
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

  NameDescription
Public methodColorado_Historical_Extraction_Start_Year_RangeCheck
Colorado_Historical_Extraction_Start_Year_RangeCheck
Public methodCreateDirectory
Creates a Directory of directoryName if it does not exist. Relative references is from the directory the program is executing from
Public methodDispose
Must be called before WaterSim object loses scope or is lost (reassigned).
Public methodFastGetAnnualData
Fast get annual data.
Public methodLockSimulation
Locks the simulation so not parameters can be set until unlocked. ///
Public methodPCTEffluentRangeCheck
PCTEffluentRangeCheck
Public methodPCTReclaimedRangeCheck
PCTReclaimedRangeCheck - Check to see of all the PCT reclaimed model paramters do nt eceeed 100% total
Public methodPCTResComRangeCheck
PCTResComRangeCheck - Checks to see if Residential an Commerical water use PCT does not excede 100.
Public methodProvider_Demand_Option_Label
Provider demand option label.
Public methodSaltVerde_Historical_Extraction_Start_Year_RangeCheck
SaltVerde_Historical_Extraction_Start_Year_RangeCheck
Public methodSimulation_AllYears
Runs all years of the specified simulation
Public methodSimulation_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;
Public methodSimulation_NextYear
Runs one year of simulation, no pre or post process is evoked.
Public methodSimulation_Stop
Stops simulation stop
Public methodsimulationYears
Public methodUnLockSimulation

Fields

  NameDescription
Public fieldColorado_Annual_Deliveries
The colorado annual deliveries
Public fieldColoradoBureau
The Colorado River Bureau/Historical River Range
Public fieldColoradoPaleo
The Colorado River Paleo River Range
Public fieldColoradoUser
Colorado river range for user supplied data
Public fieldDemand_Deficit
The demand deficit
Public fieldEffluent_Created
The effluent created
Public fieldEffluent_Discharged
The effluent discharged
Public fieldEffluent_To_PowerPlant
The effluent to power plant
Public fieldEffluent_To_Vadose
The effluent to vadose
Public fieldGPCD_Used
The gpcd used
Public fieldGroundwater_Balance
The groundwater balance
Public fieldGroundwater_Bank_Balance
The groundwater bank balance
Public fieldGroundwater_Bank_Used
The groundwater bank used
Public fieldGroundwater_Pumped_Municipal
The groundwater pumped municipal
Public fieldPCT_Effluent_to_PowerPlant
The percent effluent to power plant
Public fieldPCT_Effluent_to_Vadose
The percent effluent to vadose
Public fieldPCT_Groundwater_Treated
The percent groundwater treated
Public fieldPCT_Growth_Rate_Adjustment
The percent growth rate adjustment
Public fieldPCT_Max_Demand_Reclaim
The percent maximum demand reclaim
Public fieldPCT_Outdoor_WaterUse
The percent outdoor water use
Public fieldPCT_Reclaimed_Outdoor_Use
The percent reclaimed outdoor use
Public fieldPCT_Reclaimed_to_DirectInject
The percent reclaimed to direct inject
Public fieldPCT_Reclaimed_to_RO
The percent reclaimed to Reverse Osmosis
Public fieldPCT_Reclaimed_to_Vadose
The percent reclaimed to vadose
Public fieldPCT_Reclaimed_to_Water_Supply
The percent reclaimed to water supply
Public fieldPCT_RO_to_Water_Supply
The percent reverse osmosis water to water supply
Public fieldPCT_SurfaceWater_to_WaterBank
The percent surface water to water bank
Public fieldPCT_Wastewater_Reclaimed
The percent wastewater reclaimed
Public fieldPCT_Wastewater_to_Effluent
The percent wastewater to effluent
Public fieldPCT_WaterSupply_to_ComInd
The percent water supply to com ind
Public fieldPCT_WaterSupply_to_Residential
The percent water supply to residential
Public fieldStatic memberpdoAverageGPCDandPOP
Average gpcd and pop
Public fieldStatic memberpdoDecliningGPCDandPOP
Declining gpcd and pop
Public fieldStatic memberpdoDemandFromFile
Demand from file
Public fieldStatic memberpdoUserGPCDandPOP
User gpcd and pop
Public fieldPopulation_Used
The population used
Public fieldReclaimed_Water_Created
The reclaimed water created
Public fieldReclaimed_Water_Discharged
The reclaimed water discharged
Public fieldReclaimed_Water_to_DirectInject
The reclaimed water to direct inject
Public fieldReclaimed_Water_To_Vadose
The reclaimed water to vadose
Public fieldReclaimed_Water_Used
The reclaimed water used
Public fieldRO_Reclaimed_Water_Created
The ro reclaimed water created
Public fieldRO_Reclaimed_Water_to_DirectInject
The ro reclaimed water to direct inject
Public fieldRO_Reclaimed_Water_Used
The ro reclaimed water used
Public fieldStatic memberrsBureausource
Constant for Bureau Historical River Record source
Public fieldStatic memberrsPaleosource
Constant for Tree Ring Paleo River Record source
Public fieldStatic memberrsUsersource
Constant for User Riversource
Public fieldSaltVerde_Annual_Deliveries_SRP
The salt verde annual deliveries srp
Public fieldSaltVerde_Class_BC_Designations
Public fieldSaltVerdeBureau
The Salt Verde Bureau/Historical River Range
Public fieldSaltVerdePaleo
The Salt Verde Rivers Paleo/Tree Ring River Range
Public fieldSaltVerdeUser
Salt Verde river range for user supplied data
Public fieldSurface_to_Vadose_Time_Lag
The surface to vadose time lag
Public fieldSurfaceWater__to_Vadose
Surface water to vadose
Public fieldTotal_Demand
The total demand
Public fieldUse_GPCD
The gpcd to use with User Supplied GPCD
Public fieldUse_SurfaceWater_to_WaterBank
The use surface water to water bank
Public fieldUse_WaterSupply_to_DirectInject
The amount of water to direct inject
Public fieldWaterBank_Source_Option
The water bank source option

Properties

  NameDescription
Public propertyAPiVersion
Version of the API interface
Public propertyColorado_Climate_Adjustment_Percent
Gets or sets the colorado climate adjustment percent.
Public propertyColorado_Historical_Data_Source
Gets or sets the colorado historical data source.
Public propertyColorado_Historical_Extraction_Start_Year
Gets or sets the colorado historical extraction start year.
Public propertyColorado_River_Flow
Gets the colorado river flow.
Public propertyColorado_User_Adjustment_Percent
Gets or sets the colorado user adjustment percent.
Public propertyColorado_User_Adjustment_StartYear
Gets or sets the colorado user adjustment start year.
Public propertyColorado_User_Adjustment_Stop_Year
Gets or sets the colorado user adjustment stop year.
Public propertyStatic memberCreateModelOutputFiles
Tells FORTRAN model to write debug files. Must be set TRUE before WaterSim constructor is called.
Public propertyEffluent_To_Agriculture
Gets the effluent to agriculture.
Public propertyMead_Storage
Gets the mead storage.
Public propertyModelBuild
Verson of the Fortran Model
Public propertyParamManager
Provides access to the Parameter Manager
Public propertyPostProcess
Called after each year run Write Only
Public propertyPowell_Storage
Gets the powell storage.
Public propertyPreProcess
Called before each year run, Write Only
Public propertyProcessManager
Provides access to the Process Manager
Public propertyProvider_Demand_Option
Gets or sets the provider demand option.
Public propertySaltVerde_Climate_Adjustment_Percent
Gets or sets the salt verde climate adjustment percent.
Public propertySaltVerde_Historical_Data_Source
Gets or sets the salt verde historical data source.
Public propertySaltVerde_Historical_Extraction_Start_Year
Gets or sets the salt verde historical extraction start year.
Public propertySaltVerde_River_Flow
Gets the salt verde river flow.
Public propertySaltVerde_Storage
Gets the salt verde storage.
Public propertySaltVerde_User_Adjustment_Percent
Gets or sets the salt verde user adjustment percent.
Public propertySaltVerde_User_Adjustment_Start_Year
Gets or sets the salt verde user adjustment start year.
Public propertySaltVerde_User_Adjustment_Stop_Year
Gets or sets the salt verde user adjustment stop year.
Public propertySimulation_End_Year
Gets or sets the simulation end year.
Public propertySimulation_Start_Year
Simulation_Start_Year
Public propertySimulationLock
Property Locks the simulation so no parameters can be set until unlocked.

See Also