iTOUGH2 Command Index

This is the iTOUGH2 command index in logical order. Click on any command for a description of the command syntax, the name of the parent command, the name of subcommands, as well as the purpose and effect of the command along with an illustrative example.

There are three main blocks in the iTOUGH2 input file, identified by one of the following first-level commands:

The first block (first-level command > PARAMETER) is used to identify the TOUGH2 input parameters that will be subjected to parameter estimation, sensitivity analysis, or uncertainty propagation analysis. The second block (first-level command > OBSERVATION) is used to identify the TOUGH2 output variables that will be compared to observed data for model calibration. The third block (first-level command > COMPUTATION) is used for various program options and computational parameters.

GENERAL COMMANDS AND KEYWORDS

# (Ignore line if # in first column)
/* (Beginning of block to be commented out)
*/ (End of block being commented out)
FILE: input_file_name Copies input file from working to temporary directory (if using Unix script itough2)
OUTPUTFILE: output_file_name Copies output file from temporary to working directory (if using Unix script itough2)
ECHO ON/OFF
INCLUDE FILE: file_name

> PARAMETER

>> ABSOLUTE PERMEABILITY
>> BOTTOMHOLE PRESSURE
>> BOX-COX
>> CAPACITY
>> CAPILLARY PRESSURE FUNCTION
>> COMPRESSIBILITY
>> CONDUCTIVITY (WET/DRY)
>> DIFFUSION
>> DRIFT
>> ENTHALPY
>> FACTOR
>> FORCHHEIMER
>> GUESS (FILE: file_name)
>> IFS
>> INITIAL (PRESSURE/: ipv)
>> KLINKENBERG
>> LAG
>> LIST
>> MINC
>> PARALLEL PLATE
>> PEST
>> POROSITY
>> PRODUCTIVITY INDEX
>> PUMPING RATIO
>> RATE
>> REGION (SINK/SOURCE, PERMEABILITY, OBSERVATION)
>> REGRESSION
>> REGULARIZATION (FILE: file_name) (BETA: beta)
>> RELATIVE PERMEABILITY FUNCTION
>> SCALE
>> SELEC
>> SHIFT
>> SKIN
>> TIME
>> USER (: anno)

>>> DEFAULT
>>> LIST
>>> MATERIAL: mat_name (mat_name_i...) (+ iplus ([islotb-islote]))
>>> MODEL
>>> NONE
>>> ROCK: mat_name (mat_name_i...) (+ iplus ([islotb-islote]))
>>> SET: iset
>>> SINK: sink_name (sink_name_i ...) (+ iplus ([islotb-islote]))
>>> SOURCE: source_name (source_name_i ...) (+ iplus ([islotb-islote]))

>>>> ANNOTATION: anno
>>>> BOUND: lower upper
>>>> BOX-COX: lambda
>>>> DEVIATION: sigma
>>>> FACTOR
>>>> GAUSS
>>>> GUESS: guess
>>>> INACTIVE
>>>> INDEX: index (index_i...)
>>>> LIST
>>>> LOGARITHM
>>>> LOG(F)
>>>> NORMAL
>>>> PARAMETER: index (index_i...)
>>>> PARENT: parent_ID
>>>> PERTURB: (-)alpha (%)
>>>> PRIOR: prior_info
>>>> RANGE: lower upper
>>>> RELATED TO: parent_ID
>>>> STEP: max_step
>>>> TIED TO: parent_ID
>>>> UNIFORM
>>>> VALUE
>>>> VARIANCE: sigma^2
>>>> VARIATION: sigma
>>>> WEIGHT: 1/sigma


> OBSERVATION

>> CONCENTRATION (comp_name/COMPONENT: icomp) (phase_name/PHASE: iphase) (CHANGE/DELTA)
>> CONTENT (phase_name/PHASE: iphase) (CHANGE/DELTA)
>> COVARIANCE (FILE: filename)
>> CUMULATIVE (comp_name/COMPONENT: icomp) (phase_name/PHASE: iphase) (CHANGE/DELTA)
>> DRAWDOWN (phase_name/PHASE: iphase)
>> ENTHALPY (phase_name/PHASE: iphase) (CHANGE/DELTA)
>> FLOW (phase_name/PHASE: iphase) (component_name/COMPONENT: icomponent) (HEAT) (CHANGE/DELTA)
>> GENERATION (comp_name/COMPONENT: icomp) (phase_name/PHASE: iphase) (CHANGE/DELTA)
>> HUMIDITY (CHANGE/DELTA)
>> LIST
>> MASS FRACTION (comp_name/COMPONENT: icomp) (phase_name/PHASE: iphase) (CHANGE/DELTA)
>> MOLE FRACTION (comp_name/COMPONENT: icomp) (phase_name/PHASE: iphase) (CHANGE/DELTA)
>> MOMENT (FIRST/SECOND) (X/Y/Z) (comp_name/COMPONENT: icomp) (phase_name/PHASE: iphase) (CHANGE/DELTA)
>> PEST (CHANGE/DELTA)
>> PRESSURE (CAPILLARY) (phase_name/PHASE: iphase) (CHANGE/DELTA)
>> PRODUCTION (comp_name/COMPONENT: icomp) (phase_name/PHASE: iphase) (CHANGE/DELTA)
>> REGULARIZATION (FILE: file_name) (BETA: beta)
>> RESTART TIME : ntime (time_unit) (NEW)
>> SATURATION (phase_name/PHASE: iphase) (CHANGE/DELTA)
>> SECONDARY (phase_name/PHASE: iphase) (: ipar) (CHANGE/DELTA)
>> TEMPERATURE (CHANGE/DELTA)
>> TIME: ntime (EQUAL/LOGARITHMIC) (time_unit)
>> TIME from DATA/OBSERVATIONS
>> TOTAL MASS (comp_name/COMPONENT: icomp) (phase_name/PHASE: iphase) (CHANGE/DELTA)
>> USER (: anno) (CHANGE/DELTA)
>> VOLUME (phase_name/PHASE: iphase) (CHANGE/DELTA)
>> WATERTABLE (CHANGE/DELTA)

>>> CONNECTION: elem1 elem2 (elem_i elem_j ...) (++/+-/-+ iplus ([islotb-islote]))
>>> CONNECTION COORDINATE (BOX/ELLIPSOID/CYLINDER/CUBE) (ROTATE) (OUTSIDE): X1 Y1 Z1 (X2 Y2 Z2 (R) / (AZIMUTH DIP PLUNGE))
>>> CONNECTION PROFILE/CROSS-SECTION/MAP
>>> ELEMENT: elem (elem_i ...) (+ iplus ([islotb-islote]))
>>> ELEMENT COORDINATE (BOX/ELLIPSOID/CYLINDER/CUBE) (ROTATE) (OUTSIDE): X1 Y1 Z1 (X2 Y2 Z2 (R) / (AZIMUTH DIP PLUNGE))
>>> ELEMENT PROFILE/CROSS-SECTION/MAP
>>> LIST
>>> MODEL
>>> NONE
>>> SINK: sink_name (sink_name_i ...) (+ iplus ([islotb-islote]))
>>> SOURCE: source_name (source_name_i ...) (+ iplus ([islotb-islote]))

>>>> ABSOLUTE
>>>> ANNOTATION: anno
>>>> AUTO
>>>> AVERAGE (VOLUME)
>>>> COLUMN: itime idata (istd_dev)
>>>> COMPONENT comp_name/: icomp
>>>> DATA (NO DATA/ZERO DATA/FILE: file_name) (time_unit) (PREDICTION)
>>>> DEVIATION: sigma (ADD NOISE)
>>>> FACTOR: factor
>>>> FORMAT: format
>>>> HEADER: nskip
>>>> INDEX: index (index_i ...)
>>>> LIST
>>>> LOGARITHM
>>>> MEAN (VOLUME)
>>>> PARAMETER: index (index_i ...)
>>>> PHASE: phase_name/: iphase
>>>> PICK: npick
>>>> POLYNOM: idegree (time_unit)
>>>> RELATIVE: rel_err (%) (ADD NOISE)
>>>> REGRESSION: rho
>>>> SET: iset
>>>> SHIFT: shift (TIME (time_unit))
>>>> SKIP: nskip
>>>> SUM
>>>> VARIANCE: sigma^2 (ADD NOISE)
>>>> WEIGHT: 1/sigma (ADD NOISE)
>>>> WINDOW (INDIVIDUAL / : time_A time_B (time_unit))



> COMPUTATION

>> CONVERGE/STOP/TOLERANCE
>>> ABORT (NO)
>>> ADJUST
>>> CONSECUTIVE: max_iter1
>>> DELTFACT: deltfact
>>> DIRECT
>>> FORWARD
>>> GOODNESS-OF-FIT
>>> INCOMPLETE: max_incomplete
>>> INPUT
>>> ITERATION: max_iter
>>> LEVENBERG: lambda
>>> LIST
>>> MARQUARDT: nue
>>> REDUCTION: max_red
>>> SIGNAL
>>> SIMULATION: mtough2
>>> STEP (CURRENT/UNSCALED): max_step
>>> UPHILL: max_uphill
>>> WARNING

>> ERROR
>>> ALPHA: alpha (%)
>>> EMPIRICAL ORTHOGONAL FUNCTIONS (MATRIX: ndim) (iTOUGH2) (CORRELATION)
>>> EOF (MATRIX: ndim) (iTOUGH2) (CORRELATION)
>>> FISHER
>>> FOSM (MATRIX: ndim) (iTOUGH2) (CORRELATION) (DIAGONAL)
>>> HESSIAN
>>> IOD
>>> LINEARITY (: alpha (%))
>>> LIST
>>> MONTE CARLO (SEED: iseed) (GENERATE) (CLASS: nclass)
>>> POSTERIORI
>>> PRIORI
>>> TAU: (-)niter

>> JACOBIAN
>>> CENTERED
>>> FORWARD (: iswitch)
>>> HESSIAN
>>> LIST
>>> PERTURB: (-)perturb (%)

>> OPTION
>>> ANDREWS: c

>>> ANNEAL
>>>> ITERATION: max_iter
>>>> LIST
>>>> SCHEDULE: beta
>>>> STEP: max_step
>>>> TEMPERATURE: (-)temp0

>>> CAUCHY
>>> DESIGN
>>> DIRECT
>>> FORWARD
>>> GRID SEARCH (UNSORTED) (: ninval1 (ninval2 (ninval3)) / FILE: filename)
>>> GAUSS-NEWTON
>>> L1-ESTIMATOR
>>> LEAST-SQUARE
>>> LEVENBERG-MARQUARDT (IDENTITY/EIGENVALUE) (SUPER/TRUNCATE (: (-)trunc))
>>> LIST
>>> OBJECTIVE (UNSORTED) (: ninval1 (ninval2 (ninval3)) / FILE: filename)

>>> PEST
>>>> DECPOINT: POINT/NOPOINT
>>>> EXECUTABLE: FILE (BEOFRE/AFTER)
>>>> INSTRUCTION: num-instruction-files
>>>> PRECISION: SINGLE/DOUBLE
>>>> TEMPLATE: num-template-files

>>> PARALLEL: ncores (SLEEP: isleep) (ROOT: root_directory) (JACOBIAN / LEVENBERG: ncoreslm)
>>> PVM: nhosts (SLEEP: isleep) (FILE: node-file) (JACOBIAN / LEVENBERG: nprocslm)
>>> QUADRATIC-LINEAR: c

>>> SELECT/SUPER
>>>> CORRELATION: (-)rcorr
>>>> IMMOBILIZATION (: ofredmin)
>>>> ITERATION: niter
>>>> LIST
>>>> SENSITIVITY: (-)rsens
>>>> SEQUENTIAL
>>>> TRUNCATE (:(-)trunc)

>>> SIMPLEX
>>> SENSITIVITY (LOCAL)
>>> SENSITIVITY MORRIS
>>> SENSITIVITY SALTELLI/SOBOL
>>> STEADY-STATE (SAVE) (: max_time_step)
>>> data-WORTH analysis (PARAMETER/PREDICTION) (TRACE/DETERMINANT) (SET)

>> OUTPUT
>>> BENCHMARK
>>> CHARACTERISTIC
>>> COVARIANCE
>>> FORMAT: format (LIST, TAB/CSV/COMMA)
>>> IDENTIFIABILITY
>>> INDEX
>>> LIST
>>> JACOBIAN
>>> NEW OUTPUT
>>> OBJECTIVE
>>> PERFORMANCE
>>> PLOTFILE: format (LIST)
>>> PLOTTING: niter
>>> PRINTOUT: level
>>> RESOLUTION
>>> SENSITIVITY
>>> time_unit
>>> UPDATE
>>> RESIDUAL
>>> VERSION
>>> WORTH (PARAMETER/PREDICTION) (TRACE/DETERMINANT) (SET)

 


Top of Page | Flow Chart
Parameters | Observations | Objective Function | Minimization Algorithm | Error Analysis
Examples | Bibliography | Availability | Updates | Command Index
iTOUGH2 Home | TOUGH2 Home | ESD Home | LBNL Home

Page updated: October 25, 2014