aboutsummaryrefslogtreecommitdiff
path: root/src/Output.c
blob: e80a23be78748a8f838f26eca834a0337abad293 (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
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
 /*@@
   @file      Output.c
   @date      Tue Jan 9 1999
   @author    Gabrielle Allen
   @desc 
              Functions to deal with output of variables in HDF5 file format
   @enddesc 
   @version   $Id$
 @@*/


#include <stdlib.h>

#include "cctk.h"
#include "cctk_Parameters.h"
#include "ioHDF5GH.h"

/* the rcs ID and its dummy function to use it */
static const char *rcsid = "$Id$";
CCTK_FILEVERSION(AlphaThorns_IOHDF5_Output_c)


/* prototypes of routines defined in this source file */
int IOHDF5_TimeFor (cGH *GH, int vindex);
int IOHDF5_OutputVarAs (cGH *GH, const char *var, const char *alias);
static void CheckSteerableParameters (ioHDF5GH *myGH);


/*@@
   @routine    IOHDF5_OutputGH
   @date       Sat March 6 1999
   @author     Gabrielle Allen
   @desc
               Loops over all variables and outputs them if necessary
   @enddesc

   @calls      IOHDF5_TimeFor
               IOHDF5_OutputVarAs

   @var        GH
   @vdesc      Pointer to CCTK GH
   @vtype      cGH *
   @vio        in
   @endvar
@@*/
int IOHDF5_OutputGH (cGH *GH)
{
  DECLARE_CCTK_PARAMETERS
  int vindex;
  ioHDF5GH *myGH;
  const char *name;
  char *fullname;


  /* Get the GH extension for IOHDF5 */
  myGH = (ioHDF5GH *) CCTK_GHExtension (GH, "IOHDF5");

  CheckSteerableParameters (myGH);

  if (myGH->out_every <= 0)
  {
    return (0);
  }

  /* Loop over all variables */
  for (vindex = 0; vindex < CCTK_NumVars (); vindex++)
  {

    if (IOHDF5_TimeFor (GH, vindex))
    {
      name     = CCTK_VarName (vindex);
      fullname = CCTK_FullName (vindex);

      if (verbose)
      {
        CCTK_VInfo (CCTK_THORNSTRING, "IOHDF5_OutputGH: (fullname / name) = "
                                      "(%s / %s)", fullname, name);
      }

      IOHDF5_OutputVarAs (GH, fullname, name);

      free (fullname);

      /* Register variable as having output this iteration */
      myGH->out_last[vindex] = GH->cctk_iteration;
    }
  }

  return (0);
}


/*@@
   @routine    IOHDF5_OutputVarAs
   @date       Sat March 6 1999
   @author     Gabrielle Allen
   @desc
               Unconditional output of a variable
               using the IOHDF5 output method.
   @enddesc

   @calls      IOHDF5_Write

   @var        GH
   @vdesc      Pointer to CCTK GH
   @vtype      cGH *
   @vio        in
   @endvar
   @var        fullname
   @vdesc      complete name of variable to output
   @vtype      const char *
   @vio        in
   @endvar
   @var        alias
   @vdesc      alias name of variable to output
               (used to generate output filename)
   @vtype      const char *
   @vio        in
   @endvar
@@*/
int IOHDF5_OutputVarAs (cGH *GH, const char *fullname, const char *alias)
{
  DECLARE_CCTK_PARAMETERS
  int vindex;


  vindex = CCTK_VarIndex (fullname);

  if (verbose)
    CCTK_VInfo (CCTK_THORNSTRING, "IOHDF5_OutputVarAs: fullname, alias, "
                "index = (%s, %s, %d)", fullname, alias, vindex); 

  /* Do the output */
  IOHDF5_Write (GH, vindex, alias);

  return (0);
}


/*@@
   @routine    IOHDF5_TimeFor
   @date       Sat March 6 1999
   @author     Gabrielle Allen
   @desc
               Decides if it is time to output a variable
               using the IOHDF5 output method.
   @enddesc

   @calls      CheckSteerableParameters

   @var        GH
   @vdesc      Pointer to CCTK GH
   @vtype      cGH *
   @vio        in
   @endvar
   @var        vindex
   @vdesc      index of variable
   @vtype      int
   @vio        in
   @endvar

   @returntype int
   @returndesc
               1 if output should take place
               0 if not
   @endreturndesc
@@*/
int IOHDF5_TimeFor (cGH *GH, int vindex)
{
  ioHDF5GH *myGH;


  /* Get the GH extension for IOHDF5 */
  myGH = (ioHDF5GH *) CCTK_GHExtension (GH, "IOHDF5");

  CheckSteerableParameters (myGH);

  /* Check if any output was requested */
  if(myGH->out_every <= 0)
  {
    return (0);
  }

  /* Check this variable should be output */
  if (! (myGH->out_geo[vindex] && GH->cctk_iteration % myGH->out_every == 0))
  {
    return (0);
  }

  /* Check variable not already output this iteration */
  if (myGH->out_last[vindex] == GH->cctk_iteration)
  {
    CCTK_WARN (2, "Already done output in IOHDF5");
    return (0);
  }

  return (1);
}


/*@@
   @routine    IOHDF5_TriggerOutput
   @date       Sat March 6 1999
   @author     Gabrielle Allen
   @desc
               Triggers the output of a variable using the IOHDF5 output.
   @enddesc

   @calls      IOHDF5_Write

   @var        GH
   @vdesc      Pointer to CCTK GH
   @vtype      cGH *
   @vio        in
   @endvar
   @var        vindex
   @vdesc      index of variable
   @vtype      int
   @vio        in
   @endvar
@@*/
int IOHDF5_TriggerOutput (cGH *GH, int vindex)
{
  DECLARE_CCTK_PARAMETERS
  ioHDF5GH *myGH;
  char *fullname;
  const char *varname;


  varname = CCTK_VarName (vindex);

  myGH = (ioHDF5GH *) CCTK_GHExtension (GH, "IOHDF5");

  if (verbose)
  {
    fullname = CCTK_FullName (vindex);
    CCTK_VInfo (CCTK_THORNSTRING, "IOHDF5_TriggerOutput: "
                                  "output of (varname, fullname) "
                                  "= ('%s', '%s')", varname, fullname);
    free (fullname);
  }

  /* Do the output */
  IOHDF5_Write (GH, vindex, varname);

  /* Register variable as having output this iteration */
  myGH->out_last[vindex] = GH->cctk_iteration;

  return (0);
}


/***************************************************************************/
/*                            local functions                              */
/***************************************************************************/
/*@@
   @routine    CheckSteerableParameters
   @date       Mon Oct 10 2000
   @author     Thomas Radke
   @desc
               Checks if IOHDF5 steerable parameters were changed
               and does appropriate re-evaluation.
   @enddesc

   @calls      IOHDF5Util_ParseVarsForOutput

   @var        myGH
   @vdesc      Pointer to IOHDF5 GH
   @vtype      ioHDF5GH *
   @vio        in
   @endvar
@@*/
static void CheckSteerableParameters (ioHDF5GH *myGH)
{
  DECLARE_CCTK_PARAMETERS
  int times_set;
  static int out_vars_lastset = -1;


  /* How often to output */
  myGH->out_every = out_every > 0 ? out_every : -1;
  if (outHDF5_every > 0)
  {
    myGH->out_every = outHDF5_every;
  }

  /* re-parse the 'IOHDF5::out_vars' parameter if it was changed */
  times_set = CCTK_ParameterQueryTimesSet ("out_vars", CCTK_THORNSTRING);
  if (times_set != out_vars_lastset)
  {
    IOHDF5Util_ParseVarsForOutput (out_vars, myGH->out_geo);

    /* Save the last setting of 'out_vars' parameter */
    out_vars_lastset = times_set;
  }
}