Card input file system - user manual

Geosphere Environmental Technology Corp.

v0-11-0 – 2021/07/01

Introduction

Card Input is an input file system for GETFLOWS that can be used as a replacement of the standard base Input system (job-pvt-blk). Under the hood, the card input file system is converted to a base Input file system used by GETFLOWS to set up a computation job and run a simulation. The syntax is currently at its second version.

Compare to the base Input file system, the card input file system is flexible, self-documented, and contains several defaults value that help the first steps with the simulator. The key features of the card input file system are as follow.

1. It is possible to set up all the parameters in one unique file. Reference to external files from the main input file is also possible.

2. Thanks to the unified syntax, all parameters are set up in the same structured, self-documented syntax.

3. Default values are defined for several parameters including the linear solver parameters and the time step control parameters. This feature significantly reduces the minimal number of required user input.

4. Reusable sets of parameters (for solid and fluid properties) can be defined in objects.

Despite their difference, Card Input and Base Input file systems also shares several points. For the sake of completeness, they are presented in this manual. Knowledge of the Base Input file system is not mandatory to follow this manual.

Usage

How to run GETFLOWS

Running GETFLOWS with the card-input file-system requires to process the card-input files and to execute GETFLOWS program. The preprocessor program is called cardprocess while the simulator program is simply called GETFLOWS. The steps are as follow:

1. Run cardprocess with the suitable arguments
2. Run GETFLOWS executable file

The status of the loaded dataset and the output information are displayed on the standard output (console) as well as in some log files.

It is possible to run GETFLOWS with the card-input file system using one commmand. The command name is cardrun. Typing cardrun input.gfcard in a terminal will execute both the preprocessor and the simulator

{#fig:GETFLOWSRuntime height:600px}

Job files

Job input file

A simulation case is called a calculation job or a job. Each job defines an independent case with its associated input and output files as shown on Fig. 2.1. When GETFLOWS is executed, the Card Input input files are loaded and the base Input files are prepared by the pre-processor. Then, the computation starts and the necessary output files are created. During the computation process, GETFLOWS continues to access to the output file, so these files should not be edited or deleted until the simulation finish. While names of input and output files are arbitrary, it is usually a good practice to conform to the naming convention used in this manual.

Note that GETFLOWS is available for the operating systems Linux and Windows.

File system

Input file system

The card input files system consists the job file and the (optional) external files (Table 2.1).

The job file contains the necessary input data for the simulator execution, directly into the file or via links to external files. External files are useful to input large set of data like the grid file or the hot restart file. Data that are seldomly modified can also benefit being put in external files. Moreover, the external files can be stored in binary format to shorten the loading time and reduce the disk space requirement. Any file name can be chosen for the main input file and the external input files.

Output file system

GETFLOWS computation results are stored into several output files that are set up in the job file. Table 2.2 lists the output files generated by GETFLOWS. Among them, the main output file, the convergence monitoring files and the primary variables file are the most important ones.

The information on the input configuration is summarized in the main output file. The primary variables file contains the primary variables computed at all grid cells in a binary format. Binary file format is used for potentially large file to increased data capacity and ease frequent restart. The monitoring convergence files store in the iterative process some relevant parameters from the linear and nonlinear solvers, such as the number of iterations, the maximum variation of primary variables during two iterations, the volume status, or the norm of the computed errors. These Base output files are created when GETFLOWS is in RUN mode, which means that the input parameters are loaded and the computation is running.

Other output files are generated in the RUN mode but also in the POST mode where only output files are created from existing computation results. The name of each file is arbitrary. Some large files such as the restart file or the interstitial velocity are usually written in binary format.

GETFLOWS system

Units system

The units system for the physical parameters is listed below. Note that for some input data such as rainfall and evapotranspiration, the user can specify its own unit.

Grid system

Coordinates

GETFLOWS is based on a Cartesian coordinate system. The origin of vertical axis (Z axis) corresponds to zero meter elevation relative to sea level, and the direction of increasing coordinates is oriented toward the opposite of the elevation.

Cells numbering

Fig. 3.1 shows the three-dimensional Cartesian coordinate system and the cell numbering convention of GETFLOWS. As mentioned earlier, in GETFLOWS, the Z-axis direction is oriented toward the decreasing elevation. In the figure, O-XYZ is the Cartesian coordinate system and the IJK P-coordinate system attached to the corner of the cell designs the cell numbering convention.

The I-axis direction is oriented toward the increasing coordinate value X, the J-axis is defined as the direction of increasing coordinate value Y and the K-axis is defined as the direction of increasing coordinate value Z. Note that the axis of the IJK coordinate system are not necessary parallel to the axis of the XYZ Cartesian coordinate system. Moreover, the O-IJ 2D system does not have to be orthogonal. The origin of the IJK P-coordinate system is defined in one corner of the model, as shown in Fig. 3.1. The relationship between the total number of cells in each direction (NX, NY and NZ) and the corresponding maximum coordinate (NXP, NYP and NZP) is given by:

NXP = NX + 1
NYP = NY + 1
NZP = NZ + 1

If no Local Grid Refinement (LGR) is defined, the total number of grid cells (NNBLK) and the total number of coordinates (NNBLKP) are given by:

NNBLK = NX \* NY \* NX ! Total number of grid cells
NNBLKP = NXP \* NYP \* NZP ! Total number of coordinates

When designing an arbitrary grid cell, the cell number is assigned by dividing each IJK axis. This is commonly used in the creation of input-output data. GETFLOWS assigns a number to each cell sequentially following this rule: the cell number 1 is the cell with the coordinates (1,1,1). Then, the cell number increase with the increasing I followed by the increasing J after I=NX and finally increasing K after J=NY. This leads to the following formula to express the cell number NB with the coordinates IJK:

NB = I + (J - 1) \* NX + (K - 1) \* NX \* NY

The resulting sequence of numbers is used to store the computed primary variables.

Cell attributes

Each cell defined in the previous section is a hexahedral cell with eight vertices (or corner points). The coordinates of each vertex are arbitrary; therefore it is possible to model complex spatial shapes, such as topography and strata. Fig. 3.2 shows the cell numbered (I, J, K) with a schematic diagram. The corner point number (I1, J1, K1) is shown in the figure.

Some physical properties such as the effective porosity and the absolute permeability are assigned to each cell. These attributes are divided into those assigned on the side of the cell and those assigned on the entire cell. To be able to give an attribute to a given side of a cell, each cell side is designed with an identifier: the letter of the direction (I, J or K) followed by - if the side tangent output vector is oriented toward the decreasing values or + if the tangent vector is oriented toward the increasing values. The cell side designation is also used when one needs to specify the flow through a given side or when considering the anisotropy of the medium.

Type of simulation

Different types of simulation are implemented based on the water-gas two-phase flow analysis. In Table 3.2, the analysis type and their corresponding properties are listed (for instance, NAPL, heat, and chemical species). The simulation type should be chosen depending on the project requirements. Note that the number of equations per grid cell (NEQ), the number of phases (NPH) and the fluid systems depend on the simulation.

Note: Reactive mass transport analysis corresponds to the advection-dispersion analysis based on the velocity field from the result of the water-gas two-phase flow analysis. It uses the vector flow rate of aqueous phase and gas phase to compute the interphase mass transfer. NC: Number of Chemical species (ex: organic nitrogen, mineral nitrogen).

Card Input syntax

The card input syntax is a structured format, aimed to be clear, readable, and reusable. The structure of the input data consists of three types of elements called card, deck and object. A decks can contain cards as well as other data structure like table or even deck. A combination of these three elements is required to set up the input parameters.

Note that the syntax described in this document is an updated version. The changes with the previous version are significant.

Data structure

The structure of the input data file is indicated with identifiers, which are: !, #, &, =, and *. Each of them has a particular meaning. These identifiers, called basic identifiers, are used include the identifiers of the entities objects and decks. This section describes the signification of the basic identifier and shows how to use them.

Comment (!)

In all gfcard files (main input file, external input file), the character “!” identify the beginning of a comment. This identifier can be present anywhere in a line; the comment is effective until the end of the line (carriage return).

Example 1: at the beginning of the line

! The entire line is considered as a comment and is not read.

Example 2: in the middle of the line

#unit-system ! Only the last part of the line is a comment and is not read.

Deck opening and closing (#)

A deck is a data structure used to group some parameters together. The parameters can be card, table, import statement or other deck. groups a set of cards. The main input file is created as a combination of decks. Attributes that can be called from the deck depend on the type of object.

Fig. 4.1 represents a deck object and shows the relationship between the object and the main input file.

Note that you cannot use the same deck more than one time in the main input file.

The identifier # is a deck marker. When # is followed by a name, it starts the deck. When it is followed by end-of- followed by the name of the deck, it closes the deck.

Example

#region! start of the deck
.... ... ....
.... ... ....
#end-of-region! end of the deck

Input by card (=)

Each parameter is defined in a data structure called “cards”. It is the smallest data structure of the card input format. The cards are permutable, selected by the user among the available cards in each deck. The list of cards available for each deck is predefined and depends on the deck; the order of the cards inside of a deck is arbitrary.

A single parameter is set up using a ‘card’. In a deck of settings, a parameter is set up by card with the syntax:

name-of-the-parameter = value

A value can be a single value (integer, float, string, path) or a list of values.

Input by table (*table)

Some decks accept parameters to be set up in table format. This format is convenient to set up a group of parameters in a compact form. The marker of a table format input is *table.

In the table format (*table), one must enter the header of the table followed by the data. See the example below and also Table 10.1.

In the following example, the fluid properties of gas phase and water phase are set up in *table format.

Example:

#fluid
    #properties
        *table
            fluid-phase method-pvt  normal-fvf compressibility normal-viscosity viscosity-increment density
            water       equation    1.0        0.0             1.0              0.0                 1.0
            gas         value       n.a.       n.a.            n.a.             n.a.                1.0
    #end-of-properties
#end-of-fluid

Input by sequence of values (*sequence-)

An input by sequence is specified with one of the markers *sequence-cell, *sequence-side or *sequence-cell-surface followed by a list of value separated by space. The list of values must follows the sequence defined by the grid input information. In case of sequence-cell, the list must contains one value per cell. In case of sequence-side, the list includes one value for each side of each cell, hence six times the number of cells. In case of sequence-cell-surface, the list must contains as many values as a layer of the grid (fixed K value).

Dotted card (.)

Some decks allow the parameters related to fluid and region to be input using a dotted syntax. The part of the card before the dot define the deck name and the part of the card after the dot define the card name. Depending on the deck, the left part of the special card could be a region name or a fluid name. Then, the property of that region or fluid to be set up is indicated after the dot. The following examples show the field setting for the fluid (example 1) and for a region (example 2). Note that this syntax is equivalent to a deck but with an inline notation where each card is added to the deck as their order of appearance.

Example 1

water.compressibility = 1.E-5
water.viscosity = 1.E0

Example 2

sandgravel.effective-porosity = 0.35

Objects (in deck #store)

Definition

An object defines a collection of data describing a specific type of entity. The type of an object can be Solid, fluid, or chemical substances. The attributes of each type differ and are partly listed below:

1. Solid objects Solid objects requires setting up the absolute permeability and a set of parameters that characterize the solid phase media, such as the effective porosity and the density.

2. Fluid objects The fluid object requires a set of fluid properties such as the viscosity, the density and the specific heat capacity.

3. Chemical substance objects The chemical object requires setting up the solubility, the molecular diffusion coefficients, and a set of physical properties of saturated steam.

Optional parameters and values can be gathered in objects. The available parameters depend on the type of object. An object can collects different kind of data such as experimental data and in situ data, and therefore can be used to manage data storage.

Furthermore, an object is independent from the execution of a calculation job.

If an object file is defined, data from the object will be used; if no object file is defined, the values defined in the main input file or the default values will be used for the calculation.

Usage

When solid or fluid object are defined, it is possible to use them for assigning the cards. To do this, the card is set equal to a special value that include the name of the object followed by a dot and the name of the property to by used.

The parameter of the decks #solid and fluid>properties can be set up this way.

Example 1

water = object.fluid.groundwater.All

In this example, all the properties of the fluid water are assigned to the properties defined in the object groundwater.

Example 2

loam.absolute-permeability = object.solid.silt.absolute-permeability

In this example, the absolute permeability of the region loam is assigned to the absolute permeability defined in the object silt

List of GETFLOWS cards, decks and objects

As stated previously, GETFLOWS input settings consist of objects, decks and cards. A card is necessary included in a deck; a deck can be written directly in the input file or via an object. Fig. 5.1 shows the structure of the input file.

Only the decks required for a given analysis have to be set up; the content of the input file may vary depends on the type of analysis. Although the pre-processor should accept decks in any order, it is recommended for keep the default order of decks as descibed in this document.

The table Table 5.1 lists the decks available for the water-gas two-phase flow analysis. There are three kinds of decks, depending on their usage: required, default or optional. Required mark indicate a deck that must be set up, otherwise an error message will occur. Default mark indicates that default settings will be used if the deck is not defined. Option mark indicates optional deck that may or may not be used.

The tables Table 5.3-5.10 show the cards available for each deck in a water-gas two-phase flow analysis. As same as for the decks list of Table 5.1, each card is classified into one of the three categories: required, default or optional. In case of usage the data from an object, the data can be called from a deck. See also the decks fluid-properties and solid-properties.

The default output file contains the primary variables values on the entire computational grid. The primary variables depend on the type of simulations, as detailed in . For a water-gas two-phase flow analysis, the outputs at each cell are the air pressure and the aqueous phase saturation. The pressure of the aqueous phase and the gas phase saturation are not written directly to the output file. The aqueous phase pressure is equal to the gas phase pressure minus the capillary pressure. The gas phase saturation is equal to one (‘1’) minus the aqueous phase saturation. To output specific values such as flow rate of aqueous through a given cell, specific instruction must be added to the main input file.

Input by region or by ijk value

The following table list the allowed entries of a table along with their description.

There is two methods of allocation of properties to a cell or a group of cell: in case of region, the properties are allocated to groups of cells designed by their region name (see also design>region deck and #alias-region. In the other case, two integers for each direction defines the numbers of cells in the group.

Context

This deck is used to describe the context of the simulation. It contains only four cards: title, author, project and date (what, who, where and when).

Description

Define the ongoing simulation, including for instance the title of the simulation, the date and the name of the author.

Identifier

List of cards

See also

None

Example

#context
    title = Simulation-Title
    date   = Dec24-2009
    author = Name
#end-of-context

Design

Grid

Description

Define the corner point coordinates value of the three-dimensional grid system.

Identifier

The marker of the grid deck is as below.

List of cards

Grid numbering of the three-dimensional grid system is defined in a three axis system I-J-K that reproduce as much as possible the Cartesian coordinate system X-Y-Z (see Fig. 7.1). Usually, the directions I, J define the plane XY and the direction K is the depth axis (Z axis). The total number of cells in each direction I,J,K is noted respectively NX, NY and NZ. The total number of grid cells is calculated as follows:

NNBLK = NX * NY * NZ.

The number of corner points coordinates value in each direction I,J,K is noted respectively NXP, NYP and NZP. The relationship between the number of grid cells and the number of corner points is:

NXP = NX + 1, NYP = NY + 1, NZP = NZ + 1

The total number of corner points is defined by:

nnblkp = nxp*nyp*nzp

The corner points coordinates value should be input in the following order.

1. X coordinates value
2. Y coordinates value
3. Z coordinates value

Also each set of coordinates value should be preceded by a string indicating which coordinates value are input, usually ‘X’, ‘Y’ and ‘Z’ (see also the example).

Z-axis direction is oriented toward the decreasing elevation. So the direction of increasing coordinates is oriented toward the opposite of the elevation.

The coordinates value of the corner points should be input in an predefined order, I-J-K directions, as follows.

(1,1,1)(2,1,1)...(NXP,1,1)(1,2,1)(2,2,1)...(NXP,2,1)...(NXP,NYP,1)
(1,1,2)(2,1,2)...(NXP,1,2)(1,2,2)(2,2,2)...(NXP,2,2)...(NXP,NYP,2)
... ... ...
(1,1,NZP)(2,1,NZP)...(NXP,1,NZP)(1,2,NZP)(2,2,NZP)...(NXP,2,NZP)...(NXP,NYP,NZP)

See also

None

Example

#grid
   imax = 4
   jmax = 2
   kmax = 4
   *sequence-cell
      'X'
      0.0 1.0 2.0 3.0 4.0 0.0 1.0 2.0 3.0 4.0 0.0 1.0 2.0 3.0 4.0
      0.0 1.0 2.0 3.0 4.0 0.0 1.0 2.0 3.0 4.0 0.0 1.0 2.0 3.0 4.0
      0.0 1.0 2.0 3.0 4.0 0.0 1.0 2.0 3.0 4.0 0.0 1.0 2.0 3.0 4.0
      0.0 1.0 2.0 3.0 4.0 0.0 1.0 2.0 3.0 4.0 0.0 1.0 2.0 3.0 4.0
      0.0 1.0 2.0 3.0 4.0 0.0 1.0 2.0 3.0 4.0 0.0 1.0 2.0 3.0 4.0
      'Y'
      0.0 0.0 0.0 0.0 0.0 1.0 1.0 1.0 1.0 1.0 2.0 2.0 2.0 2.0 2.0
      0.0 0.0 0.0 0.0 0.0 1.0 1.0 1.0 1.0 1.0 2.0 2.0 2.0 2.0 2.0
      0.0 0.0 0.0 0.0 0.0 1.0 1.0 1.0 1.0 1.0 2.0 2.0 2.0 2.0 2.0
      0.0 0.0 0.0 0.0 0.0 1.0 1.0 1.0 1.0 1.0 2.0 2.0 2.0 2.0 2.0
      0.0 0.0 0.0 0.0 0.0 1.0 1.0 1.0 1.0 1.0 2.0 2.0 2.0 2.0 2.0
      'Z'
      -2. -2. -2. -2. -2. -2. -2. -2. -2. -2. -2. -2. -2. -2. -2.
      -1. -1. -1. -1. -1. -1. -1. -1. -1. -1. -1. -1. -1. -1. -1.
      0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0 0.0
      1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0
      2.0 2.0 2.0 2.0 2.0 2.0 2.0 2.0 2.0 2.0 2.0 2.0 2.0 2.0 2.0
#end-of-grid

Region

Description

Define the region names and the set of grid cells that belong to each region.

Identifier

List of cards

List of column in table

The name of the region is defined as the table name (a string within | following the *table statement. Ex: *table |atmosphere|

A region is a name assigned to a set of grid cells. The cells of each region are identified with their IJK number. Regions such as geological layer, land use, or boundary conditions can be commonly-referred in the overall input file, to facilitate the setting of input conditions.

See also

#[alias-region], design>split-region

Example

Example 1 (set up with table and importing):

#region
    *table |Atmosphere|
        i-min i-max j-min j-max k-min k-max
        1     12    1     1     1     1
    *table |Surface|
        i-min i-max j-min j-max k-min k-max
        1     12    1     1     2     2
    *table |UnderGround|
        i-min i-max j-min j-max k-min k-max
        12    12    1     1     4     4
        11    11    1     1     3     3
    *import
       <region.gfcard>
#end-of-region

Example 2 (set up by importing a gfbase blk file):

#region
    gfbase-format = blk
    *import-gfbase
        <ext-gfbase/blk.001>
#end-of-region

Example 3 (set up by importing a gfbase region file):

#region
    gfbase-format = region
    *import-gfbase
        <ext-gfbase/reg.001>
#end-of-region

Alias-region

Description

Define the region alias (group of regions).

Identifier

List of cards

Note that using an *import section, it is possible to include alias from an external file.

See also

design>region, design>split-region.

Example

#alias-region
    All = Atmosphere Surface UnderGround
    Boundary = UpStream DownStream
#end-of-alias-region

Split-region

Description

Define the partial region for region decomposition method. Note: split-region was named Solver Split in previous version of GETFLOWS.

Identifier

List of cards

This deck lists the regions where to distribute the computation tasks (card regions). In the boundary of the sub-regions (ghost zone), the primary variables (pressure, saturation) are shared. Then, the numeric solution for all regions is given. The sub-region should be defined in design>region and design>alias-region decks. Each sub-region can re-define the storage order of the Jacobian determinant defined by #solver (card ORDERS). Unless re-defined in this deck, the configuration of #solver is valid in all sub-regions.

See also

control>linear-solver, control>nonlinear-solver, design>region, design>alias-region

Example

#split-region
    region-list = surface soil-a soil-b
    orders = XYZ ZXY ZXY
#end-of-split-region

Latitude of cell center

Description

Define the latitude of the center of each cell. Use the gfbase format.

Identifier

List of cards

None

List of column in table

None

See also

None

Example

#latitude-cell-center
    *import-gfbase
        <ext-gfbase/lat.001>
#end-of-latitude-cell-center

Control

The control deck is used to set up the parameters that control the behaviour of the simulator. The parameters are grouped into severals decks: the job deck define the type of simulation, the linear and non-linear solver decks set up the solver parameters, the primary-variable deck contains the range of each variables and the solver parameters realted to the primary variables, the timestep deck includes the parameters defining the time properties of the solver, the flow-type and nb-equation deck define the type and the number of equation to be solve in each cell, the lsm-control deck set up the parameters of the land-surface model.

Job

Description

Define several general settings related to the type of simulation conducted: analysis type, execution mode, option for the advection model, fluid component system, etc.

Identifie

List of cards

Notes:

• The fluid component systems that fixes the number of equations to be solved per cell (corresponding to the number of primary variables) is determined by the selected problem type (cf. Table 8.2).
• In the water-gas two-phases flow analysis, GETFLOWS calculates the aqueous phase saturation and the gas phase pressure in every cells ; the number of equations should be nb-equation=2.
• The names of the fluid phase are fixed depending on the problem-type (see Table 8.2). In GETFLOWS, there is a maximum of three phases: Aqueous phase, gas phase and NAPL phase. The fluid phase names are used when setting the fluid properties.

See also

#pressure-volume-temperature, #normal-fvf, #normal-viscosity, #viscosity-increment, #method-pvt, #fluid>properties

Example

#job
   problem-type = 3
   runtype    = Run
#end-of-job

Notes:

• N.A.: Not Assigned.
• THMC: Thermal Hydrologic Mechanical Chemical processes.
• The number of equation correspond of the number of primary variable (last column).
• The number of component is the number of phase + the number of chemical species.
• When the job type is Flow, the number of equation is the number of phase + the number of chemical.
• When the job type is Trans, the number of equation is the number of phase.
• When Heat transport is considered, two primary variables are added.
• ICSOPT: number of solute under the 2-step solute computation method. ICSOPT is used as special treatment in solute transport simulation. Solute concentration, fluid pressure and saturation is usually solved simultaneously in solute transport simulation. Another solution method is incorporated into GETFLOWS, firstly, fluid pressure and saturation is solved, then only concentration is solved using calculated fluid velocity as operator split approach. ICSOPT shows number of solute in this method.

Jobtype designs the type of simulation. It is either Flows, Trans, LSM, Histr or Sedim.

• Flows: Mass transport and fluid flow computation. Used for 3-phase 2-component flow calculations such as density and flow analysis considering the velocity field and concentration field interaction.
• Trans: Transport computation based on previously computed fluid flow results (FLOW option). The system uses a dilute solution without interaction velocity field and concentration field (currently not used).
• Sedim: Sediment transport calculation (Bed load). Consider the simultaneous interaction of suspended sediment transport and topographic change.
• LSM: Land Surface Model.
• histr: historic

List of primary-variables:

• Pg: Gas pressure (unit: kgf/cm²)
• Pn: NAPL pressure (unit: kgf/cm²)
• Sw: Water saturation (unit: None)
• Sg: Gas saturation (unit: None)
• Rs: Volume concentration of dissolved matter in the water phase (unit: None)
• Rg: Volume concentration of volatilized matter in the air phase (unit: None)
• Tf: Mean temperature of fluid phases (unit: °C)
• Ts: Solid phase thenperature (unit: °C)
• T : Mean temperature of the and solid phases (unit: °C)
• P (P1, P2) : Probability distribution (unit: None)
• Xs: Concentration of suspended sediment
• Age: Groundwater age (unit: time)

Linear solver

Description

Define the parameters of the linear solver.

Identifier

List of cards

See also

#timestep #nonlinear-solver

Examples

Example 1

#linear-solver
   library = original    ! MKL, Lis
   method = GBiCGSTAB ! GBiCGSTAB, BiCGSTAB, GCR
   GBiCGSTAB.s = 3
   GBiCGSTAB.L = 3
   BiCGSTAB.s = 3
   GCR.m = 30
   preconditioner = GBILUp ! GBILUp, Nest, None
   GBILUp.p = 2
   matrix-order = 'XYZ'
   convergence-tolerance-method = ABS  ! ABS, RELT
   convergence-tolerance-value = 1.d-12
   max-iteration = 50

   !order = AUT      ! AUT, XYZ, XZY, YXZ, YZX, ZXY, ZYX
   !rnorm =-1.E-12
   !north = 5
   !nxitr = 20
#end-of-linear-solver

Note on versions

The gfcard input also support the version v6-x-x of GETFLOWS with the following deck:

#linear-solver
   max-iteration = 50
   rnorm = -1.e-12
   north = 10
   nxitr = 20
   order = 'XYZ'
#end-of-linear-solver

Here, the parameter rnorm can be negative. If rnorm is positive, RELT method is used. If rnorm is negative, ABS method is used.

Depending on the version (6-x-x or 7-x-x), the gfbase input related to the linear solver made by the card input processing is as follow.

For GF6 (version v6-x-x), the input in job file is:

 'SOLVER-SETTING (rnorm,north,nxitr,XYZorder) '  -1.0d-12,3,3,3000,'ZXY'

For GF7 (version v7-x-x), the input in job file is either:

​original:

'LINEAR-SOLVER-LIBRARY                       ' 'ORIGINAL'               ! 'ORG'  or 'MKL'  or 'LIS' , def.='ORG'
'LINEAR-SOLVER-METHOD                        ' 'GBiCGStab'  3  3        ! def.='GBiCGStab' 3 3
'LINEAR-SOLVER-PRECONDITIONER                ' 'GBILUp'  2              ! def.='GBILUp' 2
'LINEAR-SOLVER-MATRIX-ORDER                  ' 'XYZ'                    ! 'XYZ' or 'YXZ' or .... or 'AUT'  , def='AUT'
'LINEAR-SOLVER-CONVERGENCE-TOLERANCE         ' 'ABS'  1.d-12            ! 'ABS' or 'RELT'  , def='ABS'
'LINEAR-SOLVER-MAXIMUM-ITERATIONS            ' 50                       ! def.=50

LIS:

'LINEAR-SOLVER-LIBRARY                       ' 'LIS'                    ! 'ORG'  or 'MKL'  or 'LIS' , def.='ORG'
'LINEAR-SOLVER-MATRIX-ORDER                  ' 'XYZ'                    ! 'XYZ' or 'YXZ' or .... or 'AUT'  , def='AUT'
'LINEAR-SOLVER-CONVERGENCE-TOLERANCE         ' 'ABS'  1.d-12            ! 'ABS' or 'RELT'  , def='ABS'
'LINEAR-SOLVER-MAXIMUM-ITERATIONS            ' 50                       ! def.=50
'LINEAR-SOLVER-LIS-COMMANDLINE-OPTION        ' '-i 9 -p 2 -ilu_fill 2 -print 3'

MKL:

'LINEAR-SOLVER-LIBRARY                       ' 'MKL'               ! 'ORG'  or 'MKL'  or 'LIS' , def.='ORG'
'LINEAR-SOLVER-MATRIX-ORDER                  ' 'XYZ'               ! 'XYZ' or 'YXZ' or .... or 'AUT'  , def='AUT'

Nonlinear solver

Description

Define the parameters of the nonlinear solver.

Identifier

List of cards

See also

#timestep #linear-solver

Examples

Example:

#nonlinear-solver
   max-iteration = 10
   slp-iteration = 2
   dumping-tolerance-coefficient = 1.E1
   exclude-cell = ON
#end-of-nonlinear-solver

Primary-variable

Description

Define the parameters related to the primary variables (gas pressure, water saturation, etc).

Identifier

List of cards

(*) PG: gas phase pressure (kgf/cm²). SW: aqueous phase saturation (frac.)

Examples

Example 1: Set up by *table

#primary-variable
    *table
       primary-variable min-value  max-value nl-epsilon slp-tolerance nl-tolerance  timestep-tolerance
       PG               -1.E4      1.E4      1.E-10     1.E-7         1.E-5         1.0E-06
       SW                0.0       1.0       1.E-10     1.E-7         1.E-5         1.0E-06
    #end-of-primary-variable

Example 2: Set up by primary-variable

#primary-variable
    PG.min-value = -1.E4
    PG.max-value = 1.E4
    PG.nl-epsilon = 1.E-10
    PG.slp-tolerance = 1.E-8
    PG.nl-tolerance = 1.E-6
    PG.timestep-tolerance = 1.0E-06

    SW.min-value = 0.E0
    SW.max-value = 1.E0
    SW.nl-epsilon = 1.E-10
    SW.slp-tolerance = 1.E-8
    SW.nl-tolerance = 1.E-6
    SW.timestep-tolerance = 1.0E-06
#end-of-primary-variable

Timestep

Description

Define the time setting of the computation.

Identifier

List of cards

Notes:

1. When automatic time step is set up (automatic = ON), the simulator calculate and update the time step internally depending on the convergence determination. Convergence determination of the numerical solution is governed by parameters in the deck #control: (a) the residual norm of the linear solver convergence-tolerance-value in #linear-solver, (b) the residual norm nl-tolerance of the non-linear iterative calculation in #primary-variable. When the two convergence criterions are not satisfied, the numerical solution of the current step is said not converged and the time step size is divided by 2. Note that using the convergence mitigation options timestep-convergence allows to relax the convergence determination of condition (a) above by accepting convergence if the decrease of the residual norm is lower than the timestep-convergence value (even if it is higher than the convergence-tolerance-value value).

2. When fixed time step is set up (automatic card set to OFF), the time steps should be fixed with the table entry DTIM. In this case, the computation will continue until the total number of steps is reached whatever the convergence situation of the numerical solution.

See also

#control>linear-solver, #control>nonlinear-solver, #condition>initial

Example

Example 1: Automatic time step mode

#timestep
   automatic = ON
   time-unit = DAY       ! YEAR, WEEK, DAY, HOUR, MINUTE, SECOND
   start-time = 0.0
   end-time = 1.E30
   ndt = 100000
   dt0 = 1.E-2
   dtmax = 1.E20
   rate = 1.20
   timestep-convergence = 0.0
   *table
       primary-variable  timestep-tolerance
       PG                1.0E-06
       SW                1.0E-06
#end-of-timestep

Example 2: Manual time step mode

#timestep
   automatic = OFF
   time-unit = DAY ! YEAR, WEEK, DAY, HOUR, MINUTE, SECOND
   start-time = 0.0
   ndt = 100000
   *table |manual-timestep|
       ntim  dtim
       10    1.E-3
       30    3.E-3
       50    5.E-3
       80    1.E-2
       1000  3.E-2
#end-of-timestep

Flow-type

Description

GETFLOWS is capable to model two types of flow: Manning-type overland flow and Darcy-type underground fluid flow. This card defines the flow type to be used in each grid cell.

Identifier

List of cards

The flow type (Manning or Darcy) is defined on all grids of the region. Different flow type can be defined on different regions. The syntaxes available for setting up the flow type on each sub-region are listed in the following examples.

See also

design>region, design>alias-region

Examples

Example 1: Set up by region name’s name

#flow-type
 *table
     region   flow-type
     ALL      DARCY
     Surface  MANNING
#end-of-flow-type

Example 2: Set up by grid cell number (IJK)

#flow-type
    *table
        i-min i-max j-min j-max k-min k-max flow-type
        1     14    1     12    1     1     DARCY
        1     14    1     12    2     2     MANNING
#end-of-flow-type

Example 3: Set up by region name and card name

#flow-type
      ALL.flow-type = DARCY
      Surface.flow-type = MANNING
#end-of-flow-type

Example 4: Set up by input in sequential cell order

#flow-type
   *sequence-cell
      D D D D M M M M D D D D D D D D D D D D D D D D
#end-of-flow-type

Nb-equation

Description

Set up the number of equation to be solved at each cell.

Identifier

List of cards

See also

None

Examples

Example 1:

#nb-equation
  *table
      i-min i-max j-min j-max k-min k-max neq
      1     3     1     2     1     4     2
    surface.neq = 2
#end-of-nb-equation

Lsm-control

Description

Set up the parmeters of the land-surface model. Note that the weather data are specified in the #land deck.

Identifier

List of cards

See also

#land>lsm-rainfall, #land>lsm-wind-speed, #land>lsm-daylight-hour, #land>lsm-relative-humidity, #land>lsm-albedo, #land>lsm-storage, #land>lsm-air-temperature

Examples

Example:

#lsm-control
    surface-heat-method = single-layer-model
    use-canopy-litter = OFF
    use-snow-cover = ON
    solar-radiation-method = indirect
    start-date-of-simulation = 2005-1-1
    snowmelt-temperature = 2.0
    sugawara-parameter = 0.0
#end-of-lsm-control

Condition

The deck #condition is used to set up the general condition of the simulation, including the initial condition and the parameter adjustments. The deck can have one card (‘use-hydrostatic’) and up to seven decks (#standard, #initial, #hydrostatic, #adjust>parameter, #adjust>waterlevel, #adjust>cav, #adjust>prmch).

Its identifier is as follow.

Cards

Description

The card use-hydrostatic is used to activate the hydrostatic condition at the starting of the simulation (modification of the initial condition).

• If use-hydrostatic = on, the initial condition (defined in the deck #initial) will be modified to enforce hydrostatic condition defined in the hydrostatic deck (the hydrostatic deck is required in this case).
• If use-hydrostatic = off, the initial condition (defined in the deck #initial) will be set up without modification.

See also

#condition>initial, #condition>hydrostatic,

Example

#condition
   use-hydrostatic = on

   [...]
#end-of-condition

Standard

Description

Define the standard values for the pressure, temperature and gravitational acceleration at sea level on Earth.

Identifier

List of cards

The standard pressure is used to calculate the formation volume factor, the viscosity coefficient and the porosity. The default value of the standard pressure is 1.033kgf/cm² and the default value of the gravitational acceleration is 9.80665m/s².

See also

None

Example

#standard
   standard-pressure = 1.033
   gravity = 9.80665
#end-of-standard

Initial

Description

Define the initial condition (the value of the primary variables at the starting of the simulation). If the card use-hydrostatic of the deck #condition is set up to on, the initial condition will be modified to enforce the hydrostatic condition.

Identifier

List of cards

The cards available in the deck initial are the primary variables that depends on the problem-type. The table below describe the primary variables for the problem type 3.

In this deck, the value of the primary variables such as gas pressure and water saturation should be given to all the grid cells at the start of calculation. There are two options for this configuration:

Assign an user-defined primary variable value directly to each cell. This method is suitable for continuing an computation job from an existing calculation result.

To assign some initial condition automatically following the hydrostatic condition, see the deck #hydrostatic.

See also

#hydrostatic

Examples

Example 1: Set up by region name

#initial
    *table
        region      Pg    Sw
        Atmosphere  1.033 0.001
        Surface     1.033 0.001
        UnderGround 1.033 0.1
#end-of-initial

Example 2: Set up by the cell number

#initial
    *table
        i-min i-max j-min j-max k-min k-max Pg    Sw
        1     4     1     2     1     1     1.033 0.001
        1     4     1     2     2     2     1.033 0.001
        1     4     1     2     3     4     1.033 0.1
#end-of-initial

Example 3: Set up by the region name and card

#initial
    UnderGround.Pg = 1.10
    UnderGround.Sw = 0.50
#end-of-initial

Example 4: Set up by list cell ordering

#initial
    *import-gfbase
        <output/003/main.bin.093>
#end-of-initial

Hydrostatic

Description

The deck hydrostatic allows to set up the hydrostatic pressure condition option (modification of the initial condition in the entire field based on the standard aqueous surface level). This deck is optional. It is required only if the card use-hydrostatic of the deck #condition is set up to on.

Identifier

List of cards

Generate automatically the initial values at each cell by assuming hydrostatic pressure condition in the depth direction. First, the water level is assigned, either by layer or elevation. Then, the pressure under the water level is set up as the hydrostatic pressure and the water saturation is defined as 1.0. Over the water level, the gas pressure and water saturation are assigned to the atmospheric pressure and the residual water saturation respectively.

Examples

Example 1:

#hydrostatic
*table
region reference-layer reference-point elevation density xopt reference-pressure reference-pc  water-type
all    fwt             grid            0.0       1.0     11   1.033              0.0           fresh
*table
 i-min i-max j-min j-max k-min k-max reference-layer reference-point elevation density xopt reference-pressure reference-pc water-type
 1     4     1     2     1     1     3               grid            0.0       1.0     11   1.033              0.0          fresh
 1     4     1     2     2     2     3               grid            0.0       1.0     11   1.033              0.0          fresh
 1     4     1     2     3     4     3               grid            0.0       1.0     11   1.033              0.0          fresh
#end-of-hydrostatic

Example 2: Set up by region name under the hydrostatic condition

#hydrostatic
*table
region reference-layer reference-point elevation density xopt reference-pressure reference-pc
all    3               GRID            0.0       1.0     11   1.033              0.0
#end-of-hydrostatic

Example 3: Set up by cell range under the hydrostatic condition

#hydrostatic
*table
i-min i-max j-min j-max k-min k-max reference-layer reference-point elevation density xopt reference-pressure reference-pc
1     4     1     2     1     1     3               grid            0.0       1.0     11   1.033              0.0
1     4     1     2     2     2     3               grid            0.0       1.0     11   1.033              0.0
1     4     1     2     3     4     3               grid            0.0       1.0     11   1.033              0.0
#end-of-hydrostatic

Flow-velocity-field

[description coming later]

Example:

#flow-velocity-field
  velocity-field = steady
  binary-file = <output/003/main.bin.093>
#end-of-flow-velocity-field

Adjust>parameter

The decks present in #adjust are used to force the fluctuation of some variables with time during the simulation. Water level externl force is set up in the #adjust-waterlevel deck. The other supported parameters are set up in the #adjust-parameter deck. Note that the gfbase format for adjustment (cav file and prmch file) can still be used instead of the gfcard format (see below).

Description

Define the fluctuation of some variables (pressure, saturation, absolute permeability, etc) due to external force, excavation, etc.

Identifier

List of cards

In this deck, primary variables and geological properties time-varying fluctuations are assigned to assigned to any grid cells. Assignable primary variables depend on the fluid system. In the case of the water-gas two-phase flow analysis, the saturation of vapor phase pressure and aqueous phase is explicitly given. Linearly-interpolated values are used for the aqueous surface level at the arbitrary time between starting time and ending time.

Note that the end-time value should be greater than the start-time value. Also, all time range that overpass the global computation time range specified in the #timestep deck are discard.

The time varying geological properties should be given to arbitrary grid cells.

This configuration is effective only when the calculation time point has passed the defined start time (card TIME).

Regarding solid properties, the parameters that can be adjusted are the effective porosity, absolute permeability, Manning’s roughness coefficient, compressibility, residual saturation ratio, capillary pressure, and relative permeability. For the capillary pressure and the relative permeability, the tables that control them can be adjusted, tables defined in multiphase>define-correlation deck. In the case of adjustment to the cell group within the arbitrary area of sequence cell numbers, the absolute permeability is assigned to the medial side of the specified range. When one want to model the excavation of a ground-based open channel or a rock underground tunnel, the loose area can be accounted for and the amount of fluid passing the slope after the excavation can be controlled.

See also

#effective-porosity, #absolute-permeability, #manning-coefficient, #compressibility, #multiphase>define-correlation, #multiphase>assign-correlation, #irreducible-saturation

Examples

Example 1: Set up by region name

#adjust-parameter
    *table
        time-unit start-time end-time region    primary-variable start-value end-value
        DAY       0.0        10.0     UpStream  PG               1.01        1.02
        DAY       10.0       20.0     UpStream  PG               1.02        1.03
        DAY       20.0       30.0     UpStream  PG               1.03        1.04
#end-of-adjust-parameter

Example 2: Set up by cell range

#adjust-parameter
    *table
        time-unit start-time end-time i-min i-max j-min j-max k-min k-max primary-variable start-value end-value
        DAY       0.0        1.E2     1     6     1     1     3     4     PG               1.0         5.0
#end-of-adjust-parameter

Example 3: Set up by region name

#adjust-parameter
    *table
        time-unit time region effective-porosity abs-perm      abs-perm-i- abs-perm-i+ abs-perm-j- abs-perm-j+ abs-perm-k- abs-perm-k+
        DAY       0.0  ALL    0.2                10.           100.             100.             100.             100.             100.             100.
#end-of-adjust-parameter

Example 4: Set up by cell range

#adjust-parameter
    *table
        time-unit, time, i-min, i-max, j-min, j-max, k-min, k-max, water-xir, gas-xir
        DAY 0.0 1   6  1 10 3   4   0.001  0.0
#end-of-adjust-parameter

Adjust>waterlevel

Description

Define the water level fluctuation external force.

Identifier

List of cards

This deck control the adjustment of the time-varying dynamic boundary condition of water level at any grid cells. Main usage of waterlevel adjustemnt deck is to model the water level fluctuation of lakes or oceans area. Aqueous surface level at any time between start-time and end-time are computed by linear interpolation. Note that the latter must be greater than the former. Also, all time range that overpass the global computation time range specified in the #timestep deck are discard.

See also

None

Examples

Example 1: Set up by region name

#adjust-waterlevel
    *table
        time-unit start-time end-time region     start-value end-value
        DAY       0.0        1.0      UpStream   1.0         0.0
        DAY       1.0        2.0      UpStream   0.0         1.0
        DAY       2.0        3.0      UpStream   1.0         0.0
#end-of-adjust-waterlevel

Example 2: Set up by cell range

#adjust-waterlevel
    *table
        time-unit start-time end-time i-min i-max j-min j-max k-min k-max start-value end-value
        DAY       0.0        1.0      1     6     1     1     3     4     1.0         2.0
#end-of-adjust-waterlevel

Adjust: Legacy gfbase input format

Description

Define the time-varying change of the geological properties.

Identifier

Example

#adjust
    #cav
        *import-gfbase
            <../tests-gfbase/gfbase-files/cav.03to14.v23.KYU_SAGYO.txt>
    #end-of-cav

    #cav
        *import-gfbase
            <../tests-gfbase/gfbase-files/cav.03to14.v23.KYU_SAGYO.txt>
    #end-of-cav
#end-of-adjust

Fluid

This deck contains #properties that groups all the settings related to the physical properties of fluid and #pressure-volume-temperature that define the pressure-volume-temperature table, that is the function of some fluid properties with the pressure.

Properties

Define the physical properties of each fluid (water, gas, napl).

List of settings in #properties

In this deck, the different physical properties of each fluid can be simultaneously input. Fluid names are fixed depending on the type of simulation (water, gas, etc)

See also

#object>#[fluid]

Example

Example 1: Set up by table

#properties
    *table
        fluid-phase normal-fvf compressibility normal-viscosity viscosity-increment density method-pvt
        water       1.0        1.e-5           1.e0             1.e-5               1.0     equation
        gas         1.0        1.e-5           0.0182           1.e-5               1.22e-5 equation
        napl        1.0        1.e-5           1.e0             1.e-5               1.0     value
#end-of-properties

Example 2: Set up by fluid phase name and card’s name

#properties
    water.normal-fvf = 1.E0
    water.compressibility = 1.E-5
    water.normal-viscosity = 1.E0
    water.viscosity-increment = 1.E-5
    water.density = 1.E0
    water.method-pvt = equation
    gas.method-pvt = value
#end-of-properties

Example 3: Set up by object (no yet supported)

#properties
    water = [&my_groundwater]
    gas = [&air]
    water.density = [&air.density]
#end-of-properties

Normal-fvf

Define the formation volume factor at standard pressure condition. No default value for the volume factor has to be defined for each fluid phase. The standard pressure is defined using the deck condition>standard. Fluid names are fixed depending on the type of simulation or registered in a fluid object.

Compressibility

Define the compression ratio of the fluid phase. No default value for the compression ratio must be defined for each fluid phase. Fluid names are fixed depending on the type of simulation or registered in a fluid object.

normal-viscosity

Define the viscosity value at standard conditions of pressure and temperature. No default value for the viscosity coefficient must be defined for each target fluid phase. The standard pressure is defined in the condition>standard deck. Fluid names are fixed depending on the type of simulation or registered in a fluid object.

Viscosity-increment

Define the viscosity variation factor per pressure variation unit. No default value for the viscosity variation factor is defined; the factor must be defined for each fluid phase. The standard pressure is defined in the condition>standard deck. Fluid phase names used herein must be defined in the control>job>fluid deck or registered in a fluid object.

Density

Define the fluid density at standard pressure. No default value for the density of the fluid phase is defined; the value must be defined for each fluid phase. The standard pressure is defined in the condition>standard deck. Fluid names are fixed depending on the type of simulation or registered in a fluid object.

Method-pvt

Define the relationship between the pressure, the formation volume factor and the viscosity. When using the equation format input, the aqueous phase, the formation volume factor of the NAPL liquid phase and the viscosity is evaluated by the sum of the change for each unit of volume and pressure changes in various state standards. This variation is defined in the #fluid>#properties table under the compressibility column and in the #viscosity-increment deck. The volume of gas-phase coefficients is evaluated in a manner inversely proportional to pressure. When using the table format input, the relation is set up with values entered as a table in the pressure-volume-temperature deck. No default input format is set up; also the input format must be defined for each fluid phase present in the analysis. Fluid names are defined automatically from the problem type.

Pressure volume temperature

Description

Define the relationship between the pressure, the formation volume factor and the viscosity of each phase in the table format.

Identifier

List of cards

For each fluid phase, the card method-pvt card of the fluid>properties deck must be set up to method-pvt=value. The pressure set up in the table must be included in the range min-value, max-value defined in the #solver deck. Fluid names are fixed depending on the type of simulation or registered in a fluid object.

See also

#control>linear-solver, #control>nonlinear-solver, #method-pvt, #fluid>properties, [#object>#[fluid]]

Example

#pressure-volume-temperature
    *table
        pressure water-fvf  gas-fvf   water-viscosity gas-viscosity
        -1000.   1.0        1.0       1.0             0.0182
        0.000    1.0        1.0       1.0             0.0182
        1.033    1.0        1.0       1.0             0.0182
        2.000    0.9999573  0.5       1.0             0.0182
        5.000    0.2        1.0       0.9998249       0.0182
        10.00    0.1        1.0       0.9996042       0.0182
        20.00    0.9991628  0.05      1.0             0.0182
        30.00    0.033      0.9987214 1.0             0.0182
        40.00    0.025      0.9982800 1.0             0.0182
        50.00    0.9978386  0.02      1.0             0.0182
        100.0    0.9956316  0.01      1.0             0.0182
        500.0    0.002      0.9956316 1.0             0.0182
        1000.    .9956316   0.001     1.0             0.0182
#end-of-pressure-volume-temperature

Solid

Effective-porosity

Description

Define the effective porosity at standard pressure.

Identifier

List of cards

The effective porosity at standard pressure should be defined for the entire grid. The standard pressure is defined in condition>standard deck.

The effective porosity setting can be used to freeze the value of the primary variables such as pressure and saturation for particular cells. When a large value of effective porosity is defined (effective-porosity \(\geq\) 1E10), and in case of setting “exclude-cell=ON” in the #solver deck, the cells with effective porosity greater than 1E10 are excluded from the computation by the solver.

See also

#control>linear-solver, #control>nonlinear-solver, #solid, #store>object>#[solid]

Examples

Example 1: Set up by region name

#effective-porosity
    *table
        region      effective-porosity
        Atmosphere  1.0E30
        Surface     1.0E30
        Imperm      1.0E30
        UnderGround 0.4E0
        UpStream    1.0E30
#end-of-effective-porosity

Example 2: Set up by cell range

#effective-porosity
*table
    i-min i-max j-min j-max k-min k-max effective-porosity
    1     4     1     2     1     1     1.E30
    1     4     1     2     2     2     1.E0
#end-of-effective-porosity

Example 3: Set up by region name and card name

#effective-porosity
    Atmosphere.effective-porosity = 1.0E30
    UnderGround.effective-porosity = 0.4
#end-of-effective-porosity

Example 4: Set up by input in sequential cell order

#effective-porosity
    *sequence-cell
        1.e30 1.0 0.3 0.3 0.3 0.3 0.3 0.3 0.3 0.3 0.3 0.3
#end-of-effective-porosity

Absolute-permeability

Description

Define the absolute permeability.

Identifier

List of cards

The absolute permeability should be defined for the entire grid. The method of inputting the absolute permeability for isotropic media is different from the method for anisotropic media. In the case of isotropic media, only the value of a whole cell is necessary (abs-perm). In the case of anisotropic media, the absolute permeability should be defined for each cell side (abs-perm-i-, …). The isotropic media is equivalent to the anisotropic media with the same value of absolute permeability for each cell side. Note that the relative permeability setting of deck #define-correlation can also be used to define an anisotropic media.

See also

#solid, #store>object>#[solid], #define-correlation

Examples

Example 1: Set up by region name

#absolute-permeability
   *table
       region      abs-perm-i- abs-perm-i+ abs-perm-j- abs-perm-j+ abs-perm-k- abs-perm-k+
       Atmosphere  1.E10       1.E10       1.E10       1.E10       1.E10       1.E10
       Surface     1.E10       1.E10       1.E10       1.E10       1.E10       1.E10
       Imperm      0.E0        0.E0        0.E0        0.E0        0.E0        0.E0
       UnderGround 1.E3        1.E3        1.E3        1.E3        1.E3        1.E3
       UpStream    1.E10       1.E10       1.E10       1.E10       1.E10       1.E10
       DownStream  1.E10       1.E10       1.E10       1.E10       1.E10       1.E10
#end-of-absolute-permeability

Example 2: Set up by cell range

#absolute-permeability
   *table
       i-min  i-max  j-min  j-max  k-min  k-max  abs-perm
       1      4      1      2      4     4       1.E3
#end-of-absolute-permeability

Example 3: Set up by region name and card name

#absolute-permeability
    UpStream.abs-perm-i-= 1.E10
    UpStream.abs-perm-i+= 1.E10
    UpStream.abs-perm-j-= 1.E10
    UpStream.abs-perm-j+= 1.E10
    UpStream.abs-perm-k-= 1.E10
    UpStream.abs-perm-k+= 1.E10
    DownStream.abs-perm = 1.E10
#end-of-absolute-permeability

Example 4: Set up by input in sequential cell order

In sequential input mode, the absolute permeability values of the six sides of each cell should be given. Therefore, the number of values to be given is 6 times the number of cells. The order is (with the cell numbered starting from increasing index I, then J, then K):

abs-perm-i- abs-perm-i+ abs-perm-j- abs-perm-j+ abs-perm-k- abs-perm-k+
abs-perm-i- abs-perm-i+ abs-perm-j- abs-perm-j+ abs-perm-k- abs-perm-k+
...

#absolute-permeability
   *sequence-cell
      1.E10 1.E10 1.E3 1.E3 1.E3 1.E3 1.E3 1.E3 1.E3 1.E3 0.E0
#end-of-absolute-permeability

Example 5: Set up by external binary file

Here, the user has to set up the card file-import-cell-or-side to cell or side in order to specify if the binary file contains one value per cell or one value per side.

#absolute-permeability
   file-import-cell-or-side = 'cell'
   *import-gfbase
      <abs-perm.bin>
#end-of-absolute-permeability

Example 6: Set up by external sequence file

Here, the user has to set up the card file-import-cell-or-side to cell or side in order to specify if the file contains one value per cell or one value per side.

#absolute-permeability
   file-import-cell-or-side = 'side'
   *import-gfbase
      <abs-perm-sequence.txt>
#end-of-absolute-permeability

Absolute-permeability-factor

Description

Define the coefficient that multiply the absolute permeability to take into account the variation of absolute permeability depending on the fluid phase. This is used for instance to model the slip effect of gas molecule (Klinkenberg 1941).

Identifier

List of cards

The multiplication of absolute permeability at each phase should be defined for the entire grid. In the actual calculation, the absolute permeability defined in #absolute-permeability deck is multiplied by the defined scale factor value.

See also

#absolute-permeability, #solid, #store>object>#[solid]

Examples

Example 1: Set up by region name

#abs-perm-factor
    *table
        region      abs-perm-factor-water abs-perm-factor-gas
        Atmosphere  1.0                   1.0
        Surface     1.0                   1.0
        Imperm      1.0                   1.0
        UnderGround 1.0                   2.0
        UpStream    1.0                   1.0
#end-of-abs-perm-factor

Example 2: Set up by cell range

#abs-perm-factor
    *table
        I-MIN I-MAX J-MIN J-MAX K-MIN K-MAX abs-perm-factor-water abs-perm-factor-gas
        1     4     1     2     1     1     1.0                   1.0
        1     4     1     2     2     2     1.0                   1.0
        1     4     1     2     3     4     1.0                   2.0
#end-of-abs-perm-factor

Example 3: Set up by region name and card name

#abs-perm-factor
        UnderGround.abs-perm-factor-gas = 2.0
#end-of-abs-perm-factor

Example 4: Set up by input in sequential cell order

#abs-perm-factor
    *sequence-cell
        1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0
        1.0 1.0 2.0 2.0 2.0 2.0 2.0 2.0 2.0 2.0 2.0 2.0
#end-of-abs-perm-factor

Manning-coefficient

Description

Define the Manning’s roughness coefficient for each overland flow cell of the grid.

Identifier

List of cards

This deck defines the Manning’s roughness coefficient of overland flow cells of the grid when Manning type of flow is specified in the #flow-type deck. Different Manning’s roughness coefficient for each direction can be considered (isotropic media or anisotropic media). In the case of isotropic media, only the coefficient of a whole cell is necessary (MANN). In the case of anisotropic media, the Manning’s roughness coefficient should be defined for each cell side (I-MANN, …).

See also

#flow-type, #solid, #store>object>#[solid]

Examples

Example 1: Set up by region name

#manning-coefficient
   surface-water-model = linearized-diffusion-wave
   *table
       region      manning-i- manning-i+ manning-j- manning-j+
       Atmosphere  n.a.       n.a.       n.a.       n.a.
       Surface     1.E10      1.E10      1.E10      1.E10
       Imperm      n.a.       n.a.       n.a.       n.a.
       UnderGround n.a.       n.a.       n.a.       n.a.
       UpStream    n.a.       n.a.       n.a.       n.a.
       DownStream  n.a.       n.a.       n.a.       n.a.
#end-of-manning-coefficient

Example 2: Set up by cell range

#manning-coefficient
   surface-water-model = linearized-diffusion-wave
   *table
       i-min i-max j-min j-max k-min k-max mann
       1     4     1     2     2     2     1.E10
#end-of-manning-coefficient

Example 3: Set up by region name and card name

#manning-coefficient
   surface-water-model = linearized-diffusion-wave
   Surface.manning = 1.e10
   Surface.manning-i- = 1.e10
   Surface.manning-i+ = 1.e10
   Surface.manning-j- = 1.e10
   Surface.manning-j+ = 1.e10
#end-of-manning-coefficient

Example 4: Set up by input in sequential cell order

#manning-coefficient
   surface-water-model = linearized-diffusion-wave
   *sequence-cell
      1.E10 0.03 0.03 0.6 0.1 2.0 1.E10
#end-of-manning-coefficient

Compressibility

Description

Define the solid phase compressibility.

Identifier

List of cards

See also

#solid, store>object>#[solid]

Examples

Example 1: Set up by region name

#compressibility
    *table
        region      compressibility
        Atmosphere  1.E-5
        Surface     1.E-5
        Imperm      1.E-5
        UnderGround 1.E-5
        UpSream     1.E-5
        DownStream  1.E-5
#end-of-compressibility

Example 2: Set up by cell range

#compressibility
    *table
        i-min i-max j-min j-max k-min k-max compressibility
        1     4     1     2     3     4     1.E-5
#end-of-compressibility

Example 3: Set up by region name and card name