input_schmiddu.txt

!------------------------------------------------------------------------------|
!------------------------------------------------------------------------------|
!                                                                              |
!          8888888b.   .d88888b.  888     888       d8888 8888888b.            |
!          888  "Y88b d88P" "Y88b 888     888      d88888 888   Y88b           |
!          888    888 888     888 888     888     d88P888 888    888           |
!          888    888 888     888 888     888    d88P 888 888   d88P           |
!          888    888 888     888 888     888   d88P  888 8888888P"            |
!          888    888 888     888 888     888  d88P   888 888 T88b             |
!          888  .d88P Y88b. .d88P Y88b. .d88P d8888888888 888  T88b            |
!          8888888P"   "Y88888P"   "Y88888P" d88P     888 888   T88b           |
!                                                                              |
!             Input file for DOUAR-WSMP version 0.3 - 07/08/2013               |
!------------------------------------------------------------------------------|
!------------------------------------------------------------------------------|

This file is read by two subroutines in the code:
- read_controlling_parameters
- read_input_file
The indications between [] indicate the type of the read parameter. It can be
an integer [int], a real*8 [dp], a character chain [char] or a boolean [bool].


CONTROLLING PARAMETERS
_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-

[int]debug is a parameter that switches on/off various prints and outputs
(the level of printing for error, warning and messages of the solver id%cntl(4)
is set to the debug value).
if debug is zero, no debugging 
if debug is equal to one, this triggers the terminal display of some key
parameters 
if debug is equal to two, same as debug equal to one, and the code produces
various vtk files in the DEBUG subdirectories (surfaces, olsf, ...), as well as
cross sections for all nonlinear iterations. Careful, memory consuming!

      debug = 1

[bool]doDoRuRe is a flag that triggers the production of output files needed to
produce the DoRuRes. DoRuRe stands for 'Douar Run Report'. 

      doDoRuRe = F

[bool]compute_qp_gram triggers the production of qpgrams for every grid.

      compute_qpgram = F


RESTART
_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-

[int]irestart is a restart flag; if irestart is not 0, the run will restart from
an output file given by [char]restartfile and at step.

      irestart = 0

      restartfile = OUT/time_0000.bin


SPINUP PHASE
_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-
The spinup phase values will be used during the initial nstep_spinup steps of a
DOUAR run. These values will overrule the values given in later sections as long
as the current DOUAR step is less than or equal to nstep_spinup. Note that if
nstep_spinup is less than 1, these values will not be used. The values that are
currently supported for the general spinup phase are: dt_spinup,
griditer_spinup, nonlinear_iterations_spinup, and tol_spinup. Also note that
spinup phase variables that apply to the material, surface or cloud definitions
are given in their respective definition sections.

[int]nstep_spinup is the number of steps used for the spinup phase

      nstep_spinup = 5

[dp]dt is the time step length (if dt is negative, courant conidition is used
and automatic time stepping is turned on)

      dt_spinup = 1.1719d-5

[int]griditer is a flag that allows for nonlinear iterations; when positive, a
fixed number (griditer) of iterations is permitted; when negative, the number of
nonlinear iterations is determined by a convergence criterion.

      griditer_spinup = -10

[int]nonlinear_iterations is the maximum number of nonlinear iterations (i.e.
the iterations on a given constant grid)
if nonlinear_iterations is positive, it simply is the number of nonlinear
iterations performed for each grid. When negative it indicates an upper bound
of nonlinear iterations, but the actual number of nonlinear iterations is
determined by a convergence criterion (see the 'tol' parameter)

      nonlinear_iterations_spinup = -100

[dp]tol_spinup is the tolerance used to estimate convergence on the computed
velocity field during the spinup phase. Note that an adaptive tolerance cannot
be used during the spinup phase.

      tol_spinup = 0.01d0

[bool]sstemp_spinup is a flag for whether a steady-state thermal calculation
should be performed during the spinup phase iterations. If true, a uniform
viscosity value should be provided for the first time step using the option
sstemp_viscosity_spinup below.

      sstemp_spinup = F

[dp]sstemp_viscosity_spinup is a reference linear viscosity value to be used for
all materials during the first time step of the spinup phase when calculating a
steady-state thermal field.  This is done to ensure the first calculation
using temperature-dependent material properties considers thermal advection and
diffusion with an approximation of the velocity field in the nonlinear case. If
negative, this value will be ignored and the normal material properties will be
used.

      sstemp_viscosity_spinup = 4.7795d-7

[dp]sstemp_penalty_spinup is the penalty factor that corresponds to use of the
sstemp_viscosity_spinup above. A value of 1.d8 is recommended.

      sstemp_penalty_spinup = 1.d8

[bool]all_surf_fixed_spinup is a flag to fix all surface positions during the
spinup phase. Individual surface positions can be fixed in the section below for
surface definitions. If true, this option will override the option to fix
individual surfaces.

      all_surf_fixed_spinup = F

[bool]fixed_cloud_spinup is a flag to skip the update of the cloud particle
positions during the spinup phase. If true, cloud particles positions will not
be updated.

      fixed_cloud_spinup = F


TIMESTEPPING
_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-

[dp]dt is the time step length (if dt is negative, courant conidition is used
and automatic time stepping is turned on)

      dt = 1.1719d-3

[int]nstep is the number of time steps

      nstep = 220

[dp]courant is only used when dt is negative; it determines the size of the time
step from the maximum value of the velocity field amplitude. The time step s
the product of courant by the ratio of the smallest leaf size by the maximum
velocity.

      courant = .5d0

[bool]normaladvect is a flag used to determine which algorithm to use to
calculate the new geoletry of the normals to the surfaces at the nodes on the
surfaces
if normaladvect is T, the normals are advected using the velocity gradient
if normaladvect is F, the normals are re-computed from the geometry of the
surface

      normaladvect = T


GRID ITERATIONS
_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-

[int]griditer is a flag that allows for nonlinear iterations; when positive, a
fixed number (griditer) of iterations is permitted; when negative, the number of
nonlinear iterations is determined by a convergence criterion.

      griditer = -100

[dp]octree_refine_ratio is the threshold value used to determine whether the
octree has converged or not. the larger the value, the less stringent the test.

      octree_refine_ratio = .025d0


NONLINEAR ITERATIONS
_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-_-

[int]nonlinear_iterations is the maximum number of nonlinear iterations (i.e.
the iterations on a given constant grid)
if nonlinear_iterations is positive, it simply is the number of nonlinear
iterations performed for each grid. When negative it indicates an upper bound
of nonlinear iterations, but the actual number of nonlinear iterations is
determined by a convergence criterion (see the 'tol' parameter)

      nonlinear_iterations = -100

[int]nb_iter_nl_min is the number of nonlinear iterations required for velocity
convergence when using the convergence criterion tolerance value below. Note
that this is different than simply requiring a given number of nonlinear
iterations as the velocity field must also be converged within the tolerance
below.

      nb_iter_nl_min = 0