IWFMModel#
Model Geometry#
Nodes#
Return the number of nodes in an IWFM model |
|
Return the x,y coordinates of the nodes in an IWFM model |
|
Return an array of node ids in an IWFM model |
|
Return node id, x-, and y-coordinates for each node in an IWFM model |
|
|
Return nodes that make up the boundary of an IWFM model |
|
takes an unordered dataframe with two columns of node ids and orders them such that the start id of the next is equal to the end id of the previous. |
Elements#
Return the number of elements in an IWFM model |
|
|
Return an array of node ids for an IWFM element. |
Return an array of element ids in an IWFM model |
|
Return element configuration information for all elements in an IWFM model |
|
Return element configuration information including x-y coordinates for nodes |
Subregions#
Return the number of subregions in an IWFM model |
|
Return an array of IDs for subregions identified in an IWFM model |
|
|
Return the name corresponding to the subregion_id in an IWFM model |
Return the subregions names specified in an IWFM model |
|
Return an array identifying the IWFM Model elements contained within each subregion. |
Stratigraphy#
Return the number of layers in an IWFM model |
|
Return the ground surface elevation for each node specified in the IWFM model |
|
Return the aquifer top elevations for each finite element node and each layer |
|
Return the aquifer bottom elevations for each finite element node and each layer |
|
|
Return the stratigraphy at given X,Y coordinates |
Lakes#
Return the number of lakes in an IWFM model |
|
Return an array of lake IDs in an IWFM model |
|
|
Return the number of finite element grid cells that make up a lake |
|
Return the element ids with the specified lake ID |
Streams#
Return the number of stream reaches in an IWFM model |
|
Return an array of stream reach IDs in an IWFM Model stream reaches in an IWFM model |
|
Return the stream reach names specified in an IWFM model |
|
|
Return the number of stream nodes in a stream reach |
|
Return the stream node IDs corresponding to stream nodes in a specified reach |
|
Return the groundwater node IDs corresponding to stream nodes in a specified reach |
Return the number of stream nodes in an IWFM model |
|
Return an array of stream node IDs in the IWFM model |
|
Return the stream channel bottom elevation at each stream node |
|
|
Return the number of data points in the stream flow rating table for a stream node |
|
Return the stream rating table for a specified stream node |
Return the number of stream nodes immediately upstream of the provided stream node id |
|
Return an array of the stream node ids immediately upstream of the provided stream node id |
|
Return the IDs for the upstream stream node in each stream reach |
|
Return the IDs for the downstream stream node in each stream reach |
|
Return the destination index that each stream reach flows into. |
|
Return the outflow destination types that each stream reach flows into. |
|
|
Return the number of stream reaches immediately upstream of the specified reach |
|
Return the IDs of the reaches that are immediately upstream of the specified reach |
|
checks if a specified stream node .is located upstream from another specified stream node within the stream network of the IWFM model |
Return the stream nodes and groundwater nodes for every reach in an IWFM model |
Bypasses#
Return the number of bypasses in an IWFM model |
|
Return the bypass identification numbers specified in an IWFM model |
|
|
Return the stream node IDs corresponding to bypass locations |
|
Return stream node IDs and destination types and IDS where bypass flows are delivered. |
|
Return the bypass outflows for the current simulation timestep |
|
Return the recoverable loss factor for a bypass |
|
Return the nonrecoverable loss factor for a bypass |
Inflows and Small Watersheds#
Return the number of stream boundary inflows specified by the user as timeseries input data |
|
Return the identification numbers for the stream boundary inflows specified by the user as timeseries input data |
|
Return the stream node IDs that receive boundary inflows specified by the user as timeseries input data |
|
Return the number of small watersheds specified in an IWFM model |
|
Return the small watershed identification numbers specified in the IWFM model |
Tile Drains#
Return the number of tile drain nodes in an IWFM model |
|
Return the user-specified IDs for tile drains simulated in an IWFM model |
|
Return the node ids where tile drains are specified |
Land Use#
Return the number of agricultural crops simulated in an IWFM model |
Stream and Bypass Flows#
|
Return stream flow at a stream node for the current time step in a simulation |
|
Return stream flows at every stream node for the current timestep |
Return gain from groundwater for every stream node for the current timestep |
|
|
Return gain from lakes for every stream node for the current timestep |
Return stream boundary inflows at a specified set of inflow locations listed by their indices for the current simulation timestep |
|
|
Return rainfall runoff at every stream node for the current timestep |
Return the stream reach IDs that correspond to one or more stream node IDs |
|
|
Return agricultural and urban return flows at every stream node for the current timestep |
Return riparian evapotranspiration from every stream node for the current timestep |
|
|
Return stream stages at every stream node for the current timestep |
|
Return tile drain flows into every stream node for the current timestep |
|
Return small watershed inflows at every stream node for the current timestep |
|
Return net bypass inflows for every stream node for the current timestep |
Return actual diversion amounts for a list of diversions during a model simulation |
Diversions and Pumping#
Return the number of surface water diversions in an IWFM model |
|
Return the surface water diversion identification numbers specified in an IWFM model |
|
|
Return the flags for the initial purpose of the diversions as ag, urban, or both |
Return the stream node IDs corresponding to diversion locations |
|
Return the number of wells simulated in an IWFM model |
|
Return the pumping well IDs specified in an IWFM model |
|
|
Return the flags for the initial purpose of the well pumping as ag, urban, or both |
Return the number of element pumps simulated in an IWFM model |
|
Return the element pump IDs specified in an IWFM model |
|
|
Return the flags for the initial purpose of the element pumping as ag, urban, or both |
Return the supply shortage for urban diversions at the destination of those supplies plus any conveyance losses |
|
Return the supply shortage for urban element pumping at the destination of those supplies plus any conveyance losses |
|
Return the supply shortage for urban wells at the destination of those supplies plus any conveyance losses |
|
Return the supply shortage for agricultural diversions at the destination of those supplies plus any conveyance losses |
|
Return the supply shortage for agricultural element pumping at the destination of those supplies plus any conveyance losses |
|
Return the supply shortage for agricultural wells at the destination of those supplies plus any conveyance losses |
|
Return the agricultural supply requirement for one or more model elements |
|
Return the agricultural supply requirement for one or more model subregions |
|
Return the urban supply requirement for one or more model elements |
|
Return the urban supply requirement for one or more model subregions |
Aquifer Properties#
Return the aquifer horizontal hydraulic conductivity for each finite element node and each layer |
|
Return the aquifer vertical hydraulic conductivity for each finite element node and each layer |
|
Return the aquitard vertical hydraulic conductivity for each finite element node and each layer |
|
Return the aquifer specific storage for each finite element node and each layer |
|
Return the aquifer specific yield for each finite element node and each layer |
|
Return all aquifer parameters at each model node and layer |
Simulation Results#
|
Return the simulated groundwater heads for a single user-specified model layer for every model node over a user-specified time interval. |
|
calculates a depth to water for an IWFM model layer for all dates between the provided start date and end date. |
|
Return the groundwater heads at all nodes in every aquifer layer for the current simulation time step |
|
Return the simulated subsidence at all nodes in every aquifer layer for the current simulation time step |
Return subregional depth-to-groundwater values that are weighted-averaged with respect to agricultural pumping rates during a model run |
|
Return zonal depth-to-groundwater values that are weighted-averaged with respect to agricultural pumping rates during a model run |
Simulation Hydrographs#
Return the number of subsidence hydrographs specified in an IWFM model |
|
Return the ids for the subsidence hydrographs specified in an IWFM model |
|
Return the x,y-coordinates for the subsidence hydrograph locations specified in an IWFM model |
|
Return the subsidence hydrograph location names specified in an IWFM model |
|
|
Return the simulated subsidence hydrograph for the provided subsidence hydrograph ID |
Return the number of tile drain hydrographs specified in an IWFM model |
|
Return the ids for the tile drain hydrographs specified in an IWFM model |
|
Return the x,y-coordinates for the tile drain observations specified in an IWFM model |
|
Return the number of groundwater hydrographs specified in an IWFM model |
|
Return the ids for the groundwater hydrographs specified in an IWFM model |
|
Return the x,y-coordinates for the groundwater hydrographs specified in an IWFM model |
|
Return the groundwater hydrograph location names specified in an IWFM model |
|
Return model information for the groundwater hydrographs, including hydrograph ID, x- and y- coordinates, name, and stratigraphy. |
|
|
Return the simulated groundwater hydrograph for the provided groundwater hydrograph ID |
Return a simulated groundwater hydrograph for a node and layer |
|
Return the number of stream flow hydrographs specified in an IWFM model |
|
Return the ids for the stream hydrographs specified in an IWFM model |
|
Return the x,y-coordinates for the stream flow observation locations specified in an IWFM model |
|
Return the stream flow hydrograph location names specified in an IWFM model |
|
|
Return the simulated stream hydrograph for the provided stream hydrograph id |
Return the number of different hydrograph types being printed by the IWFM model |
|
Return a list of different hydrograph types being printed by the IWFM model |
Plotting#
|
plots model nodes on predefined axes |
|
plots model elements on predefined axes |
Model Simulation#
advances the state of the hydrologic system in time (e.g. groundwater heads at current timestep are switched to groundwater heads at previous timestep) during a model run. |
|
advances the simulation time step by one simulation time step |
|
reads in all of the time series data for the current simulation time step |
|
reads time series data for the current simulation time step and allows overwriting certain time series data |
|
restores the pumping rates to the values read from the Pumping Rate input file during a model run. |
|
|
opens a text log file to print out error and warning messages |
the error message in case a procedure call from IWFM API returns an error code (status) other than 0 |
|
prints the last error message (generated when a procedure call from IWFM API returns an error code (status) other than 0) to the message log file |
|
|
sets the path to the directory where the preprocessor main input file is located |
|
sets the path to the directory where the simulation main input file is located |
turns the automatic supply adjustment of diversions and pumping to meet agricultural and/or urban water demands on or off during a model run |
|
sets the maximum number of iterations that will be used in automatic supply adjustment |
|
|
sets the tolerance, given as a fraction of the water demand that will be used in automatic supply adjustment |
performs all of the computations for the entire simulation period |
|
|
simulates the model application for a specified time interval |
simulates a single timestep of the model application |
|
prints out all the simulation results at the end of a simulation |
|
check if the end of simulation period has been reached during a model run |
General#
|
Instantiate the IWFM Model Object. |
|
Terminate the IWFM Model Object. |
check if a Model object is instantiated |
|
deletes the binary file, IW_ModelData_ForInquiry.bin, generated by the IWFM DLL when the Model Object is instantiated |
|
returns the version of the IWFM DLL |
Private Methods#
determines if a provided time_interval is greater than or equal to the simulation_time_interval |
|
|
Return the available names for a given location_type |
|
private method returning the number of hydrographs for a given IWFM feature type |
|
private method returning the ids of the hydrographs for a provided location type |
|
private method returning the hydrograph coordinates for a provided feature type |
|
private method returning a simulated hydrograph for a selected hydrograph type and hydrograph index |
|
converts a string to a list of strings based on an array of the starting character position (index). |
performs validation that a provided value is an IWFM-format date string based on string length and format MM/DD/YYYY_HH:MM |
|
|
performs validation that a provided value is an IWFM-format time-interval string |
|
private method returning the flags for the initial assignment of water supplies (diversions, well pumping, element pumping) designating if they serve agricultural, urban, or both |
|
Return the agricultural water supply requirement at a specified set of locations |
Return the urban water supply requirement at a specified set of locations |
|
private method returning the supply shortage for agriculture at the destination of those supplies plus any conveyance losses |
|
Return the supply shortage for agriculture at the destination of those supplies plus any conveyance losses |
|
|
private method returning the number of locations for a specified location type |
|
private method returning the location identification numbers used by the model for a specified location type |