BUDGET Module: FFTools Plug-In

Main FFTools Page | Description | Setup | Input File Format | Output File Format Example

Description

The BUDGET module reports flow rates and volumes for the SHB, SES, LAKE3D and CRB modules of FFTools, and also flows and volumes related to the model domain (for example, combined flows to/from 1^st, 2^nd and 3^rd kind boundary-condition nodes). If the user does not need to save a complete DAC file, BUDGET can be used to save all flows for all time steps to allow for a complete water balance evaluation regardless of whether other FFTools modules are active.

NOTE: BUDGET saves information at the end of a time step. It cannot be used to save information at interim times.

Suggested FEFLOW Configuration

The BUDGET module has been tested on models with the following characteristics:

FEFLOW versions 7.x
Three-dimensional mesh using layered prismatic elements (prismatic elements having a triangular shape in horizontal cross section)
All slices set to "fixed" in FEFLOW's "3D Layer Configuration..." editor
FEFLOW Problem Class: Richard's equation for variably-saturated media
State: Transient

Support for other types of models (quadrilateral elements, tetrahedral elements, etc.) may be added in future releases.

Setup

Setup of BUDGET is specified via the BUDGET tab (Figure 1) of the FFTools Plug-in edit window. A BUDGET file is not saved unless requested (Save Budgets box is checked) and an output Log File is specified under "Output Options". If the Save Budget at Select Times is specified, then an additional setup file is required. See below regarding the format of this file. The Save Budget at Select Times information can be saved in the FEM file or the user can opt to import the information from the setup file every time a simulation in executed.

Figure 1: BUDGET Data Setup Tab.

Format of the Selected Times Setup File

This setup file is only needed when output for only select times is desired:

Input L1, identifies this file as a BUDGET input file:

BUDGET
Input L2, (current release allows only only one option):

FULL
Input L3 (optional), Save BUDGET data at the end of specific time steps using time-step identifiers:

TS,<TS options>
Input L4 (optional); Save data at the end of specific time steps using units of time:

TIME,<Time options>

Where:

<TS options>

"TS,ALL" indicates that BUDGET data will be saved at every time step,
"TS,FIRST" indicates that BUDGET data will be saved at the first time step,
"TS,LAST" indicates that BUDGET data will be saved at the last time step,
Use a comma-separated list to specify the time-step number or an increment as follows:
- "TS,#,#,..." will cause BUDGET to save data at the specified time steps. For example, "TS,1,11,234" would save data at the end of time steps numbered 1, 11 and 234
- "TS,+#" will cause BUDGET to save data every #^th time step. For example, "TS,+5" will cause BUDGET to save data every 5^th time step, that is, at the end of time steps 5, 10, 15, ...

<TIME options> is a comma-separated list of time values (at least one entry required):
- "TIME,#,#,..." will cause BUDGET to save data at the specified times. For example, if the model uses days as a time unit and the user specifies "TIME,1.1,11.6,234.45", then BUDGET would save data at simulation 1.1 days, 11.6 days and 234.45 days.
- "TIME,+#" Budget data will be saved every '#' time units, e.g. '+5.5' would cause data to be saved every 5.5 time units. For example, +5" will cause BUDGET to save data every 5.5 days, that is, at the end of time steps 5.5, 11, 16.5, etc.

Example setup file for saving BUDGET data at specific times:


        BUDGET

        FULL

        TS,FIRST,LAST,+5

        TIME,256.3,1087.3

Output File Format

Output from BUDGET is written to the user-specified log file in a CSV format and includes standard FEFLOW budget terms plus budget data for the SHB, SES, LAKE3D and CRB modules of FFTools. If none of these FFTools modules is used, BUDGET will still list standard FEFLOW budget terms. A list of all possible budget terms is listed below. All rate values are reported first, followed by volumetric values. NOTE: an incomplete BUDGET listing will result if the user does not request a budget for all time steps.

Note: "All" in the "Module" field means that flows from all types of boundary conditions for that category, whether specified using an FFTools module or using some other method, will be included in the reported rate or volume value.