-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathdefaults.yaml
321 lines (258 loc) · 7.18 KB
/
defaults.yaml
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
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
#
# Defaults parameters for pyRSW
#
# --------------------
space:
Lx:
default: 1.
doc: Domain length along x
type: float
Ly:
default: 1.
doc: Domain length along y
type: float
theta:
default: [0, 6.283185307179586]
doc: Range of azymuth for cylindrical coordinates. Range of latitude for spherical coordinates
type: list
lat_pole_shift:
default: 0.
doc: Meridional angle shift for the North Pole. Controls the Coriolis parameter
type: float
r:
default: [0.5, 2]
doc: Range of radius for cylindrical coordinates
type: list
coordinates:
default: cartesian
doc: type of coordinates
avail: cartesian, cylindrical
type: str
partialcell:
default: False
doc: Activate the partial cell
type: bool
openbc:
default: False
doc: Deactivate the periodicity in the halo
type: bool
geometry:
avail: closed, perio_x, perio_y, perio_xy
default: closed
doc: Domain geometry
type: str
nx:
default: 128
doc: Number of gridpoints in x direction in the local subdomain
type: int
ny:
default: 128
doc: Number of gridpoints in y direction in the local subdomain
type: int
nz:
default: 1
doc: Number of layers
type: int
npx:
default: 1
doc: Number of subdomains in x
type: int
npy:
default: 1
doc: Number of subdomains in y
type: int
npz:
default: 1
doc: Number of subdomains in z. It has to be 1
type: int
# --------------------
numerics:
nh:
default: 3
doc: Number of ghost points in the halo
type: int
timestepping:
avail: EF, LF, Heun, RK3_SSP, AB2, AB3, RK4_LS
default: RK3_SSP
doc: Time scheme
type: str
VF_linear:
default: False
doc: Use linear interpolation on the vorticity flux
type: bool
VF_order:
default: 5
doc: Interpolation order for the vorticity flux
avail: 1, 3, 5
type: int
MF_linear:
default: False
doc: Use linear interpolation on the mass flux
type: bool
MF_order:
default: 5
doc: Interpolation order for the mass flux
avail: 1, 3, 5
type: int
# --------------------
output:
expname:
default: myexp
doc: Name of the experiment used in the name of the output directory and output files
avail: any valid filename(avoid white spaces)
type: str
datadir:
default: ~/data/pyRSW
avail: any valid path(existent or not) with write access
doc: Folder in which the output files of the simulation are stored
type: str
filemode:
default: overwrite
avail: overwrite, count, continue
doc: Handling of existing output files with the same name
type: str
physicalunits:
default: True
doc: Transform model native units into physical units
type: bool
halo_included:
default: False
doc: Whether to store the arrays with the halo or not
type: bool
restart:
default: False
doc: Whether to use restarts, if activated, the first batch will use the user initial conditions and write a restart at thend, then when relaunched, the model will start from this last restart.
type: bool
singlefile:
default: True
doc: Whether to write a single history file or one per core
type: bool
freq_diag:
default: 0.05
doc: Interval of time between two outputs in the diag file
type: float
freq_his:
default: 10.
doc: Interval of time between two outputs in the history file
type: float
nprint:
default: 20
doc: Numer of time steps between two prints
type: int
var_to_save:
default: [h, u, vor, pv]
doc: List of variables names that we want to output in the history file. The variables names have to be consistent with the model
type: str
hisdtype:
default: "f"
doc: Numpy dtype for float in the netCDF file. See np.typecodes
avail: "efdg"
type: str
# --------------------
physics:
g:
default: 1.
doc: Acceleration of gravity
type: float
f0:
default: 1.
doc: Coriolis parameter
type: float
rho:
default: 1.
doc: Density of each layer
type: list
H:
default: 1.
doc: Thickness of each layer
type: list
linear:
default: False
doc: If True use the linearized equations
type: bool
forcing:
default: False
doc: Activate a forcing. Needs to provide the name of the forcing routine
type: bool
noslip:
default: False
doc: Add a noslip condition along the boundaries
type: bool
# --------------------
plotting options:
cmap:
avail: needs to be in the pyplot list
default: RdBu_r
doc: Set the colormap
type: str
colorscheme:
avail: auto, imposed
default: auto
doc: Method to adjust the colorscale
type: str
cax:
default: [-1., 1.]
doc: min, max values for the color range
type: list
freq_plot:
default: 1
doc: Number of iterations between two plotting refresh
type: int
generate_mp4:
default: False
doc: Generate a mp4 video file on the fly
type: bool
plotvar:
default: h
doc: Name of the variable to plot
avail: h, u, vor, pv, p, ke
type: str
imshow_interpolation:
avail: nearest, bilinear
default: nearest
doc: Interpolation scheme for the imshow rendering
type: str
plot_type:
avail: imshow, pcolormesh
default: imshow
doc: Type of interactive plot, imshow or pcolormesh
type: str
plot_interactive:
default: True
doc: Set on the interactive plotting. Turn it off to speed up the computation
type: bool
plotting_module:
avail: a_user_file_name
default: plotting
doc: Give the name of your plotting module(python script). It should look like core/plotting.py
type: str
# --------------------
time:
cfl:
default: 0.5
doc: Desired cfl that sets the time step in the case of auto_dt
type: float
auto_dt:
default: False
doc: Whether to use a varying time step or a constant one
type: bool
dt_max:
default: 0.01
doc: Maximum time step to use (for the auto_dt case)
type: float
dt:
default: 0.01
doc: Time step to use when it is constant
type: float
tend:
default: 1.
doc: Integration time
type: float
duration:
default: 1.
doc: Integration time
type: float
timeunit:
default: 1.
doc: Time unit, used to print the results
type: float