Create models and animations of data that changes over time.
Create models and animations of data that changes over time.
Parse a TVF file consisting of dates, values, and (optionally) labels.
Extract a horizon from a set of time-based horizons.
Loop through a series of times or specify a specific time of interest.
Subsections of Time
read tcf
The read tcf module is specifically designed to create models and animations of data that changes over time. This type of data can result from water table elevation and/or chemical measurements taken at discrete times or output from groundwater simulations or other 3D time-domain simulations.
The read tcf module creates a field using a Time Control File (.TCF) to specify the date/time, field and corresponding data component to read (in netCDF, Field or UCD format), for each time step of a time data field. All file types specified in the TCF file must be the same (e.g. all netCDF or all UCD). The same file can be repeated, specifying different data components to represent different time steps of the output.
The module effectively includes internal interpolation between appropriate pairs of the files and data components specified in the TCF file. Its internal structure only requires reading two successive time steps rather than the complete listing of time steps normally represented in a time data field.
Ports
| Direction | Name | Type | Description |
|---|---|---|---|
| Input | Input Date | Date | Date used for interpolating between dates in a time control file format. |
| Output | Start Date | Date | Start Date used for interpolating between dates in a time control file format. |
| Output | End Date | Date | End Date used for interpolating between dates in a time control file format. |
| Output | Output Date | Date | Date used for interpolating between dates in a time control file format. |
| Output | Output Field | Field | The main output field with interpolated data. |
| Output | Geology Legend | Geology Legend | Geology legend output. |
Properties
| Property | Type | Description |
|---|---|---|
| Filename | String | The time control file name to process for interpolation. |
| Execute | Button | The Execute button forces the module to run. |
| Log Process Nodal Data | Boolean | The Log Process Nodal Data value when selected will take the log value of the input nodal data. |
| Log Process Cell Data | Boolean | The Log Process Cell Data value when selected will take the log value of the input cell data. |
| Date And Time | Date | The Date and Time of interest. |
| Time Loop | Loop | The Time Loop controls setting the Date and Time by specified increments. |
| Start Date | Date | The Start Date is the beginning time of the simulation. This value is set to the first date in the file. |
| End Date | Date | The End Date is the end time for the simulation. This value is set to the last date in the file. |
| Step Time Units | Choice: Seconds, Minutes, Hours, Days, Weeks, Years | The Step Time Units specify the increment for advancement when stepping or running. |
| Step Size | Double | The Step Size value specifies a factor, along with the Step Time Units, for the increment for advancement when stepping or running. |
Subsections of read tcf
TCF File Format and Example
The listing below is the full contents of the Time Control File control_tce_cdf.tcf. Blank lines or any lines beginning with a “#” are ignored. Valid lines representing time steps must be in order of ascending time and consisting of:
a) a date and/or time in Windows standard format
b) a file name with an absolute path or just the filename (if the data files are in the same directory as the TCF file). This is not a true relative path (..\file.cdf and subdir\file.cdf don’t work, but file.cdf does), but gives some of the relative path abilities.
c) the data component to use for that time step. (You can specify -1 in the third column, which causes ALL the data components to pass through.)
NOTE: These three items on each line must be separated with a comma “,”.
This file contains the list of control commands for the
TCE time data in netCDF format.
The format is a date/time, then the file, then the nodal data component.
The END on the last line is optional.
Each line MUST be comma delimited
(since spaces can exist in the time and filename)
6/1/1990 12:00 AM, $XP_PATH<0>/data/netcdf/time_data/tce_01.cdf, 0
12/1/1990, $XP_PATH<0>/data/netcdf/time_data/tce_02.cdf, 0
2/1/1991, $XP_PATH<0>/data/netcdf/time_data/tce_03.cdf, 0
5/1/1991, $XP_PATH<0>/data/netcdf/time_data/tce_04.cdf, 0
8/1/1991, $XP_PATH<0>/data/netcdf/time_data/tce_05.cdf, 0
11/1/1991, $XP_PATH<0>/data/netcdf/time_data/tce_06.cdf, 0
3/1/1992, $XP_PATH<0>/data/netcdf/time_data/tce_07.cdf, 0
6/1/1992, $XP_PATH<0>/data/netcdf/time_data/tce_08.cdf, 0
10/1/1992, $XP_PATH<0>/data/netcdf/time_data/tce_09.cdf, 0
3/1/1993, $XP_PATH<0>/data/netcdf/time_data/tce_10.cdf, 0
4/1/1993, $XP_PATH<0>/data/netcdf/time_data/tce_11.cdf, 0
8/1/1993, $XP_PATH<0>/data/netcdf/time_data/tce_12.cdf, 0
12/1/1993, $XP_PATH<0>/data/netcdf/time_data/tce_13.cdf, 0
3/1/1994, $XP_PATH<0>/data/netcdf/time_data/tce_14.cdf, 0
6/1/1994, $XP_PATH<0>/data/netcdf/time_data/tce_15.cdf, 0
9/1/1994, $XP_PATH<0>/data/netcdf/time_data/tce_16.cdf, 0
11/1/1994, $XP_PATH<0>/data/netcdf/time_data/tce_17.cdf, 0
3/1/1995, $XP_PATH<0>/data/netcdf/time_data/tce_18.cdf, 0
5/1/1995, $XP_PATH<0>/data/netcdf/time_data/tce_19.cdf, 0
8/1/1995, $XP_PATH<0>/data/netcdf/time_data/tce_20.cdf, 0
10/1/1995, $XP_PATH<0>/data/netcdf/time_data/tce_21.cdf, 0
1/1/1996, $XP_PATH<0>/data/netcdf/time_data/tce_22.cdf, 0
5/1/1996, $XP_PATH<0>/data/netcdf/time_data/tce_23.cdf, 0
9/1/1996, $XP_PATH<0>/data/netcdf/time_data/tce_24.cdf, 0
11/1/1996, $XP_PATH<0>/data/netcdf/time_data/tce_25.cdf, 0
12/1/1996, $XP_PATH<0>/data/netcdf/time_data/tce_26.cdf, 0
3/1/1997 12:00 AM, $XP_PATH<0>/data/netcdf/time_data/tce_27.cdf, 0
6/1/1997, $XP_PATH<0>/data/netcdf/time_data/tce_28.cdf, 0
9/1/1997, $XP_PATH<0>/data/netcdf/time_data/tce_29.cdf, 0
12/1/1997, $XP_PATH<0>/data/netcdf/time_data/tce_30.cdf, 0
3/1/1998, $XP_PATH<0>/data/netcdf/time_data/tce_31.cdf, 0
6/1/1998, $XP_PATH<0>/data/netcdf/time_data/tce_32.cdf, 0
9/1/1998, $XP_PATH<0>/data/netcdf/time_data/tce_33.cdf, 0
11/1/1998, $XP_PATH<0>/data/netcdf/time_data/tce_34.cdf, 0
5/1/1999, $XP_PATH<0>/data/netcdf/time_data/tce_35.cdf, 0
10/1/1999, $XP_PATH<0>/data/netcdf/time_data/tce_36.cdf, 0
3/1/2000, $XP_PATH<0>/data/netcdf/time_data/tce_37.cdf, 0
7/1/2000, $XP_PATH<0>/data/netcdf/time_data/tce_38.cdf, 0
11/1/2000, $XP_PATH<0>/data/netcdf/time_data/tce_39.cdf, 0
3/1/2001, $XP_PATH<0>/data/netcdf/time_data/tce_40.cdf, 0
5/1/2001, $XP_PATH<0>/data/netcdf/time_data/tce_41.cdf, 0
10/1/2001, $XP_PATH<0>/data/netcdf/time_data/tce_42.cdf, 0
END
read multi tcf
The read multi tcf module is specifically designed to create models and animations of data that changes over time. This type of data can result from water table elevation and/or chemical measurements taken at discrete times or output from groundwater simulations or other 3D time-domain simulations.
The read multi tcf module creates a field using one or more Time Control Files (.TCF). It creates a mesh grid with the interpolated data from a user-specified number of TCF files. It outputs the first data component from each of the initial TCF files and all of the time-interpolated data components from the last TCF file.
For example, if you were trying to create a time animation of the union of 3 analytes (e.g. Benzene, Toluene and Xylene), read multi tcf allows you to select all three separate TCF files. Only the first data component from each of the first two TCF files is output as a new data component, and all of the data components from the third TCF file are then output (typically concentration, confidence, uncertainty, Geo Layer, Material ID, Elevation, etc.). This allows you to explode layers and do other typical subsetting and processing operations on the output of this module.
The TCF files should be created using identical grids with date ranges that overlap the time period of interest.
The module effectively includes internal interpolation between appropriate pairs of the files and data components specified in the TCF files. Its internal structure only requires reading two successive time steps rather than the complete listing of time steps normally represented in a time data field.
Ports
| Direction | Name | Type | Description |
|---|---|---|---|
| Input | Input Date | Date | Date used for interpolating between dates in a time control file format. |
| Output | Start Date | Date | Start Date used for interpolating between dates in a time control file format. |
| Output | End Date | Date | End Date used for interpolating between dates in a time control file format. |
| Output | Output Date | Date | Date used for interpolating between dates in a time control file format. |
| Output | Output Field | Field | The main output field with interpolated data. |
| Output | Geology Legend | Geology Legend | Geology legend output. |
Properties
| Property | Type | Description |
|---|---|---|
| Time Control File List | File list | The Time Control File List will read any number of TCF files and allow processing for those files. |
| Date And Time | Date | The Date and Time of interest. |
| Time Loop | Loop | The Time Loop controls setting the Date and Time by specified increments. |
| Step Time Units | Choice: Seconds, Minutes, Hours, Days, Weeks, Years | The Step Time Units specify the increment for advancement when stepping or running. |
| Step Size | Double | The Step Size value specifies a factor, along with the Step Time Units, for the increment for advancement when stepping or running. |
Subsections of read multi tcf
TCF File Format and Example
The listing below is the full contents of the Time Control File control_tce_cdf.tcf. Blank lines or any lines beginning with a “#” are ignored. Valid lines representing time steps must be in order of ascending time and consisting of:
a) a date and/or time in Windows standard format
b) a file name with an absolute path or just the filename (if the data files are in the same directory as the TCF file). This is not a true relative path (..\file.cdf and subdir\file.cdf don’t work, but file.cdf does), but gives some of the relative path abilities.
c) the data component to use for that time step. (You can specify -1 in the third column, which causes ALL the data components to pass through.)
NOTE: These three items on each line must be separated with a comma “,”.
This file contains the list of control commands for the
TCE time data in netCDF format.
The format is a date/time, then the file, then the nodal data component.
The END on the last line is optional.
Each line MUST be comma delimited
(since spaces can exist in the time and filename)
6/1/1990 12:00 AM, $XP_PATH<0>/data/netcdf/time_data/tce_01.cdf, 0
12/1/1990, $XP_PATH<0>/data/netcdf/time_data/tce_02.cdf, 0
2/1/1991, $XP_PATH<0>/data/netcdf/time_data/tce_03.cdf, 0
5/1/1991, $XP_PATH<0>/data/netcdf/time_data/tce_04.cdf, 0
8/1/1991, $XP_PATH<0>/data/netcdf/time_data/tce_05.cdf, 0
11/1/1991, $XP_PATH<0>/data/netcdf/time_data/tce_06.cdf, 0
3/1/1992, $XP_PATH<0>/data/netcdf/time_data/tce_07.cdf, 0
6/1/1992, $XP_PATH<0>/data/netcdf/time_data/tce_08.cdf, 0
10/1/1992, $XP_PATH<0>/data/netcdf/time_data/tce_09.cdf, 0
3/1/1993, $XP_PATH<0>/data/netcdf/time_data/tce_10.cdf, 0
4/1/1993, $XP_PATH<0>/data/netcdf/time_data/tce_11.cdf, 0
8/1/1993, $XP_PATH<0>/data/netcdf/time_data/tce_12.cdf, 0
12/1/1993, $XP_PATH<0>/data/netcdf/time_data/tce_13.cdf, 0
3/1/1994, $XP_PATH<0>/data/netcdf/time_data/tce_14.cdf, 0
6/1/1994, $XP_PATH<0>/data/netcdf/time_data/tce_15.cdf, 0
9/1/1994, $XP_PATH<0>/data/netcdf/time_data/tce_16.cdf, 0
11/1/1994, $XP_PATH<0>/data/netcdf/time_data/tce_17.cdf, 0
3/1/1995, $XP_PATH<0>/data/netcdf/time_data/tce_18.cdf, 0
5/1/1995, $XP_PATH<0>/data/netcdf/time_data/tce_19.cdf, 0
8/1/1995, $XP_PATH<0>/data/netcdf/time_data/tce_20.cdf, 0
10/1/1995, $XP_PATH<0>/data/netcdf/time_data/tce_21.cdf, 0
1/1/1996, $XP_PATH<0>/data/netcdf/time_data/tce_22.cdf, 0
5/1/1996, $XP_PATH<0>/data/netcdf/time_data/tce_23.cdf, 0
9/1/1996, $XP_PATH<0>/data/netcdf/time_data/tce_24.cdf, 0
11/1/1996, $XP_PATH<0>/data/netcdf/time_data/tce_25.cdf, 0
12/1/1996, $XP_PATH<0>/data/netcdf/time_data/tce_26.cdf, 0
3/1/1997 12:00 AM, $XP_PATH<0>/data/netcdf/time_data/tce_27.cdf, 0
6/1/1997, $XP_PATH<0>/data/netcdf/time_data/tce_28.cdf, 0
9/1/1997, $XP_PATH<0>/data/netcdf/time_data/tce_29.cdf, 0
12/1/1997, $XP_PATH<0>/data/netcdf/time_data/tce_30.cdf, 0
3/1/1998, $XP_PATH<0>/data/netcdf/time_data/tce_31.cdf, 0
6/1/1998, $XP_PATH<0>/data/netcdf/time_data/tce_32.cdf, 0
9/1/1998, $XP_PATH<0>/data/netcdf/time_data/tce_33.cdf, 0
11/1/1998, $XP_PATH<0>/data/netcdf/time_data/tce_34.cdf, 0
5/1/1999, $XP_PATH<0>/data/netcdf/time_data/tce_35.cdf, 0
10/1/1999, $XP_PATH<0>/data/netcdf/time_data/tce_36.cdf, 0
3/1/2000, $XP_PATH<0>/data/netcdf/time_data/tce_37.cdf, 0
7/1/2000, $XP_PATH<0>/data/netcdf/time_data/tce_38.cdf, 0
11/1/2000, $XP_PATH<0>/data/netcdf/time_data/tce_39.cdf, 0
3/1/2001, $XP_PATH<0>/data/netcdf/time_data/tce_40.cdf, 0
5/1/2001, $XP_PATH<0>/data/netcdf/time_data/tce_41.cdf, 0
10/1/2001, $XP_PATH<0>/data/netcdf/time_data/tce_42.cdf, 0
END
time value
The time value module is used to parse a TVF file consisting of dates, values, and (optional) labels. The starting and end dates are read from the file and the controls can be used to interpolate the values to the date and time of interest.
Ports
| Direction | Name | Type | Description |
|---|---|---|---|
| Input | Input Date | Date | Date used for interpolating between dates in a time domain file format. |
| Output | Start Date | Date | Start Date used for interpolating between dates in a time domain file format. |
| Output | End Date | Date | End Date used for interpolating between dates in a time domain file format. |
| Output | Output Date | Date | Date used for interpolating between dates in a time domain file format. |
| Output | Current Date And Time Label | String | Text containing the name of the label for the Current Date and Time. |
| Output | Current Date And Time Value | Number | Interpolated value for the Current Date and Time. |
Properties
| Property | Type | Description |
|---|---|---|
| Filename | String | The file name to process for interpolation. |
| Execute | Button | The Execute button forces the module to run. |
| Label Options | Choice: Use Previous Label, Use Closest Label | The Label Options control which label is read from the file. If “Use Previous” is selected the last set label before the Current Date will be used. If “Use Closest” is selected the label closest to the date will be used. |
| Date And Time | Date | The Date and Time of interest. |
| Time Loop | Loop | The Time Loop controls setting the Date and Time by specified increments. |
| Start Date | Date | The Start Date is the beginning time of the simulation. This value is set to the first date in the file. |
| End Date | Date | The End Date is the end time for the simulation. This value is set to the last date in the file. |
| Step Time Units | Choice: Seconds, Minutes, Hours, Days, Weeks, Years | The Step Time Units specify the increment for advancement when stepping or running. |
| Step Size | Double | The Step Size value specifies a factor, along with the Step Time Units, for the increment for advancement when stepping or running. |
| Current Date And Time Value | Double | The value interpolated from the file using the set Date And Time. |
| Current Date And Time Label | String | The string set from the file using the set Date And Time. |
Subsections of time value
TVF files provide a way to generate a time varying numeric and option string (label). The file is similar to the TCF file, but does not reference information in external files.
The file consists of two or more rows, each having 2 or 3 columns of information. The columns must contain:
- Date and/or time in Windows standard format
- A numeric (float) value (required)
- A string consisting of one or more words. These need not be in quotes. Everything on the row after the numeric value will be used. (optional)
Dates must be in order from earliest to latest and not repeating. Only the label column is optional.
time horizon
The time horizon module allows you to extract a surface from a set of time-based surfaces. The time for the extracted surface can be any time between the start and end of the surface set. It will interpolate between adjacent known times.
Ports
| Direction | Name | Type | Description |
|---|---|---|---|
| Input | Input Time Based Geologic Field | Field | The main time based geologic field to create the interpolated surface from. |
| Input | Input Date | Date | Date used for interpolating between dates in a time control file format. |
| Output | Start Date | Date | Start Date used for interpolating between dates in a time control file format. |
| Output | End Date | Date | End Date used for interpolating between dates in a time control file format. |
| Output | Output Date | Date | Date used for interpolating between dates in a time control file format. |
| Output | Output Geologic Field | Field | The geologic surface output from the module. |
| Output | Geology Legend | Geology Legend | Geology legend output. |
Properties
| Property | Type | Description |
|---|---|---|
| Date And Time | Date | The Date and Time of interest. |
| Time Loop | Loop | The Time Loop controls setting the Date and Time by specified increments. |
| Start Date | Date | The Start Date is the beginning time of the simulation. This value is set to the first date in the file. |
| End Date | Date | The End Date is the end time for the simulation. This value is set to the last date in the file. |
| Step Time Units | Choice: Seconds, Minutes, Hours, Days, Weeks, Years | The Step Time Units specify the increment for advancement when stepping or running. |
| Step Size | Double | The Step Size value specifies a factor, along with the Step Time Units, for the increment for advancement when stepping or running. |
| Material Number | Integer | The Material Number provides the ability to set the material number for the geologic info port. |
| Material Name | String | The Material Name provides the ability to set the material name for the geologic info port. |
time loop
The time loop module is one of a limited set of Time Data modules. These modules are specifically designed to create models and animations of data that changes over time. This type of data can result from water table elevation and/or chemical measurements taken at discrete times or output from groundwater simulations or other 3D time-domain simulations.
The time loop module allows you to loop through a series of times or specify a time for interpolation from a time field.
Ports
| Direction | Name | Type | Description |
|---|---|---|---|
| Input | Input Start Date | Date | Start Date used for animation range. |
| Input | Input End Date | Date | End Date used for animation range. |
| Input | Input Date | Date | Date of interest. |
| Output | Output Start Date | Date | Start Date used for animation range. |
| Output | Output End Date | Date | End Date used for animation range. |
| Output | Output Date | Date | Date used for interpolating between dates in a time control file format. |
Properties
| Property | Type | Description |
|---|---|---|
| Date And Time | Date | The Date and Time of interest. |
| Time Loop | Loop | The Time Loop controls setting the Date and Time by specified increments. |
| Start Date | Date | The Start Date is the beginning time of the simulation. |
| End Date | Date | The End Date is the end time for the simulation. |
| Step Time Units | Choice: Seconds, Minutes, Hours, Days, Weeks, Years | The Step Time Units specify the increment for advancement when stepping or running. |
| Step Size | Double | The Step Size value specifies a factor, along with the Step Time Units, for the increment for advancement when stepping or running. |