Control Block¶

The Control block sets up the time stepping and time step cotroling parameters. The Control block sets up the time stepping and time step cotroling parameters.

Warning

This block is mandatory for all simulations.

Flags Overview¶

Note

All flags and their description are included in the table below. A detailed description of which values are possible for each input flag follows.

Flag	Required	Description
`INIT_TIMESTEP`	Yes	initial time step in s
`TIME_STEP_CTRL_START`	No	start iteration of time step control
`TSTEP_MIN`	Yes	minimal time step allowed
`TSTEP_MAX`	Yes	maximum time step allowed
`TIME_END`	No	end time for the simulation
`ITE_END`	No	end iteration step for the simulation
`WCT_LIM`	Yes	wall clock time limit set for the simulation
`CFL_LIM`	No	upper limit for CFL number during the simulation
`CFL_CTRL`	No	determines whether to use CFL for time step control
`FOU_LIM`	No	upper limit for Fourier number
`FOU_CTRL`	No	turn on/off Fourier number for time step control
`DEBUG_GLOBAL`	No	turn on/off print out 3D array entries for debug
`DEBUG_LOCAL`	No	turn on/off print out stdout debugging information for DEBUG_END_ITE iterations
`DEBUG_END_ITE`	No	integer shows how often the debugging message should be printed

Flags Details¶

INIT_TIMESTEP

Determines the initial time step at the beginning of the simulation in seconds.

Type: Real
Values: whatever suits your simulation
Default: no default

TIME_STEP_CTRL_START

Determines the iteration from which time step control begins.

Type: positive Integer
Values: whatever suits your simulation
Default: 1

TSTEP_MIN

Minimal time step allowed in seconds.

Type: Real
Values: whatever suits your simulation
Default: 1.0D-10

TSTEP_MAX

Maximum time step allowed in seconds.

Type: Real
Values: whatever suits your simulation
Default: no default

TIME_END

Determines physical end time of simulation in seconds.

Type: Real
Values: whatever suits your simulation
Default: no default

ITE_END

Determines end iteration of simulation.

Type: positive Integer
Values: whatever suits your simulation
Default: no default

WCT_LIM

Determines wall clock time limit (in hours) of simulation to write a last restart file before the simulation gets terminated.

Type: positive double
Values: whatever suits your simulation
Default: no default

CFL_LIM

Determines upper limit of CFL during simulation.

Type: Real
Values: whatever suits your simulation
Default: no default

CFL_CTRL

Turn on/off to use CFL for time step control.

Type: Boolean
Values: .true. and .false.
Default: no default

FOU_LIM

Upper limit of Fourier number, which is controlling the numerical diffusion.

Type: Real
Values: <0.25 for explicit integration is recommended
Default: no default

fou_CTRL

Turn on/off to use Fourier number for time step control.

Type: Boolean
Values: .true. and .false.
Default: no default

DEBUG_GLOBAL

Turn on/off to print out 3D array entries.

Type: Boolean
Values: .true. and .false.
Default: no default

DEBUG_LOCAL

Turn on/off to print out stdout debugging information for DEBUG_END_ITE iterations.

Type: Boolean
Values: .true. and .false.
Default: no default

DEBUG_END_ITE

Non-negative integer shows how often the debugging message should be printed.

Type: Integer
Values: whatever it suits to your simulation
Default: 10

Example¶

&NML_CONTROL
    INIT_TIMESTEP=1.D-8,
    TSTEP_MIN=1.D-10,
    TSTEP_MAX=50.D-6,
    TIME_END=3.D0,
    ITE_END=100000,
    TIME_STEP_CTRL_START=0,
    WCT_LIM=1.D0,
    CFL_LIM=0.2D0,
    CFL_CTRL=.true.,
    FOU_LIM=0.2D0,
    FOU_CTRL=.true.,
    DEBUG_GLOBAL=.false.,
    DEBUG_LOCAL=.false.,
    DEBUG_END_ITE=1000
/