aboutsummaryrefslogtreecommitdiff
path: root/param.ccl
blob: b9f6d66cf506b5d80516d2ab9a1e0ccdff058f1d (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
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
# Parameter definitions for thorn IOFlexIO


#############################################################################
### declare IOFlexIO parameters
#############################################################################
private:

##########################
# What variables to output
##########################
STRING output2D "Variables to output in 2D FlexIO file format"
{
  :: "default is to output nothing"
} ""
STRING output3D "Variables to output in 3D FlexIO file format"
{
  :: "default is to output nothing"
} ""
################
# Various things
################
LOGICAL checkpoint_FlexIO "Do checkpointing with IOFlexIO"
{
} "no"
LOGICAL reuse_fh "Reuse file handles by closing files after each write operation."
{
} "no"


#############################################################################
### import IOUtil parameters
#############################################################################
friend: IO

####################
# Output directories
####################
EXTEND STRING IO_outdir "Name of IO output directory"
{
} "."
EXTEND STRING IO_outdir2D "Name of IO 2D output directory, overrides IO_outdir"
{
} "IO_outdir"
EXTEND STRING IO_outdir3D "Name of IO 3D output directory, overrides IO_outdir"
{
} "IO_outdir"


########################
# How often to do output
########################
EXTEND INTEGER IO_every "How often to do IO output"
{
  -1:* ::
} -1
EXTEND INTEGER IO_2Devery "How often to do 2D output, overrides IO_every"
{
  -1:* ::		
} -1
EXTEND INTEGER IO_3Devery "How often to do 3D output, overrides IO_every"
{
  -1:* ::
} -1


################
# various things
################
EXTEND LOGICAL IO_verbose "Give extended screen output in IO?"
{
} "no"
EXTEND LOGICAL IO_datestamp "Write date as attribute to IO 3D output file?"
{
} "yes"
EXTEND LOGICAL IO_parameters "Write parameters to IO 3D output file?"
{
} "yes"
EXTEND LOGICAL IO_structures "Write structures to IO 3D output file?"
{
} "yes"


#######################
# Specific to 3D output
#######################
EXTEND KEYWORD iomode "Which mode for 3D IO"
{
  "proc"    :: "every processor writes its share of data into a separate file"
  "np"      :: "data is collected and written by every N'th processor into a separate file, where N is specified by the parameter ioproc_every"
  "onefile" :: "all output is written into a single file by processor 0"
} "proc"

EXTEND INTEGER ioproc_every "Do IO on every N processors."
{
  1:*       :: "Must be a positive integer"
} 8
EXTEND LOGICAL onefileperslice "Write one file per time slice, as opposed to all data in one file"
{
} "no"
EXTEND LOGICAL unchunked "Don't write data in chunks."
{
} "no"


##############################################
# Downsampling parameters (only for 3D output)
##############################################
EXTEND INTEGER downsample_x "Factor by which to downsample output in x direction. Point (0,0,0) is always included."
{
  1:*       :: "Must be a positive integer"
} 1
EXTEND INTEGER downsample_y "Factor by which to downsample output in y direction. Point (0,0,0) is always included."
{
  1:*       :: "Must be a positive integer"
} 1
EXTEND INTEGER downsample_z "Factor by which to downsample output in z direction. Point (0,0,0) is always included."
{
  1:*       :: "Must be a positive integer"
} 1
EXTEND LOGICAL out_single "Output 3D data in single precision ? This parameter is ignored for Cactus compiled with SINGLE_PRECISION."
{
} "no"


###################################
# Checkpointing/recovery parameters
###################################
EXTEND LOGICAL checkpoint_ID "Checkpoint initial data ?"
{
} "no"
EXTEND LOGICAL checkpoint_keep_all "Keep all checkpoint files ?"
{
} "no"
EXTEND LOGICAL recover "Recover from a checkpoint file ?"
{
} "no"
EXTEND INTEGER checkpoint_every "Checkpoint every x iterations"
{
  -1:* :: "negative values disable checkpointing"
} -1
EXTEND INTEGER checkpoint_keep "How many checkpoint files to keep"
{
  1:* :: "1 overwrites the latest checkpoint file"
} 1
EXTEND STRING checkpoint_file "File name for regular checkpoint"
{
} "checkpoint"
EXTEND STRING checkpoint_ID_file "File name for initial data checkpoint"
{
} "checkpointID"
EXTEND STRING recover_file "File name of recovery file"
{
} "checkpoint"
EXTEND STRING checkpoint_dir "Output directory for checkpoint files"
{
} "."
EXTEND STRING recovery_dir "Directory to look for the recovery file"
{
} "."