Structure Struct Reference
Water control structure attributes. More...
#include <watmgmt.h>
Data Fields | |
| int | flag |
| int | histID |
| int | aggID |
| char | S_nam [20] |
| int | str_cell_i |
| int | str_cell_j |
| int | canal_fr |
| int | canal_to |
| int | cell_i_fr |
| int | cell_j_fr |
| int | cell_i_to |
| int | cell_j_to |
| float | HW_stage |
| float | TW_stage |
| struct Schedule * | HW_graph |
| struct Schedule * | TW_graph |
| int | flagTWsched |
| int | flagHWsched |
| int | flagTWtide |
| int | flagHWtide |
| int | cell_i_HW |
| int | cell_j_HW |
| int | cell_i_TW |
| int | cell_j_TW |
| int | cell_HW |
| int | cell_TW |
| float | w_coef |
| double | flow |
| int | TPser |
| int | TNser |
| int | TSser |
| float | TP |
| float | TN |
| float | TS |
| double | conc_P |
| double | conc_N |
| double | conc_S |
| double | SumFlow |
| double | Sum_P |
| double | Sum_N |
| double | Sum_S |
| int | multiOut |
| char | SrcDest [10] |
| struct Structure * | next_in_list |
Detailed Description
Water control structure attributes.Definition at line 153 of file watmgmt.h.
Field Documentation
| int Structure::flag |
historical/other-data data flag: <0 = skip structure info, structure not operating; 0 = rule-based structure; >0 = historical/other-data data array, flag=1 normally in this case, but is >1 for aggregated SFWMM structures;
Definition at line 155 of file watmgmt.h.
Referenced by flowData_CanCan(), flowData_CanCel(), Flows_in_Structures(), ReadStructFlow_PtSer(), and ReadStructures().
historical/other-data structure ID
Definition at line 156 of file watmgmt.h.
Referenced by flowCalc_CelCan(), flowData_CanCan(), flowData_CanCel(), flowData_CelCan(), flowData_CelCel(), ReadStructFlow_PtSer(), and ReadStructures().
| int Structure::aggID |
| char Structure::S_nam[20] |
water control structure name
Definition at line 158 of file watmgmt.h.
Referenced by Canal_Network_Init(), flowCalc_CanCan(), flowCalc_CanCel(), flowCalc_CelCan(), flowData_CanCan(), flowData_CanCel(), flowData_CelCan(), flowData_CelCel(), Flows_in_Structures(), ReadStructFlow_PtSer(), ReadStructTP_PtSer(), ReadStructTS_PtSer(), and ReadStructures().
row of the water control structure's cell
Definition at line 159 of file watmgmt.h.
Referenced by flowCalc_CanCan(), flowCalc_CanCel(), flowData_CanCan(), flowData_CanCel(), flowData_CelCan(), and ReadStructures().
column of the water control structure's cell
Definition at line 160 of file watmgmt.h.
Referenced by flowCalc_CanCan(), flowCalc_CanCel(), flowData_CanCan(), flowData_CanCel(), flowData_CelCan(), and ReadStructures().
number-ID of the donor canal
Definition at line 161 of file watmgmt.h.
Referenced by flowCalc_CanCan(), flowCalc_CanCel(), flowData_CanCan(), flowData_CanCel(), FluxChannel(), and ReadStructures().
number-ID of the recipient canal
Definition at line 162 of file watmgmt.h.
Referenced by flowCalc_CanCan(), flowCalc_CelCan(), flowData_CanCan(), flowData_CanCel(), flowData_CelCan(), FluxChannel(), and ReadStructures().
row of the donor water control structure's cell
Definition at line 163 of file watmgmt.h.
Referenced by flowCalc_CelCan(), flowCalc_CelCel(), flowData_CelCan(), flowData_CelCel(), and ReadStructures().
column of the donor water control structure's cell
Definition at line 164 of file watmgmt.h.
Referenced by flowCalc_CelCel(), flowData_CelCan(), flowData_CelCel(), and ReadStructures().
row of the recipient water control structure's cell
Definition at line 165 of file watmgmt.h.
Referenced by flowCalc_CanCel(), flowCalc_CelCel(), flowData_CanCan(), flowData_CanCel(), flowData_CelCel(), and ReadStructures().
column of the recipient water control structure's cell
Definition at line 166 of file watmgmt.h.
Referenced by flowCalc_CanCel(), flowCalc_CelCel(), flowData_CanCan(), flowData_CanCel(), flowData_CelCel(), and ReadStructures().
| float Structure::HW_stage |
target stage in canal or cell upstream
Definition at line 167 of file watmgmt.h.
Referenced by flowCalc_CanCan(), flowCalc_CanCel(), flowCalc_CelCan(), Flows_in_Structures(), and ReadStructures().
| float Structure::TW_stage |
target stage in canal or cell downstream
Definition at line 168 of file watmgmt.h.
Referenced by flowCalc_CanCan(), flowCalc_CanCel(), flowCalc_CelCan(), Flows_in_Structures(), and ReadStructures().
struct Schedule* Structure::HW_graph [read] |
pointer to array of data if headwater target stage is to be an annual schedule graph (time-varying)
Definition at line 169 of file watmgmt.h.
Referenced by Flows_in_Structures(), and ReadStructures().
struct Schedule* Structure::TW_graph [read] |
pointer to array of data if tailwater target stage is to be an annual schedule graph (time-varying)
Definition at line 170 of file watmgmt.h.
Referenced by Flows_in_Structures(), and ReadStructures().
flag to indicate the type of TailWater target to be used (-1=none, 0=constant, or 1=annual schedule)
Definition at line 171 of file watmgmt.h.
Referenced by flowCalc_CanCan(), flowCalc_CanCel(), flowCalc_CelCan(), Flows_in_Structures(), and ReadStructures().
flag to indicate the type of HeadWater target to be used (-1=none, 0=constant, or 1=annual schedule)
Definition at line 172 of file watmgmt.h.
Referenced by flowCalc_CanCan(), flowCalc_CanCel(), flowCalc_CelCan(), Flows_in_Structures(), and ReadStructures().
flag to indicate a TailWater management schedule that is tidal (true) or non-tidal (false), thus susceptible to Sea Level Rise
Definition at line 173 of file watmgmt.h.
Referenced by Flows_in_Structures(), and ReadStructures().
flag to indicate a HeadWater management schedule that is tidal (true) or non-tidal (false), thus susceptible to Sea Level Rise
Definition at line 174 of file watmgmt.h.
Referenced by Flows_in_Structures(), and ReadStructures().
row of the headwater cell that may influence the operation
Definition at line 175 of file watmgmt.h.
Referenced by flowCalc_CelCan(), and ReadStructures().
column of the headwater cell that may influence the operation
Definition at line 176 of file watmgmt.h.
Referenced by flowCalc_CelCan(), and ReadStructures().
row of the tailwater cell that may influence the operation
Definition at line 177 of file watmgmt.h.
Referenced by flowCalc_CanCel(), and ReadStructures().
column of the tailwater cell that may influence the operation
Definition at line 178 of file watmgmt.h.
Referenced by flowCalc_CanCel(), and ReadStructures().
cell ID of the headwater cell that may influence the operation
Definition at line 179 of file watmgmt.h.
Referenced by flowCalc_CanCan(), flowCalc_CanCel(), and ReadStructures().
cell ID of the tailwater cell that may influence the operation
Definition at line 180 of file watmgmt.h.
Referenced by flowCalc_CanCan(), flowCalc_CelCan(), and ReadStructures().
| float Structure::w_coef |
weir coefficient (=0 for virtual structure)
Definition at line 181 of file watmgmt.h.
Referenced by flowCalc_CanCan(), flowCalc_CanCel(), flowCalc_CelCan(), flowCalc_CelCel(), and ReadStructures().
| double Structure::flow |
flow through structure (m^3/d)
Definition at line 182 of file watmgmt.h.
Referenced by flowCalc_CanCan(), flowCalc_CanCel(), flowCalc_CelCan(), flowCalc_CelCel(), flowData_CanCan(), flowData_CanCel(), flowData_CelCan(), flowData_CelCel(), Flows_in_Structures(), and FluxChannel().
| int Structure::TPser |
TP conc: flag to indicate use of concentration that is: -1=calc'd, 0= constant, 1=time series
Definition at line 183 of file watmgmt.h.
Referenced by flowCalc_CelCan(), flowData_CanCan(), flowData_CanCel(), flowData_CelCan(), flowData_CelCel(), and ReadStructures().
| int Structure::TNser |
UNUSED TN conc: flag to indicate use of concentration that is: -1=calc'd, 0= constant, 1=time series
Definition at line 184 of file watmgmt.h.
Referenced by flowCalc_CelCan(), flowData_CanCan(), flowData_CanCel(), flowData_CelCan(), flowData_CelCel(), and ReadStructures().
| int Structure::TSser |
TS (Total Salt) conc: flag to indicate use of concentration that is: -1=calc'd, 0= constant, 1=time series
Definition at line 185 of file watmgmt.h.
Referenced by flowCalc_CelCan(), flowData_CanCan(), flowData_CanCel(), flowData_CelCan(), flowData_CelCel(), and ReadStructures().
| float Structure::TP |
historical TP concentration, constant value across time
Definition at line 186 of file watmgmt.h.
Referenced by flowCalc_CelCan(), flowData_CanCan(), flowData_CanCel(), flowData_CelCan(), flowData_CelCel(), and ReadStructures().
| float Structure::TN |
UNUSED historical TN concentration, constant value across time
Definition at line 187 of file watmgmt.h.
Referenced by flowCalc_CelCan(), flowData_CanCan(), flowData_CanCel(), flowData_CelCan(), flowData_CelCel(), and ReadStructures().
| float Structure::TS |
historical TS (salt) concentration, constant value across time
Definition at line 188 of file watmgmt.h.
Referenced by flowCalc_CelCan(), flowData_CanCan(), flowData_CanCel(), flowData_CelCan(), flowData_CelCel(), and ReadStructures().
| double Structure::conc_P |
Phosphorus conc in flow through structure (g/L = kg/m3)
Definition at line 189 of file watmgmt.h.
Referenced by flowCalc_CanCan(), flowCalc_CanCel(), flowCalc_CelCan(), flowCalc_CelCel(), flowData_CanCan(), flowData_CanCel(), flowData_CelCan(), flowData_CelCel(), and Flows_in_Structures().
| double Structure::conc_N |
Nitrogen conc in flow through structure (g/L = kg/m3)
Definition at line 190 of file watmgmt.h.
Referenced by flowCalc_CanCan(), flowCalc_CanCel(), flowCalc_CelCan(), flowData_CanCan(), flowData_CanCel(), flowData_CelCan(), flowData_CelCel(), and Flows_in_Structures().
| double Structure::conc_S |
Salt conc in flow through structure (g/L = kg/m3)
Definition at line 191 of file watmgmt.h.
Referenced by flowCalc_CanCan(), flowCalc_CanCel(), flowCalc_CelCan(), flowCalc_CelCel(), flowData_CanCan(), flowData_CanCel(), flowData_CelCan(), flowData_CelCel(), and Flows_in_Structures().
| double Structure::SumFlow |
sum of flow through structure over the summary interval (m^3)
Definition at line 192 of file watmgmt.h.
Referenced by Flows_in_Structures(), and ReadStructures().
| double Structure::Sum_P |
TP mass sum (conc_P*flow) in flow through structure over the summary interval (kg)
Definition at line 193 of file watmgmt.h.
Referenced by Flows_in_Structures(), and ReadStructures().
| double Structure::Sum_N |
UNUSED nitrogen mass sum (conc_N*flow) in flow through structure over the summary interval (kg)
Definition at line 194 of file watmgmt.h.
Referenced by ReadStructures().
| double Structure::Sum_S |
salt mass sum (conc_S*flow) in flow through structure over the summary interval (kg)
Definition at line 195 of file watmgmt.h.
Referenced by Flows_in_Structures(), and ReadStructures().
flag to indicate a structure has been processed as multiple outflow from one canal
Definition at line 196 of file watmgmt.h.
Referenced by flowData_CanCan(), flowData_CanCel(), flowData_CelCan(), and Flows_in_Structures().
| char Structure::SrcDest[10] |
raster-vector flow type, of Source and Destination: Canal ('Can') or Cell ('Cel')
Definition at line 197 of file watmgmt.h.
Referenced by Flows_in_Structures(), and ReadStructures().
struct Structure* Structure::next_in_list [read] |
points to the next structure in list
Definition at line 198 of file watmgmt.h.
Referenced by Canal_Network_Init(), flowData_CanCan(), flowData_CanCel(), Flows_in_Structures(), FluxChannel(), ReadStructFlow_PtSer(), and ReadStructures().
The documentation for this struct was generated from the following file:
