]>
Overall verbosity of the program
0
0, 1, 2, 3
Path to the directory where most of the outputs are stored.
DORiE will attempt to create it if it does not exist.
./
path
Base file name for VTK output.
string
Defines whether VTK files should be written as ASCII (``true``)
or binary (``false``). ASCII is easier to parse in case you want to write
your own post-processing, but takes a lot more space on your hard drive.
true, false
false
Grid geometry. The grid can either be structured rectangular / cubic
(``rectangular``) or unstructured triangular / tetrahedral (``gmsh``). The former does not
require any additional input, while in the latter case a gmsh file with
the corresponding grid is to be given.
rectangular
rectangular, gmsh
Choose grid type: rectangular, gmsh
Dimensionality of the domain.
2
2, 3
Order of the finite element method used. Values > 1 are not
thoroughly tested.
1
1, 2, 3
Path to the gmsh file containing the grid if ``gridType`` is set
to ``gmsh``.
path
Physical extensions of the domain in meters. Given in x, then y,
then z-direction. If a mesh file is imported, they have to match its maximum
extensions.
float × float (× float)
1 1
Initial number of cells in each dimension (x, then y, then z) if ``gridType``
is set to ``rectangular``. This represents the coarsest level of the grid
(i.e., refinement level 0).
int × int (× int)
100 100
Initial level of refinement of the grid. 0 means no refinement.
int
0
Path to the boundary condition file.
path
Type of spatial segmentation of the boundaries specified in the BC file
rectangularGrid
rectangularGrid
Choose type of boundary segmentation: rectangularGrid
Whether to interpolate between the boundary conditions
at different times linearly (``true``) or not at all (``false``). May require
different boundary condition files.
true, false
false
There are currently two possible initial conditions to choose
from: A constant potential throughout the domain (``gravityFlow``), or a
linear potential gradient (``hydrEquilibrium``).
hydrEquilibrium, gravityFlow
hydrEquilibrium
Choose initial condition: hydrEquilibrium, gravityFlow
Initial matric head at the lower boundary of the domain
float
0
Gradient of the matric head towards the upper boundary
(positive y coordinate).
float
-1
Starting time in seconds.
float
0
Ending time in seconds.
float
1E6
Minimum time step that is allowed before DORiE stops running.
with an error, in seconds.
float
0.1
Value of the first time step in seconds.
float
10
Largest allowed time step in seconds. Use this to control the
density of your output.
float
1E5
Minimum number of Newton iterations of the solver per
time step. At maxTimestep, the Newton solver is not allowed to calculate more
than this number of iterations.
int
1
Maximum number of Newton iterations of the solver per
time step. At minTimestep, the Newton solver is not allowed to calculate more
than this number of iterations.
int
12
Factor the current time step is multiplied with when increasing
the time step.
float > 1
1.5
Factor the current time step is multiplied with when decreasing
the time step.
float < 1
0.5
Path to an HDF5 array file containing all parameters used in the chosen
parameterization. Can be created using the ``dorie pfg`` command.
path
Create with 'dorie pfg'
Scaling factor of the parameter field. A value > 1 zooms into
the field; a value < 1 zooms out. This may of course change the statistical
properties of the field (e.g. correlation lengths).
float × float (× float)
1 1
The parameter field is shifted by this value (in physical units)
float × float (× float)
0 0
Sets the interpolation behavior when querying parameter field values
at a certain grid cell. Higher-order interpolation smoothes the parameter field,
but comes at a computational cost.
nearest, linear, cubic
nearest
Penalty factor to be used in the Discontinuous Galerkin scheme
float
10
If the ratio between last and current calculation defect exceeds this value,
the linear operator matrix is reassembled to ensure convergence.
float
5E-2
Maximum iteration count of linear searches performed to deduce
the optimal damping factor for reducing the defect.
int
10
Absolute error tolerance of the Newton solver.
float
1E-10
Relative error tolerance of the Newton solver.
float
1E-10
Required defect reduction of the linear solver. The Newton solver calculates
the required linear reduction for second order Newton convergence automatically and
chooses the smaller value of both.
float
1E-3
Switches adaptive grid refinement (h-adaptivity) on (``true``) or
off (``false``). If enabled, an unstructured grid manager with higher computational
cost is used when using rectangular / cubic grids.
true, false
false
The maximum refinement level kept in the grid. This is a useful
tool to prevent over-refinement. If this value is high, the grid can
be refined to an arbitrary degree, leading to an evenly distributed error
across the grid. Make sure you avoid refinement levels which imply grid cell sizes
beyond the Richards continuum scale.
int
10
Minimum refinement level of the grid. Grid cells will not get
coarsened below this level.
int
0
Marking strategy used in order to find the grid cells that should
be refined / coarsened.
**elementFraction**: Of the N elements in the sorted list of local errors, the first
αN elements are refined while the last βN elements are being coarsened.
**errorFraction**: Refine (coarse) as many elements as necessary, such that the
total relative contribution of all refined (coarsened) cells to the
global error is α (β), starting with the most (least) contributing
element. The total number of affected entities can vary greatly
between different iterations, and (with α = β) much more elements
are coarsened than refined.
**threshold**: All elements with a local error η > α are being refined once.
Coarsening occurs for all elements that carry an error smaller
than β.
**targetTolerance**: All elements with a local error η > α are being refined as often
as necessary until the requirement η < α is met for all grid cells.
Coarsening occurs for all elements that carry an error smaller
than β.
elementFraction, errorFraction, targetTolerance, threshold
elementFraction
elementFraction, errorFraction, targetTolerance, threshold
The value of α for the chosen ``markingStrategy``.
float
0.1
The value of β for the chosen ``markingStrategy``.
float
0.2
Grid refinement is skipped entirely for the given time step if
all grid elements carry an error lower than this value. This is to only
make the grid as fine as necessary.
float
1E-8
Switches debug mode on (``true``) or off (``false``). In debug mode,
the execution of DORiE stops immediately until a developer hooks into the
process with a debugger and sets the variable ``i`` to a value > 0. Only
intended for use by developers.
true, false
false