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
322
323
324
325
326
327
328
329
330
331
|
/*@@
@file Output.c
@date Mon 21 September
@author Gabrielle Allen
@desc
Functions to deal with scalar output of grid variables
@enddesc
@@*/
/*#define IO_DEBUG*/
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include "cctk.h"
#include "cctk_Parameters.h"
#include "iobasicGH.h"
/* function prototypes */
int IOBasic_TimeForOutput (cGH *GH, int vindex);
int IOBasic_OutputGH (cGH *GH);
static void CheckSteerableParameters (iobasicGH *myGH);
static void SetOutputFlag (int vindex, const char *optstring, void *arg);
/*@@
@routine IOBasic_OutputGH
@date Sat March 6 1999
@author Gabrielle Allen
@desc
Loops over all variables and outputs them if necessary
@enddesc
@calledby CCTK_OutputGH ("IOBasic")
@history
@endhistory
@var GH
@vdesc Pointer to CCTK GH
@vtype cGH
@vio in
@endvar
@@*/
int IOBasic_OutputGH (cGH *GH)
{
int vindex;
const char *name;
iobasicGH *myGH;
/* Get the GH extensions for IOBasic */
myGH = (iobasicGH *) GH->extensions [CCTK_GHExtensionHandle ("IOBasic")];
CheckSteerableParameters (myGH);
/* Return if no output is required */
if (myGH->outScalar_every <= 0)
{
return (0);
}
/* Loop over all variables */
for (vindex = 0; vindex < CCTK_NumVars (); vindex++)
{
/* Is it time for output ? */
if (! IOBasic_TimeForOutput (GH, vindex))
{
continue;
}
/* Get the variable name for this index (for filename) */
name = CCTK_VarName (vindex);
#ifdef IO_DEBUG
printf("\nIn IOBasic_OutputGH\n----------------\n");
printf(" Index = %d\n",vindex);
printf(" Variable = -%s-\n",name);
printf(" Last output iteration was = %d\n",myGH->outScalar_last[vindex]);
#endif
/* Make the IO call */
if (CCTK_GroupTypeFromVarI (vindex) == CCTK_SCALAR)
{
IOBasic_Write (GH, vindex, name);
}
else
{
IOBasic_WriteGF (GH, vindex, name);
}
/* Register GF as having 0D output this iteration */
myGH->outScalar_last [vindex] = GH->cctk_iteration;
} /* end of loop over all variables */
return (0);
}
/*@@
@routine IOBasic_OutputVarAs
@date Sat March 6 1999
@author Gabrielle Allen
@desc
unconditional output of a variable using the IOBasic output method
@enddesc
@calledby IOBasic_OutputGH, CCTK_OutputVarAsByMethod ("IOBasic")
@var GH
@vdesc Pointer to CCTK GH
@vtype cGH
@vio in
@vcomment
@endvar
@var fullname
@vdesc complete name of variable to output
@vtype const char *
@vio in
@vcomment
@endvar
@var alias
@vdesc alias name of variable to output (used to generate output filename)
@vtype const char *
@vio in
@vcomment
@endvar
@@*/
int IOBasic_OutputVarAs (cGH *GH, const char *fullname, const char *alias)
{
int vindex;
vindex = CCTK_VarIndex (fullname);
#ifdef IO_DEBUG
printf("\nIn IOBasic_OutputVarAs\n-------------------\n");
printf(" Fullname = -%s-\n",fullname);
printf(" Alias = -%s-\n",alias);
printf(" Index = %d\n",vindex);
#endif
if (CCTK_GroupTypeFromVarI (vindex) == CCTK_SCALAR)
{
IOBasic_Write (GH, vindex, alias);
}
else
{
IOBasic_WriteGF (GH, vindex, alias);
}
return (0);
}
/*@@
@routine IOBasic_TimeForOutput
@date Sat March 6 1999
@author Gabrielle Allen
@desc
Decides if it is time to output a variable using Scalar output
method
@enddesc
@calls CCTK_GHExtensionHandle
CCTK_GroupTypeFromVar
CCTK_WARN
@calledby
@history
@endhistory
@var GH
@vdesc Pointer to CCTK GH
@vtype cGH
@vio in
@vcomment
@endvar
@var vindex
@vdesc index of variable
@vtype int
@vio in
@vcomment
@endvar
@@*/
int IOBasic_TimeForOutput (cGH *GH, int vindex)
{
int return_type;
iobasicGH *myGH;
char *fullname;
/* Default is do not do output */
return_type = 0;
/* Get the GH extension for IOBasic */
myGH = (iobasicGH *) GH->extensions [CCTK_GHExtensionHandle ("IOBasic")];
CheckSteerableParameters (myGH);
/* check if any output was requested */
if (myGH->outScalar_every <= 0)
{
return (0);
}
/* Check if this variable should be output */
if (myGH->do_outScalar [vindex] &&
(GH->cctk_iteration % myGH->outScalar_every) == 0)
{
/* Check if variable wasn't already output this iteration */
if (myGH->outScalar_last [vindex] == GH->cctk_iteration)
{
fullname = CCTK_FullName (vindex);
CCTK_VWarn (5, __LINE__, __FILE__, CCTK_THORNSTRING,
"Already done IOBasic scalar output for '%s' in "
"current iteration (probably via triggers)", fullname);
free (fullname);
}
else
{
return_type = 1;
}
}
return (return_type);
}
/*@@
@routine IOBasic_TriggerOutput
@date Sat March 6 1999
@author Gabrielle Allen
@desc
Triggers the output a variable using IOBasic's Scalar
output method
method
@enddesc
@calledby CCTK scheduler
@var GH
@vdesc Pointer to CCTK GH
@vtype cGH
@vio in
@vcomment
@endvar
@var vindex
@vdesc index of variable to output
@vtype int
@vio in
@vcomment
@endvar
@@*/
int IOBasic_TriggerOutput (cGH *GH, int vindex)
{
const char *name;
iobasicGH *myGH;
/* Get the GH extension for IOBasic */
myGH = (iobasicGH *) GH->extensions [CCTK_GHExtensionHandle ("IOBasic")];
name = CCTK_VarName (vindex);
#ifdef IO_DEBUG
printf ("\nIn IOBasic_TriggerOutput\n---------------------\n");
printf (" Index = %d\n", vindex);
printf (" Variable = -%s-\n", name);
#endif
/* Do the Scalar output */
if (CCTK_GroupTypeFromVarI (vindex) == CCTK_SCALAR)
{
IOBasic_Write (GH, vindex, name);
}
else
{
IOBasic_WriteGF (GH, vindex, name);
}
/* Register variable as having Scalar output this iteration */
myGH->outScalar_last [vindex] = GH->cctk_iteration;
return (0);
}
/**************************** local functions ******************************/
/* check if steerable parameters have changed */
static void CheckSteerableParameters (iobasicGH *myGH)
{
DECLARE_CCTK_PARAMETERS
int times_set;
static int outScalar_vars_lastset = -1;
/* How often to output */
myGH->outScalar_every = out_every > 0 ? out_every : -1;
if (outScalar_every > 0)
{
myGH->outScalar_every = outScalar_every;
}
/* re-parse the 'outScalar_vars' parameter if it was changed */
times_set = CCTK_ParameterQueryTimesSet ("outScalar_vars", CCTK_THORNSTRING);
if (times_set != outScalar_vars_lastset)
{
memset (myGH->do_outScalar, 0, CCTK_NumVars ());
CCTK_TraverseString (outScalar_vars, SetOutputFlag, myGH->do_outScalar,
CCTK_GROUP_OR_VAR);
/* Save the last setting of 'outScalar_vars' parameter */
outScalar_vars_lastset = times_set;
}
}
/* callback for CCTK_TraverseString() to set the output flag
for the given variable */
static void SetOutputFlag (int vindex, const char *optstring, void *arg)
{
char *flags = (char *) arg;
flags[vindex] = 1;
if (optstring)
{
CCTK_VWarn (5, __LINE__, __FILE__, CCTK_THORNSTRING,
"Optional string '%s' in variable name ignored", optstring);
}
}
|