aboutsummaryrefslogtreecommitdiff
path: root/Carpet/CarpetIOStreamedHDF5/param.ccl
blob: 1aacda901f812d8919f8bb0f67fc713ef728fc42 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
# Parameter definitions for thorn CarpetIOStreamedHDF5

private:

STRING out_vars "Variables to stream in HDF5 file format" STEERABLE = ALWAYS
{
  ".+" :: "Space-separated list of fully qualified variable/group names"
  "^$" :: "An empty string to output nothing"
} ""
 
KEYWORD out_criterion "Criterion to select CarpetIOHDF5 output intervals, overrides out_every" STEERABLE = ALWAYS
{
  "default"   :: "Use 'IO::out_criterion'"
  "never"     :: "Never output"
  "iteration" :: "Output every so many iterations"
  "divisor"   :: "Output if (iteration % out_every) == 0."
  "time"      :: "Output every that much coordinate time"
} "default"

INT out_every "How often to do HDF5 streaming, overrides IO::out_every" STEERABLE = ALWAYS
{
   1:* :: "Output every so many time steps"
  -1:0 :: "No output"
  -2   :: "Use 'IO::out_every'"
} -2

REAL out_dt "How often to do CarpetIOHDF5 output, overrides 'IO::out_dt'" STEERABLE = ALWAYS
{
  (0:* :: "In intervals of that much coordinate time"
   0   :: "As often as possible"
  -1   :: "Disable output"
  -2   :: "Default to 'IO::out_dt'"
} -2

INT port "Port number for clients to connect to" STEERABLE = RECOVER
{
  1000:32000 :: "Ports below 1000 require root access"
} 10000

INT max_num_clients "Maximum number of clients allowed to connect at the same time" STEERABLE = RECOVER
{
  1:20 :: "a small positive number"
} 3


#############################################################################
### import IOUtil parameters
#############################################################################
shares: IO

USES INT     out_every     AS io_out_every
USES REAL    out_dt        AS io_out_dt
USES KEYWORD out_criterion AS io_out_criterion
USES KEYWORD verbose
USES BOOLEAN out_unchunked
USES BOOLEAN strict_io_parameter_check