### GWE-UZE #### Structure of Blocks _FOR EACH SIMULATION_ ``` BEGIN OPTIONS [FLOW_PACKAGE_NAME ] [AUXILIARY ] [FLOW_PACKAGE_AUXILIARY_NAME ] [BOUNDNAMES] [PRINT_INPUT] [PRINT_TEMPERATURE] [PRINT_FLOWS] [SAVE_FLOWS] [TEMPERATURE FILEOUT ] [BUDGET FILEOUT ] [BUDGETCSV FILEOUT ] [TS6 FILEIN ] [OBS6 FILEIN ] END OPTIONS ``` ``` BEGIN PACKAGEDATA [] [] [] [] ... END PACKAGEDATA ``` _FOR ANY STRESS PERIOD_ ``` BEGIN PERIOD ... END PERIOD ``` #### Explanation of Variables ##### Block: OPTIONS * `flow_package_name` keyword to specify the name of the corresponding flow package. If not specified, then the corresponding flow package must have the same name as this advanced transport package (the name associated with this package in the GWE name file). * `auxiliary` defines an array of one or more auxiliary variable names. There is no limit on the number of auxiliary variables that can be provided on this line; however, lists of information provided in subsequent blocks must have a column of data for each auxiliary variable name defined here. The number of auxiliary variables detected on this line determines the value for naux. Comments cannot be provided anywhere on this line as they will be interpreted as auxiliary variable names. Auxiliary variables may not be used by the package, but they will be available for use by other parts of the program. The program will terminate with an error if auxiliary variables are specified on more than one line in the options block. * `flow_package_auxiliary_name` keyword to specify the name of an auxiliary variable in the corresponding flow package. If specified, then the simulated temperatures from this advanced transport package will be copied into the auxiliary variable specified with this name. Note that the flow package must have an auxiliary variable with this name or the program will terminate with an error. If the flows for this advanced transport package are read from a file, then this option will have no effect. * `BOUNDNAMES` keyword to indicate that boundary names may be provided with the list of unsaturated zone flow cells. * `PRINT_INPUT` keyword to indicate that the list of unsaturated zone flow information will be written to the listing file immediately after it is read. * `PRINT_TEMPERATURE` keyword to indicate that the list of UZF cell temperatures will be printed to the listing file for every stress period in which "TEMPERATURE PRINT" is specified in Output Control. If there is no Output Control option and PRINT_TEMPERATURE is specified, then temperatures are printed for the last time step of each stress period. * `PRINT_FLOWS` keyword to indicate that the list of unsaturated zone flow rates will be printed to the listing file for every stress period time step in which "BUDGET PRINT" is specified in Output Control. If there is no Output Control option and "PRINT_FLOWS" is specified, then flow rates are printed for the last time step of each stress period. * `SAVE_FLOWS` keyword to indicate that unsaturated zone flow terms will be written to the file specified with "BUDGET FILEOUT" in Output Control. * `TEMPERATURE` keyword to specify that record corresponds to temperature. * `tempfile` name of the binary output file to write temperature information. * `BUDGET` keyword to specify that record corresponds to the budget. * `FILEOUT` keyword to specify that an output filename is expected next. * `budgetfile` name of the binary output file to write budget information. * `BUDGETCSV` keyword to specify that record corresponds to the budget CSV. * `budgetcsvfile` name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation. * `TS6` keyword to specify that record corresponds to a time-series file. * `FILEIN` keyword to specify that an input filename is expected next. * `ts6_filename` defines a time-series file defining time series that can be used to assign time-varying values. See the "Time-Variable Input" section for instructions on using the time-series capability. * `OBS6` keyword to specify that record corresponds to an observations file. * `obs6_filename` name of input file to define observations for the UZE package. See the "Observation utility" section for instructions for preparing observation input files. Table ref{table:gwe-obstypetable} lists observation type(s) supported by the UZE package. ##### Block: PACKAGEDATA * `uzfno` integer value that defines the UZF cell number associated with the specified PACKAGEDATA data on the line. UZFNO must be greater than zero and less than or equal to NUZFCELLS. Unsaturated zone flow information must be specified for every UZF cell or the program will terminate with an error. The program also will terminate with an error if information for a UZF cell is specified more than once. * `strt` real value that defines the starting temperature for the unsaturated zone flow cell. * `aux` represents the values of the auxiliary variables for each unsaturated zone flow. The values of auxiliary variables must be present for each unsaturated zone flow. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the "Time-Variable Input" section), values can be obtained from a time series by entering the time-series name in place of a numeric value. * `boundname` name of the unsaturated zone flow cell. BOUNDNAME is an ASCII character variable that can contain as many as 40 characters. If BOUNDNAME contains spaces in it, then the entire name must be enclosed within single quotes. ##### Block: PERIOD * `iper` integer value specifying the starting stress period number for which the data specified in the PERIOD block apply. IPER must be less than or equal to NPER in the TDIS Package and greater than zero. The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block. The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block. * `uzfno` integer value that defines the UZF cell number associated with the specified PERIOD data on the line. UZFNO must be greater than zero and less than or equal to NUZFCELLS. * `uzesetting` line of information that is parsed into a keyword and values. Keyword values that can be used to start the UZESETTING string include: STATUS, TEMPERATURE, INFILTRATION, UZET, and AUXILIARY. These settings are used to assign the temperature associated with the corresponding flow terms. Temperatures cannot be specified for all flow terms. STATUS TEMPERATURE INFILTRATION UZET AUXILIARY * `status` keyword option to define UZF cell status. STATUS can be ACTIVE, INACTIVE, or CONSTANT. By default, STATUS is ACTIVE, which means that temperature will be calculated for the UZF cell. If a UZF cell is inactive, then there will be no energy fluxes into or out of the UZF cell and the inactive value will be written for the UZF cell temperature. If a UZF cell is constant, then the temperature for the UZF cell will be fixed at the user specified value. * `temperature` real or character value that defines the temperature for the unsaturated zone flow cell. The specified TEMPERATURE is only applied if the unsaturated zone flow cell is a constant temperature cell. If the Options block includes a TIMESERIESFILE entry (see the "Time-Variable Input" section), values can be obtained from a time series by entering the time-series name in place of a numeric value. * `infiltration` real or character value that defines the temperature of the infiltration (e.g.,:circC:or:circF) for the UZF cell. If the Options block includes a TIMESERIESFILE entry (see the "Time-Variable Input" section), values can be obtained from a time series by entering the time-series name in place of a numeric value. * `uzet` real or character value that states what fraction of the simulated unsaturated zone evapotranspiration is associated with evaporation. The evaporative losses from the unsaturated zone moisture content will have an evaporative cooling effect on the GWE cell from which the evaporation originated. If this value is larger than 1, then it will be reset to 1. If the Options block includes a TIMESERIESFILE entry (see the "Time-Variable Input" section), values can be obtained from a time series by entering the time-series name in place of a numeric value. * `AUXILIARY` keyword for specifying auxiliary variable. * `auxname` name for the auxiliary variable to be assigned AUXVAL. AUXNAME must match one of the auxiliary variable names defined in the OPTIONS block. If AUXNAME does not match one of the auxiliary variable names defined in the OPTIONS block the data are ignored. * `auxval` value for the auxiliary variable. If the Options block includes a TIMESERIESFILE entry (see the "Time-Variable Input" section), values can be obtained from a time series by entering the time-series name in place of a numeric value. #### Example Input File ``` BEGIN OPTIONS AUXILIARY aux1 aux2 BOUNDNAMES PRINT_INPUT PRINT_TEMPERATURE PRINT_FLOWS SAVE_FLOWS TEMPERATURE FILEOUT gwe_02.uze.bin BUDGET FILEOUT gwe_02.uze.bud OBS6 FILEIN gwe_02.uze.obs END OPTIONS BEGIN PACKAGEDATA # L STRT aux1 aux2 bname 1 0.0 99.0 999.0 MYUZFCELL1 2 0.0 99.0 999.0 MYUZFCELL2 3 0.0 99.0 999.0 MYUZFCELL3 END PACKAGEDATA BEGIN PERIOD 1 1 STATUS ACTIVE 2 STATUS ACTIVE 3 STATUS ACTIVE END PERIOD 1 ``` #### Available Observation Types | Stress Package | Observation Type | ID1 | ID2 | Description | |----------------|------------------|-----|-----|-------------| | UZE | temperature | uzeno or boundname | -- | uze cell temperature. If boundname is specified, boundname must be unique for each uze cell. | | UZE | flow-ja-face | uzeno or boundname | uzeno or -- | Energy flow between two uze cells. If a boundname is specified for ID1, then the result is the total energy flow for all uze cells. If a boundname is specified for ID1 then ID2 is not used. | | UZE | storage | uzeno or boundname | -- | Simulated energy storage flow rate for a uze cell or group of uze cells. | | UZE | constant | uzeno or boundname | -- | Simulated energy constant-flow rate for a uze cell or a group of uze cells. | | UZE | from-mvr | uzeno or boundname | -- | Simulated energy inflow into a uze cell or group of uze cells from the MVE package. Energy inflow is calculated as the product of provider temperature and the mover flow rate. | | UZE | uze | uzeno or boundname | -- | Energy flow rate for a uze cell or group of uze cells and its aquifer connection(s). | | UZE | infiltration | uzeno or boundname | -- | Infiltration rate applied to a uze cell or group of uze cells multiplied by the infiltration temperature. | | UZE | rej-inf | uzeno or boundname | -- | Rejected infiltration rate applied to a uze cell or group of uze cells multiplied by the infiltration temperature. | | UZE | uzet | uzeno or boundname | -- | Unsaturated zone evapotranspiration rate applied to a uze cell or group of uze cells multiplied by the uze cell temperature. | | UZE | rej-inf-to-mvr | uzeno or boundname | -- | Rejected infiltration rate applied to a uze cell or group of uze cells multiplied by the infiltration temperature that is sent to the mover package. | #### Example Observation Input File ``` BEGIN options DIGITS 7 PRINT_INPUT END options BEGIN continuous FILEOUT gwe_02.uze.obs.csv # obsname obstype id1 id2 mwe-1-temp TEMPERATURE 1 mwe-1-stor STORAGE 1 mwe-1-gwe1 UZE 1 mwe-1-gwe2 UZE 2 mwe-2-gwe1 UZE 3 END continuous ```